Skip to content

Commit

Permalink
Add the available routes to the README of zPages (open-telemetry#3132)
Browse files Browse the repository at this point in the history
Added the available routes in the zPages extension README for the users
convenience.
  • Loading branch information
alexvanboxel authored May 10, 2021
1 parent d673b47 commit 18ddc14
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions extension/zpagesextension/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ Enables an extension that serves zPages, an HTTP endpoint that provides live
data for debugging different components that were properly instrumented for such.
All core exporters and receivers provide some zPage instrumentation.

zPages are useful to for in-process diagnostics without having to depend on any
backend to examine traces or metrics.

The following settings are required:

- `endpoint` (default = localhost:55679): Specifies the HTTP endpoint that serves
Expand All @@ -18,3 +21,47 @@ extensions:
The full list of settings exposed for this exporter are documented [here](./config.go)
with detailed sample configurations [here](./testdata/config.yaml).
## Exposed zPages routes
The collector exposes the following zPage routes:
### ServiceZ
ServiceZ gives an overview of the collector services by gives quick access to the
`pipelinez` and `extensionz` zPages. The page also provides build and runtime
information.

Example URL: https://localhost:55679/debug/servicez

### PipelineZ

PipelineZ brings insight on the running pipelines running in the collector. You can
find information on type, if data is mutated and the receivers, processors and exporters
that are used for each pipeline.

Example URL: https://localhost:55679/debug/pipelinez

### ExtensionZ

ExtensionZ shows the extensions that are active in the collector.

Example URL: https://localhost:55679/debug/extensionz

### TraceZ
The TraceZ route is available to examine and bucketize spans by latency buckets for
example

(0us, 10us, 100us, 1ms, 10ms, 100ms, 1s, 10s, 1m]
They also allow you to quickly examine error samples

Example URL: https://localhost:55679/debug/tracez

### RpcZ
The Rpcz route is available to help examine statistics of remote procedure calls (RPCs)
that are properly instrumented. For example when using gRPC

Example URL: https://localhost:55679/debug/rpcz



0 comments on commit 18ddc14

Please sign in to comment.