-
Notifications
You must be signed in to change notification settings - Fork 147
docs: add circuit breaker metrics counters #1012
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.
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
Conversation
✅ Deploy Preview for crossplane ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
jbw976
left a comment
There was a problem hiding this 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!
- looks like the DCO check is failing, can you make sure the commit(s) are all signed off?
- do these metrics names need to be updated after this refactor PR has now been merged?
Signed-off-by: mfkd <mattkfd@gmail.com>
|
Thanks @jbw976. I’ve pushed your requested changes. Namely:
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: 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? |
jeanduplessis
left a comment
There was a problem hiding this 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.
|
@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. |
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>
|
@jeanduplessis Thanks! I’ll get to it sometime next week. |

Summary
Related issues
Testing
hugo serverand ensured it formats correctly