flags

Documentation

Index

• func AddLoggingFlag(flagSet *flag.FlagSet)
• type AdminServer
  • func NewAdminServer(hostPort string) *AdminServer
  • func (s *AdminServer) AddFlags(flagSet *flag.FlagSet)
  • func (s *AdminServer) Close() error
  • func (s *AdminServer) HC() *healthcheck.HealthCheck
  • func (s *AdminServer) Handle(path string, handler http.Handler)
  • func (s *AdminServer) Serve() error
• type Service
  • func NewService(adminPort int) *Service
  • func (s *Service) AddFlags(flagSet *flag.FlagSet)
  • func (s *Service) HC() *healthcheck.HealthCheck
  • func (s *Service) RunAndThen(shutdown func())
  • func (s *Service) SetHealthCheckStatus(status healthcheck.Status)
  • func (s *Service) Start(v *viper.Viper) error
• type SharedFlags
  • func (flags *SharedFlags) InitFromViper(v *viper.Viper) *SharedFlags
  • func (flags *SharedFlags) NewLogger(conf zap.Config, options ...zap.Option) (*zap.Logger, error)

Functions

func AddLoggingFlag

func AddLoggingFlag(flagSet *flag.FlagSet)

AddLoggingFlag adds logging flag for SharedFlags

Types

type AdminServer

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

AdminServer runs an HTTP server with admin endpoints, such as healthcheck at /, /metrics, etc.

func NewAdminServer

func NewAdminServer(hostPort string) *AdminServer

NewAdminServer creates a new admin server.

func (*AdminServer) AddFlags

func (s *AdminServer) AddFlags(flagSet *flag.FlagSet)

AddFlags registers CLI flags.

func (*AdminServer) Close

func (s *AdminServer) Close() error

Close stops the HTTP server

func (*AdminServer) HC

func (s *AdminServer) HC() *healthcheck.HealthCheck

HC returns the reference to HeathCheck.

func (*AdminServer) Handle

func (s *AdminServer) Handle(path string, handler http.Handler)

Handle adds a new handler to the admin server.

func (*AdminServer) Serve

func (s *AdminServer) Serve() error

Serve starts HTTP server.

type Service

type Service struct {
	// AdminPort is the HTTP ports number for admin server.
	AdminPort int

	// NoStorage indicates that storage type CLI flag is not applicable
	NoStorage bool

	// Admin is the admin server that hosts the health check and metrics endpoints.
	Admin *AdminServer

	// Logger is initialized after parsing Viper flags like --log-level.
	Logger *zap.Logger

	// MetricsFactory is the root factory without a namespace.
	MetricsFactory metrics.Factory
	// contains filtered or unexported fields
}

Service represents an abstract Jaeger backend component with some basic shared functionality.

func NewService

func NewService(adminPort int) *Service

NewService creates a new Service.

func (*Service) AddFlags

func (s *Service) AddFlags(flagSet *flag.FlagSet)

AddFlags registers CLI flags.

func (*Service) HC

func (s *Service) HC() *healthcheck.HealthCheck

HC returns the reference to HeathCheck.

func (*Service) RunAndThen

func (s *Service) RunAndThen(shutdown func())

RunAndThen sets the health check to Ready and blocks until SIGTERM is received. If then runs the shutdown function and exits.

func (*Service) SetHealthCheckStatus

func (s *Service) SetHealthCheckStatus(status healthcheck.Status)

SetHealthCheckStatus sets status of healthcheck

func (*Service) Start

func (s *Service) Start(v *viper.Viper) error

Start bootstraps the service and starts the admin server.

type SharedFlags

type SharedFlags struct {
	// Logging holds logging configuration
	Logging logging
}

SharedFlags holds flags configuration

func (*SharedFlags) InitFromViper

func (flags *SharedFlags) InitFromViper(v *viper.Viper) *SharedFlags

InitFromViper initializes SharedFlags with properties from viper

func (*SharedFlags) NewLogger

func (flags *SharedFlags) NewLogger(conf zap.Config, options ...zap.Option) (*zap.Logger, error)

NewLogger returns logger based on configuration in SharedFlags