|
1 | 1 | ---
|
2 |
| -title: Kubernetes z-pages Reference |
| 2 | +reviewers: |
| 3 | +- richabanker |
| 4 | +title: Kubernetes z-pages |
3 | 5 | content_type: reference
|
4 |
| -auto_generated: true |
5 |
| -description: >- |
6 |
| - Details of the zpages data that Kubernetes components expose. |
7 |
| ---- |
| 6 | +weight: 20 |
| 7 | +--- |
| 8 | + |
| 9 | +<!-- overview --> |
| 10 | + |
| 11 | +{{< feature-state for_k8s_version="v1.32" state="alpha" >}} |
| 12 | + |
| 13 | +Kubernetes core components exposes a suite of z-endpoints to make it easier for users to debug their components. As of 1.32, these endpoints only support plain text format and 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 since they are introduced as alpha features and their format may change in future releases. |
| 14 | + |
| 15 | +<!-- body --> |
| 16 | + |
| 17 | +## z-pages |
| 18 | + |
| 19 | +Kubernetes now includes "z-pages" to help you troubleshoot problems with its core control plane components. These special debugging endpoints provide internal information about running components. Currently we have the following endpoints: |
| 20 | + |
| 21 | +- [z-pages](#z-pages) |
| 22 | + - [flagz](#flagz) |
| 23 | + - [statusz](#statusz) |
| 24 | + |
| 25 | +### flagz |
| 26 | + |
| 27 | +Enabled using the ComponentFlagz feature gate, the flagz endpoint shows you the command line flags that were used to start a component. |
| 28 | + |
| 29 | +The flagz data for apiserver looks like this: |
| 30 | + |
| 31 | +``` |
| 32 | +kube-apiserver flags |
| 33 | +Warning: This endpoint is not meant to be machine parseable, has no formatting compatibility guarantees and is for debugging purposes only. |
| 34 | +
|
| 35 | +advertise-address=192.168.8.2 |
| 36 | +contention-profiling=false |
| 37 | +enable-priority-and-fairness=true |
| 38 | +profiling=true |
| 39 | +authorization-mode=[Node,RBAC] |
| 40 | +authorization-webhook-cache-authorized-ttl=5m0s |
| 41 | +authorization-webhook-cache-unauthorized-ttl=30s |
| 42 | +authorization-webhook-version=v1beta1 |
| 43 | +default-watch-cache-size=100 |
| 44 | +``` |
| 45 | + |
| 46 | +### statusz |
| 47 | + |
| 48 | +Enabled using the ComponentStatusz feature gate, statusz endpoint displays the high level information about the component such as its Kubernetes version, emulation version, start time and more. |
| 49 | + |
| 50 | +The statusz data for apiserver looks like this: |
| 51 | + |
| 52 | +``` |
| 53 | +kube-apiserver statusz |
| 54 | +Warning: This endpoint is not meant to be machine parseable, has no formatting compatibility guarantees and is for debugging purposes only. |
| 55 | +
|
| 56 | +Started: Wed Oct 16 21:03:43 UTC 2024 |
| 57 | +Up: 0 hr 00 min 16 sec |
| 58 | +Go version: go1.23.2 |
| 59 | +Binary version: 1.32.0-alpha.0.1484+5eeac4f21a491b-dirty |
| 60 | +Emulation version: 1.32.0-alpha.0.1484 |
| 61 | +``` |
0 commit comments