Skip to content

Commit 9e0c62e

Browse files
authored
add: prometheus docs (coder#1035)
1 parent 13b84e6 commit 9e0c62e

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

admin/prometheus.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Prometheus integration
3+
description: Learn how to configure Prometheus with Coder.
4+
---
5+
6+
The Prometheus integration enables you to query and visualize Coder's platform
7+
metrics.
8+
9+
## Requirements
10+
11+
- A Coder deployment on Kubernetes
12+
- [Prometheus Operator](https://github.com/prometheus-operator/prometheus-operator)
13+
installed on your cluster
14+
15+
## Configuration
16+
17+
Coder sends Prometheus-formatted metrics to port `2112` on the `coderd`
18+
container. Use the below PodMonitor resource to connect the Prometheus Operator
19+
to this endpoint:
20+
21+
```yaml
22+
apiVersion: monitoring.coreos.com/v1
23+
kind: PodMonitor
24+
metadata:
25+
name: master-monitor
26+
namespace: coder
27+
spec:
28+
selector:
29+
matchLabels:
30+
app.kubernetes.io/component: coderd
31+
podMetricsEndpoints:
32+
- port: prom-coderd
33+
```

manifest.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,9 @@
371371
{
372372
"path": "./admin/git.md"
373373
},
374+
{
375+
"path": "./admin/prometheus.md"
376+
},
374377
{
375378
"path": "./admin/licensing.md"
376379
},

0 commit comments

Comments
 (0)