pipelines

Documentation

Index

• type Pipelines
  • func Build(ctx context.Context, set Settings) (*Pipelines, error)
  • func (bps *Pipelines) GetExporters() map[config.DataType]map[config.ComponentID]component.Exporter
  • func (bps *Pipelines) HandleZPages(w http.ResponseWriter, r *http.Request)
  • func (bps *Pipelines) ShutdownAll(ctx context.Context) error
  • func (bps *Pipelines) StartAll(ctx context.Context, host component.Host) error
• type Settings

Types

type Pipelines

type Pipelines struct {
	// contains filtered or unexported fields
}

Pipelines is set of all pipelines created from exporter configs.

func Build

func Build(ctx context.Context, set Settings) (*Pipelines, error)

Build builds all pipelines from config.

func (*Pipelines) GetExporters

func (bps *Pipelines) GetExporters() map[config.DataType]map[config.ComponentID]component.Exporter

func (*Pipelines) HandleZPages

func (bps *Pipelines) HandleZPages(w http.ResponseWriter, r *http.Request)

func (*Pipelines) ShutdownAll

func (bps *Pipelines) ShutdownAll(ctx context.Context) error

ShutdownAll stops all pipelines.

Shutdown order is the reverse of starting: receivers, processors, then exporters. This gives senders a chance to send all their data to a not "shutdown" component.

func (*Pipelines) StartAll

func (bps *Pipelines) StartAll(ctx context.Context, host component.Host) error

StartAll starts all pipelines.

Start with exporters, processors (in reverse configured order), then receivers. This is important so that components that are earlier in the pipeline and reference components that are later in the pipeline do not start sending data to later components which are not yet started.

type Settings

type Settings struct {
	Telemetry component.TelemetrySettings
	BuildInfo component.BuildInfo

	// ReceiverFactories maps receiver type names in the config to the respective component.ReceiverFactory.
	ReceiverFactories map[config.Type]component.ReceiverFactory

	// ReceiverConfigs is a map of config.ComponentID to config.Receiver.
	ReceiverConfigs map[config.ComponentID]config.Receiver

	// ProcessorFactories maps processor type names in the config to the respective component.ProcessorFactory.
	ProcessorFactories map[config.Type]component.ProcessorFactory

	// ProcessorConfigs is a map of config.ComponentID to config.Processor.
	ProcessorConfigs map[config.ComponentID]config.Processor

	// ExporterFactories maps exporter type names in the config to the respective component.ExporterFactory.
	ExporterFactories map[config.Type]component.ExporterFactory

	// ExporterConfigs is a map of config.ComponentID to config.Exporter.
	ExporterConfigs map[config.ComponentID]config.Exporter

	// PipelineConfigs is a map of config.ComponentID to config.Pipeline.
	PipelineConfigs map[config.ComponentID]*config.Pipeline
}

Settings holds configuration for building Pipelines.