Skip to content

docs: add prometheus scrape_config example #8113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 20, 2023
Merged

docs: add prometheus scrape_config example #8113

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4b1040e
docs: add prometheus scrape_config example
ericpaulsen Jun 20, 2023
6fe3599
make: fmt
ericpaulsen Jun 20, 2023
117921b
add: label
ericpaulsen Jun 20, 2023
d1b4900
fix: spelling
ericpaulsen Jun 20, 2023
02994ee
scheme: http
ericpaulsen Jun 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/admin/prometheus.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,19 @@ coderd_api_active_users_duration_hour 0
The Prometheus endpoint can be enabled in the [Helm chart's](https://github.com/coder/coder/tree/main/helm) `values.yml` by setting the environment variable `CODER_PROMETHEUS_ADDRESS` to `0.0.0.0:2112`.
The environment variable `CODER_PROMETHEUS_ENABLE` will be enabled automatically.

### Prometheus configuration

To allow Prometheus to scrape the Coder metrics, you will need to create a `scape_config`
in your `prometheus.yml` file, or in the Prometheus Helm chart values. Below is an
example `scrape_config`:

```yaml
scrape_configs:
- job_name: "coder"
static_configs:
- targets: ["<ip>:2112"] # replcace with the the IP address of the Coder pod or server
```

## Available metrics

<!-- Code generated by 'make docs/admin/prometheus.md'. DO NOT EDIT -->
Expand Down