service

Documentation

Overview

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

Index

• func AddSetFlagProperties(v *viper.Viper, cmd *cobra.Command) error
• func FileLoaderConfigFactory(v *viper.Viper, cmd *cobra.Command, factories component.Factories) (*configmodels.Config, error)
• type Application
  • func New(params Parameters) (*Application, error)
  • func (app *Application) Command() *cobra.Command
  • func (app *Application) GetExporters() map[configmodels.DataType]map[configmodels.Exporter]component.Exporter
  • func (app *Application) GetExtensions() map[configmodels.Extension]component.ServiceExtension
  • func (app *Application) GetFactory(kind component.Kind, componentType configmodels.Type) component.Factory
  • func (app *Application) GetLogger() *zap.Logger
  • func (app *Application) GetStateChannel() chan State
  • func (app *Application) RegisterZPages(mux *http.ServeMux, pathPrefix string)
  • func (app *Application) ReportFatalError(err error)
  • func (app *Application) Run() error
  • func (app *Application) Shutdown()
• type ConfigFactory
• type Parameters
• type State

Functions

func AddSetFlagProperties

func AddSetFlagProperties(v *viper.Viper, cmd *cobra.Command) error

AddSetFlagProperties overrides properties from set flag(s) in supplied viper instance. The implementation reads set flag(s) from the cmd and passes the content to a new viper instance as .properties file. Then the properties from new viper instance are read and set to the supplied viper.

func FileLoaderConfigFactory

func FileLoaderConfigFactory(v *viper.Viper, cmd *cobra.Command, factories component.Factories) (*configmodels.Config, error)

FileLoaderConfigFactory implements ConfigFactory and it creates configuration from file and from --set command line flag (if the flag is present).

Types

type Application

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

Application represents a collector application

func New

func New(params Parameters) (*Application, error)

New creates and returns a new instance of Application.

func (*Application) Command

func (app *Application) Command() *cobra.Command

Command returns Application's root command.

func (*Application) GetExporters

func (app *Application) GetExporters() map[configmodels.DataType]map[configmodels.Exporter]component.Exporter

func (*Application) GetExtensions

func (app *Application) GetExtensions() map[configmodels.Extension]component.ServiceExtension

func (*Application) GetFactory

func (app *Application) GetFactory(kind component.Kind, componentType configmodels.Type) component.Factory

func (*Application) GetLogger

func (app *Application) GetLogger() *zap.Logger

GetLogger returns logger used by the Application. The logger is initialized after application start.

func (*Application) GetStateChannel

func (app *Application) GetStateChannel() chan State

GetStateChannel returns state channel of the application.

func (*Application) RegisterZPages

func (app *Application) RegisterZPages(mux *http.ServeMux, pathPrefix string)

func (*Application) ReportFatalError

func (app *Application) ReportFatalError(err error)

ReportFatalError is used to report to the host that the receiver encountered a fatal error (i.e.: an error that the instance can't recover from) after its start function has already returned.

func (*Application) Run

func (app *Application) Run() error

Run starts the collector according to the command and configuration given by the user, and waits for it to complete.

func (*Application) Shutdown

func (app *Application) Shutdown()

type ConfigFactory

type ConfigFactory func(v *viper.Viper, cmd *cobra.Command, factories component.Factories) (*configmodels.Config, error)

ConfigFactory creates config. The ConfigFactory implementation should call AddSetFlagProperties to enable configuration passed via `--set` flag. Viper and command instances are passed from the Application. The factories also belong to the Application and are equal to the factories passed via Parameters.

type Parameters

type Parameters struct {
	// Factories component factories.
	Factories component.Factories
	// ApplicationStartInfo provides application start information.
	ApplicationStartInfo component.ApplicationStartInfo
	// ConfigFactory that creates the configuration.
	// If it is not provided the default factory (FileLoaderConfigFactory) is used.
	// The default factory loads the configuration file and overrides component's configuration
	// properties supplied via --set command line flag.
	ConfigFactory ConfigFactory
	// LoggingOptions provides a way to change behavior of zap logging.
	LoggingOptions []zap.Option
}

Parameters holds configuration for creating a new Application.

type State

type State int

State defines Application's state.

const (
	Starting State = iota
	Running
	Closing
	Closed
)