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
+10-5Lines changed: 10 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -303,7 +303,7 @@ It will expose the statusz endpoint again
303
303
304
304
###### Are there any tests for feature enablement/disablement?
305
305
306
-
Unit test will be introduced in alpha implementation.
306
+
Unit and integration tests will be introduced in alpha implementation.
307
307
308
308
### Rollout, Upgrade and Rollback Planning
309
309
@@ -315,7 +315,7 @@ This section must be completed when targeting beta to a release.
315
315
316
316
This feature should not cause rollout failures. If it does, we can disable the feature. In the worst
317
317
case, it is possible it could cause runtime failures, but it is highly unlikely we would not detect this
318
-
with existing tests.
318
+
with existing tests. The endpoint is isolated and does not affect core workloads.
319
319
320
320
###### What specific metrics should inform a rollback?
321
321
@@ -374,7 +374,7 @@ This is a debugging feature and not something that workloads depend on. Therefor
374
374
375
375
###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
376
376
377
-
This enhancement proposes data that can be used to determine the health of the component.
377
+
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.)
378
378
379
379
###### Are there any missing metrics that would be useful to have to improve observability of this feature?
380
380
@@ -390,11 +390,11 @@ No, each component's statusz is independent.
390
390
391
391
###### Will enabling / using this feature result in any new API calls?
392
392
393
-
No
393
+
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.
394
394
395
395
###### Will enabling / using this feature result in introducing new API types?
396
396
397
-
No.
397
+
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.
398
398
399
399
###### Will enabling / using this feature result in any new calls to the cloud provider?
400
400
@@ -431,6 +431,11 @@ Overreliance on statusz for critical monitoring. We will clearly document the in
431
431
The feature can be disabled by setting the feature-gate to false if the performance impact of it is not tolerable.
432
432
433
433
## Implementation History
434
+
- v1.32: New `/statusz` endpoint introduced for [apiserver](https://github.com/kubernetes/kubernetes/pull/125577),
435
+
- 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)
436
+
- 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)
437
+
- 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