service

Documentation

Overview

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

Index

• type Application
  • func New(params Parameters) (*Application, error)
  • func (app *Application) Command() *cobra.Command
  • func (app *Application) GetLogger() *zap.Logger
  • func (app *Application) GetStateChannel() chan State
  • func (app *Application) Run() error
  • func (app *Application) Shutdown()
• type Parameters
• type State

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

Shutdown shuts down the application.

type Parameters

type Parameters struct {
	// Factories component factories.
	Factories component.Factories
	// ApplicationStartInfo provides application start information.
	ApplicationStartInfo component.ApplicationStartInfo
	// ParserProvider provides the configuration's Parser.
	// 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.
	ParserProvider parserprovider.ParserProvider
	// 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
)