whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

flow control metrics: switch to snake_case for labels

Browse Source 
Signed-off-by: Adhityaa Chandrasekar <adtac@google.com>
This commit is contained in:
Adhityaa Chandrasekar
2020-11-05 15:31:09 +00:00
parent 76e773ce85
commit 5ab1d974b5
1 changed files with 22 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/en/docs/concepts/cluster-administration/flow-control.md
+22 -15
View File
@@ -331,6 +331,13 @@ PriorityLevelConfigurations.
### Metrics ### Metrics
{{< note >}}
In versions of Kubernetes before v1.20, the labels `flow_schema` and
`priority_level` were inconsistently named `flowSchema` and `priorityLevel`,
respectively. If you're running Kubernetes versions v1.19 and earlier, you
should refer to the documentation for your version.
{{< /note >}}
When you enable the API Priority and Fairness feature, the kube-apiserver When you enable the API Priority and Fairness feature, the kube-apiserver
exports additional metrics. Monitoring these can help you determine whether your exports additional metrics. Monitoring these can help you determine whether your
configuration is inappropriately throttling important traffic, or find configuration is inappropriately throttling important traffic, or find
@@ -338,8 +345,8 @@ poorly-behaved workloads that may be harming system health.
* `apiserver_flowcontrol_rejected_requests_total` is a counter vector * `apiserver_flowcontrol_rejected_requests_total` is a counter vector
(cumulative since server start) of requests that were rejected, (cumulative since server start) of requests that were rejected,
broken down by the labels `flowSchema` (indicating the one that broken down by the labels `flow_schema` (indicating the one that
matched the request), `priorityLevel` (indicating the one to which matched the request), `priority_level` (indicating the one to which
the request was assigned), and `reason`. The `reason` label will be the request was assigned), and `reason`. The `reason` label will be
have one of the following values: have one of the following values:
* `queue-full`, indicating that too many requests were already * `queue-full`, indicating that too many requests were already
@@ -352,8 +359,8 @@ poorly-behaved workloads that may be harming system health.
* `apiserver_flowcontrol_dispatched_requests_total` is a counter * `apiserver_flowcontrol_dispatched_requests_total` is a counter
vector (cumulative since server start) of requests that began vector (cumulative since server start) of requests that began
executing, broken down by the labels `flowSchema` (indicating the executing, broken down by the labels `flow_schema` (indicating the
one that matched the request) and `priorityLevel` (indicating the one that matched the request) and `priority_level` (indicating the
one to which the request was assigned). one to which the request was assigned).
* `apiserver_current_inqueue_requests` is a gauge vector of recent * `apiserver_current_inqueue_requests` is a gauge vector of recent
@@ -384,17 +391,17 @@ poorly-behaved workloads that may be harming system health.
* `apiserver_flowcontrol_current_inqueue_requests` is a gauge vector * `apiserver_flowcontrol_current_inqueue_requests` is a gauge vector
holding the instantaneous number of queued (not executing) requests, holding the instantaneous number of queued (not executing) requests,
broken down by the labels `priorityLevel` and `flowSchema`. broken down by the labels `priority_level` and `flow_schema`.
* `apiserver_flowcontrol_current_executing_requests` is a gauge vector * `apiserver_flowcontrol_current_executing_requests` is a gauge vector
holding the instantaneous number of executing (not waiting in a holding the instantaneous number of executing (not waiting in a
queue) requests, broken down by the labels `priorityLevel` and queue) requests, broken down by the labels `priority_level` and
`flowSchema`. `flow_schema`.
* `apiserver_flowcontrol_priority_level_request_count_samples` is a * `apiserver_flowcontrol_priority_level_request_count_samples` is a
histogram vector of observations of the then-current number of histogram vector of observations of the then-current number of
requests broken down by the labels `phase` (which takes on the requests broken down by the labels `phase` (which takes on the
values `waiting` and `executing`) and `priorityLevel`. Each values `waiting` and `executing`) and `priority_level`. Each
histogram gets observations taken periodically, up through the last histogram gets observations taken periodically, up through the last
activity of the relevant sort. The observations are made at a high activity of the relevant sort. The observations are made at a high
rate. rate.
@@ -402,7 +409,7 @@ poorly-behaved workloads that may be harming system health.
* `apiserver_flowcontrol_priority_level_request_count_watermarks` is a * `apiserver_flowcontrol_priority_level_request_count_watermarks` is a
histogram vector of high or low water marks of the number of histogram vector of high or low water marks of the number of
requests broken down by the labels `phase` (which takes on the requests broken down by the labels `phase` (which takes on the
values `waiting` and `executing`) and `priorityLevel`; the label values `waiting` and `executing`) and `priority_level`; the label
`mark` takes on values `high` and `low`. The water marks are `mark` takes on values `high` and `low`. The water marks are
accumulated over windows bounded by the times when an observation accumulated over windows bounded by the times when an observation
was added to was added to
@@ -411,7 +418,7 @@ poorly-behaved workloads that may be harming system health.
* `apiserver_flowcontrol_request_queue_length_after_enqueue` is a * `apiserver_flowcontrol_request_queue_length_after_enqueue` is a
histogram vector of queue lengths for the queues, broken down by histogram vector of queue lengths for the queues, broken down by
the labels `priorityLevel` and `flowSchema`, as sampled by the the labels `priority_level` and `flow_schema`, as sampled by the
enqueued requests. Each request that gets queued contributes one enqueued requests. Each request that gets queued contributes one
sample to its histogram, reporting the length of the queue just sample to its histogram, reporting the length of the queue just
after the request was added. Note that this produces different after the request was added. Note that this produces different
@@ -428,12 +435,12 @@ poorly-behaved workloads that may be harming system health.
* `apiserver_flowcontrol_request_concurrency_limit` is a gauge vector * `apiserver_flowcontrol_request_concurrency_limit` is a gauge vector
hoding the computed concurrency limit (based on the API server's hoding the computed concurrency limit (based on the API server's
total concurrency limit and PriorityLevelConfigurations' concurrency total concurrency limit and PriorityLevelConfigurations' concurrency
shares), broken down by the label `priorityLevel`. shares), broken down by the label `priority_level`.
* `apiserver_flowcontrol_request_wait_duration_seconds` is a histogram * `apiserver_flowcontrol_request_wait_duration_seconds` is a histogram
vector of how long requests spent queued, broken down by the labels vector of how long requests spent queued, broken down by the labels
`flowSchema` (indicating which one matched the request), `flow_schema` (indicating which one matched the request),
`priorityLevel` (indicating the one to which the request was `priority_level` (indicating the one to which the request was
assigned), and `execute` (indicating whether the request started assigned), and `execute` (indicating whether the request started
executing). executing).
{{< note >}} {{< note >}}
@@ -445,8 +452,8 @@ poorly-behaved workloads that may be harming system health.
* `apiserver_flowcontrol_request_execution_seconds` is a histogram * `apiserver_flowcontrol_request_execution_seconds` is a histogram
vector of how long requests took to actually execute, broken down by vector of how long requests took to actually execute, broken down by
the labels `flowSchema` (indicating which one matched the request) the labels `flow_schema` (indicating which one matched the request)
and `priorityLevel` (indicating the one to which the request was and `priority_level` (indicating the one to which the request was
assigned). assigned).
### Debug endpoints ### Debug endpoints