From f6d24eef0ffd34d509fa5793a29919551438f1ae Mon Sep 17 00:00:00 2001 From: Marcus Ramberg Date: Wed, 12 Oct 2022 04:56:21 +0200 Subject: [PATCH] Add basic documentation for the prometheus exporter (#2582) --- runatlantis.io/docs/server-side-repo-config.md | 13 ++++++++++--- runatlantis.io/docs/stats.md | 2 +- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/runatlantis.io/docs/server-side-repo-config.md b/runatlantis.io/docs/server-side-repo-config.md index 84f64ccda9..a54c8bd2ec 100644 --- a/runatlantis.io/docs/server-side-repo-config.md +++ b/runatlantis.io/docs/server-side-repo-config.md @@ -459,9 +459,10 @@ If you set a workflow with the key `default`, it will override this. ### Metrics -| Key | Type | Default | Required | Description | -|------------------------|-------------------|---------|-----------|------------------------------------------| -| statsd | [Statsd](#statsd) | none | no | Statsd metrics provider | +| Key | Type | Default | Required | Description | +|------------------------|---------------------------|---------|-----------|------------------------------------------| +| statsd | [Statsd](#statsd) | none | no | Statsd metrics provider | +| prometheus | [Prometheus](#prometheus) | none | no | Statsd metrics provider | ### Statsd @@ -469,3 +470,9 @@ If you set a workflow with the key `default`, it will override this. | ------ | ------ | ------- | -------- | -------------------------------------- | | host | string | none | yes | statsd host ip address | | port | string | none | yes | statsd port | + +### Prometheus + +| Key | Type | Default | Required | Description | +| -------- | ------ | ------- | -------- | -------------------------------------- | +| endpoint | string | none | yes | path to metrics endpoint | diff --git a/runatlantis.io/docs/stats.md b/runatlantis.io/docs/stats.md index 1717154489..b4f12c4b60 100644 --- a/runatlantis.io/docs/stats.md +++ b/runatlantis.io/docs/stats.md @@ -3,7 +3,7 @@ Atlantis exposes a set of metrics for each of its operations including errors, successes, and latencies. ::: warning NOTE -Only statsd is supported currently, but it should be relatively straightforward to add other providers such as prometheus. +Currently Statsd and Prometheus is supported. See configuration below for details. ::: ## Configuration