blob: 16c8dd9e8de7064de23792995449e8089806623f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
---
title: "Metrics"
description: "Configuring the Metrics Telemetry settings"
summary: "Configuring the Metrics Telemetry settings."
date: 2022-06-15T17:51:47+10:00
draft: false
images: []
weight: 109200
toc: true
---
*Authelia* allows administrators to configure a [Prometheus] Metrics Exporter.
## Configuration
{{< config-alert-example >}}
```yaml {title="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
{{< confkey type="boolean" default="false" required="no" >}}
Determines if the [Prometheus] HTTP Metrics Exporter is enabled.
### address
{{< confkey type="string" syntax="address" default="tcp://:9959/metrics" required="no" >}}
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
{{< confkey type="structure" structure="server-buffers" required="no" >}}
Configures the server buffers.
### timeouts
{{< confkey type="structure" structure="server-timeouts" required="no" >}}
Configures the server timeouts.
## See More
- [Telemetry Reference Documentation](../../reference/guides/metrics.md)
[Prometheus]: https://prometheus.io/
|
