git » chasquid » master » tree

[master] / docs / monitoring.md

Monitoring

chasquid includes an HTTP server for monitoring purposes, which for security it is not enabled by default.

You can use the monitoring_address configuration option to enable it.

Then just browse the address and human-friendly links to various monitoring and debugging tools should appear.

These include:

Variables

chasquid exports some variables for monitoring, via the standard expvar package and the OpenMetrics text format, which can be useful for whitebox monitoring.

They're accessible on the monitoring HTTP server, at /debug/vars (default endpoint for expvars) and /metrics (common endpoint for openmetrics).

The /metrics endpoint is also compatible with Prometheus.

Note these are still subject to change, although breaking changes will be avoided whenever possible, and will be noted in the release notes.

List of exported variables: