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

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

NOTE

While the check_collector_pipeline configuration exists for the OpenTelemetry Health Check Extension, 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.

Example Configuration

Basic Configuration

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

Web Interface

Standalone Extension

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

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