jaeger: github.com/jaegertracing/jaeger/cmd/flags Index | Files

package flags

import "github.com/jaegertracing/jaeger/cmd/flags"

Package flags defines command line flags that are shared by several jaeger components. They are defined in this shared location so that if several components are wired into a single binary (e.g. a local container of complete Jaeger backend) they can all share the flags.


Package Files

admin.go doc.go flags.go service.go

func AddConfigFileFlag Uses

func AddConfigFileFlag(flagSet *flag.FlagSet)

AddConfigFileFlag adds flags for ExternalConfFlags

func AddFlags Uses

func AddFlags(flagSet *flag.FlagSet)

AddFlags adds flags for SharedFlags

func AddLoggingFlag Uses

func AddLoggingFlag(flagSet *flag.FlagSet)

AddLoggingFlag adds logging flag for SharedFlags

func ParseJaegerTags Uses

func ParseJaegerTags(jaegerTags string) map[string]string

ParseJaegerTags parses the Jaeger tags string into a map.

func TryLoadConfigFile Uses

func TryLoadConfigFile(v *viper.Viper) error

TryLoadConfigFile initializes viper with config file specified as flag

type AdminServer Uses

type AdminServer struct {
    // contains filtered or unexported fields

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

func NewAdminServer Uses

func NewAdminServer(hostPort string) *AdminServer

NewAdminServer creates a new admin server.

func (*AdminServer) AddFlags Uses

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

AddFlags registers CLI flags.

func (*AdminServer) Close Uses

func (s *AdminServer) Close() error

Close stops the HTTP server

func (*AdminServer) HC Uses

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

HC returns the reference to HeathCheck.

func (*AdminServer) Handle Uses

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

Handle adds a new handler to the admin server.

func (*AdminServer) Serve Uses

func (s *AdminServer) Serve() error

Serve starts HTTP server.

type Service Uses

type Service struct {
    // AdminPort is the HTTP port 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 Uses

func NewService(adminPort int) *Service

NewService creates a new Service.

func (*Service) AddFlags Uses

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

AddFlags registers CLI flags.

func (*Service) HC Uses

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

HC returns the reference to HeathCheck.

func (*Service) RunAndThen Uses

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 Uses

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

SetHealthCheckStatus sets status of healthcheck

func (*Service) Start Uses

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

Start bootstraps the service and starts the admin server.

type SharedFlags Uses

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

SharedFlags holds flags configuration

func (*SharedFlags) InitFromViper Uses

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

InitFromViper initializes SharedFlags with properties from viper

func (*SharedFlags) NewLogger Uses

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

NewLogger returns logger based on configuration in SharedFlags

Package flags imports 20 packages (graph) and is imported by 18 packages. Updated 2020-04-26. Refresh now. Tools for package owners.