docs
docs copied to clipboard
docs: add circuit breaker metrics counters
Summary
- document the three XR circuit breaker Prometheus counters alongside the existing Crossplane metrics table
Related issues
Testing
- I ran
hugo serverand ensured it formats correctly
Deploy Preview for crossplane ready!
| Name | Link |
|---|---|
| Latest commit | 5de70e28c271cfab3dfe68370a8bd3653bf0f992 |
| 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...Use your smartphone camera to open QR code link. |
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.
Thanks @jbw976. I’ve pushed your requested changes.
Namely:
- DSO sign off
- Updated the circuit breaker metrics from
crossplane_circuit_breaker_*tocircuit_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?
@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 Thanks! I’ll get to it sometime next week.
