Authelia Get started

Metrics

Authelia allows administrators to configure a Prometheus Metrics Exporter.

Configuration

Example Configuration

This section is intended as an example configuration to help users with a rough contextual layout of this configuration section, it is not intended to explain the options. The configuration shown may not be a valid configuration, and you should see the options section below and the navigation links to properly understand each option individually.

configuration.yml 
telemetry:
  metrics:
    enabled: false
    address: 'tcp://:9959/metrics'
    buffers:
      read: 4096
      write: 4096
    timeouts:
      read: '6s'
      write: '6s'
      idle: '30s'

Options

This section describes the individual configuration options.

enabled

boolean false not required

Determines if the Prometheus HTTP Metrics Exporter is enabled.

address

string address tcp://:9959/metrics not required

Reference Note

This configuration option uses a common syntax. For more information please see both the configuration example and the Common Syntax: Address reference guide.

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

structure server-buffers not required

Reference Note

This configuration option uses a common structure. For more information please see both the configuration example and the Common Structure: Server Buffers reference guide.

Configures the server buffers.

timeouts

structure server-timeouts not required

Reference Note

This configuration option uses a common structure. For more information please see both the configuration example and the Common Structure: Server Timeouts reference guide.

Configures the server timeouts.

See More

Last updated on July 7, 2024
Edit this page on GitHub
Prev
Telemetry
Next
Identity Providers