builder

Documentation

Overview

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

Index

• func Flags(flags *flag.FlagSet)
• func MemBallastSize() int
• type BuiltPipelines
  • func BuildPipelines(logger *zap.Logger, appInfo component.ApplicationStartInfo, ...) (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(logger *zap.Logger, appInfo component.ApplicationStartInfo, ...) (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.NamedEntity]component.Exporter
• type Extensions
  • func BuildExtensions(logger *zap.Logger, appInfo component.ApplicationStartInfo, ...) (Extensions, error)
  • func (exts Extensions) NotifyPipelineNotReady() error
  • func (exts Extensions) NotifyPipelineReady() error
  • func (exts Extensions) ShutdownAll(ctx context.Context) error
  • func (exts Extensions) StartAll(ctx context.Context, host component.Host) error
  • func (exts Extensions) ToMap() map[config.NamedEntity]component.Extension
• type Receivers
  • func BuildReceivers(logger *zap.Logger, appInfo component.ApplicationStartInfo, ...) (Receivers, error)
  • func (rcvs Receivers) ShutdownAll(ctx context.Context) error
  • func (rcvs Receivers) StartAll(ctx context.Context, host component.Host) 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 MemBallastSize

func MemBallastSize() int

MemBallastSize returns the size of memory ballast to use in MBs

Types

type BuiltPipelines

type BuiltPipelines map[*config.Pipeline]*builtPipeline

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

func BuildPipelines

func BuildPipelines(
	logger *zap.Logger,
	appInfo component.ApplicationStartInfo,
	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.Exporter]*builtExporter

Exporters is a map of exporters created from exporter configs.

func BuildExporters

func BuildExporters(
	logger *zap.Logger,
	appInfo component.ApplicationStartInfo,
	config *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.NamedEntity]component.Exporter

type Extensions

type Extensions map[config.Extension]*builtExtension

Extensions is a map of extensions created from extension configs.

func BuildExtensions

func BuildExtensions(
	logger *zap.Logger,
	appInfo component.ApplicationStartInfo,
	config *config.Config,
	factories map[config.Type]component.ExtensionFactory,
) (Extensions, error)

BuildExtensions builds Extensions from config.

func (Extensions) NotifyPipelineNotReady

func (exts Extensions) NotifyPipelineNotReady() error

func (Extensions) NotifyPipelineReady

func (exts Extensions) NotifyPipelineReady() error

func (Extensions) ShutdownAll

func (exts Extensions) ShutdownAll(ctx context.Context) error

ShutdownAll stops all exporters.

func (Extensions) StartAll

func (exts Extensions) StartAll(ctx context.Context, host component.Host) error

StartAll starts all exporters.

func (Extensions) ToMap

func (exts Extensions) ToMap() map[config.NamedEntity]component.Extension

type Receivers

type Receivers map[config.Receiver]*builtReceiver

Receivers is a map of receivers created from receiver configs.

func BuildReceivers

func BuildReceivers(
	logger *zap.Logger,
	appInfo component.ApplicationStartInfo,
	config *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.