config

package
Version: v0.37.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 13, 2021 License: Apache-2.0 Imports: 15 Imported by: 169

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

Constants

View Source
const (
	// KeyDelimiter is used as the default key delimiter in the default koanf instance.
	KeyDelimiter = "::"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type ComponentID added in v0.25.0

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 added in v0.37.0

func NewComponentID(typeVal Type) ComponentID

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

func NewComponentIDFromString added in v0.37.0

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 added in v0.37.0

func NewComponentIDWithName(typeVal Type, nameVal string) ComponentID

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

func (ComponentID) Name added in v0.25.0

func (id ComponentID) Name() string

Name returns the custom name of the component.

func (ComponentID) String added in v0.25.0

func (id ComponentID) String() string

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

func (ComponentID) Type added in v0.25.0

func (id ComponentID) Type() Type

Type returns the type of the component.

type Config added in v0.24.0

Config defines the configuration for the various elements of collector or agent.

func (*Config) Validate added in v0.24.0

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 added in v0.24.0

type DataType string

DataType is the data type that is supported for collection. 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 added in v0.24.0

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 added in v0.24.0

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 added in v0.24.0

func NewExporterSettings(id ComponentID) ExporterSettings

NewExporterSettings return a new ExporterSettings with the given ComponentID.

func (*ExporterSettings) ID added in v0.26.0

func (rs *ExporterSettings) ID() ComponentID

ID returns the receiver ComponentID.

func (*ExporterSettings) SetIDName added in v0.26.0

func (rs *ExporterSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ExporterSettings) Validate added in v0.25.0

func (rs *ExporterSettings) Validate() error

type Exporters added in v0.24.0

type Exporters map[ComponentID]Exporter

Exporters is a map of names to Exporters.

type Extension added in v0.24.0

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 added in v0.24.0

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 added in v0.24.0

func NewExtensionSettings(id ComponentID) ExtensionSettings

NewExtensionSettings return a new ExtensionSettings with the given ComponentID.

func (*ExtensionSettings) ID added in v0.26.0

func (rs *ExtensionSettings) ID() ComponentID

ID returns the receiver ComponentID.

func (*ExtensionSettings) SetIDName added in v0.26.0

func (rs *ExtensionSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ExtensionSettings) Validate added in v0.25.0

func (rs *ExtensionSettings) Validate() error

Validate validates the configuration and returns an error if invalid.

type Extensions added in v0.24.0

type Extensions map[ComponentID]Extension

Extensions is a map of names to extensions.

type Map added in v0.37.0

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

Map represents the raw configuration map for the OpenTelemetry Collector. The config.Map can be unmarshalled into the Collector's config using the "configunmarshaler" package.

func NewMap added in v0.37.0

func NewMap() *Map

NewMap creates a new empty config.Map instance.

func NewMapFromBuffer added in v0.37.0

func NewMapFromBuffer(buf io.Reader) (*Map, error)

NewMapFromBuffer creates a new config.Map by reading the given yaml buffer.

func NewMapFromFile added in v0.37.0

func NewMapFromFile(fileName string) (*Map, error)

NewMapFromFile creates a new config.Map by reading the given file.

func NewMapFromStringMap added in v0.37.0

func NewMapFromStringMap(data map[string]interface{}) *Map

NewMapFromStringMap creates a config.Map from a map[string]interface{}.

func (*Map) AllKeys added in v0.37.0

func (l *Map) AllKeys() []string

AllKeys returns all keys holding a value, regardless of where they are set. Nested keys are returned with a KeyDelimiter separator.

func (*Map) Get added in v0.37.0

func (l *Map) Get(key string) interface{}

Get can retrieve any value given the key to use.

func (*Map) IsSet added in v0.37.0

func (l *Map) IsSet(key string) bool

IsSet checks to see if the key has been set in any of the data locations. IsSet is case-insensitive for a key.

func (*Map) Merge added in v0.37.0

func (l *Map) Merge(in *Map) error

Merge merges the input given configuration into the existing config. Note that the given map may be modified.

func (*Map) Set added in v0.37.0

func (l *Map) Set(key string, value interface{})

Set sets the value for the key.

func (*Map) Sub added in v0.37.0

func (l *Map) Sub(key string) (*Map, error)

Sub returns new Parser instance representing a sub-config of this instance. It returns an error is the sub-config is not a map (use Get()) and an empty Parser if none exists.

func (*Map) ToStringMap added in v0.37.0

func (l *Map) ToStringMap() map[string]interface{}

ToStringMap creates a map[string]interface{} from a Parser.

func (*Map) Unmarshal added in v0.37.0

func (l *Map) Unmarshal(rawVal interface{}) error

Unmarshal unmarshalls the config into a struct. Tags on the fields of the structure must be properly set.

func (*Map) UnmarshalExact added in v0.37.0

func (l *Map) UnmarshalExact(intoCfg interface{}) error

UnmarshalExact unmarshalls the config into a struct, erroring if a field is nonexistent.

type Pipeline added in v0.24.0

type Pipeline struct {
	Name       string
	InputType  DataType
	Receivers  []ComponentID
	Processors []ComponentID
	Exporters  []ComponentID
}

Pipeline defines a single pipeline.

type Pipelines added in v0.24.0

type Pipelines map[string]*Pipeline

Pipelines is a map of names to Pipelines.

type Processor added in v0.24.0

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 added in v0.24.0

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 added in v0.24.0

func NewProcessorSettings(id ComponentID) ProcessorSettings

NewProcessorSettings return a new ProcessorSettings with the given ComponentID.

func (*ProcessorSettings) ID added in v0.26.0

func (rs *ProcessorSettings) ID() ComponentID

ID returns the receiver ComponentID.

func (*ProcessorSettings) SetIDName added in v0.26.0

func (rs *ProcessorSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ProcessorSettings) Validate added in v0.25.0

func (rs *ProcessorSettings) Validate() error

Validate validates the configuration and returns an error if invalid.

type Processors added in v0.24.0

type Processors map[ComponentID]Processor

Processors is a map of names to Processors.

type Receiver added in v0.24.0

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 added in v0.24.0

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 added in v0.26.0

func NewReceiverSettings(id ComponentID) ReceiverSettings

NewReceiverSettings return a new ReceiverSettings with the given ComponentID.

func (*ReceiverSettings) ID added in v0.26.0

func (rs *ReceiverSettings) ID() ComponentID

ID returns the receiver ComponentID.

func (*ReceiverSettings) SetIDName added in v0.26.0

func (rs *ReceiverSettings) SetIDName(idName string)

SetIDName sets the receiver name.

func (*ReceiverSettings) Validate added in v0.24.0

func (rs *ReceiverSettings) Validate() error

Validate validates the configuration and returns an error if invalid.

type Receivers added in v0.24.0

type Receivers map[ComponentID]Receiver

Receivers is a map of names to Receivers.

type Service added in v0.24.0

type Service struct {
	Telemetry ServiceTelemetry

	// Extensions are the ordered list of extensions configured for the service.
	Extensions []ComponentID

	// Pipelines are the set of data pipelines configured for the service.
	Pipelines Pipelines
}

Service defines the configurable components of the service.

type ServiceTelemetry added in v0.36.0

type ServiceTelemetry struct {
	Logs ServiceTelemetryLogs
}

ServiceTelemetry defines the configurable settings for service telemetry.

type ServiceTelemetryLogs added in v0.36.0

type ServiceTelemetryLogs struct {
	// Level is the minimum enabled logging level.
	Level zapcore.Level

	// Development puts the logger in development mode, which changes the
	// behavior of DPanicLevel and takes stacktraces more liberally.
	Development bool

	// Encoding sets the logger's encoding.
	// Valid values are "json" and "console".
	Encoding string
}

ServiceTelemetryLogs defines the configurable settings for service telemetry logs. This MUST be compatible with zap.Config. Cannot use directly zap.Config because the collector uses mapstructure and not yaml tags.

type Type added in v0.24.0

type Type string

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

type Unmarshallable added in v0.32.0

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

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

Directories

Path Synopsis
Package configauth implements the configuration settings to ensure authentication on incoming requests, and allows exporters to add authentication on outgoing requests.
Package configauth implements the configuration settings to ensure authentication on incoming requests, and allows exporters to add authentication on outgoing requests.
Package configgrpc defines the configuration settings to create a gRPC client and server.
Package configgrpc defines the configuration settings to create a gRPC client and server.
Package confighttp defines the configuration settings for creating an HTTP client and server.
Package confighttp defines the configuration settings for creating an HTTP client and server.
Package confignet implements the configuration settings for protocols to connect and transport data information.
Package confignet implements the configuration settings for protocols to connect and transport data information.
Package configtelemetry defines various telemetry level for configuration.
Package configtelemetry defines various telemetry level for configuration.
Package configtest loads the configuration to test packages implementing the config package interfaces.
Package configtest loads the configuration to test packages implementing the config package interfaces.
Package configtls implements the TLS settings to load and configure TLS clients and servers.
Package configtls implements the TLS settings to load and configure TLS clients and servers.
Package configunmarshaler implements configuration unmarshalling from a config.Map.
Package configunmarshaler implements configuration unmarshalling from a config.Map.
experimental
config
Package config under config/experimental contains configuration related types and interfaces that typically live under the "go.opentelemetry.io/collector/config" package but aren't stable yet to be published there.
Package config under config/experimental contains configuration related types and interfaces that typically live under the "go.opentelemetry.io/collector/config" package but aren't stable yet to be published there.
configsource
Package configsource is an experimental package that defines the interface of "configuration sources," e.g., Vault, ZooKeeper, etcd2, and others.
Package configsource is an experimental package that defines the interface of "configuration sources," e.g., Vault, ZooKeeper, etcd2, and others.
internal
configsource
Package configsource is an internal package that implements methods for injecting, watching, and updating data from ConfigSource into configuration.
Package configsource is an internal package that implements methods for injecting, watching, and updating data from ConfigSource into configuration.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL