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

• func UnmarshalExporter(conf *confmap.Conf, cfg Exporter) error
• func UnmarshalExtension(conf *confmap.Conf, cfg Extension) error
• func UnmarshalProcessor(conf *confmap.Conf, cfg Processor) error
• func UnmarshalReceiver(conf *confmap.Conf, cfg Receiver) error
• type ComponentID
  • func NewComponentID(typeVal Type) ComponentID
  • func NewComponentIDFromString(idStr string) (ComponentID, error)
  • func NewComponentIDWithName(typeVal Type, nameVal string) ComponentID
  • func (id ComponentID) Name() string
  • func (id ComponentID) String() string
  • func (id ComponentID) Type() Type
  • func (id *ComponentID) UnmarshalText(text []byte) error
• type Config
  • func (cfg *Config) Validate() error
• type DataType
• type Exporter
• type ExporterSettings
  • func NewExporterSettings(id ComponentID) ExporterSettings
  • func (es *ExporterSettings) ID() ComponentID
  • func (es *ExporterSettings) SetIDName(idName string)
  • func (es *ExporterSettings) Validate() error
• type Extension
• type ExtensionSettings
  • func NewExtensionSettings(id ComponentID) ExtensionSettings
  • func (es *ExtensionSettings) ID() ComponentID
  • func (es *ExtensionSettings) SetIDName(idName string)
  • func (es *ExtensionSettings) Validate() error
• type Pipeline
• type Pipelines
• type Processor
• type ProcessorSettings
  • func NewProcessorSettings(id ComponentID) ProcessorSettings
  • func (ps *ProcessorSettings) ID() ComponentID
  • func (ps *ProcessorSettings) SetIDName(idName string)
  • func (ps *ProcessorSettings) Validate() error
• type Receiver
• type ReceiverSettings
  • func NewReceiverSettings(id ComponentID) ReceiverSettings
  • func (rs *ReceiverSettings) ID() ComponentID
  • func (rs *ReceiverSettings) SetIDName(idName string)
  • func (rs *ReceiverSettings) Validate() error
• type Service
• type Type
• type Unmarshallable

Functions

func UnmarshalExporter

func UnmarshalExporter(conf *confmap.Conf, cfg Exporter) error

UnmarshalExporter helper function to unmarshal an Exporter config. It checks if the config implements Unmarshallable and uses that if available, otherwise uses Map.UnmarshalExact, erroring if a field is nonexistent.

func UnmarshalExtension

func UnmarshalExtension(conf *confmap.Conf, cfg Extension) error

UnmarshalExtension helper function to unmarshal an Extension config. It checks if the config implements Unmarshallable and uses that if available, otherwise uses Map.UnmarshalExact, erroring if a field is nonexistent.

func UnmarshalProcessor

func UnmarshalProcessor(conf *confmap.Conf, cfg Processor) error

UnmarshalProcessor helper function to unmarshal a Processor config. It checks if the config implements Unmarshallable and uses that if available, otherwise uses Map.UnmarshalExact, erroring if a field is nonexistent.

func UnmarshalReceiver

func UnmarshalReceiver(conf *confmap.Conf, cfg Receiver) error

UnmarshalReceiver helper function to unmarshal a Receiver config. It checks if the config implements Unmarshallable and uses that if available, otherwise uses Map.UnmarshalExact, erroring if a field is nonexistent.

Types

type ComponentID

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

ComponentID represents the identity for a component. It combines two values: * type - the Type of the component. * name - the name of that component. The component ComponentID (combination type + name) is unique for a given component.Kind.

func NewComponentID

func NewComponentID(typeVal Type) ComponentID

NewComponentID returns a new ComponentID with the given Type and empty name.

func NewComponentIDFromString

func NewComponentIDFromString(idStr string) (ComponentID, error)

NewComponentIDFromString decodes a string in type[/name] format into ComponentID. The type and name components will have spaces trimmed, the "type" part must be present, the forward slash and "name" are optional. The returned ComponentID will be invalid if err is not-nil.

func NewComponentIDWithName

func NewComponentIDWithName(typeVal Type, nameVal string) ComponentID

NewComponentIDWithName returns a new ComponentID with the given Type and name.

func (ComponentID) Name

func (id ComponentID) Name() string

Name returns the custom name of the component.

func (ComponentID) String

func (id ComponentID) String() string

String returns the ComponentID string representation as "type[/name]" format.

func (ComponentID) Type

func (id ComponentID) Type() Type

Type returns the type of the component.

func (*ComponentID) UnmarshalText

func (id *ComponentID) UnmarshalText(text []byte) error

UnmarshalText implements the encoding.TextUnmarshaler interface.

type Config

type Config struct {
	// Receivers is a map of ComponentID to Receivers.
	Receivers map[ComponentID]Receiver

	// Exporters is a map of ComponentID to Exporters.
	Exporters map[ComponentID]Exporter

	// Processors is a map of ComponentID to Processors.
	Processors map[ComponentID]Processor

	// Extensions is a map of ComponentID to extensions.
	Extensions map[ComponentID]Extension

	Service
}

Config defines the configuration for the various elements of collector or agent. Deprecated: [v0.52.0] Use service.Config

func (*Config) Validate

func (cfg *Config) Validate() error

Validate returns an error if the config is invalid.

This function performs basic validation of configuration. There may be more subtle invalid cases that we currently don't check for but which we may want to add in the future (e.g. disallowing receiving and exporting on the same endpoint).

type DataType

type DataType = Type

DataType is a special Type that represents the data types supported by the collector. We currently support collecting metrics, traces and logs, this can expand in the future.

const (
	// TracesDataType is the data type tag for traces.
	TracesDataType DataType = "traces"

	// MetricsDataType is the data type tag for metrics.
	MetricsDataType DataType = "metrics"

	// LogsDataType is the data type tag for logs.
	LogsDataType DataType = "logs"
)

Currently supported data types. Add new data types here when new types are supported in the future.

type Exporter

type Exporter interface {
	// contains filtered or unexported methods
}

Exporter is the configuration of a component.Exporter. Specific extensions must implement this interface and must embed ExporterSettings struct or a struct that extends it.

type ExporterSettings

type ExporterSettings struct {
	// 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 ComponentID) ExporterSettings

NewExporterSettings return a new ExporterSettings with the given ComponentID.

func (*ExporterSettings) ID

func (es *ExporterSettings) ID() ComponentID

ID returns the receiver ComponentID.

func (*ExporterSettings) SetIDName

func (es *ExporterSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ExporterSettings) Validate

func (es *ExporterSettings) Validate() error

Validate validates the configuration and returns an error if invalid.

type Extension

type Extension interface {
	// contains filtered or unexported methods
}

Extension is the configuration of a component.Extension. Specific extensions must implement this interface and must embed ExtensionSettings struct or a struct that extends it.

type ExtensionSettings

type ExtensionSettings struct {
	// 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 ComponentID) ExtensionSettings

NewExtensionSettings return a new ExtensionSettings with the given ComponentID.

func (*ExtensionSettings) ID

func (es *ExtensionSettings) ID() ComponentID

ID returns the receiver ComponentID.

func (*ExtensionSettings) SetIDName

func (es *ExtensionSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ExtensionSettings) Validate

func (es *ExtensionSettings) Validate() error

Validate validates the configuration and returns an error if invalid.

type Pipeline

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

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

type Pipelines

type Pipelines = map[ComponentID]*Pipeline

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

type Processor

type Processor interface {
	// contains filtered or unexported methods
}

Processor is the configuration of a component.Processor. Specific extensions must implement this interface and must embed ProcessorSettings struct or a struct that extends it.

type ProcessorSettings

type ProcessorSettings struct {
	// 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 ComponentID) ProcessorSettings

NewProcessorSettings return a new ProcessorSettings with the given ComponentID.

func (*ProcessorSettings) ID

func (ps *ProcessorSettings) ID() ComponentID

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

Validate validates the configuration and returns an error if invalid.

type Receiver

type Receiver interface {
	// contains filtered or unexported methods
}

Receiver is the configuration of a component.Receiver. Specific extensions must implement this interface and must embed ReceiverSettings struct or a struct that extends it.

type ReceiverSettings

type ReceiverSettings struct {
	// 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 ComponentID) ReceiverSettings

NewReceiverSettings return a new ReceiverSettings with the given ComponentID.

func (*ReceiverSettings) ID

func (rs *ReceiverSettings) ID() ComponentID

ID returns the receiver ComponentID.

func (*ReceiverSettings) SetIDName

func (rs *ReceiverSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ReceiverSettings) Validate

func (rs *ReceiverSettings) Validate() error

Validate validates the configuration and returns an error if invalid.

type Service

type Service struct {
	// Telemetry is the configuration for collector's own telemetry.
	Telemetry telemetry.Config `mapstructure:"telemetry"`

	// Extensions are the ordered list of extensions configured for the service.
	Extensions []ComponentID `mapstructure:"extensions"`

	// Pipelines are the set of data pipelines configured for the service.
	Pipelines map[ComponentID]*Pipeline `mapstructure:"pipelines"`
}

Service defines the configurable components of the service. Deprecated: [v0.52.0] Use service.ConfigService

type Type

type Type string

Type is the component type as it is used in the config.

type Unmarshallable

type Unmarshallable interface {
	// Unmarshal is a function that unmarshalls a confmap.Conf into the unmarshable struct in a custom way.
	// The confmap.Conf for this specific component may be nil or empty if no config available.
	Unmarshal(component *confmap.Conf) error
}

Unmarshallable defines an optional interface for custom configuration unmarshalling. A configuration struct can implement this interface to override the default unmarshalling.