service

Documentation

Overview

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

Index

• Constants
• func NewCommand(set CollectorSettings) *cobra.Command
• type Collector
  • func New(set CollectorSettings) (*Collector, error)
  • func (col *Collector) GetLogger() *zap.Logger
  • func (col *Collector) GetState() State
  • func (col *Collector) Run(ctx context.Context) error
  • func (col *Collector) Shutdown()
• type CollectorSettings
• type ConfigProvider
  • func MustNewConfigProvider(locations []string, configMapProviders map[string]configmapprovider.Provider, ...) ConfigProvider
  • func MustNewDefaultConfigProvider(configLocations []string, properties []string) ConfigProvider
  • func NewConfigProvider(locations []string, configMapProviders map[string]configmapprovider.Provider, ...) ConfigProvider
  • func NewDefaultConfigProvider(configLocations []string, properties []string) ConfigProvider
• type State

Constants

const AddCollectorVersionTag = true

AddCollectorVersionTag indicates if the collector version tag should be added to all telemetry metrics

Functions

func NewCommand

func NewCommand(set CollectorSettings) *cobra.Command

NewCommand constructs a new cobra.Command using the given Collector. TODO: Make this independent of the collector internals.

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) GetLogger

func (col *Collector) GetLogger() *zap.Logger

GetLogger returns logger used by the Collector. The logger is initialized after collector server start.

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 given, 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
}

CollectorSettings holds configuration for creating a new Collector.

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.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 MustNewConfigProvider

func MustNewConfigProvider(
	locations []string,
	configMapProviders map[string]configmapprovider.Provider,
	cfgMapConverters []config.MapConverterFunc,
	configUnmarshaler configunmarshaler.ConfigUnmarshaler) ConfigProvider

MustNewConfigProvider returns a new ConfigProvider that provides the configuration: * Retrieve the config.Map by merging all retrieved maps from all the configmapprovider.Provider in order. * Then applies all the ConfigMapConverterFunc in the given order. * Then unmarshalls the final config.Config using the given configunmarshaler.ConfigUnmarshaler.

The `configMapProviders` is a map of pairs <scheme,Provider>.

Notice: This API is experimental.

func MustNewDefaultConfigProvider

func MustNewDefaultConfigProvider(configLocations []string, properties []string) ConfigProvider

MustNewDefaultConfigProvider returns the default ConfigProvider, and it creates configuration from a file defined by the given configFile and overwrites fields using properties.

func NewConfigProvider

func NewConfigProvider(
	locations []string,
	configMapProviders map[string]configmapprovider.Provider,
	cfgMapConverters []config.MapConverterFunc,
	configUnmarshaler configunmarshaler.ConfigUnmarshaler) ConfigProvider

Deprecated: [v0.44.0] use MustNewConfigProvider instead NewConfigProvider returns a new ConfigProvider that provides the configuration: * Retrieve the config.Map by merging all retrieved maps from all the configmapprovider.Provider in order. * Then applies all the config.MapConverterFunc in the given order. * Then unmarshalls the final config.Config using the given configunmarshaler.ConfigUnmarshaler.

The `configMapProviders` is a map of pairs <scheme,Provider>.

Notice: This API is experimental.

func NewDefaultConfigProvider

func NewDefaultConfigProvider(configLocations []string, properties []string) ConfigProvider

Deprecated: [v.0.44.0] use MustNewDefaultConfigProvider instead NewDefaultConfigProvider returns the default ConfigProvider, and it creates configuration from a file defined by the given configFile and overwrites fields using properties.

type State

type State int

State defines Collector's state.

const (
	Starting State = iota
	Running
	Closing
	Closed
)