Add ingress_controller_configuration_push_count.failure_reason label description #4500
Conversation
czeslavo
added
do not merge
✅ Deploy Preview for kongdocs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
czeslavo
added
team-k8s
| * [workqueue metrics definition](https://github.com/kubernetes/component-base/blob/release-1.20/metrics/prometheus/workqueue/metrics.go#L29) | ||
| `ingress_controller_configuration_push_count` provides the number of successful or failed configuration pushes to {{site.base_gateway}}. | ||
|
|
||
| This metric expects that the following parameters are configured: |
There was a problem hiding this comment.
@czeslavo I added this to each metric section because the full metric example (ex. ingress_controller_configuration_push_count[success=true|false][protocol=db-less|deck]) was too long for the page. Is this accurate to call these "parameters"? And would customers know where to put these values without the example (ex. ingress_controller_configuration_push_count[success=true|false][protocol=db-less|deck])?
There was a problem hiding this comment.
These parameters are called metric's labels. I reworded the sentences to specifically use this term (b317f2a). They are populated by us while reporting the metric, and the user can inspect them. I think that it's going to be enough to have all possible values of every label explained in the way you've structured that. 👍
…description (#4500) * Add ingress_controller_configuration_push_count.failure_reason label description * Add network label value * point * drop unnecessary row * Fix table formatting and copyedit * Add lead in sentence to bullet points * add types, parameters -> labels Co-authored-by: Diana <[email protected]>
Summary
It adds a description regarding
ingress_controller_configuration_push_count.failure_reasonmetric label. Label was released in KIC 2.7.0 therefore it's conditionally rendered using{% if_version gte:2.7.x %}.Reason
Kong/kubernetes-ingress-controller#2484
Depends on: Kong/kubernetes-ingress-controller#2965
Testing
https://deploy-preview-4500--kongdocs.netlify.app/kubernetes-ingress-controller/2.7.x/references/prometheus/