log

Documentation

Index

• Constants
• Variables
• func AddFlagsToCommand(cmd *cobra.Command, config *Config)
• func Configure(logConfig *Config) error
• func GetLogger(ctx context.Context) *logrus.Entry
• func IsInvalidLogFormat(err error) bool
• func WithLogger(ctx context.Context, logger *logrus.Entry) context.Context
• type Config

Constants

const (
	// LogVerbosityInfo is the verbosity level for info logging.
	LogVerbosityInfo = 0
	// LogVerbosityDebug is the verbosity level for debug logging.
	LogVerbosityDebug = 2
	// LogVerbosityTrace is the verbosity level for trace logging.
	LogVerbosityTrace = 9
)

const (
	// LogFormatText specifies a textual log format.
	LogFormatText = "text"
	// LogFormatJSON specifies a JSON log format.
	LogFormatJSON = "json"
)

const LoggerKey loggerCtxKeyType = "flintlockd.logger"

LoggerKey is the key to use for the logger in the context.

Variables

var ErrLogOutputRequired = errors.New("you must specify a log output")

ErrLogOutputRequired is used when no log output is specified.

Functions

func AddFlagsToCommand

func AddFlagsToCommand(cmd *cobra.Command, config *Config)

AddFlagsToCommand will add the logging flags to the supplied command and bind to the provided config.

func Configure

func Configure(logConfig *Config) error

Configure will configure the logger from the supplied config.

func GetLogger

func GetLogger(ctx context.Context) *logrus.Entry

GetLogger will get a logger from the supplied context for create a new logger.

func IsInvalidLogFormat

func IsInvalidLogFormat(err error) bool

IsInvalidLogFormat tests an error to see if its a invalid log format error.

func WithLogger

func WithLogger(ctx context.Context, logger *logrus.Entry) context.Context

WithLogger is used to attached a logger to a specific context.

Types

type Config

type Config struct {
	// Verbosity specifies the logging verbosity level.
	Verbosity int
	// Format specifies the logging output format.
	Format string
	// Output specifies the destination for logging. You can specify the special
	// values of 'stderr' or 'stdout' or a file path.
	Output string
}

Config represents the configuration settings for a logger.