diff --git a/roles/promtail/README.md b/roles/promtail/README.md index ef7bca5..dfb1605 100644 --- a/roles/promtail/README.md +++ b/roles/promtail/README.md @@ -10,10 +10,12 @@ Role Variables -------------- (all optional) -`promtail_version`: version to install -`promtail_loki_server`: set loki server -`promtail_loki_port`: set loki port -`custom_scrape_configs`: path to custom scrape configs +- `promtail_version`: Promtail version to install +- `promtail_loki_server`: address of the Loki server +- `promtail_loki_port`: Loki listening port +- `promtail_positions_path`: a YAML file containing last scraped positions in the logs (default: `/var/lib/promtail/positions.yaml`) +- `promtail_custom_scrape_configs`: additional `scrape_configs` configuration +- `promtail_add_var_logs`: scrape the entire `/var/logs` directory (default: `true`) Dependencies ------------