Skip to content

Commit 0eb76a3

Browse files
richabankerrexagod
andcommitted
Update keps/sig-instrumentation/4827-component-statusz/README.md
Co-authored-by: Pranshu Srivastava <[email protected]>
1 parent 311c912 commit 0eb76a3

File tree

1 file changed

+4
-4
lines changed
  • keps/sig-instrumentation/4827-component-statusz

1 file changed

+4
-4
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Originating at Google and embedded by default in many internal servers, z-pages
103103

104104
With statusz, we envision the following advantages
105105

106-
* Consolidated and precise information: Presenting critical build data in a clear, concise format, eliminates the need to dig through logs or configurations to gather this essential information. Z-pages offer a distinct advantage over external monitoring solutions by providing insights from within the server itself. This inherent integration eliminates the need for complex external setups and potential network latency issues
106+
* Consolidated and precise information: Presenting critical build data in a clear, concise format, eliminates the need to dig through logs or configurations to gather this essential information. Z-pages offer a distinct advantage over external monitoring solutions by providing insights from within the server itself. This inherent integration eliminates the need for complex external setups like manual inspection of logs, configuration files, or running external scripts that may be subject to potential network latency issues
107107
* Streamlined troubleshooting and debugging: Immediate access to crucial build information like binary version, Go version and compatibility details enables better understanding of the component's state. We hope this interface makes it easier to identify version mismatches or incompatibilities that might contribute to issues, accelerating troubleshooting and debugging efforts
108108

109109

@@ -145,7 +145,7 @@ We are proposing to add a new endpoint, /statusz on all core Kubernetes componen
145145

146146
### Data Format and versioning
147147

148-
Initially, the statusz page will exclusively support a plain text format for responses. We will implement these endpoints using versioned URLs, like /v1/statusz, to ensure future compatibility. This versioning strategy allows us to seamlessly introduce structured data formats (e.g., JSON) in the future, through a distinct endpoint such as /v2/statusz, without disrupting existing implementations.
148+
Initially, the statusz page will exclusively support a plain text format for responses. We will implement these endpoints using versioned URLs, like /statusz/v1, to ensure future compatibility. This versioning strategy allows us to seamlessly introduce structured data formats (e.g., JSON) in the future, through a distinct endpoint such as /statusz/v2, without disrupting existing implementations.
149149

150150
### Authz and authn
151151

@@ -157,7 +157,7 @@ Access to the endpoint will be limited to members of the `system:monitoring grou
157157

158158
#### Request
159159
* Method: **GET**
160-
* Endpoint: **v1/statusz**
160+
* Endpoint: **/statusz/v1**
161161
* Body: empty
162162

163163
#### Response fields
@@ -232,7 +232,7 @@ to implement this enhancement.
232232

233233
#### Deprecation
234234

235-
We plan to use the existing strategy for deprecating the zpage as is used for metrics currently, that is
235+
We plan to use the existing strategy for deprecating a zpage as is used for metrics deprecation currently, that is,
236236

237237
- Announce deprecation and support policy of the z-page
238238
- Two versions passed since introducing the functionality that deprecates the z-page (to address version skew)

0 commit comments

Comments
 (0)