You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: keps/sig-instrumentation/4828-component-flagz/README.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -377,7 +377,7 @@ This section must be completed when targeting beta to a release.
377
377
378
378
This feature should not cause rollout failures. If it does, we can disable the feature. In the worst
379
379
case, it is possible it could cause runtime failures, but it is highly unlikely we would not detect this
380
-
with existing tests.
380
+
with existing tests. The endpoint is intended to provide enhanced observability into component state.
381
381
382
382
###### What specific metrics should inform a rollback?
383
383
@@ -437,6 +437,7 @@ This is a debugging feature and not something that workloads depend on. Therefor
437
437
###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
438
438
439
439
This enhancement proposes data that can be used to determine the health of the component.
440
+
(though this endpoint is not intended to be used for alerting.)
440
441
441
442
###### Are there any missing metrics that would be useful to have to improve observability of this feature?
442
443
@@ -452,11 +453,11 @@ No, each component's flagz is independent.
452
453
453
454
###### Will enabling / using this feature result in any new API calls?
454
455
455
-
No
456
+
Yes, enabling this feature will result in a new HTTP endpoint (/flagz) being served by each component (including apiserver). However, this is not a Kubernetes API type or resource; it is a non-resource endpoint that provides component flag information for debugging and observability. No new Kubernetes API objects or resource types are introduced.
456
457
457
458
###### Will enabling / using this feature result in introducing new API types?
458
459
459
-
No.
460
+
No, this feature does not introduce new Kubernetes API types or resources. While the flagz endpoint uses a structured JSON response with Group/Version/Kind for content negotiation and consistency, it is not a Kubernetes API object and is not managed or persisted by the API server. The GVK is used solely to provide a predictable format for clients querying the endpoint.
460
461
461
462
###### Will enabling / using this feature result in any new calls to the cloud provider?
462
463
@@ -486,14 +487,17 @@ flagz endpoint for apiserver will not be available if the API server itself is d
486
487
487
488
###### What are other known failure modes?
488
489
489
-
Overreliance on flagz for critical monitoring. We will clearly document the intended use cases and limitations of the flagz endpoint, emphasizing that it's primarily for informational and troubleshooting purposes, not real-time monitoring or alerting.
490
+
Overreliance on flagz for critical monitoring. We will clearly document the intended use cases and limitations of the flagz endpoint, emphasizing that it's primarily for informational and troubleshooting purposes.
490
491
491
492
###### What steps should be taken if SLOs are not being met to determine the problem?
492
493
493
494
The feature can be disabled by setting the feature-gate to false if the performance impact of it is not tolerable.
494
495
495
496
## Implementation History
496
497
498
+
- 1.32: New `flagz` endpoint introduced for [apiserver](https://github.com/kubernetes/kubernetes/pull/127581)
499
+
- 1.33: `/flagz` enablement extended to [kubelet](https://github.com/kubernetes/kubernetes/pull/128857), [scheduler](https://github.com/kubernetes/kubernetes/pull/128818), [controller-manager](https://github.com/kubernetes/kubernetes/pull/128824), and [kube-proxy](https://github.com/kubernetes/kubernetes/pull/128985)
0 commit comments