zpagesextension

README

zPages

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.

The following settings are required:

• endpoint (default = localhost:55679): Specifies the HTTP endpoint that serves zPages. Use localhost: to make it available only locally, or ":" to make it available on all network interfaces.

Example:

extensions:
  zpages:

The full list of settings exposed for this exporter are documented here with detailed sample configurations here.

Documentation

Overview

Package zpagesextension implements an extension that exposes zPages of properly instrumented components.

Index

• func NewFactory() component.ExtensionFactory
• type Config

Functions

func NewFactory

func NewFactory() component.ExtensionFactory

NewFactory creates a factory for Z-Pages extension.

Types

type Config

type Config struct {
	configmodels.ExtensionSettings `mapstructure:",squash"`

	// Endpoint is the address and port in which the zPages will be listening to.
	// Use localhost:<port> to make it available only locally, or ":<port>" to
	// make it available on all network interfaces.
	Endpoint string `mapstructure:"endpoint"`
}

Config has the configuration for the extension enabling the zPages extension.