service

README

OpenTelemetry Collector Service

How to provide configuration

The --config flag accepts either a file path or values in the form of a config URI "<scheme>:<opaque_data>". Currently, the OpenTelemetry Collector supports the following providers scheme:

• file - Reads configuration from a file. E.g. file:path/to/config.yaml.
• env - Reads configuration from an environment variable. E.g. env:MY_CONFIG_IN_AN_ENVVAR.
• yaml - Reads configuration from yaml bytes. E.g. yaml:exporters::logging::loglevel: debug.

For more technical details about how configuration is resolved you can read the configuration resolving design.

Single Config Source

1. Simple local file:

   ./otelcorecol --config=examples/local/otel-config.yaml

2. Simple local file using the new URI format:

   ./otelcorecol --config=file:examples/local/otel-config.yaml

3. Config provided via an environment variable:

   ./otelcorecol --config=env:MY_CONFIG_IN_AN_ENVVAR

Multiple Config Sources

1. Merge a otel-config.yaml file with the content of an environment variable MY_OTHER_CONFIG and use the merged result as the config:

   ./otelcorecol --config=file:examples/local/otel-config.yaml --config=env:MY_OTHER_CONFIG

2. Merge a config.yaml file with the content of a yaml bytes configuration (overwrites the exporters::logging::loglevel config) and use the content as the config:

   ./otelcorecol --config=file:examples/local/otel-config.yaml --config="yaml:exporters::logging::loglevel: info"

Documentation

Overview

Package service handles the command-line, configuration, and runs the OpenTelemetry Collector.

Index

• func NewCommand(set CollectorSettings) *cobra.Command
• type Collector
  • func New(set CollectorSettings) (*Collector, error)
  • func (col *Collector) GetState() State
  • func (col *Collector) Run(ctx context.Context) error
  • func (col *Collector) Shutdown()
• type CollectorSettings
• type Config
• type ConfigProvider
  • func NewConfigProvider(set ConfigProviderSettings) (ConfigProvider, error)
• type ConfigProviderSettings
• type ConfigService
• type ConfigServicePipeline
• type State
  • func (s State) String() string

Functions

func NewCommand

func NewCommand(set CollectorSettings) *cobra.Command

NewCommand constructs a new cobra.Command using the given CollectorSettings.

Types

type Collector

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

Collector represents a server providing the OpenTelemetry Collector service.

func New

func New(set CollectorSettings) (*Collector, error)

New creates and returns a new instance of Collector.

func (*Collector) GetState

func (col *Collector) GetState() State

GetState returns current state of the collector server.

func (*Collector) Run

func (col *Collector) Run(ctx context.Context) error

Run starts the collector according to the given configuration, and waits for it to complete. Consecutive calls to Run are not allowed, Run shouldn't be called once a collector is shut down.

func (*Collector) Shutdown

func (col *Collector) Shutdown()

Shutdown shuts down the collector server.

type CollectorSettings

type CollectorSettings struct {
	// Factories component factories.
	Factories component.Factories

	// BuildInfo provides collector start information.
	BuildInfo component.BuildInfo

	// DisableGracefulShutdown disables the automatic graceful shutdown
	// of the collector on SIGINT or SIGTERM.
	// Users who want to handle signals themselves can disable this behavior
	// and manually handle the signals to shutdown the collector.
	DisableGracefulShutdown bool

	// ConfigProvider provides the service configuration.
	// If the provider watches for configuration change, collector may reload the new configuration upon changes.
	ConfigProvider ConfigProvider

	// LoggingOptions provides a way to change behavior of zap logging.
	LoggingOptions []zap.Option

	// SkipSettingGRPCLogger avoids setting the grpc logger
	SkipSettingGRPCLogger bool
	// contains filtered or unexported fields
}

CollectorSettings holds configuration for creating a new Collector.

type Config

type Config = config.Config

type ConfigProvider

type ConfigProvider interface {
	// Get returns the service configuration, or error otherwise.
	//
	// Should never be called concurrently with itself, Watch or Shutdown.
	Get(ctx context.Context, factories component.Factories) (*Config, error)

	// Watch blocks until any configuration change was detected or an unrecoverable error
	// happened during monitoring the configuration changes.
	//
	// Error is nil if the configuration is changed and needs to be re-fetched. Any non-nil
	// error indicates that there was a problem with watching the config changes.
	//
	// Should never be called concurrently with itself or Get.
	Watch() <-chan error

	// Shutdown signals that the provider is no longer in use and the that should close
	// and release any resources that it may have created.
	//
	// This function must terminate the Watch channel.
	//
	// Should never be called concurrently with itself or Get.
	Shutdown(ctx context.Context) error
}

ConfigProvider provides the service configuration.

The typical usage is the following:

cfgProvider.Get(...)
cfgProvider.Watch() // wait for an event.
cfgProvider.Get(...)
cfgProvider.Watch() // wait for an event.
// repeat Get/Watch cycle until it is time to shut down the Collector process.
cfgProvider.Shutdown()

func NewConfigProvider

func NewConfigProvider(set ConfigProviderSettings) (ConfigProvider, error)

NewConfigProvider returns a new ConfigProvider that provides the service configuration: * Initially it resolves the "configuration map":

• Retrieve the confmap.Conf by merging all retrieved maps from the given `locations` in order.
• Then applies all the confmap.Converter in the given order.

* Then unmarshalls the confmap.Conf into the service Config.

type ConfigProviderSettings

type ConfigProviderSettings struct {
	// ResolverSettings are the settings to configure the behavior of the confmap.Resolver.
	ResolverSettings confmap.ResolverSettings

	// Deprecated: [v0.58.0] use ConfigProviderSettings.ResolverSettings.URIs
	Locations []string

	// Deprecated: [v0.58.0] use ConfigProviderSettings.ResolverSettings.Providers
	MapProviders map[string]confmap.Provider

	// Deprecated: [v0.58.0] use ConfigProviderSettings.ResolverSettings.Converter
	MapConverters []confmap.Converter
}

ConfigProviderSettings are the settings to configure the behavior of the ConfigProvider.

type ConfigService

type ConfigService = config.Service

type ConfigServicePipeline

type ConfigServicePipeline = config.Pipeline

type State

type State int

State defines Collector's state.

const (
	Starting State = iota
	Running
	Closing
	Closed
)

func (State) String

func (s State) String() string