# Health Check

### Health Check Extension Extension

The Health Check Extension enables an HTTP URL that can be probed to check the status of the Bindplane Collector.

### Configuration Table

<table><thead><tr><th width="218.14453125">Parameter</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td>listen_address</td><td><code>string</code></td><td>0.0.0.0</td><td>Hostname or IP address where the collector will publish the health check status.</td></tr><tr><td>listen_port</td><td>int</td><td>13133</td><td>HTTP port on which to publish the health check status.</td></tr><tr><td>path</td><td>string</td><td>/</td><td>the path to be configured for the health check server</td></tr><tr><td>healthy_response_body</td><td>string</td><td></td><td>A static body that overrides the default response returned by health check service when the collector is healthy.</td></tr><tr><td>unhealthy_response_body</td><td>string</td><td></td><td>A static body that overrides the default response returned by the health check service when the collector is unhealthy.</td></tr><tr><td>enable_tls</td><td>bool</td><td>false</td><td>Whether or not to use TLS.</td></tr><tr><td>cert_file</td><td>string</td><td></td><td>A TLS certificate used for authentication.</td></tr><tr><td>key_file</td><td>Private Key File</td><td></td><td>A TLS private key used for authentication.</td></tr><tr><td>mutual_tls</td><td>bool</td><td>false</td><td>Whether or not to use mutual TLS authentication</td></tr><tr><td>client_ca_file</td><td>string</td><td></td><td>Certificate authority used to validate the client TLS certificates.</td></tr></tbody></table>

{% hint style="info" %}
**NOTE**

While the `check_collector_pipeline` configuration exists for the [OpenTelemetry Health Check Extension](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/healthcheckextension/README.md), it's configuration is not exposed because its not working as expected. The Bindplane Health Check extension will be updated once a new extension is available as a replacement. More details can be found on the [OpenTelemetry Collector Contrib issue](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/11780).
{% endhint %}

### Example Configuration

#### Basic Configuration

For a basic configuration, we need to specify the `listen_address`, `listen_port`, and `path` parameters.

**Web Interface**

<figure><img src="/files/eHJ3WMArACURqghSCZ1f" alt="Bindplane docs - Health Check - image 1"><figcaption></figcaption></figure>

**Standalone Extension**

```yaml
apiVersion: bindplane.observiq.com/v1
kind: Extension
metadata:
  name: health_check
spec:
  type: health_check
  parameters:
    - name: listen_address
      value: '0.0.0.0'
    - name: listen_port
      value: 13133
    - name: path
      value: /
```

**Configuration with Embedded Extension**

// cspell:ignore 01HKZCF76TEYBEGHY0DZR040EQ

```yaml
apiVersion: bindplane.observiq.com/v1
kind: Configuration
metadata:
  id: example_configuration
  name: example_configuration
  labels:
    platform: linux
spec:
  contentType: ''
  measurementInterval: ''
  extensions:
    - id: 01HKZCF76TEYBEGHY0DZR040EQ
      type: health_check
      parameters:
        - name: listen_address
          value: 0.0.0.0
        - name: listen_port
          value: 13133
        - name: path
          value: /
        - name: healthy_response_body
          value: ''
        - name: unhealthy_response_body
          value: ''
        - name: enable_tls
          value: false
        - name: cert_file
          value: ''
        - name: key_file
          value: ''
        - name: mutual_tls
          value: false
        - name: client_ca_file
          value: ''
  selector:
    matchLabels:
      configuration: example_configuration
```


---

# 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/configuration/bindplane-otel-collector/extensions/health-check.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.