/* Copyright 2021 The Kubernetes Authors All rights reserved. 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 provides a logging interface. package logging import ( "encoding/json" "fmt" "os" "path/filepath" "github.com/go-logr/logr" "github.com/go-logr/logr/funcr" ) // Logger provides a logging interface. type Logger struct { logr.Logger root string errorFile string } // New returns a logr.Logger. func New(root string, errorFile string, verbosity int) *Logger { opts := funcr.Options{ LogCaller: funcr.All, LogTimestamp: true, Verbosity: verbosity, } inner := funcr.NewJSON(func(obj string) { fmt.Fprintln(os.Stderr, obj) }, opts) return &Logger{Logger: inner, root: root, errorFile: errorFile} } // Error implements logr.Logger.Error. func (l *Logger) Error(err error, msg string, kvList ...interface{}) { l.Logger.WithCallDepth(1).Error(err, msg, kvList...) if l.errorFile == "" { return } payload := struct { Msg string Err string Args map[string]interface{} }{ Msg: msg, Err: err.Error(), Args: map[string]interface{}{}, } if len(kvList)%2 != 0 { kvList = append(kvList, "") } for i := 0; i < len(kvList); i += 2 { k, ok := kvList[i].(string) if !ok { k = fmt.Sprintf("%v", kvList[i]) } payload.Args[k] = kvList[i+1] } jb, err := json.Marshal(payload) if err != nil { l.Logger.Error(err, "can't encode error payload") content := fmt.Sprintf("%v", err) l.writeContent([]byte(content)) } else { l.writeContent(jb) } } // ExportError exports the error to the error file if --export-error is enabled. func (l *Logger) ExportError(content string) { if l.errorFile == "" { return } l.writeContent([]byte(content)) } // DeleteErrorFile deletes the error file. func (l *Logger) DeleteErrorFile() { if l.errorFile == "" { return } errorFile := filepath.Join(l.root, l.errorFile) if err := os.Remove(errorFile); err != nil { if os.IsNotExist(err) { return } l.Logger.Error(err, "can't delete the error-file", "filename", errorFile) } } // writeContent writes the error content to the error file. func (l *Logger) writeContent(content []byte) { if _, err := os.Stat(l.root); os.IsNotExist(err) { fileMode := os.FileMode(0775) // umask applies if err := os.Mkdir(l.root, fileMode); err != nil { l.Logger.Error(err, "can't create the root directory", "root", l.root) return } } tmpFile, err := os.CreateTemp(l.root, "tmp-err-") if err != nil { l.Logger.Error(err, "can't create temporary error-file", "directory", l.root, "prefix", "tmp-err-") return } defer func() { if err := tmpFile.Close(); err != nil { l.Logger.Error(err, "can't close temporary error-file", "filename", tmpFile.Name()) } }() if _, err = tmpFile.Write(content); err != nil { l.Logger.Error(err, "can't write to temporary error-file", "filename", tmpFile.Name()) return } errorFile := filepath.Join(l.root, l.errorFile) if err := os.Rename(tmpFile.Name(), errorFile); err != nil { l.Logger.Error(err, "can't rename to error-file", "temp-file", tmpFile.Name(), "error-file", errorFile) return } if err := os.Chmod(errorFile, 0644); err != nil { l.Logger.Error(err, "can't change permissions on the error-file", "error-file", errorFile) } }