/* Copyright 2018 The Knative Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */ package logging import ( "encoding/json" "errors" "fmt" "go.uber.org/zap" "go.uber.org/zap/zapcore" corev1 "k8s.io/api/core/v1" "github.com/knative/pkg/logging/logkey" ) // 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 NewLogger(configJSON string, levelOverride string) (*zap.SugaredLogger, zap.AtomicLevel) { logger, atomicLevel, err := newLoggerFromConfig(configJSON, levelOverride) if err == nil { return logger.Sugar(), atomicLevel } loggingCfg := zap.NewProductionConfig() if len(levelOverride) > 0 { if level, err := levelFromString(levelOverride); err == nil { loggingCfg.Level = zap.NewAtomicLevelAt(*level) } } logger, err2 := loggingCfg.Build() if err2 != nil { panic(err2) } return logger.Named("fallback-logger").Sugar(), loggingCfg.Level } // NewLoggerFromConfig creates a logger using the provided Config func NewLoggerFromConfig(config *Config, name string) (*zap.SugaredLogger, zap.AtomicLevel) { logger, level := NewLogger(config.LoggingConfig, config.LoggingLevel[name].String()) return logger.Named(name), level } func newLoggerFromConfig(configJSON string, levelOverride string) (*zap.Logger, zap.AtomicLevel, error) { if len(configJSON) == 0 { return nil, zap.AtomicLevel{}, errors.New("empty logging configuration") } var loggingCfg zap.Config if err := json.Unmarshal([]byte(configJSON), &loggingCfg); err != nil { return nil, zap.AtomicLevel{}, err } if len(levelOverride) > 0 { if level, err := levelFromString(levelOverride); err == nil { loggingCfg.Level = zap.NewAtomicLevelAt(*level) } } logger, err := loggingCfg.Build() if err != nil { return nil, zap.AtomicLevel{}, err } logger.Info("Successfully created the logger.", zap.String(logkey.JSONConfig, configJSON)) logger.Sugar().Infof("Logging level set to %v", loggingCfg.Level) return logger, loggingCfg.Level, nil } // Config contains the configuration defined in the logging ConfigMap. // +k8s:deepcopy-gen=true type Config struct { LoggingConfig string LoggingLevel map[string]zapcore.Level } // NewConfigFromMap creates a LoggingConfig from the supplied map, // expecting the given list of components. func NewConfigFromMap(data map[string]string, components ...string) (*Config, error) { lc := &Config{} if zlc, ok := data["zap-logger-config"]; ok { lc.LoggingConfig = zlc } lc.LoggingLevel = make(map[string]zapcore.Level) for _, component := range components { if ll, ok := data["loglevel."+component]; ok { if len(ll) > 0 { level, err := levelFromString(ll) if err != nil { return nil, err } lc.LoggingLevel[component] = *level } } } return lc, nil } // NewConfigFromConfigMap creates a LoggingConfig from the supplied ConfigMap, // expecting the given list of components. func NewConfigFromConfigMap(configMap *corev1.ConfigMap, components ...string) (*Config, error) { return NewConfigFromMap(configMap.Data, components...) } func levelFromString(level string) (*zapcore.Level, error) { var zapLevel zapcore.Level if err := zapLevel.UnmarshalText([]byte(level)); err != nil { return nil, fmt.Errorf("invalid logging level: %v", level) } return &zapLevel, nil } // UpdateLevelFromConfigMap returns a helper func that can be used to update the logging level // when a config map is updated func UpdateLevelFromConfigMap(logger *zap.SugaredLogger, atomicLevel zap.AtomicLevel, levelKey string, components ...string) func(configMap *corev1.ConfigMap) { return func(configMap *corev1.ConfigMap) { loggingConfig, err := NewConfigFromConfigMap(configMap, components...) if err != nil { logger.Error("Failed to parse the logging configmap. Previous config map will be used.", zap.Error(err)) return } if level, ok := loggingConfig.LoggingLevel[levelKey]; ok { if atomicLevel.Level() != level { logger.Infof("Updating logging level for %v from %v to %v.", levelKey, atomicLevel.Level(), level) atomicLevel.SetLevel(level) } } } }