From 675847208e4369d1470d995764ba5f00231d4a13 Mon Sep 17 00:00:00 2001 From: Eric Paulsen Date: Fri, 1 Jul 2022 11:29:30 -0500 Subject: [PATCH] add: prometheus docs --- admin/prometheus.md | 33 +++++++++++++++++++++++++++++++++ manifest.json | 3 +++ 2 files changed, 36 insertions(+) create mode 100644 admin/prometheus.md diff --git a/admin/prometheus.md b/admin/prometheus.md new file mode 100644 index 000000000..5af44108b --- /dev/null +++ b/admin/prometheus.md @@ -0,0 +1,33 @@ +--- +title: Prometheus integration +description: Learn how to configure Prometheus with Coder. +--- + +The Prometheus integration enables you to query and visualize Coder's platform +metrics. + +## Requirements + +- A Coder deployment on Kubernetes +- [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator) +installed on your cluster + +## Configuration + +Coder sends Prometheus-formatted metrics to port `2112` on the `coderd` +container. Use the below PodMonitor resource to connect the Prometheus Operator +to this endpoint: + +```yaml +apiVersion: monitoring.coreos.com/v1 +kind: PodMonitor +metadata: + name: master-monitor + namespace: coder +spec: + selector: + matchLabels: + app.kubernetes.io/component: coderd + podMetricsEndpoints: + - port: prom-coderd +``` diff --git a/manifest.json b/manifest.json index ad99fe472..a59ad71f3 100644 --- a/manifest.json +++ b/manifest.json @@ -371,6 +371,9 @@ { "path": "./admin/git.md" }, + { + "path": "./admin/prometheus.md" + }, { "path": "./admin/licensing.md" },