zPages extension

Use the zPages extension to activate an extension that serves zPages, an HTTP endpoint that provides live data for debugging different components.

The zPages extension serves zPages, an HTTP endpoint that provides live data for debugging different components, if they were properly instrumented for such. zPages are useful for in-process diagnostics without having to depend on any backend to examine traces or metrics.

All core exporters and receivers provide some zPage instrumentation.

Get started

Note: This component is included in the default configuration of the Splunk Distribution of the OpenTelemetry Collector when deploying in host monitoring (agent) mode. See Collector deployment modes for more information. For details about the default configuration, see Configure the Collector for Kubernetes with Helm, Collector for Linux default configuration, or Collector for Windows default configuration. You can customize your configuration any time as explained in this document.

Follow these steps to configure and activate the component:

Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform:
Configure the extension as described in this doc.
Restart the Collector.

Sample configuration

This is a configuration example for the extension:

extensions:
  zpages:
    endpoint: "localhost:55679"

To complete the configuration, include the extension in the service section of your configuration file:

service:
  extensions: [zpages]

The following settings are required to configure the extension:

endpoint. Specifies the HTTP endpoint that serves zPages.
- localhost:55679 by default.
- Use localhost: to make the ZPages extension available only locally.
- Use ":" to make the ZPages extension available on all network interfaces.

See the full list of exposed settings in the section Settings.

Exposed zPages routes

The Collector exposes the following zPage routes:

ServiceZ

ServiceZ gives an overview of the Collector services, and provides quick access to the pipelinez, extensionz, and featurez zPages. The page also provides build and runtime information.

For example, http://localhost:55679/debug/servicez.

PipelineZ

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

For example, http://localhost:55679/debug/pipelinez.

ExtensionZ

ExtensionZ shows the extensions that are active in the Collector.

For example, http://localhost:55679/debug/extensionz.

FeatureZ

FeatureZ lists the feature gates available along with their current status and description.

For example, http://localhost:55679/debug/featurez.

TraceZ

The TraceZ route examines and sorts spans by latency buckets like 0us, 10us, 100us, 1ms, 10ms, 100ms, 1s, 10s, or 1m. They also allow you to quickly examine error samples.

For example, http://localhost:55679/debug/tracez.

RpcZ

The Rpcz route helps examine statistics of remote procedure calls (RPCs) that are properly instrumented, such as gRPC.

For example, http://localhost:55679/debug/rpcz.

Settings

The following table shows the configuration options for the zPages extension:

included

https://raw.githubusercontent.com/splunk/collector-config-tools/main/cfg-metadata/extension/zpages.yaml

Troubleshooting

If you are a Splunk Observability Cloud customer and are not able to see your data in Splunk Observability Cloud, you can get help in the following ways.

Available to Splunk Observability Cloud customers

Submit a case in the Splunk Support Portal.
Contact Splunk Support.

Available to prospective customers and free trial users

Ask a question and get answers through community support at Splunk Answers.
Join the Splunk #observability user group Slack channel to communicate with customers, partners, and Splunk employees worldwide. To join, see Chat groups.

Documentation