Metrics

Heimdall generates OpenTelemetry metrics and can export these either by pushing these to an OTEL collector (the default behavior), or by exposing them via a pull based service (Prometheus style).

Metrics are generated and exported by default. If this is not desired, you can explicitly disable this behavior by making use of the configuration options, described below. Alternatively, you can set the OTEL_METRICS_EXPORTER environment variable to none.

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

Beyond that, the entire configuration happens by making use of the environment variables as defined by OpenTelemetry Environment Variable Specification and OpenTelemetry SDK Configuration. Head over to Observability section and the referenced OTEL documentation for more details.

Last updated on Oct 5, 2023

Logging
Tracing