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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
---
title: "Telemetry"
description: "A reference guide on the telemetry collection"
summary: "This section contains reference documentation for Authelia's telemetry systems."
date: 2022-06-15T17:51:47+10:00
draft: false
images: []
weight: 220
toc: true
seo:
title: "" # custom title (optional)
description: "" # custom description (recommended)
canonical: "" # custom canonical URL (optional)
noindex: false # false (default) or true
---
No telemetry data is collected by any *Authelia* binaries, tooling, etc by default and all telemetry data is intended
to be used by administrators of their individual *Authelia* installs.
## Metrics
### Prometheus
*Authelia* supports exporting [Prometheus] metrics. These metrics are served on a separate port at the `/metrics` path
when configured. If metrics are enabled the metrics listener listens on `:9959` as per the officially
[registered port] unless configured otherwise.
#### Example Prometheus Job
```yaml
# Authelia
- job_name: authelia
scrape_interval: 60s
scheme: http
static_configs:
- targets: [authelia_address:9959]
```
*Notes: Replace 'authelia_address' with the URL or IP of your Authelia container.*
#### Recorded Metrics
##### Vectored Counters
| Name | Vectors | Description |
|:-------------------:|:---------------------------:|:--------------------:|
| request | `code`, `method` | All Requests |
| authz | `code` | Authz Requests |
| authn | `success`, `banned` | Authn Requests (1FA) |
| authn_second_factor | `success`, `banned`, `type` | Authn Requests (2FA) |
##### Vectored Histograms
| Name | Vectors | Buckets |
|:-------------------------------:|:------------------:|:-------------------------------------------------------------------------------------------------------------:|
| authn_duration | `success` | .0005, .00075, .001, .005, .01, .025, .05, .075, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.8, 0.9, 1, 5, 10, 15, 30, 60 |
| request_duration | `code` | .005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10, 15, 20, 30, 40, 50, 60 |
| request_duration_openid_connect | `endpoint`, `code` | .005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10, 15, 20, 30, 40, 50, 60 |
#### Vector Definitions
##### code
The HTTP response status code.
##### method
The HTTP request method.
##### success
If the authentication was successful (`true`) or not (`false`).
##### banned
If the authentication was considered banned (`true`) or not (`false`).
##### type
The authentication type `webauthn`, `totp`, or `duo`.
##### endpoint
The endpoint name.
OpenID Connect 1.0 Endpoint Names:
- authorization
- pushed_authorization_request
- token
- userinfo
- revocation
- introspection
- openid_configuration
- oauth_configuration
- jwks
[Prometheus]: https://prometheus.io/
[registered port]: https://github.com/prometheus/prometheus/wiki/Default-port-allocations
|
