Skip to content

chore(docs): document prometheus path label configuration options #2564

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

Open
kalEl2001 wants to merge 1 commit into
base: master
Choose a base branch
from
+27 −0
Open

chore(docs): document prometheus path label configuration options #2564

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions docs/oathkeeper/configure-deploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,6 +376,33 @@ serve:
EOF
```

### Controlling request path labels

By default, Oathkeeper includes the full request path as a label on Prometheus metrics. For high-cardinality APIs this can
produce an unbounded number of label values, which increases Prometheus memory usage. Three configuration options let you
control this behavior:

| Option | Type | Default | Description |
|---|---|---|---|
| `hide_request_paths` | bool | `false` | When `true`, the request path label is omitted entirely. |
| `collapse_request_paths` | bool | `true` | When `true`, the path is truncated to the first N segments (controlled by `collapse_request_paths_depth`). |
| `collapse_request_paths_depth` | int | `1` | Number of path segments to keep when `collapse_request_paths` is enabled. |
Comment on lines +381 to +389

For example, with `collapse_request_paths: true` and `collapse_request_paths_depth: 2`, a request to
`/decisions/my-service/some-resource` is recorded as `/decisions/my-service`, keeping cardinality low while still
distinguishing between top-level services.

```yaml
serve:
prometheus:
port: 9000
host: localhost
metrics_path: /metrics
hide_request_paths: false
collapse_request_paths: true
collapse_request_paths_depth: 2
```

Prometheus can be run as a Docker container. More information are available on
[https://github.com/prometheus/prometheus](https://github.com/prometheus/prometheus). Start with setting up a Prometheus
configuration:
Expand Down
Loading