logging

Documentation

Overview

logging is a copy of knative/pkg's logging package, except it uses desugared loggers.

Index

• Constants
• func FromContext(ctx context.Context) *zap.Logger
• func NewConfigFromConfigMap(configMap *corev1.ConfigMap) (*logging.Config, error)
• func NewConfigFromMap(data map[string]string) (*logging.Config, error)
• func NewLogger(configJSON string, levelOverride string) (*zap.SugaredLogger, zap.AtomicLevel)
• func NewLoggerFromConfig(config *logging.Config, name string) (*zap.SugaredLogger, zap.AtomicLevel)
• func UpdateLevelFromConfigMap(logger *zap.SugaredLogger, atomicLevel zap.AtomicLevel, levelKey string) func(configMap *corev1.ConfigMap)
• func With(ctx context.Context, fields ...zap.Field) context.Context
• func WithLogger(ctx context.Context, logger *zap.Logger) context.Context

Constants

const ConfigMapNameEnv = "CONFIG_LOGGING_NAME"

Functions

func FromContext

func FromContext(ctx context.Context) *zap.Logger

func NewConfigFromConfigMap

func NewConfigFromConfigMap(configMap *corev1.ConfigMap) (*logging.Config, error)

NewConfigFromConfigMap creates a LoggingConfig from the supplied ConfigMap

func NewConfigFromMap

func NewConfigFromMap(data map[string]string) (*logging.Config, error)

NewConfigFromMap creates a LoggingConfig from the supplied map

func NewLogger

func NewLogger(configJSON string, levelOverride string) (*zap.SugaredLogger, zap.AtomicLevel)

NewLogger creates a logger with the supplied configuration. In addition to the logger, it returns AtomicLevel that can be used to change the logging level at runtime. If configuration is empty, a fallback configuration is used. If configuration cannot be used to instantiate a logger, the same fallback configuration is used.

func NewLoggerFromConfig

func NewLoggerFromConfig(config *logging.Config, name string) (*zap.SugaredLogger, zap.AtomicLevel)

NewLoggerFromConfig creates a logger using the provided Config

func UpdateLevelFromConfigMap

func UpdateLevelFromConfigMap(logger *zap.SugaredLogger, atomicLevel zap.AtomicLevel, levelKey string) func(configMap *corev1.ConfigMap)

UpdateLevelFromConfigMap returns a helper func that can be used to update the logging level when a config map is updated

func With

func With(ctx context.Context, fields ...zap.Field) context.Context

func WithLogger

func WithLogger(ctx context.Context, logger *zap.Logger) context.Context