builder

Documentation

Overview

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

Index

• func Flags(flags *flag.FlagSet)
• func GetConfigFile() string
• func MemBallastSize() int
• type BuiltPipelines
  • func (bps BuiltPipelines) ShutdownProcessors(logger *zap.Logger) error
  • func (bps BuiltPipelines) StartProcessors(logger *zap.Logger, host component.Host) error
• type Exporters
  • func (exps Exporters) ShutdownAll() error
  • func (exps Exporters) StartAll(logger *zap.Logger, host component.Host) error
• type ExportersBuilder
  • func NewExportersBuilder(logger *zap.Logger, config *configmodels.Config, ...) *ExportersBuilder
  • func (eb *ExportersBuilder) Build() (Exporters, error)
• type PipelinesBuilder
  • func NewPipelinesBuilder(logger *zap.Logger, config *configmodels.Config, exporters Exporters, ...) *PipelinesBuilder
  • func (pb *PipelinesBuilder) Build() (BuiltPipelines, error)
• type Receivers
  • func (rcvs Receivers) StartAll(logger *zap.Logger, host component.Host) error
  • func (rcvs Receivers) StopAll() error
• type ReceiversBuilder
  • func NewReceiversBuilder(logger *zap.Logger, config *configmodels.Config, builtPipelines BuiltPipelines, ...) *ReceiversBuilder
  • func (rb *ReceiversBuilder) Build() (Receivers, error)

Functions

func Flags

func Flags(flags *flag.FlagSet)

Flags adds flags related to basic building of the collector application to the given flagset.

func GetConfigFile

func GetConfigFile() string

GetConfigFile gets the config file from the config file flag.

func MemBallastSize

func MemBallastSize() int

MemBallastSize returns the size of memory ballast to use in MBs

Types

type BuiltPipelines

type BuiltPipelines map[*configmodels.Pipeline]*builtPipeline

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

func (BuiltPipelines) ShutdownProcessors

func (bps BuiltPipelines) ShutdownProcessors(logger *zap.Logger) error

func (BuiltPipelines) StartProcessors

func (bps BuiltPipelines) StartProcessors(logger *zap.Logger, host component.Host) error

type Exporters

type Exporters map[configmodels.Exporter]*builtExporter

Exporters is a map of exporters created from exporter configs.

func (Exporters) ShutdownAll

func (exps Exporters) ShutdownAll() error

ShutdownAll stops all exporters.

func (Exporters) StartAll

func (exps Exporters) StartAll(logger *zap.Logger, host component.Host) error

StartAll starts all exporters.

type ExportersBuilder

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

ExportersBuilder builds exporters from config.

func NewExportersBuilder

func NewExportersBuilder(
	logger *zap.Logger,
	config *configmodels.Config,
	factories map[string]component.ExporterFactoryBase,
) *ExportersBuilder

NewExportersBuilder creates a new ExportersBuilder. Call BuildExporters() on the returned value.

func (*ExportersBuilder) Build

func (eb *ExportersBuilder) Build() (Exporters, error)

BuildExporters exporters from config.

type PipelinesBuilder

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

PipelinesBuilder builds pipelines from config.

func NewPipelinesBuilder

func NewPipelinesBuilder(
	logger *zap.Logger,
	config *configmodels.Config,
	exporters Exporters,
	factories map[string]component.ProcessorFactoryBase,
) *PipelinesBuilder

NewPipelinesBuilder creates a new PipelinesBuilder. Requires exporters to be already built via ExportersBuilder. Call BuildProcessors() on the returned value.

func (*PipelinesBuilder) Build

func (pb *PipelinesBuilder) Build() (BuiltPipelines, error)

BuildProcessors pipeline processors from config.

type Receivers

type Receivers map[configmodels.Receiver]*builtReceiver

Receivers is a map of receivers created from receiver configs.

func (Receivers) StartAll

func (rcvs Receivers) StartAll(logger *zap.Logger, host component.Host) error

StartAll starts all receivers.

func (Receivers) StopAll

func (rcvs Receivers) StopAll() error

StopAll stops all receivers.

type ReceiversBuilder

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

ReceiversBuilder builds receivers from config.

func NewReceiversBuilder

func NewReceiversBuilder(
	logger *zap.Logger,
	config *configmodels.Config,
	builtPipelines BuiltPipelines,
	factories map[string]component.ReceiverFactoryBase,
) *ReceiversBuilder

NewReceiversBuilder creates a new ReceiversBuilder. Call BuildProcessors() on the returned value.

func (*ReceiversBuilder) Build

func (rb *ReceiversBuilder) Build() (Receivers, error)

BuildProcessors receivers from config.