Skip to content

Commit a99c799

Browse files
authored
Merge pull request #5611 from richabanker/statusz-prr
Update ComponentStatusz milestones and PRR
2 parents d05dd3f + e9f25d6 commit a99c799

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
@@ -441,7 +441,7 @@ It will expose the statusz endpoint again
441441

442442
###### Are there any tests for feature enablement/disablement?
443443

444-
Unit test will be introduced in alpha implementation.
444+
Unit and integration tests will be introduced in alpha implementation.
445445

446446
### Rollout, Upgrade and Rollback Planning
447447

@@ -453,7 +453,7 @@ This section must be completed when targeting beta to a release.
453453

454454
This feature should not cause rollout failures. If it does, we can disable the feature. In the worst
455455
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.
457457

458458
###### What specific metrics should inform a rollback?
459459

@@ -512,7 +512,7 @@ This is a debugging feature and not something that workloads depend on. Therefor
512512

513513
###### What are the SLIs (Service Level Indicators) an operator can use to determine the health of the service?
514514

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.)
516516

517517
###### Are there any missing metrics that would be useful to have to improve observability of this feature?
518518

@@ -528,11 +528,11 @@ No, each component's statusz is independent.
528528

529529
###### Will enabling / using this feature result in any new API calls?
530530

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.
532532

533533
###### Will enabling / using this feature result in introducing new API types?
534534

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.
536536

537537
###### Will enabling / using this feature result in any new calls to the cloud provider?
538538

@@ -562,13 +562,18 @@ statusz endpoint for apiserver will not be available if the API server itself is
562562

563563
###### What are other known failure modes?
564564

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.
566566

567567
###### What steps should be taken if SLOs are not being met to determine the problem?
568568

569569
The feature can be disabled by setting the feature-gate to false if the performance impact of it is not tolerable.
570570

571571
## 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)
576+
572577

573578
## Drawbacks
574579

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

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

2727
# The milestone at which this feature was, or is targeted to be, at each stage.
2828
milestone:
2929
alpha: "v1.32"
30-
beta: "v1.33"
31-
stable: "v1.34"
30+
beta: "v1.36"
31+
stable: "v1.37"
3232

3333
feature-gates:
3434
- name: ComponentStatusz

0 commit comments

Comments
 (0)