flags

Documentation

Overview

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.

Index

• Constants
• Variables
• func AddConfigFileFlag(flagSet *flag.FlagSet)
• func AddFlags(flagSet *flag.FlagSet)
• func TryLoadConfigFile(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)

Constants

const (
	// CassandraStorageType is the storage type flag denoting a Cassandra backing store
	CassandraStorageType = "cassandra"
	// MemoryStorageType is the storage type flag denoting an in-memory store
	MemoryStorageType = "memory"
	// ESStorageType is the storage type flag denoting an ElasticSearch backing store
	ESStorageType = "elasticsearch"
)

Variables

var ErrUnsupportedStorageType = errors.New("Storage Type is not supported")

ErrUnsupportedStorageType is the error when dealing with an unsupported storage type

Functions

func AddConfigFileFlag

func AddConfigFileFlag(flagSet *flag.FlagSet)

AddConfigFileFlag adds flags for ExternalConfFlags

func AddFlags

func AddFlags(flagSet *flag.FlagSet)

AddFlags adds flags for SharedFlags

func TryLoadConfigFile

func TryLoadConfigFile(v *viper.Viper) error

TryLoadConfigFile initializes viper with config file specified as flag

Types

type SharedFlags

type SharedFlags struct {
	// SpanStorage defines common settings for Span Storage.
	SpanStorage spanStorage
	// DependencyStorage defines common settings for Dependency Storage.
	DependencyStorage dependencyStorage
	// 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