Skip to content

Conversation

@mfkd
Copy link
Contributor

@mfkd mfkd commented Oct 22, 2025

Summary

  • document the three XR circuit breaker Prometheus counters alongside the existing Crossplane metrics table

Related issues

Testing

  • I ran hugo server and ensured it formats correctly

@netlify
Copy link

netlify bot commented Oct 22, 2025

Deploy Preview for crossplane ready!

Name Link
🔨 Latest commit 5de70e2
🔍 Latest deploy log https://app.netlify.com/projects/crossplane/deploys/6903441385fd36000856d8f3
😎 Deploy Preview https://deploy-preview-1012--crossplane.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 92 (🔴 down 1 from production)
Accessibility: 90 (🔴 down 2 from production)
Best Practices: 92 (no change from production)
SEO: 100 (no change from production)
PWA: 70 (no change from production)
View the detailed breakdown and full score reports

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

Copy link
Member

@jbw976 jbw976 left a comment

Choose a reason for hiding this comment

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

Thanks for the docs update too @mfkd!

Signed-off-by: mfkd <mattkfd@gmail.com>
@mfkd
Copy link
Contributor Author

mfkd commented Oct 30, 2025

Thanks @jbw976. I’ve pushed your requested changes.

Namely:

  1. DSO sign off
  2. Updated the circuit breaker metrics from crossplane_circuit_breaker_* to circuit_breaker_* to reflect the refactor changes in crossplane/crossplane#6870

While reviewing the metrics docs, I noticed gaps around engine, function-runner, and cached-runner metrics. The docs appear to list only one histogram metric and omit related counters/gauges, which may make it harder for users to discover all available metrics. Is this intentional for now?

Code references:
Engine metrics — not currently listed in metrics.md
Function runner metrics — only run_function_seconds histogram appears to be documented. Also the documentation has not been updated to reflect the naming change made here
Cached runner metrics — not currently listed in metrics.md

From what I can tell, the documented metrics mainly cover those exposed by controller-runtime, client-go, and some implemented in crossplane-runtime but omits much of the metrics mentioned above in crossplane/crossplane.

Would it make sense to open follow-up PRs to document these missing metrics in metrics.md, or is there existing work covering this?

Copy link
Collaborator

@jeanduplessis jeanduplessis left a comment

Choose a reason for hiding this comment

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

Thanks for adding these metrics @mfkd
I'm ignoring the failed Vale check as it list unrelated issues.

@jeanduplessis jeanduplessis merged commit 414a94c into crossplane:master Nov 19, 2025
6 of 7 checks passed
@jeanduplessis
Copy link
Collaborator

@mfkd I don't believe we intentionally are leaving out the missing metrics you mention. If you're willing to add them in a follow up PR that would be appreciated.

jeanduplessis added a commit that referenced this pull request Nov 19, 2025
Adds circuit breaker metrics that were added to master in #1012. These
metrics are available since v2.1 and should be documented in the v2.1
version folder.

Signed-off-by: Jean du Plessis <jean@upbound.io>
@mfkd
Copy link
Contributor Author

mfkd commented Nov 20, 2025

@jeanduplessis Thanks! I’ll get to it sometime next week.

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.

Add Prometheus metrics for circuit breaker monitoring

3 participants