-
Notifications
You must be signed in to change notification settings - Fork 14.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs for zpages #48760
Merged
Merged
Add docs for zpages #48760
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
14 changes: 14 additions & 0 deletions
14
...en/docs/reference/command-line-tools-reference/feature-gates/component-flagz.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: ComponentFlagz | ||
content_type: feature_gate | ||
_build: | ||
list: never | ||
render: false | ||
|
||
stages: | ||
- stage: alpha | ||
defaultValue: false | ||
fromVersion: "1.32" | ||
--- | ||
Enables the component's flagz endpoint. | ||
See [zpages](/docs/reference/instrumentation/zpages/) for more information. |
14 changes: 14 additions & 0 deletions
14
.../docs/reference/command-line-tools-reference/feature-gates/component-statusz.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: ComponentStatusz | ||
content_type: feature_gate | ||
_build: | ||
list: never | ||
render: false | ||
|
||
stages: | ||
- stage: alpha | ||
defaultValue: false | ||
fromVersion: "1.32" | ||
--- | ||
Enables the component's statusz endpoint. | ||
See [zpages](/docs/reference/instrumentation/zpages/) for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
title: Kubernetes z-pages | ||
content_type: reference | ||
weight: 60 | ||
reviewers: | ||
- dashpole | ||
--- | ||
|
||
|
||
<!-- overview --> | ||
|
||
{{< feature-state for_k8s_version="v1.32" state="alpha" >}} | ||
|
||
Kubernetes core components can expose a suite of _z-endpoints_ to make it easier for users | ||
to debug their cluster and its components. These endpoints are strictly to be used for human | ||
inspection to gain real time debugging information of a component binary. | ||
Avoid automated scraping of data returned by these endpoints; in Kubernetes {{< skew currentVersion >}} | ||
these are an **alpha** feature and the response format may change in future releases. | ||
|
||
<!-- body --> | ||
|
||
## z-pages | ||
|
||
Kubernetes v{{< skew currentVersion >}} allows you to enable _z-pages_ to help you troubleshoot | ||
problems with its core control plane components. These special debugging endpoints provide internal | ||
information about running components. For Kubernetes {{< skew currentVersion >}}, components | ||
serve the following endpoints (when enabled): | ||
|
||
- [z-pages](#z-pages) | ||
- [statusz](#statusz) | ||
- [flagz](#flagz) | ||
|
||
### statusz | ||
|
||
Enabled using the `ComponentStatusz` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), | ||
the `/statusz` endpoint displays high level information about the component such as its Kubernetes version, emulation version, start time and more. | ||
|
||
The `/statusz` response from the API server is similar to: | ||
|
||
``` | ||
kube-apiserver statusz | ||
Warning: This endpoint is not meant to be machine parseable, has no formatting compatibility guarantees and is for debugging purposes only. | ||
|
||
Started: Wed Oct 16 21:03:43 UTC 2024 | ||
Up: 0 hr 00 min 16 sec | ||
Go version: go1.23.2 | ||
Binary version: 1.32.0-alpha.0.1484+5eeac4f21a491b-dirty | ||
Emulation version: 1.32.0-alpha.0.1484 | ||
``` | ||
|
||
### flagz | ||
|
||
Enabled using the `ComponentFlagz` [feature gate](/docs/reference/command-line-tools-reference/feature-gates/), the `/flagz` endpoint shows you the command line arguments that were used to start a component. | ||
|
||
The `/flagz` data for the API server looks something like: | ||
|
||
``` | ||
kube-apiserver flags | ||
Warning: This endpoint is not meant to be machine parseable, has no formatting compatibility guarantees and is for debugging purposes only. | ||
|
||
advertise-address=192.168.8.2 | ||
contention-profiling=false | ||
enable-priority-and-fairness=true | ||
profiling=true | ||
authorization-mode=[Node,RBAC] | ||
authorization-webhook-cache-authorized-ttl=5m0s | ||
authorization-webhook-cache-unauthorized-ttl=30s | ||
authorization-webhook-version=v1beta1 | ||
default-watch-cache-size=100 | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this right:
?