> For the complete documentation index, see [llms.txt](https://docs.bindplane.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bindplane.com/integrations/sources/bindplane.md).

# Bindplane

### Description

Monitor the logs of a Bindplane server. Requires a Bindplane Collector be installed on the same system as the server.

### Supported Platforms

Bindplane Collector: `v1.40.0`+

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

#### Configuration

<table><thead><tr><th width="154.921875">Field</th><th>Description</th></tr></thead><tbody><tr><td>Bindplane Log Path</td><td>The absolute path to the Bindplane log. Default is <code>/var/log/bindplane/bindplane.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></tbody></table>

### Example Configuration

#### Basic Configuration

For basic configuration, the defaults are used.

**Web Interface**

<figure><img src="/files/UT65z3AL2oOpqd5ghjHV" alt="Bindplane docs - Bindplane - 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: '/var/log/bindplane/bindplane.log'
    - name: enable_offset_storage
      value: true
    - name: offset_storage_dir
      value: '$OIQ_OTEL_COLLECTOR_HOME/storage'
    - name: start_at
      value: 'end'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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.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.