klogr.go

Documentation: k8s.io/klog/v2

     1  /*
     2  Copyright 2021 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package klog
    18  
    19  import (
    20  	"github.com/go-logr/logr"
    21  
    22  	"k8s.io/klog/v2/internal/serialize"
    23  )
    24  
    25  const (
    26  	// nameKey is used to log the `WithName` values as an additional attribute.
    27  	nameKey = "logger"
    28  )
    29  
    30  // NewKlogr returns a logger that is functionally identical to
    31  // klogr.NewWithOptions(klogr.FormatKlog), i.e. it passes through to klog. The
    32  // difference is that it uses a simpler implementation.
    33  func NewKlogr() Logger {
    34  	return New(&klogger{})
    35  }
    36  
    37  // klogger is a subset of klogr/klogr.go. It had to be copied to break an
    38  // import cycle (klogr wants to use klog, and klog wants to use klogr).
    39  type klogger struct {
    40  	callDepth int
    41  
    42  	// hasPrefix is true if the first entry in values is the special
    43  	// nameKey key/value. Such an entry gets added and later updated in
    44  	// WithName.
    45  	hasPrefix bool
    46  
    47  	values []interface{}
    48  	groups string
    49  }
    50  
    51  func (l *klogger) Init(info logr.RuntimeInfo) {
    52  	l.callDepth += info.CallDepth
    53  }
    54  
    55  func (l *klogger) Info(level int, msg string, kvList ...interface{}) {
    56  	merged := serialize.MergeKVs(l.values, kvList)
    57  	// Skip this function.
    58  	VDepth(l.callDepth+1, Level(level)).InfoSDepth(l.callDepth+1, msg, merged...)
    59  }
    60  
    61  func (l *klogger) Enabled(level int) bool {
    62  	return VDepth(l.callDepth+1, Level(level)).Enabled()
    63  }
    64  
    65  func (l *klogger) Error(err error, msg string, kvList ...interface{}) {
    66  	merged := serialize.MergeKVs(l.values, kvList)
    67  	ErrorSDepth(l.callDepth+1, err, msg, merged...)
    68  }
    69  
    70  // WithName returns a new logr.Logger with the specified name appended.  klogr
    71  // uses '.' characters to separate name elements.  Callers should not pass '.'
    72  // in the provided name string, but this library does not actually enforce that.
    73  func (l klogger) WithName(name string) logr.LogSink {
    74  	if l.hasPrefix {
    75  		// Copy slice and modify value. No length checks and type
    76  		// assertions are needed because hasPrefix is only true if the
    77  		// first two elements exist and are key/value strings.
    78  		v := make([]interface{}, 0, len(l.values))
    79  		v = append(v, l.values...)
    80  		prefix, _ := v[1].(string)
    81  		v[1] = prefix + "." + name
    82  		l.values = v
    83  	} else {
    84  		// Preprend new key/value pair.
    85  		v := make([]interface{}, 0, 2+len(l.values))
    86  		v = append(v, nameKey, name)
    87  		v = append(v, l.values...)
    88  		l.values = v
    89  		l.hasPrefix = true
    90  	}
    91  	return &l
    92  }
    93  
    94  func (l klogger) WithValues(kvList ...interface{}) logr.LogSink {
    95  	l.values = serialize.WithValues(l.values, kvList)
    96  	return &l
    97  }
    98  
    99  func (l klogger) WithCallDepth(depth int) logr.LogSink {
   100  	l.callDepth += depth
   101  	return &l
   102  }
   103  
   104  var _ logr.LogSink = &klogger{}
   105  var _ logr.CallDepthLogSink = &klogger{}
   106
View as plain text