Add basic documentation for the prometheus exporter (#2582)

runatlantis · Oct 12, 2022 · f6d24ee · f6d24ee
1 parent 1a81ffc
commit f6d24ee
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/runatlantis.io/docs/server-side-repo-config.md b/runatlantis.io/docs/server-side-repo-config.md
@@ -459,13 +459,20 @@ 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
 
 | Key    | Type   | Default | Required | Description                            |
 | ------ | ------ | ------- | -------- | -------------------------------------- |
 | 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
@@ -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