Skip to content

Commit a9a7249

Browse files
authored
Merge pull request #24905 from adtac/apfsnake
flow control metrics: switch to snake_case for labels
2 parents 6d72006 + 5ab1d97 commit a9a7249

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

content/en/docs/concepts/cluster-administration/flow-control.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -331,15 +331,22 @@ PriorityLevelConfigurations.
331331

332332
### Metrics
333333

334+
{{< note >}}
335+
In versions of Kubernetes before v1.20, the labels `flow_schema` and
336+
`priority_level` were inconsistently named `flowSchema` and `priorityLevel`,
337+
respectively. If you're running Kubernetes versions v1.19 and earlier, you
338+
should refer to the documentation for your version.
339+
{{< /note >}}
340+
334341
When you enable the API Priority and Fairness feature, the kube-apiserver
335342
exports additional metrics. Monitoring these can help you determine whether your
336343
configuration is inappropriately throttling important traffic, or find
337344
poorly-behaved workloads that may be harming system health.
338345

339346
* `apiserver_flowcontrol_rejected_requests_total` is a counter vector
340347
(cumulative since server start) of requests that were rejected,
341-
broken down by the labels `flowSchema` (indicating the one that
342-
matched the request), `priorityLevel` (indicating the one to which
348+
broken down by the labels `flow_schema` (indicating the one that
349+
matched the request), `priority_level` (indicating the one to which
343350
the request was assigned), and `reason`. The `reason` label will be
344351
have one of the following values:
345352
* `queue-full`, indicating that too many requests were already
@@ -352,8 +359,8 @@ poorly-behaved workloads that may be harming system health.
352359

353360
* `apiserver_flowcontrol_dispatched_requests_total` is a counter
354361
vector (cumulative since server start) of requests that began
355-
executing, broken down by the labels `flowSchema` (indicating the
356-
one that matched the request) and `priorityLevel` (indicating the
362+
executing, broken down by the labels `flow_schema` (indicating the
363+
one that matched the request) and `priority_level` (indicating the
357364
one to which the request was assigned).
358365

359366
* `apiserver_current_inqueue_requests` is a gauge vector of recent
@@ -384,25 +391,25 @@ poorly-behaved workloads that may be harming system health.
384391

385392
* `apiserver_flowcontrol_current_inqueue_requests` is a gauge vector
386393
holding the instantaneous number of queued (not executing) requests,
387-
broken down by the labels `priorityLevel` and `flowSchema`.
394+
broken down by the labels `priority_level` and `flow_schema`.
388395

389396
* `apiserver_flowcontrol_current_executing_requests` is a gauge vector
390397
holding the instantaneous number of executing (not waiting in a
391-
queue) requests, broken down by the labels `priorityLevel` and
392-
`flowSchema`.
398+
queue) requests, broken down by the labels `priority_level` and
399+
`flow_schema`.
393400

394401
* `apiserver_flowcontrol_priority_level_request_count_samples` is a
395402
histogram vector of observations of the then-current number of
396403
requests broken down by the labels `phase` (which takes on the
397-
values `waiting` and `executing`) and `priorityLevel`. Each
404+
values `waiting` and `executing`) and `priority_level`. Each
398405
histogram gets observations taken periodically, up through the last
399406
activity of the relevant sort. The observations are made at a high
400407
rate.
401408

402409
* `apiserver_flowcontrol_priority_level_request_count_watermarks` is a
403410
histogram vector of high or low water marks of the number of
404411
requests broken down by the labels `phase` (which takes on the
405-
values `waiting` and `executing`) and `priorityLevel`; the label
412+
values `waiting` and `executing`) and `priority_level`; the label
406413
`mark` takes on values `high` and `low`. The water marks are
407414
accumulated over windows bounded by the times when an observation
408415
was added to
@@ -411,7 +418,7 @@ poorly-behaved workloads that may be harming system health.
411418

412419
* `apiserver_flowcontrol_request_queue_length_after_enqueue` is a
413420
histogram vector of queue lengths for the queues, broken down by
414-
the labels `priorityLevel` and `flowSchema`, as sampled by the
421+
the labels `priority_level` and `flow_schema`, as sampled by the
415422
enqueued requests. Each request that gets queued contributes one
416423
sample to its histogram, reporting the length of the queue just
417424
after the request was added. Note that this produces different
@@ -428,12 +435,12 @@ poorly-behaved workloads that may be harming system health.
428435
* `apiserver_flowcontrol_request_concurrency_limit` is a gauge vector
429436
hoding the computed concurrency limit (based on the API server's
430437
total concurrency limit and PriorityLevelConfigurations' concurrency
431-
shares), broken down by the label `priorityLevel`.
438+
shares), broken down by the label `priority_level`.
432439

433440
* `apiserver_flowcontrol_request_wait_duration_seconds` is a histogram
434441
vector of how long requests spent queued, broken down by the labels
435-
`flowSchema` (indicating which one matched the request),
436-
`priorityLevel` (indicating the one to which the request was
442+
`flow_schema` (indicating which one matched the request),
443+
`priority_level` (indicating the one to which the request was
437444
assigned), and `execute` (indicating whether the request started
438445
executing).
439446
{{< note >}}
@@ -445,8 +452,8 @@ poorly-behaved workloads that may be harming system health.
445452

446453
* `apiserver_flowcontrol_request_execution_seconds` is a histogram
447454
vector of how long requests took to actually execute, broken down by
448-
the labels `flowSchema` (indicating which one matched the request)
449-
and `priorityLevel` (indicating the one to which the request was
455+
the labels `flow_schema` (indicating which one matched the request)
456+
and `priority_level` (indicating the one to which the request was
450457
assigned).
451458

452459
### Debug endpoints

0 commit comments

Comments
 (0)