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

Co-authored-by: Pranshu Srivastava <[email protected]>

Author: richabanker

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

@@ -103,7 +103,7 @@ Originating at Google and embedded by default in many internal servers, z-pages
 
 With statusz, we envision the following advantages
 
-* 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
+* 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
 * 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
 
 
@@ -115,7 +115,7 @@ With statusz, we envision the following advantages
 ### Non-Goals
 
 * Replace existing monitoring solutions: metrics, logs, traces
-* Provide extensibility for exposing information about underlying runtime components (like the CNI) through this mechanism
+* To provide a general-purpose extension mechanism for other components (e.g., container runtime, CNI, device plugins) to expose their own information through z-pages
 * Provide information about components that are not directly accessible due to network restrictions
 
 ## Proposal
@@ -145,7 +145,7 @@ We are proposing to add a new endpoint, /statusz on all core Kubernetes componen
 
 ### Data Format and versioning
 
-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.
+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.
 
 ### Authz and authn
 
@@ -157,7 +157,7 @@ Access to the endpoint will be limited to members of the `system:monitoring grou
 
 #### Request
 * Method: **GET** 
-* Endpoint: **v1/statusz**
+* Endpoint: **/statusz/v1**
 * Body: empty
 
 #### Response fields
@@ -172,22 +172,14 @@ Access to the endpoint will be limited to members of the `system:monitoring grou
 #### Sample response
 
 ```
-----------------------------
-title: Kubernetes Statusz
-description: Details of the status data that Kubernetes components report.
-----------------------------
-
-## Started: Fri Sep  6 06:19:51 UTC 2024
-## Up: 0 hr 00 min 30 sec
-
-## Build Info
---------------
-### Go version: go1.23.0
-### Binary version: 1.31.0-beta.0.981+c6be932655a03b-dirty
-### Emulation version: 1.31.0-beta.0.981
-### Minimum Compatibility version: 1.30.0
-
-## List of useful endpoints
+Started: Fri Sep  6 06:19:51 UTC 2024
+Up: 0 hr 00 min 30 sec
+Go version: go1.23.0
+Binary version: 1.31.0-beta.0.981+c6be932655a03b-dirty
+Emulation version: 1.31.0-beta.0.981
+Minimum Compatibility version: 1.30.0
+
+List of useful endpoints
 --------------
 healthz:/healthz
 livez:/livez
@@ -232,7 +224,7 @@ to implement this enhancement.
 
 #### Deprecation
 
-We plan to use the existing strategy for deprecating the zpage as is used for metrics currently, that is
+We plan to use the existing strategy for deprecating a zpage as is used for metrics deprecation currently, that is,
 
 - Announce deprecation and support policy of the z-page
 - Two versions passed since introducing the functionality that deprecates the z-page (to address version skew)