Categorygo.opentelemetry.io/collector/extension
modulepackage
0.120.0
Repository: https://github.com/open-telemetry/opentelemetry-collector.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
3
Dependents
216
Files
76 SLOC

# README

General Information

Extensions provide capabilities on top of the primary functionality of the collector. Generally, extensions are used for implementing components that can be added to the Collector, but which do not require direct access to telemetry data and are not part of the pipelines (like receivers, processors or exporters). Example extensions are: Health Check extension that responds to health check requests or PProf extension that allows fetching Collector's performance profile.

Supported service extensions (sorted alphabetically):

The contributors repository may have more extensions that can be added to custom builds of the Collector.

Ordering Extensions

The order extensions are specified for the service is important as this is the order in which each extension will be started and the reverse order in which they will be shutdown. The ordering is determined in the extensions tag under the service tag in the configuration file, example:

service:
  # Extensions specified below are going to be loaded by the service in the
  # order given below, and shutdown on reverse order.
  extensions: [extension1, extension2]

# Packages

Package auth implements the configuration settings to ensure authentication on incoming requests, and allows exporters to add authentication on outgoing requests.
Package extensioncapabilities provides interfaces that can be implemented by extensions to provide additional capabilities.
No description provided by the author
No description provided by the author
No description provided by the author
Package zpagesextension implements an extension that exposes zPages of properly instrumented components.

# Functions

MakeFactoryMap takes a list of factories and returns a map with Factory type as keys.
NewFactory returns a new Factory based on this configuration.

# Structs

Settings is passed to Factory.Create(...) function.

# Interfaces

Extension is the interface for objects hosted by the OpenTelemetry Collector that don't participate directly on data pipelines but provide some functionality to the service, examples: health check endpoint, z-pages, etc.
No description provided by the author

# Type aliases

CreateFunc is the equivalent of Factory.Create(...) function.