component

Documentation

Index

• func MakeExporterFactoryMap(factories ...ExporterFactoryBase) (map[configmodels.Type]ExporterFactoryBase, error)
• func MakeExtensionFactoryMap(factories ...ExtensionFactory) (map[configmodels.Type]ExtensionFactory, error)
• func MakeProcessorFactoryMap(factories ...ProcessorFactoryBase) (map[configmodels.Type]ProcessorFactoryBase, error)
• func MakeReceiverFactoryMap(factories ...ReceiverFactoryBase) (map[configmodels.Type]ReceiverFactoryBase, error)
• type Component
• type CustomUnmarshaler
• type Exporter
• type ExporterCreateParams
• type ExporterFactory
• type ExporterFactoryBase
• type ExporterFactoryOld
• type ExtensionCreateParams
• type ExtensionFactory
• type Factory
• type Host
• type Kind
• type LogExporter
• type LogExporterFactory
• type LogProcessor
• type LogProcessorFactory
• type LogReceiver
• type LogReceiverFactory
• type MetricsExporter
• type MetricsExporterBase
• type MetricsExporterOld
• type MetricsProcessor
• type MetricsProcessorBase
• type MetricsProcessorOld
• type MetricsReceiver
• type PipelineWatcher
• type Processor
• type ProcessorCapabilities
• type ProcessorCreateParams
• type ProcessorFactory
• type ProcessorFactoryBase
• type ProcessorFactoryOld
• type Receiver
• type ReceiverCreateParams
• type ReceiverFactory
• type ReceiverFactoryBase
• type ReceiverFactoryOld
• type ServiceExtension
• type TraceExporter
• type TraceExporterBase
• type TraceExporterOld
• type TraceProcessor
• type TraceProcessorBase
• type TraceProcessorOld
• type TraceReceiver

Functions

func MakeExporterFactoryMap

func MakeExporterFactoryMap(factories ...ExporterFactoryBase) (map[configmodels.Type]ExporterFactoryBase, error)

MakeExporterFactoryMap takes a list of exporter factories and returns a map with factory type as keys. It returns a non-nil error when more than one factories have the same type.

func MakeExtensionFactoryMap

func MakeExtensionFactoryMap(factories ...ExtensionFactory) (map[configmodels.Type]ExtensionFactory, error)

MakeExtensionFactoryMap takes a list of extension factories and returns a map with factory type as keys. It returns a non-nil error when more than one factories have the same type.

func MakeProcessorFactoryMap

func MakeProcessorFactoryMap(factories ...ProcessorFactoryBase) (map[configmodels.Type]ProcessorFactoryBase, error)

MakeProcessorFactoryMap takes a list of processor factories and returns a map with factory type as keys. It returns a non-nil error when more than one factories have the same type.

func MakeReceiverFactoryMap

func MakeReceiverFactoryMap(factories ...ReceiverFactoryBase) (map[configmodels.Type]ReceiverFactoryBase, error)

MakeReceiverFactoryMap takes a list of receiver factories and returns a map with factory type as keys. It returns a non-nil error when more than one factories have the same type.

Types

type Component

type Component interface {
	// Start tells the component to start. Host parameter can be used for communicating
	// with the host after Start() has already returned. If error is returned by
	// Start() then the collector startup will be aborted.
	// If this is an exporter component it may prepare for exporting
	// by connecting to the endpoint.
	Start(ctx context.Context, host Host) error

	// Shutdown is invoked during service shutdown.
	Shutdown(ctx context.Context) error
}

Component is either a receiver, exporter, processor or extension.

type CustomUnmarshaler

type CustomUnmarshaler func(componentViperSection *viper.Viper, intoCfg interface{}) error

CustomUnmarshaler is a function that un-marshals a viper data into a config struct in a custom way. componentViperSection *viper.Viper

The config for this specific component. May be nil or empty if no config available.

intoCfg interface{}

An empty interface wrapping a pointer to the config struct to unmarshal into.

type Exporter

type Exporter interface {
	Component
}

Exporter defines functions that all exporters must implement.

type ExporterCreateParams

type ExporterCreateParams struct {
	// Logger that the factory can use during creation and can pass to the created
	// component to be used later as well.
	Logger *zap.Logger
}

ExporterCreateParams is passed to Create*Exporter functions.

type ExporterFactory

type ExporterFactory interface {
	ExporterFactoryBase

	// CreateTraceExporter creates a trace exporter based on this config.
	// If the exporter type does not support tracing or if the config is not valid
	// error will be returned instead.
	CreateTraceExporter(ctx context.Context, params ExporterCreateParams,
		cfg configmodels.Exporter) (TraceExporter, error)

	// CreateMetricsExporter creates a metrics exporter based on this config.
	// If the exporter type does not support metrics or if the config is not valid
	// error will be returned instead.
	CreateMetricsExporter(ctx context.Context, params ExporterCreateParams,
		cfg configmodels.Exporter) (MetricsExporter, error)
}

ExporterFactory can create TraceExporter and MetricsExporter. This is the new factory type that can create new style exporters.

type ExporterFactoryBase

type ExporterFactoryBase interface {
	Factory

	// CreateDefaultConfig creates the default configuration for the Exporter.
	// This method can be called multiple times depending on the pipeline
	// configuration and should not cause side-effects that prevent the creation
	// of multiple instances of the Exporter.
	// The object returned by this method needs to pass the checks implemented by
	// 'configcheck.ValidateConfig'. It is recommended to have such check in the
	// tests of any implementation of the Factory interface.
	CreateDefaultConfig() configmodels.Exporter
}

ExporterFactoryBase defines the common functions for all exporter factories.

type ExporterFactoryOld

type ExporterFactoryOld interface {
	ExporterFactoryBase

	// CreateTraceExporter creates a trace exporter based on this config.
	CreateTraceExporter(logger *zap.Logger, cfg configmodels.Exporter) (TraceExporterOld, error)

	// CreateMetricsExporter creates a metrics exporter based on this config.
	CreateMetricsExporter(logger *zap.Logger, cfg configmodels.Exporter) (MetricsExporterOld, error)
}

ExporterFactoryOld can create TraceExporterOld and MetricsExporterOld.

type ExtensionCreateParams

type ExtensionCreateParams struct {
	// Logger that the factory can use during creation and can pass to the created
	// component to be used later as well.
	Logger *zap.Logger
}

ExtensionCreateParams is passed to ExtensionFactory.Create* functions.

type ExtensionFactory

type ExtensionFactory interface {
	Factory

	// CreateDefaultConfig creates the default configuration for the Extension.
	// This method can be called multiple times depending on the pipeline
	// configuration and should not cause side-effects that prevent the creation
	// of multiple instances of the Extension.
	// The object returned by this method needs to pass the checks implemented by
	// 'configcheck.ValidateConfig'. It is recommended to have such check in the
	// tests of any implementation of the Factory interface.
	CreateDefaultConfig() configmodels.Extension

	// CreateExtension creates a service extension based on the given config.
	CreateExtension(ctx context.Context, params ExtensionCreateParams, cfg configmodels.Extension) (ServiceExtension, error)
}

ExtensionFactory is a factory interface for extensions to the service.

type Factory

type Factory interface {
	// Type gets the type of the component created by this factory.
	Type() configmodels.Type
}

Factory interface must be implemented by all component factories.

type Host

type Host interface {
	// ReportFatalError is used to report to the host that the extension
	// encountered a fatal error (i.e.: an error that the instance can't recover
	// from) after its start function had already returned.
	ReportFatalError(err error)

	// GetFactory of the specified kind. Returns the factory for a component type.
	// This allows components to create other components. For example:
	//   func (r MyReceiver) Start(host component.Host) error {
	//     apacheFactory := host.GetFactory(KindReceiver,"apache").(component.ReceiverFactory)
	//     receiver, err := apacheFactory.CreateMetricsReceiver(...)
	//     ...
	//   }
	// GetFactory can be called by the component anytime after Start() begins and
	// until Shutdown() is called. Note that the component is responsible for destroying
	// other components that it creates.
	GetFactory(kind Kind, componentType configmodels.Type) Factory

	// Return map of extensions. Only enabled and created extensions will be returned.
	// Typically is used to find an extension by type or by full config name. Both cases
	// can be done by iterating the returned map. There are typically very few extensions
	// so there there is no performance implications due to iteration.
	GetExtensions() map[configmodels.Extension]ServiceExtension

	// Return map of exporters. Only enabled and created exporters will be returned.
	// Typically is used to find exporters by type or by full config name. Both cases
	// can be done by iterating the returned map. There are typically very few exporters
	// so there there is no performance implications due to iteration.
	// This returns a map by DataType of maps by exporter configs to the exporter instance.
	// Note that an exporter with the same name may be attached to multiple pipelines and
	// thus we may have an instance of the exporter for multiple data types.
	// This is an experimental function that may change or even be removed completely.
	GetExporters() map[configmodels.DataType]map[configmodels.Exporter]Exporter
}

Host represents the entity that is hosting a Component. It is used to allow communication between the Component and its host (normally the service.Application is the host).

type Kind

type Kind int

Kind specified one of the 4 components kinds, see consts below.

const (
	KindReceiver Kind
	KindProcessor
	KindExporter
	KindExtension
)

type LogExporter

type LogExporter interface {
	Exporter
	consumer.LogConsumer
}

LogExporter is a LogConsumer that is also an Exporter.

type LogExporterFactory

type LogExporterFactory interface {
	ExporterFactoryBase

	// CreateLogExporter creates an exporter based on the config.
	// If the exporter type does not support logs or if the config is not valid
	// error will be returned instead.
	CreateLogExporter(
		ctx context.Context,
		params ExporterCreateParams,
		cfg configmodels.Exporter,
	) (LogExporter, error)
}

LogExporterFactory can create a LogExporter.

type LogProcessor

type LogProcessor interface {
	Processor
	consumer.LogConsumer
}

LogProcessor is a processor that can consume logs.

type LogProcessorFactory

type LogProcessorFactory interface {
	ProcessorFactoryBase

	// CreateLogProcessor creates a processor based on the config.
	// If the processor type does not support logs or if the config is not valid
	// error will be returned instead.
	CreateLogProcessor(
		ctx context.Context,
		params ProcessorCreateParams,
		cfg configmodels.Processor,
		nextConsumer consumer.LogConsumer,
	) (LogProcessor, error)
}

LogProcessorFactory can create LogProcessor.

type LogReceiver

type LogReceiver interface {
	Receiver
}

A LogReceiver is a "log data"-to-"internal format" converter. Its purpose is to translate data from the wild into internal data format. LogReceiver feeds a consumer.LogConsumer with data.

type LogReceiverFactory

type LogReceiverFactory interface {
	ReceiverFactoryBase

	// CreateLogReceiver creates a log receiver based on this config.
	// If the receiver type does not support the data type or if the config is not valid
	// error will be returned instead.
	CreateLogReceiver(
		ctx context.Context,
		params ReceiverCreateParams,
		cfg configmodels.Receiver,
		nextConsumer consumer.LogConsumer,
	) (LogReceiver, error)
}

LogReceiverFactory can create a LogReceiver.

type MetricsExporter

type MetricsExporter interface {
	consumer.MetricsConsumer
	MetricsExporterBase
}

MetricsExporter is a TraceExporter that can consume new-style metrics.

type MetricsExporterBase

type MetricsExporterBase interface {
	Exporter
}

MetricsExporterBase defines a common interface for MetricsExporter and MetricsExporterOld

type MetricsExporterOld

type MetricsExporterOld interface {
	consumer.MetricsConsumerOld
	MetricsExporterBase
}

MetricsExporterOld is a TraceExporter that can consume old-style metrics.

type MetricsProcessor

type MetricsProcessor interface {
	consumer.MetricsConsumer
	MetricsProcessorBase
}

MetricsProcessor is a processor that can consume metrics.

type MetricsProcessorBase

type MetricsProcessorBase interface {
	Processor
}

MetricsProcessorBase is a common interface for MetricsProcessor and MetricsProcessorV2

type MetricsProcessorOld

type MetricsProcessorOld interface {
	consumer.MetricsConsumerOld
	MetricsProcessorBase
}

MetricsProcessor is a processor that can consume old-style metrics.

type MetricsReceiver

type MetricsReceiver interface {
	Receiver
}

A MetricsReceiver is an "arbitrary data"-to-"internal format" converter. Its purpose is to translate data from the wild into internal metrics format. MetricsReceiver feeds a consumer.MetricsConsumer with data.

For example it could be Prometheus data source which translates Prometheus metrics into consumerdata.MetricsData.

type PipelineWatcher

type PipelineWatcher interface {
	// Ready notifies the ServiceExtension that all pipelines were built and the
	// receivers were started, i.e.: the service is ready to receive data
	// (notice that it may already have received data when this method is called).
	Ready() error

	// NotReady notifies the ServiceExtension that all receivers are about to be stopped,
	// i.e.: pipeline receivers will not accept new data.
	// This is sent before receivers are stopped, so the ServiceExtension can take any
	// appropriate action before that happens.
	NotReady() error
}

PipelineWatcher is an extra interface for ServiceExtension hosted by the OpenTelemetry Service that is to be implemented by extensions interested in changes to pipeline states. Typically this will be used by extensions that change their behavior if data is being ingested or not, e.g.: a k8s readiness probe.

type Processor

type Processor interface {
	Component

	// GetCapabilities must return the capabilities of the processor.
	GetCapabilities() ProcessorCapabilities
}

Processor defines the common functions that must be implemented by TraceProcessor and MetricsProcessor.

type ProcessorCapabilities

type ProcessorCapabilities struct {
	// MutatesConsumedData is set to true if Consume* function of the
	// processor modifies the input TraceData or MetricsData argument.
	// Processors which modify the input data MUST set this flag to true. If the processor
	// does not modify the data it MUST set this flag to false. If the processor creates
	// a copy of the data before modifying then this flag can be safely set to false.
	MutatesConsumedData bool
}

ProcessorCapabilities describes the capabilities of a Processor.

type ProcessorCreateParams

type ProcessorCreateParams struct {
	// Logger that the factory can use during creation and can pass to the created
	// component to be used later as well.
	Logger *zap.Logger
}

ProcessorCreateParams is passed to Create* functions in ProcessorFactory.

type ProcessorFactory

type ProcessorFactory interface {
	ProcessorFactoryBase

	// CreateTraceProcessor creates a trace processor based on this config.
	// If the processor type does not support tracing or if the config is not valid
	// error will be returned instead.
	CreateTraceProcessor(ctx context.Context, params ProcessorCreateParams,
		nextConsumer consumer.TraceConsumer, cfg configmodels.Processor) (TraceProcessor, error)

	// CreateMetricsProcessor creates a metrics processor based on this config.
	// If the processor type does not support metrics or if the config is not valid
	// error will be returned instead.
	CreateMetricsProcessor(ctx context.Context, params ProcessorCreateParams,
		nextConsumer consumer.MetricsConsumer, cfg configmodels.Processor) (MetricsProcessor, error)
}

ProcessorFactory is factory interface for processors. This is the new factory type that can create new style processors.

type ProcessorFactoryBase

type ProcessorFactoryBase interface {
	Factory

	// CreateDefaultConfig creates the default configuration for the Processor.
	// This method can be called multiple times depending on the pipeline
	// configuration and should not cause side-effects that prevent the creation
	// of multiple instances of the Processor.
	// The object returned by this method needs to pass the checks implemented by
	// 'configcheck.ValidateConfig'. It is recommended to have such check in the
	// tests of any implementation of the Factory interface.
	CreateDefaultConfig() configmodels.Processor
}

ProcessorFactoryBase defines the common functions for all processor factories.

type ProcessorFactoryOld

type ProcessorFactoryOld interface {
	ProcessorFactoryBase

	// CreateTraceProcessor creates a trace processor based on this config.
	// If the processor type does not support tracing or if the config is not valid
	// error will be returned instead.
	CreateTraceProcessor(logger *zap.Logger, nextConsumer consumer.TraceConsumerOld,
		cfg configmodels.Processor) (TraceProcessorOld, error)

	// CreateMetricsProcessor creates a metrics processor based on this config.
	// If the processor type does not support metrics or if the config is not valid
	// error will be returned instead.
	CreateMetricsProcessor(logger *zap.Logger, nextConsumer consumer.MetricsConsumerOld,
		cfg configmodels.Processor) (MetricsProcessorOld, error)
}

ProcessorFactoryOld is factory interface for processors.

type Receiver

type Receiver interface {
	Component
}

Receiver defines functions that trace and metric receivers must implement.

type ReceiverCreateParams

type ReceiverCreateParams struct {
	// Logger that the factory can use during creation and can pass to the created
	// component to be used later as well.
	Logger *zap.Logger
}

ReceiverCreateParams is passed to ReceiverFactory.Create* functions.

type ReceiverFactory

type ReceiverFactory interface {
	ReceiverFactoryBase

	// CreateTraceReceiver creates a trace receiver based on this config.
	// If the receiver type does not support tracing or if the config is not valid
	// error will be returned instead.
	CreateTraceReceiver(ctx context.Context, params ReceiverCreateParams,
		cfg configmodels.Receiver, nextConsumer consumer.TraceConsumer) (TraceReceiver, error)

	// CreateMetricsReceiver creates a metrics receiver based on this config.
	// If the receiver type does not support metrics or if the config is not valid
	// error will be returned instead.
	CreateMetricsReceiver(ctx context.Context, params ReceiverCreateParams,
		cfg configmodels.Receiver, nextConsumer consumer.MetricsConsumer) (MetricsReceiver, error)
}

ReceiverFactory can create TraceReceiver and MetricsReceiver. This is the new factory type that can create new style receivers.

type ReceiverFactoryBase

type ReceiverFactoryBase interface {
	Factory

	// CreateDefaultConfig creates the default configuration for the Receiver.
	// This method can be called multiple times depending on the pipeline
	// configuration and should not cause side-effects that prevent the creation
	// of multiple instances of the Receiver.
	// The object returned by this method needs to pass the checks implemented by
	// 'configcheck.ValidateConfig'. It is recommended to have such check in the
	// tests of any implementation of the Factory interface.
	CreateDefaultConfig() configmodels.Receiver

	// CustomUnmarshaler returns a custom unmarshaler for the configuration or nil if
	// there is no need for custom unmarshaling. This is typically used if viper.UnmarshalExact()
	// is not sufficient to unmarshal correctly.
	CustomUnmarshaler() CustomUnmarshaler
}

ReceiverFactoryBase defines the common functions for all receiver factories.

type ReceiverFactoryOld

type ReceiverFactoryOld interface {
	ReceiverFactoryBase

	// CreateTraceReceiver creates a trace receiver based on this config.
	// If the receiver type does not support tracing or if the config is not valid
	// error will be returned instead.
	CreateTraceReceiver(ctx context.Context, logger *zap.Logger, cfg configmodels.Receiver,
		nextConsumer consumer.TraceConsumerOld) (TraceReceiver, error)

	// CreateMetricsReceiver creates a metrics receiver based on this config.
	// If the receiver type does not support metrics or if the config is not valid
	// error will be returned instead.
	CreateMetricsReceiver(ctx context.Context, logger *zap.Logger, cfg configmodels.Receiver,
		nextConsumer consumer.MetricsConsumerOld) (MetricsReceiver, error)
}

ReceiverFactoryOld can create TraceReceiver and MetricsReceiver.

type ServiceExtension

type ServiceExtension interface {
	Component
}

ServiceExtension 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.

type TraceExporter

type TraceExporter interface {
	consumer.TraceConsumer
	TraceExporterBase
}

TraceExporter is a TraceExporter that can consume new-style traces.

type TraceExporterBase

type TraceExporterBase interface {
	Exporter
}

TraceExporterBase defines a common interface for TraceExporter and TraceExporterOld

type TraceExporterOld

type TraceExporterOld interface {
	consumer.TraceConsumerOld
	TraceExporterBase
}

TraceExporterOld is a TraceExporter that can consume old-style traces.

type TraceProcessor

type TraceProcessor interface {
	consumer.TraceConsumer
	TraceProcessorBase
}

TraceProcessor is a processor that can consume traces.

type TraceProcessorBase

type TraceProcessorBase interface {
	Processor
}

TraceProcessorBase is a common interface for TraceProcessor and TraceProcessorOld

type TraceProcessorOld

type TraceProcessorOld interface {
	consumer.TraceConsumerOld
	TraceProcessorBase
}

TraceProcessorOld is a processor that can consume old-style traces.

type TraceReceiver

type TraceReceiver interface {
	Receiver
}

A TraceReceiver is an "arbitrary data"-to-"internal format" converter. Its purpose is to translate data from the wild into internal trace format. TraceReceiver feeds a consumer.TraceConsumer with data.

For example it could be Zipkin data source which translates Zipkin spans into consumerdata.TraceData.