config

Documentation

Overview

Package config defines the data models for entities. This file defines the models for configuration format. The defined entities are: Config (the top-level structure), Receivers, Exporters, Processors, Pipelines.

Receivers, Exporters and Processors typically have common configuration settings, however sometimes specific implementations will have extra configuration settings. This requires the configuration data for these entities to be polymorphic.

To satisfy these requirements we declare interfaces Receiver, Exporter, Processor, which define the behavior. We also provide helper structs ReceiverSettings, ExporterSettings, ProcessorSettings, which define the common settings and unmarshaling from config files.

Specific Receivers/Exporters/Processors are expected to at the minimum implement the corresponding interface and if they have additional settings they must also extend the corresponding common settings struct (the easiest approach is to embed the common struct).

Index

• type ExporterSettings
  • func NewExporterSettings(id component.ID) ExporterSettings
  • func (es *ExporterSettings) ID() component.ID
  • func (es *ExporterSettings) SetIDName(idName string)
  • func (es *ExporterSettings) Validate() error
• type ExtensionSettings
  • func NewExtensionSettings(id component.ID) ExtensionSettings
  • func (es *ExtensionSettings) ID() component.ID
  • func (es *ExtensionSettings) SetIDName(idName string)
  • func (es *ExtensionSettings) Validate() error
• type Pipeline
• type Pipelines
• type ProcessorSettings
  • func NewProcessorSettings(id component.ID) ProcessorSettings
  • func (ps *ProcessorSettings) ID() component.ID
  • func (ps *ProcessorSettings) SetIDName(idName string)
  • func (ps *ProcessorSettings) Validate() error
• type ReceiverSettings
  • func NewReceiverSettings(id component.ID) ReceiverSettings
  • func (rs *ReceiverSettings) ID() component.ID
  • func (rs *ReceiverSettings) SetIDName(idName string)
  • func (rs *ReceiverSettings) Validate() error

Types

type ExporterSettings

type ExporterSettings struct {
	component.ExporterConfig
	// contains filtered or unexported fields
}

ExporterSettings defines common settings for a component.Exporter configuration. Specific exporters can embed this struct and extend it with more fields if needed.

It is highly recommended to "override" the Validate() function.

When embedded in the exporter config, it must be with `mapstructure:",squash"` tag.

func NewExporterSettings

func NewExporterSettings(id component.ID) ExporterSettings

NewExporterSettings return a new ExporterSettings with the given ComponentID.

func (*ExporterSettings) ID

func (es *ExporterSettings) ID() component.ID

ID returns the receiver component.ID.

func (*ExporterSettings) SetIDName

func (es *ExporterSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ExporterSettings) Validate

func (es *ExporterSettings) Validate() error

Deprecated: [v0.65.0] use component.ValidateConfig.

type ExtensionSettings

type ExtensionSettings struct {
	component.ExtensionConfig
	// contains filtered or unexported fields
}

ExtensionSettings defines common settings for a component.Extension configuration. Specific processors can embed this struct and extend it with more fields if needed.

It is highly recommended to "override" the Validate() function.

When embedded in the extension config, it must be with `mapstructure:",squash"` tag.

func NewExtensionSettings

func NewExtensionSettings(id component.ID) ExtensionSettings

NewExtensionSettings return a new ExtensionSettings with the given ID.

func (*ExtensionSettings) ID

func (es *ExtensionSettings) ID() component.ID

ID returns the receiver ID.

func (*ExtensionSettings) SetIDName

func (es *ExtensionSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ExtensionSettings) Validate

func (es *ExtensionSettings) Validate() error

Deprecated: [v0.65.0] use component.ValidateConfig.

type Pipeline

type Pipeline struct {
	Receivers  []component.ID `mapstructure:"receivers"`
	Processors []component.ID `mapstructure:"processors"`
	Exporters  []component.ID `mapstructure:"exporters"`
}

Pipeline defines a single pipeline. Deprecated: [v0.52.0] Use service.ConfigServicePipeline

type Pipelines

type Pipelines = map[component.ID]*Pipeline

Deprecated: [v0.52.0] will be removed soon.

type ProcessorSettings

type ProcessorSettings struct {
	component.ProcessorConfig
	// contains filtered or unexported fields
}

ProcessorSettings defines common settings for a component.Processor configuration. Specific processors can embed this struct and extend it with more fields if needed.

It is highly recommended to "override" the Validate() function.

When embedded in the processor config it must be with `mapstructure:",squash"` tag.

func NewProcessorSettings

func NewProcessorSettings(id component.ID) ProcessorSettings

NewProcessorSettings return a new ProcessorSettings with the given ComponentID.

func (*ProcessorSettings) ID

func (ps *ProcessorSettings) ID() component.ID

ID returns the receiver ComponentID.

func (*ProcessorSettings) SetIDName

func (ps *ProcessorSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ProcessorSettings) Validate

func (ps *ProcessorSettings) Validate() error

Deprecated: [v0.65.0] use component.ValidateConfig.

type ReceiverSettings

type ReceiverSettings struct {
	component.ReceiverConfig
	// contains filtered or unexported fields
}

ReceiverSettings defines common settings for a component.Receiver configuration. Specific receivers can embed this struct and extend it with more fields if needed.

It is highly recommended to "override" the Validate() function.

When embedded in the receiver config it must be with `mapstructure:",squash"` tag.

func NewReceiverSettings

func NewReceiverSettings(id component.ID) ReceiverSettings

NewReceiverSettings return a new ReceiverSettings with the given ID.

func (*ReceiverSettings) ID

func (rs *ReceiverSettings) ID() component.ID

ID returns the receiver ID.

func (*ReceiverSettings) SetIDName

func (rs *ReceiverSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ReceiverSettings) Validate

func (rs *ReceiverSettings) Validate() error

Deprecated: [v0.65.0] Not needed anymore since the Validate() will be moved from Config interface to the optional ConfigValidator interface.