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) GetStateChannel() chan State
  • func (col *Collector) Run(ctx context.Context) error
  • func (col *Collector) Shutdown()
• type CollectorSettings
• 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) GetStateChannel

func (col *Collector) GetStateChannel() chan State

GetStateChannel returns state channel 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

	// ConfigMapProvider provides the configuration's config.Map.
	// If it is not provided a default provider is used. The default provider loads the configuration
	// from a config file define by the --config command line flag and overrides component's configuration
	// properties supplied via --set command line flag.
	// If the provider is parserprovider.Watchable, collector may reload the configuration upon error.
	ConfigMapProvider parserprovider.MapProvider

	// ConfigUnmarshaler unmarshalls the configuration's Parser into the service configuration.
	// If it is not provided a default unmarshaler is used.
	ConfigUnmarshaler configunmarshaler.ConfigUnmarshaler

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

CollectorSettings holds configuration for creating a new Collector.

type State

type State int

State defines Collector's state.

const (
	Starting State = iota
	Running
	Closing
	Closed
)