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/4827-component-statusz/README.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -441,7 +441,7 @@ It will expose the statusz endpoint again
441
441
442
442
###### Are there any tests for feature enablement/disablement?
443
443
444
-
Unit test will be introduced in alpha implementation.
444
+
Unit and integration tests will be introduced in alpha implementation.
445
445
446
446
### Rollout, Upgrade and Rollback Planning
447
447
@@ -453,7 +453,7 @@ This section must be completed when targeting beta to a release.
453
453
454
454
This feature should not cause rollout failures. If it does, we can disable the feature. In the worst
455
455
case, it is possible it could cause runtime failures, but it is highly unlikely we would not detect this
456
-
with existing tests.
456
+
with existing tests. The endpoint is isolated and does not affect core workloads.
457
457
458
458
###### What specific metrics should inform a rollback?
459
459
@@ -512,7 +512,7 @@ This is a debugging feature and not something that workloads depend on. Therefor
512
512
513
513
###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
514
514
515
-
This enhancement proposes data that can be used to determine the health of the component.
515
+
This enhancement proposes data that can be used to determine the health of the component (though this endpoint is not intended to be used for alerting.)
516
516
517
517
###### Are there any missing metrics that would be useful to have to improve observability of this feature?
518
518
@@ -528,11 +528,11 @@ No, each component's statusz is independent.
528
528
529
529
###### Will enabling / using this feature result in any new API calls?
530
530
531
-
No
531
+
Yes, enabling this feature will result in a new HTTP endpoint (/statusz) 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 status information for debugging and observability. No new Kubernetes API objects or resource types are introduced.
532
532
533
533
###### Will enabling / using this feature result in introducing new API types?
534
534
535
-
No.
535
+
No, this feature does not introduce new Kubernetes API types or resources. While the statusz 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.
536
536
537
537
###### Will enabling / using this feature result in any new calls to the cloud provider?
538
538
@@ -562,13 +562,18 @@ statusz endpoint for apiserver will not be available if the API server itself is
562
562
563
563
###### What are other known failure modes?
564
564
565
-
Overreliance on statusz for critical monitoring. We will clearly document the intended use cases and limitations of the statusz endpoint, emphasizing that it's primarily for informational and troubleshooting purposes, not real-time monitoring or alerting.
565
+
Overreliance on statusz for critical monitoring. We will clearly document the intended use cases and limitations of the statusz endpoint, emphasizing that it's primarily for informational and troubleshooting purposes.
566
566
567
567
###### What steps should be taken if SLOs are not being met to determine the problem?
568
568
569
569
The feature can be disabled by setting the feature-gate to false if the performance impact of it is not tolerable.
570
570
571
571
## Implementation History
572
+
- v1.32: New `/statusz` endpoint introduced for [apiserver](https://github.com/kubernetes/kubernetes/pull/125577),
573
+
- v1.33: `/statusz` enablement extended to [kubelet](https://github.com/kubernetes/kubernetes/pull/128811), [scheduler](https://github.com/kubernetes/kubernetes/pull/128987), [controller-manager](https://github.com/kubernetes/kubernetes/pull/128991), and [kube-proxy](https://github.com/kubernetes/kubernetes/pull/128989)
574
+
- v1.34: `/statusz` response enhanced to add a `Paths` field listing down all debug endpoints available for [apiserver](https://github.com/kubernetes/kubernetes/pull/132581)
575
+
- v1.35: `Paths` field added for [kubelet](https://github.com/kubernetes/kubernetes/pull/133239), [scheduler](https://github.com/kubernetes/kubernetes/pull/132606), [controller-manager](https://github.com/kubernetes/kubernetes/pull/133218), and [kube-proxy](https://github.com/kubernetes/kubernetes/pull/133190)
0 commit comments