Skip to content

Commit e9f25d6

Browse files
committed
PRR for structured ComponentStatusz
1 parent 9b92579 commit e9f25d6

File tree

2 files changed

+14
-9
lines changed

2 files changed

+14
-9
lines changed

keps/sig-instrumentation/4827-component-statusz/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ It will expose the statusz endpoint again
303303
304304
###### Are there any tests for feature enablement/disablement?
305305
306-
Unit test will be introduced in alpha implementation.
306+
Unit and integration tests will be introduced in alpha implementation.
307307
308308
### Rollout, Upgrade and Rollback Planning
309309
@@ -315,7 +315,7 @@ This section must be completed when targeting beta to a release.
315315
316316
This feature should not cause rollout failures. If it does, we can disable the feature. In the worst
317317
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.
319319
320320
###### What specific metrics should inform a rollback?
321321
@@ -374,7 +374,7 @@ This is a debugging feature and not something that workloads depend on. Therefor
374374
375375
###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
376376
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.)
378378
379379
###### Are there any missing metrics that would be useful to have to improve observability of this feature?
380380
@@ -390,11 +390,11 @@ No, each component's statusz is independent.
390390
391391
###### Will enabling / using this feature result in any new API calls?
392392
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.
394394
395395
###### Will enabling / using this feature result in introducing new API types?
396396
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.
398398
399399
###### Will enabling / using this feature result in any new calls to the cloud provider?
400400
@@ -424,13 +424,18 @@ statusz endpoint for apiserver will not be available if the API server itself is
424424
425425
###### What are other known failure modes?
426426
427-
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.
427+
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.
428428
429429
###### What steps should be taken if SLOs are not being met to determine the problem?
430430
431431
The feature can be disabled by setting the feature-gate to false if the performance impact of it is not tolerable.
432432
433433
## 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)
438+
434439
435440
## Drawbacks
436441

keps/sig-instrumentation/4827-component-statusz/kep.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ stage: alpha
1919
# The most recent milestone for which work toward delivery of this KEP has been
2020
# done. This can be the current (upcoming) milestone, if it is being actively
2121
# worked on.
22-
latest-milestone: "v1.32"
22+
latest-milestone: "v1.35"
2323

2424
# The milestone at which this feature was, or is targeted to be, at each stage.
2525
milestone:
2626
alpha: "v1.32"
27-
beta: "v1.33"
28-
stable: "v1.34"
27+
beta: "v1.36"
28+
stable: "v1.37"
2929

3030
feature-gates:
3131
- name: ComponentStatusz

0 commit comments

Comments
 (0)