authelia/docs/content/en/configuration/telemetry/metrics.md

1.5 KiB

title description lead date draft images menu weight toc
Metrics Configuring the Metrics Telemetry settings Configuring the Metrics Telemetry settings. 2022-06-15T17:51:47+10:00 false
configuration
parent
telemetry
108200 true

Authelia allows administrators to configure a Prometheus Metrics Exporter.

Configuration

{{< config-alert-example >}}

telemetry:
  metrics:
    enabled: false
    address: "tcp://0.0.0.0:9959"
    buffers:
      read: 4096
      write: 4096
    timeouts:
      read: 6s
      write: 6s
      idle: 30s

Options

This section describes the individual configuration options.

enabled

{{< confkey type="boolean" default="false" required="no" >}}

Determines if the Prometheus HTTP Metrics Exporter is enabled.

address

{{< confkey type="address" default="tcp://0.0.0.0:9959" required="no" >}}

Configures the listener address for the Prometheus HTTP Metrics Exporter. This configuration key uses the Address format. The scheme must be tcp:// or empty.

buffers

Configures the server buffers. See the Server Buffers documentation for more information.

timeouts

Configures the server timeouts. See the Server Timeouts documentation for more information.

See More