builder

Documentation

Overview

Package builder handles the options to build the OpenTelemetry collector pipeline.

Index

• type BuiltPipelines
  • func BuildPipelines(settings component.TelemetrySettings, buildInfo component.BuildInfo, ...) (BuiltPipelines, error)
  • func (bps BuiltPipelines) ShutdownProcessors(ctx context.Context) error
  • func (bps BuiltPipelines) StartProcessors(ctx context.Context, host component.Host) error
• type Exporters
  • func BuildExporters(settings component.TelemetrySettings, buildInfo component.BuildInfo, ...) (Exporters, error)
  • func (exps Exporters) ShutdownAll(ctx context.Context) error
  • func (exps Exporters) StartAll(ctx context.Context, host component.Host) error
  • func (exps Exporters) ToMapByDataType() map[config.DataType]map[config.ComponentID]component.Exporter
• type Receivers
  • func BuildReceivers(settings component.TelemetrySettings, buildInfo component.BuildInfo, ...) (Receivers, error)
  • func (rcvs Receivers) ShutdownAll(ctx context.Context) error
  • func (rcvs Receivers) StartAll(ctx context.Context, host component.Host) error

Types

type BuiltPipelines

type BuiltPipelines map[config.ComponentID]*builtPipeline

BuiltPipelines is a map of build pipelines created from pipeline configs.

func BuildPipelines

func BuildPipelines(
	settings component.TelemetrySettings,
	buildInfo component.BuildInfo,
	config *config.Config,
	exporters Exporters,
	factories map[config.Type]component.ProcessorFactory,
) (BuiltPipelines, error)

BuildPipelines builds pipeline processors from config. Requires exporters to be already built via BuildExporters.

func (BuiltPipelines) ShutdownProcessors

func (bps BuiltPipelines) ShutdownProcessors(ctx context.Context) error

func (BuiltPipelines) StartProcessors

func (bps BuiltPipelines) StartProcessors(ctx context.Context, host component.Host) error

type Exporters

type Exporters map[config.ComponentID]*builtExporter

Exporters is a map of exporters created from exporter configs.

func BuildExporters

func BuildExporters(
	settings component.TelemetrySettings,
	buildInfo component.BuildInfo,
	cfg *config.Config,
	factories map[config.Type]component.ExporterFactory,
) (Exporters, error)

BuildExporters builds Exporters from config.

func (Exporters) ShutdownAll

func (exps Exporters) ShutdownAll(ctx context.Context) error

ShutdownAll stops all exporters.

func (Exporters) StartAll

func (exps Exporters) StartAll(ctx context.Context, host component.Host) error

StartAll starts all exporters.

func (Exporters) ToMapByDataType

func (exps Exporters) ToMapByDataType() map[config.DataType]map[config.ComponentID]component.Exporter

type Receivers

type Receivers map[config.ComponentID]*builtReceiver

Receivers is a map of receivers created from receiver configs.

func BuildReceivers

func BuildReceivers(
	settings component.TelemetrySettings,
	buildInfo component.BuildInfo,
	cfg *config.Config,
	builtPipelines BuiltPipelines,
	factories map[config.Type]component.ReceiverFactory,
) (Receivers, error)

BuildReceivers builds Receivers from config.

func (Receivers) ShutdownAll

func (rcvs Receivers) ShutdownAll(ctx context.Context) error

ShutdownAll stops all receivers.

func (Receivers) StartAll

func (rcvs Receivers) StartAll(ctx context.Context, host component.Host) error

StartAll starts all receivers.