RPJosh
/
authelia
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
authelia/docs/content/en/configuration/telemetry/metrics.md

1.9 KiB
Raw Permalink Blame History

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://: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://:9959/" required="no" >}}

Reference Note: This configuration option uses the address common syntax. Please see the documentation on this format for more information.

Configures the listener address for the Prometheus Metrics Exporter HTTP Server. The address itself is a listener and the scheme must either be the unix scheme or one of the tcp schemes.

buffers

Reference Note: This configuration option uses the Server buffers common structure. Please see the documentation on this structure for more information.

Configures the server buffers.

timeouts

Reference Note: This configuration option uses the Server timeouts common structure. Please see the documentation on this structure for more information.

Configures the server timeouts.

See More