Metrics

Heimdall exposes Prometheus style metrics on 127.0.0.1:10250/metrics endpoint for analysis and visualization purposes.

Configuration

Configuration for this service can be adjusted in the metrics property of heimdall’s configuration by making use of the following properties.

  • enabled: boolean (optional)

    By making use of this property, you can configure heimdall to enable or disable the metrics service. Defaults to true (metrics exposure is enabled).

    Example 1. Disabling metrics.
    metrics:
  enabled: false

  • 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. Defaults to 127.0.0.1 - the loopback interface to avoid unwanted exposure of metrics.

    If you operate heimdall in a container, you should set this property to a value, which would allow your APM system to scrape this information.
    Example 2. Configure heimdall to allow listening on any TCP/IP interfaces.
    metrics:
  host: 0.0.0.0

  • port: integer (optional)

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

    Example 3. Configure heimdall to listen on port 9999 for metrics requests.
    metrics:
  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 4. Configure heimdall expose metrics information behind /prometheus path.
    metrics:
  metrics_path: /prometheus

Last updated on Jan 19, 2023

Logging
Tracing