Monitoring

Monitoring BindPlane Server

BindPlane can be configured to export metrics about its health, for example allowing you to see a sudden drop in connected agents or dangerously high memory utilization. These metrics can be collected by two methods: scraping a Prometheus endpoint on the server, or sending to an OTLP endpoint.

For both methods, we recommend collecting the metrics with the BindPlane Agent, which can then perform processing and forward metrics to your monitoring platform.

By default, your config.yaml file will contain this base metrics block, which doesn't export anything:

1metrics:
2  interval: 1m0s
3  prometheus:
4    endpoint: /metrics

OTLP

Use the following values for the metrics block of your config.yaml.

1metrics:
2  type: otlp
3  interval: 60s
4  otlp:
5    endpoint: 127.0.0.1:4317
6    insecure: true

With this configuration, metrics will be exported every 60 seconds to an OTLP endpoint without TLS. To have your BindPlane Agent collect these metrics, add an OTLP source listening on port 4317.

Prometheus

Use the following values for the metrics block of your config.yaml.

1metrics:
2  type: prometheus
3  interval: 60s
4  prometheus:
5    endpoint: /metrics

With this configuration, metrics will be available in Prometheus format at the /metrics of the BindPlane server. The endpoint will be available without authentication. To protect the endpoint with basic auth, provide the username and password parameters:

1metrics:
2  type: prometheus
3  interval: 60s
4  prometheus:
5    endpoint: /metrics
6    username: user
7    password: pass

We recommend collecting the metrics using the BindPlane Agent, or you can also scrape it directly from a tool like Grafana.