Metrics

As of today, heimdall only supports Prometheus as metrics backend, which is also enabled by default by exposing available metrics on 0.0.0.0:9000/metrics endpoint.

Prometheus

Configuration for Prometheus can be adjusted in the prometheus property, which lives in the metrics property of heimdall’s configuration and supports following properties.

  • host: string (optional)

    By making use of this property, you can specify the TCP/IP address on which heimdall should listen for connections from client applications. The entry 0.0.0.0 allows listening for all IPv4 addresses. 0.0.0.0 is also the default setting.

    Example 1. Configure heimdall to allow only local TCP/IP “loopback” connections to be made.
    metrics:
  prometheus:
    host: 127.0.0.1

  • port: integer (optional)

    By making use of this property, you can specify the TCP port the heimdall should listen on. Defaults to 9000.

    Example 2. Configure heimdall to listen on port 9999 for metrics requests.
    metrics:
  prometheus:
    port: 9999

  • metrics_path: string (optional)

    By making use of this property, you can specify the path under which prometheus metrics information is made available. Defaults to /metrics.

    Example 3. Configure heimdall expose metrics information behind /prometheus path.
    metrics:
  prometheus:
    metrics_path: /prometheus

Last updated on Jun 29, 2022

Logging
Tracing