# Bindplane Collector

### Description

Monitor the logs and metrics of the Bindplane Collector the config is applied to.

### Supported Platforms

Bindplane Collector: `v1.40.0`+

| Platform | Metrics | Logs | Traces |
| -------- | ------- | ---- | ------ |
| Linux    | ✓       | ✓    |        |
| Windows  | ✓       | ✓    |        |
| macOS    | ✓       | ✓    |        |

#### Configuration

<table><thead><tr><th width="152.953125">Field</th><th>Description</th></tr></thead><tbody><tr><td>Collector Log Path</td><td>The absolute path to the bindplane-agent log. Default is <code>$OIQ_OTEL_COLLECTOR_HOME/log/collector.log</code>.</td></tr><tr><td>Enable File Offset Storage</td><td>When enabled, the current position into a file will be saved to disk, and reading will resume from where it left off after a collector restart.</td></tr><tr><td>Offset Storage Directory</td><td>The directory that the offset storage file will be created. Default is <code>$OIQ_OTEL_COLLECTOR_HOME/storage</code>.</td></tr><tr><td>Start At</td><td>Where in the log file to begin reading logs from. Can be <code>beginning</code> or <code>end</code>.</td></tr><tr><td>Collection Interval</td><td>Sets how often (seconds) to scrape for metrics.</td></tr><tr><td>Process Metrics</td><td>When enabled, the source will collect process metrics. Default is <code>true</code>.</td></tr><tr><td>Receiver Metrics</td><td>When enabled, the source will collect receiver metrics. Default is <code>true</code>.</td></tr><tr><td>Processor Metrics</td><td>When enabled, the source will collect processor metrics. Default is <code>true</code>.</td></tr><tr><td>Exporter Metrics</td><td>When enabled, the source will collect exporter metrics. Default is <code>true</code>.</td></tr></tbody></table>

### Example Configuration

#### Basic Configuration

For basic configuration, the defaults are used.

**Web Interface**

<figure><img src="/files/J0Sdncmo1Lswoo5kiwv6" alt="Bindplane docs - Bindplane Collector - image 1"><figcaption></figcaption></figure>

**Standalone Source**

```yaml
apiVersion: bindplane.observiq.com/v1
kind: Source
metadata:
  id: bindplane-agent
  name: bindplane-agent
spec:
  type: bindplane-agent
  parameters:
    - name: log_path
      value: '$OIQ_OTEL_COLLECTOR_HOME/log/collector.log'
    - name: enable_offset_storage
      value: true
    - name: offset_storage_dir
      value: '$OIQ_OTEL_COLLECTOR_HOME/storage'
    - name: start_at
      value: 'end'
    - name: collection_interval
      value: 60
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.bindplane.com/integrations/sources/bindplane-collector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
