From 88f8e8448bf873cf41035cb858422a10a1d03018 Mon Sep 17 00:00:00 2001 From: Mike Spreitzer Date: Tue, 30 Nov 2021 11:45:53 -0500 Subject: [PATCH] Clarify APF metric wrt all three stages of execution --- .../fairqueuing/queueset/queueset_test.go | 8 +++--- .../pkg/util/flowcontrol/metrics/metrics.go | 28 +++++++++---------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/staging/src/k8s.io/apiserver/pkg/util/flowcontrol/fairqueuing/queueset/queueset_test.go b/staging/src/k8s.io/apiserver/pkg/util/flowcontrol/fairqueuing/queueset/queueset_test.go index e14e57bf285..2ced2c5be94 100644 --- a/staging/src/k8s.io/apiserver/pkg/util/flowcontrol/fairqueuing/queueset/queueset_test.go +++ b/staging/src/k8s.io/apiserver/pkg/util/flowcontrol/fairqueuing/queueset/queueset_test.go @@ -351,7 +351,7 @@ func (uss *uniformScenarioState) finalReview() { } if uss.evalInqueueMetrics { e := ` - # HELP apiserver_flowcontrol_current_inqueue_requests [ALPHA] Number of requests currently pending in queues of the API Priority and Fairness system + # HELP apiserver_flowcontrol_current_inqueue_requests [ALPHA] Number of requests currently pending in queues of the API Priority and Fairness subsystem # TYPE apiserver_flowcontrol_current_inqueue_requests gauge ` + uss.expectedInqueue err := metrics.GatherAndCompare(e, "apiserver_flowcontrol_current_inqueue_requests") @@ -374,7 +374,7 @@ func (uss *uniformScenarioState) finalReview() { } if uss.evalExecutingMetrics && len(uss.expectedExecuting) > 0 { e := ` - # HELP apiserver_flowcontrol_current_executing_requests [ALPHA] Number of requests in regular execution phase in the API Priority and Fairness system + # HELP apiserver_flowcontrol_current_executing_requests [ALPHA] Number of requests in initial (for a WATCH) or any (for a non-WATCH) execution stage in the API Priority and Fairness subsystem # TYPE apiserver_flowcontrol_current_executing_requests gauge ` + uss.expectedExecuting err := metrics.GatherAndCompare(e, "apiserver_flowcontrol_current_executing_requests") @@ -386,7 +386,7 @@ func (uss *uniformScenarioState) finalReview() { } if uss.evalExecutingMetrics && len(uss.expectedConcurrencyInUse) > 0 { e := ` - # HELP apiserver_flowcontrol_request_concurrency_in_use [ALPHA] Concurrency (number of seats) occupided by the currently executing (all phases count) requests in the API Priority and Fairness system + # HELP apiserver_flowcontrol_request_concurrency_in_use [ALPHA] Concurrency (number of seats) occupied by the currently executing (initial stage for a WATCH, any stage otherwise) requests in the API Priority and Fairness subsystem # TYPE apiserver_flowcontrol_request_concurrency_in_use gauge ` + uss.expectedConcurrencyInUse err := metrics.GatherAndCompare(e, "apiserver_flowcontrol_request_concurrency_in_use") @@ -398,7 +398,7 @@ func (uss *uniformScenarioState) finalReview() { } if uss.evalExecutingMetrics && len(expectedRejects) > 0 { e := ` - # HELP apiserver_flowcontrol_rejected_requests_total [ALPHA] Number of requests rejected by API Priority and Fairness system + # HELP apiserver_flowcontrol_rejected_requests_total [ALPHA] Number of requests rejected by API Priority and Fairness subsystem # TYPE apiserver_flowcontrol_rejected_requests_total counter ` + expectedRejects err := metrics.GatherAndCompare(e, "apiserver_flowcontrol_rejected_requests_total") diff --git a/staging/src/k8s.io/apiserver/pkg/util/flowcontrol/metrics/metrics.go b/staging/src/k8s.io/apiserver/pkg/util/flowcontrol/metrics/metrics.go index 88f812490ba..e03bc12e182 100644 --- a/staging/src/k8s.io/apiserver/pkg/util/flowcontrol/metrics/metrics.go +++ b/staging/src/k8s.io/apiserver/pkg/util/flowcontrol/metrics/metrics.go @@ -89,7 +89,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "rejected_requests_total", - Help: "Number of requests rejected by API Priority and Fairness system", + Help: "Number of requests rejected by API Priority and Fairness subsystem", StabilityLevel: compbasemetrics.ALPHA, }, []string{priorityLevel, flowSchema, "reason"}, @@ -99,7 +99,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "dispatched_requests_total", - Help: "Number of requests released by API Priority and Fairness system for service", + Help: "Number of requests executed by API Priority and Fairness subsystem", StabilityLevel: compbasemetrics.ALPHA, }, []string{priorityLevel, flowSchema}, @@ -110,7 +110,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "priority_level_seat_count_samples", - Help: "Periodic observations of the number of requests", + Help: "Periodic observations of number of seats occupied for any stage of execution (but only initial stage for WATCHes)", Buckets: []float64{0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1}, ConstLabels: map[string]string{phase: "executing"}, StabilityLevel: compbasemetrics.ALPHA, @@ -119,7 +119,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "priority_level_seat_count_watermarks", - Help: "Watermarks of the number of requests", + Help: "Watermarks of the number of seats occupied for any stage of execution (but only initial stage for WATCHes)", Buckets: []float64{0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1}, ConstLabels: map[string]string{phase: "executing"}, StabilityLevel: compbasemetrics.ALPHA, @@ -132,7 +132,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "priority_level_request_count_samples", - Help: "Periodic observations of the number of requests", + Help: "Periodic observations of the number of requests waiting or in any stage of execution (but only initial stage for WATCHes)", Buckets: []float64{0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1}, StabilityLevel: compbasemetrics.ALPHA, }, @@ -140,7 +140,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "priority_level_request_count_watermarks", - Help: "Watermarks of the number of requests", + Help: "Watermarks of the number of requests waiting or in any stage of execution (but only initial stage for WATCHes)", Buckets: []float64{0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1}, StabilityLevel: compbasemetrics.ALPHA, }, @@ -152,7 +152,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "read_vs_write_request_count_samples", - Help: "Periodic observations of the number of requests", + Help: "Periodic observations of the number of requests waiting or in regular stage of execution", Buckets: []float64{0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1}, StabilityLevel: compbasemetrics.ALPHA, }, @@ -160,7 +160,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "read_vs_write_request_count_watermarks", - Help: "Watermarks of the number of requests", + Help: "Watermarks of the number of requests waiting or in regular stage of execution", Buckets: []float64{0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1}, StabilityLevel: compbasemetrics.ALPHA, }, @@ -221,7 +221,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "current_inqueue_requests", - Help: "Number of requests currently pending in queues of the API Priority and Fairness system", + Help: "Number of requests currently pending in queues of the API Priority and Fairness subsystem", StabilityLevel: compbasemetrics.ALPHA, }, []string{priorityLevel, flowSchema}, @@ -231,7 +231,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "request_queue_length_after_enqueue", - Help: "Length of queue in the API Priority and Fairness system, as seen by each request after it is enqueued", + Help: "Length of queue in the API Priority and Fairness subsystem, as seen by each request after it is enqueued", Buckets: queueLengthBuckets, StabilityLevel: compbasemetrics.ALPHA, }, @@ -242,7 +242,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "request_concurrency_limit", - Help: "Shared concurrency limit in the API Priority and Fairness system", + Help: "Shared concurrency limit in the API Priority and Fairness subsystem", StabilityLevel: compbasemetrics.ALPHA, }, []string{priorityLevel}, @@ -252,7 +252,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "current_executing_requests", - Help: "Number of requests in regular execution phase in the API Priority and Fairness system", + Help: "Number of requests in initial (for a WATCH) or any (for a non-WATCH) execution stage in the API Priority and Fairness subsystem", StabilityLevel: compbasemetrics.ALPHA, }, []string{priorityLevel, flowSchema}, @@ -262,7 +262,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "request_concurrency_in_use", - Help: "Concurrency (number of seats) occupided by the currently executing (all phases count) requests in the API Priority and Fairness system", + Help: "Concurrency (number of seats) occupied by the currently executing (initial stage for a WATCH, any stage otherwise) requests in the API Priority and Fairness subsystem", StabilityLevel: compbasemetrics.ALPHA, }, []string{priorityLevel, flowSchema}, @@ -283,7 +283,7 @@ var ( Namespace: namespace, Subsystem: subsystem, Name: "request_execution_seconds", - Help: "Duration of regular phase of request execution in the API Priority and Fairness system", + Help: "Duration of initial stage (for a WATCH) or any (for a non-WATCH) stage of request execution in the API Priority and Fairness subsystem", Buckets: requestDurationSecondsBuckets, StabilityLevel: compbasemetrics.ALPHA, },