mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
61 lines
2.8 KiB
Plaintext
61 lines
2.8 KiB
Plaintext
|
// Module included in the following assemblies:
|
||
|
|
//
|
||
|
|
// * observability/otel/otel-collector/otel-collector-extensions.adoc
|
||
|
|
|
||
|
|
:_mod-docs-content-type: REFERENCE
|
||
|
|
[id="otel-extensions-zpages-extension_{context}"]
|
||
|
|
= zPages Extension
|
||
|
|
|
||
|
|
[role="_abstract"]
|
||
|
|
The zPages Extension provides an HTTP endpoint that serves live data for debugging instrumented components in real time. You can use this extension for in-process diagnostics and insights into traces and metrics without relying on an external backend. With this extension, you can monitor and troubleshoot the behavior of the OpenTelemetry Collector and related components by watching the diagnostic information at the provided endpoint.
|
||
|
|
|
||
|
|
:FeatureName: The zPages Extension
|
||
|
|
include::snippets/technology-preview.adoc[]
|
||
|
|
|
||
|
|
.OpenTelemetry Collector custom resource with the configured zPages Extension
|
||
|
|
[source,yaml]
|
||
|
|
----
|
||
|
|
# ...
|
||
|
|
config:
|
||
|
|
extensions:
|
||
|
|
zpages:
|
||
|
|
endpoint: "localhost:55679" # <1>
|
||
|
|
|
||
|
|
receivers:
|
||
|
|
otlp:
|
||
|
|
protocols:
|
||
|
|
http: {}
|
||
|
|
exporters:
|
||
|
|
debug: {}
|
||
|
|
|
||
|
|
service:
|
||
|
|
extensions: [zpages]
|
||
|
|
pipelines:
|
||
|
|
traces:
|
||
|
|
receivers: [otlp]
|
||
|
|
exporters: [debug]
|
||
|
|
# ...
|
||
|
|
----
|
||
|
|
|
||
|
|
<1> Specifies the HTTP endpoint for serving the zPages extension. The default is `localhost:55679`.
|
||
|
|
|
||
|
|
[IMPORTANT]
|
||
|
|
====
|
||
|
|
Accessing the HTTP endpoint requires port-forwarding because the {OTELOperator} does not expose this route.
|
||
|
|
|
||
|
|
You can enable port-forwarding by running the following `oc` command:
|
||
|
|
|
||
|
|
[source,terminal]
|
||
|
|
----
|
||
|
|
$ oc port-forward pod/$(oc get pod -l app.kubernetes.io/name=instance-collector -o=jsonpath='{.items[0].metadata.name}') 55679
|
||
|
|
----
|
||
|
|
====
|
||
|
|
|
||
|
|
The Collector provides the following zPages for diagnostics:
|
||
|
|
|
||
|
|
*ServiceZ*:: Shows an overview of the Collector services and links to the following zPages: *PipelineZ*, *ExtensionZ*, and *FeatureZ*. This page also displays information about the build version and runtime. An example of this page's URL is `http://localhost:55679/debug/servicez`.
|
||
|
|
*PipelineZ*:: Shows detailed information about the active pipelines in the Collector. This page displays the pipeline type, whether data are modified, and the associated receivers, processors, and exporters for each pipeline. An example of this page's URL is `http://localhost:55679/debug/pipelinez`.
|
||
|
|
*ExtensionZ*:: Shows the currently active extensions in the Collector. An example of this page's URL is `http://localhost:55679/debug/extensionz`.
|
||
|
|
*FeatureZ*:: Shows the feature gates enabled in the Collector along with their status and description. An example of this page's URL is `http://localhost:55679/debug/featurez`.
|
||
|
|
*TraceZ*:: Shows spans categorized by latency. Available time ranges include 0 µs, 10 µs, 100 µs, 1 ms, 10 ms, 100 ms, 1 s, 10 s, 1 m. This page also allows for quick inspection of error samples. An example of this page's URL is `http://localhost:55679/debug/tracez`.
|