aboutsummaryrefslogtreecommitdiffstats
path: root/ansible/roles/alloy/README.md
blob: 65d0d7fc30ae016a0459966e8254a2f338b21ed2 (plain) (blame)
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
# Grafana Alloy

This role deploys an instance of Grafana Alloy with configuration that by
default:
- Exports the system journal to the configured Loki instance
- Exports other log files as configured below

It requires the addition of the Grafana package repository to allow Alloy to be
installed with `apt`. This is handled by the role.

## Configuration values

Loki configuration options:

- `alloy_loki_endpoint`: The Loki log push endpoint to stream logs into.
- `alloy_loki_user`: Basic authentication username for Loki.
- `alloy_loki_password`: Basic authentication password for Loki.

Optional configuration options:

- `alloy_extra_files`: A list of objects with `name` and `path` that configure
  extra file sources to be shipped to Loki (in addition to the journal and paths
  mentioned above). Wildcards are supported. The `name` attribute must be
  alphanumeric or `_`.

Defaulted configuration options:

- `alloy_grafana_signing_key`: Signing key URL to use for Grafana packages
  (default: `https://apt.grafana.com/gpg.key`)
- `alloy_grafana_signing_key_fingerprint`: Expected key fingerprint from above
  configuration key, used to prevent malicious tampering (default: most recent
  known fingerprint of above address)
- `alloy_grafana_repository`: Repository to configure and add to aptitude
  (default: `deb https://apt.grafana.com stable main`)