From 02525ae35ce528dd4a9729de8814b99e13e7d4a3 Mon Sep 17 00:00:00 2001 From: "tom.chivert" Date: Thu, 14 Sep 2023 15:46:09 +0200 Subject: [PATCH] update documentation --- README.md | 6 ++++-- docs/variables.md | 1 + 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 440cd30..402019d 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,8 @@ prometheus ========== The present role : - - installs prometheus server inside a Docker container - - installs various prometheus exporter + - Installs Prometheus server inside a docker container. + - Installs various Prometheus exporter. - node - blackbox - apache @@ -16,6 +16,8 @@ The present role : - postgres - mongodb - opensearch (via plugin for opensearch https://github.com/aiven/prometheus-exporter-plugin-for-opensearch) + - Deploys Grafana with a dashboard for each exporter configured. + - Supports deploying VictoriaMetrics as the Prometheus backend. Please note that Docker and Haproxy their own embedded exporters. - https://docs.docker.com/config/daemon/prometheus/ diff --git a/docs/variables.md b/docs/variables.md index a048116..277f46b 100644 --- a/docs/variables.md +++ b/docs/variables.md @@ -19,6 +19,7 @@ | prometheus_nodes_ip | The IP addresses of Prometheus nodes | Dictionary | localhost: "127.0.0.1" | | prometheus_retention_time | The retention time for Prometheus data | String | "15d" | | prometheus_server_enable | Whether to enable the Prometheus server | Boolean | false | +| prometheus_use_victoriametrics | Use VictoriaMetrics as prometheus backend | Boolean | false | | prometheus_server_global_evaluation_interval | The global evaluation interval for Prometheus server | Integer | 15 | | prometheus_server_global_scrape_interval | The global scrape interval for Prometheus server | Integer | 15 | | prometheus_server_job_name | The job name for Prometheus server | String | "prometheus" |