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 ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ConnectorSettings ¶ added in v0.67.0
type ConnectorSettings struct {
// contains filtered or unexported fields
}
ConnectorSettings defines common settings for a component.Connector configuration. Specific connectors can embed this struct and extend it with more fields if needed.
When embedded in the exporter config, it must be with `mapstructure:",squash"` tag.
func NewConnectorSettings ¶ added in v0.67.0
func NewConnectorSettings(id component.ID) ConnectorSettings
NewConnectorSettings return a new ConnectorSettings with the given ComponentID.
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.
When embedded in the exporter config, it must be with `mapstructure:",squash"` tag.
func NewExporterSettings ¶ added in v0.24.0
func NewExporterSettings(id component.ID) ExporterSettings
NewExporterSettings return a new ExporterSettings with the given ComponentID.
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.
When embedded in the extension config, it must be with `mapstructure:",squash"` tag.
func NewExtensionSettings ¶ added in v0.24.0
func NewExtensionSettings(id component.ID) ExtensionSettings
NewExtensionSettings return a new ExtensionSettings with the given ID.
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.
When embedded in the processor config it must be with `mapstructure:",squash"` tag.
func NewProcessorSettings ¶ added in v0.24.0
func NewProcessorSettings(id component.ID) ProcessorSettings
NewProcessorSettings return a new ProcessorSettings with the given ComponentID.
type ReceiverSettings ¶ added in v0.24.0
type ReceiverSettings struct {
// contains filtered or unexported fields
}
ReceiverSettings defines common settings for a receiver.Receiver configuration. Specific receivers can embed this struct and extend it with more fields if needed.
When embedded in the receiver config it must be with `mapstructure:",squash"` tag.
func NewReceiverSettings ¶ added in v0.26.0
func NewReceiverSettings(id component.ID) ReceiverSettings
NewReceiverSettings return a new ReceiverSettings with the given ID.
Source Files
¶
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. |
|
xconfighttp
Module
|
|
|
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. |
|
configretry
module
|
|
|
Package configtelemetry defines various telemetry level for configuration.
|
Package configtelemetry defines various telemetry level for configuration. |
|
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. |