Skip to content

docs: document available cert-manager Prometheus metrics - #2222

Open
amarkdotdev wants to merge 1 commit into
cert-manager:masterfrom
amarkdotdev:docs/prometheus-metrics-reference
Open

docs: document available cert-manager Prometheus metrics#2222
amarkdotdev wants to merge 1 commit into
cert-manager:masterfrom
amarkdotdev:docs/prometheus-metrics-reference

Conversation

@amarkdotdev

Copy link
Copy Markdown

Summary

  • Documents the Prometheus metrics exposed by the cert-manager controller on the existing Prometheus Metrics page (Certificate, Challenge, Issuer, ACME client, Venafi, controller sync, and clock metrics), based on pkg/metrics and internal/collectors.
  • Adds a warning that labeled /metrics series often appear only after first use, which can look like a scrape failure right after startup.
  • Notes where metrics are defined in code so new metrics can be kept in sync with the docs.

Fixes #850

Test plan

  • Preview content/docs/devops-tips/prometheus-metrics.md and confirm the new Available metrics section renders with tables for each category
  • Spot-check metric names/labels against https://github.com/cert-manager/cert-manager/tree/master/pkg/metrics and internal/collectors
  • Confirm Venafi OAuth metrics remain documented (now under Available metrics → Venafi metrics)
  • Confirm the first-use warning and source-of-truth note are present

List controller Prometheus metrics (certificates, challenges, issuers,
ACME/Venafi clients, sync, clock) on the metrics page, and warn that
labeled series appear only after first use.

Fixes cert-manager#850

Signed-off-by: amarkdotdev <amarkdotdev@users.noreply.github.com>
@cert-manager-prow cert-manager-prow Bot added the dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. label Aug 3, 2026
@cert-manager-prow

Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign jakexks for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@cert-manager-prow cert-manager-prow Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Aug 3, 2026
@netlify

netlify Bot commented Aug 3, 2026

Copy link
Copy Markdown

Deploy Preview for cert-manager ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 56bc0b8
🔍 Latest deploy log https://app.netlify.com/projects/cert-manager/deploys/6a70dff252a0610008891692
😎 Deploy Preview https://deploy-preview-2222--cert-manager.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dco-signoff: yes Indicates that all commits in the pull request have the valid DCO sign-off message. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document available cert-manager Prometheus metrics

1 participant