Add metrics api docs#3478
Conversation
knative-prow-robot
added
the
do-not-merge/work-in-progress
knative-prow-robot
added
the
size/L
evankanderson
left a comment
evankanderson
left a comment
There was a problem hiding this comment.
I'm assuming this is an interim step and we'll autogenerate the docs from something canonical that we can also test from in the future?
| weight: 99 | ||
| type: "docs" | ||
| --- | ||
|
|
There was a problem hiding this comment.
Add something here indicating that these are a snapshot of current metrics and may change in the future?
| weight: 99 | ||
| type: "docs" | ||
| --- | ||
|
|
| | pending_pods | Number of pods that are pending currently | Gauge | configuration_name<br>namespace_name<br>revision_name<br>service_name | Dimensionless | Stable | | ||
| | terminating_pods | Number of pods that are terminating currently | Gauge | configuration_name<br>namespace_name<br>revision_name<br>service_name<br> | Dimensionless | Stable | | ||
|
|
||
| ### QUEUE proxy |
There was a problem hiding this comment.
Not sure we need to capitalize here?
| | event_dispatch_latencies | The time spent dispatching an event from a in-memory Channel | Histogram | container_name<br>event_type<br>namespace_name=<br>response_code<br>response_code_class<br>unique_name | Milliseconds | Stable | ||
|
|
||
|
|
||
| Note: A number of metrics eg. controller, Go runtime and others are omitted here as they are common across most components. For more about these metrics check the [Serving metrics API section](../serving/metrics/). |
There was a problem hiding this comment.
Use the #controller anchor on this ref?
Yes my idea is to use some file as input data but we dont need to decide this now. Also metrics dont change that often. Le't help users is my thinking here. |
knative-prow-robot
removed
the
do-not-merge/work-in-progress
evankanderson
left a comment
evankanderson
left a comment
There was a problem hiding this comment.
/lgtm
/approve
I expect we may move these docs around as we reorganize content to better serve different personas.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: evankanderson The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
knative-prow-robot
added
the
approved
3 participants
Fixes #1792
Proposed Changes
Screenshots bellow:
Note: tables can be improved with some custom table shortcode etc (goes beyond of this PR). Also in the future info could
be extracted from a cvs file (common practice with hugo).
/cc @matzew @markusthoemmes @evankanderson