Skip to content

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

Closed
kalEl2001 wants to merge 2 commits into
ory:masterfrom
kalEl2001:master
Closed

chore(docs): document prometheus path label configuration options#2563
kalEl2001 wants to merge 2 commits into
ory:masterfrom
kalEl2001:master

Conversation

@kalEl2001
Copy link
Copy Markdown

@kalEl2001 kalEl2001 commented May 20, 2026

Document the collapse_request_paths_depth configuration option for Oathkeeper's
Prometheus metrics, introduced in ory/oathkeeper#.

The existing monitoring section only covered basic Prometheus setup (port, host,
metrics_path). This adds a "Controlling request path labels" subsection explaining
all three path label options (hide_request_paths, collapse_request_paths, and
the new collapse_request_paths_depth) with a comparison table and a config example.

Related Issue or Design Document

ory/oathkeeper#1212

Checklist

  • I have read the contributing guidelines and signed the CLA.
  • I have referenced an issue containing the design document if my change introduces a new feature.
  • I have read the security policy.
  • I confirm that this pull request does not address a security vulnerability.
    If this pull request addresses a security vulnerability,
    I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added the necessary documentation within the code base (if appropriate).

Further comments

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents Oathkeeper’s Prometheus request-path label cardinality controls by adding a dedicated subsection to the Monitoring guide, including the newly introduced collapse_request_paths_depth option.

Changes:

  • Add a “Controlling request path labels” subsection describing hide_request_paths, collapse_request_paths, and collapse_request_paths_depth.
  • Include a comparison table and an example serve.prometheus configuration snippet.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/oathkeeper/configure-deploy.mdx Outdated
Comment thread docs/oathkeeper/configure-deploy.mdx Outdated

### Controlling request path labels

By default, Oathkeeper includes the full request path as a label on Prometheus metrics. For high-cardinality APIs this can
@kalEl2001 kalEl2001 changed the title add docs for prometheus parameters docs(oathkeeper): document prometheus path label configuration options May 20, 2026
@kalEl2001 kalEl2001 changed the title docs(oathkeeper): document prometheus path label configuration options chore(docs): document prometheus path label configuration options May 20, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ kalEl2001
❌ kalEl2001-cc
You have signed the CLA already but the status is still pending? Let us recheck it.

@kalEl2001 kalEl2001 closed this May 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants