1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
|
/*
Copyright 2019 The Kubernetes 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 cli
import (
"bytes"
"fmt"
"io"
"runtime"
"strings"
"sync"
"sync/atomic"
"sigs.k8s.io/kind/pkg/log"
"sigs.k8s.io/kind/pkg/internal/env"
)
// Logger is the kind cli's log.Logger implementation
type Logger struct {
writer io.Writer
writerMu sync.Mutex
verbosity log.Level
bufferPool *bufferPool
// kind special additions
isSmartWriter bool
}
var _ log.Logger = &Logger{}
// NewLogger returns a new Logger with the given verbosity
func NewLogger(writer io.Writer, verbosity log.Level) *Logger {
l := &Logger{
verbosity: verbosity,
bufferPool: newBufferPool(),
}
l.SetWriter(writer)
return l
}
// SetWriter sets the output writer
func (l *Logger) SetWriter(w io.Writer) {
l.writerMu.Lock()
defer l.writerMu.Unlock()
l.writer = w
_, isSpinner := w.(*Spinner)
l.isSmartWriter = isSpinner || env.IsSmartTerminal(w)
}
// ColorEnabled returns true if the caller is OK to write colored output
func (l *Logger) ColorEnabled() bool {
l.writerMu.Lock()
defer l.writerMu.Unlock()
return l.isSmartWriter
}
func (l *Logger) getVerbosity() log.Level {
return log.Level(atomic.LoadInt32((*int32)(&l.verbosity)))
}
// SetVerbosity sets the loggers verbosity
func (l *Logger) SetVerbosity(verbosity log.Level) {
atomic.StoreInt32((*int32)(&l.verbosity), int32(verbosity))
}
// synchronized write to the inner writer
func (l *Logger) write(p []byte) (n int, err error) {
l.writerMu.Lock()
defer l.writerMu.Unlock()
return l.writer.Write(p)
}
// writeBuffer writes buf with write, ensuring there is a trailing newline
func (l *Logger) writeBuffer(buf *bytes.Buffer) {
// ensure trailing newline
if buf.Len() == 0 || buf.Bytes()[buf.Len()-1] != '\n' {
buf.WriteByte('\n')
}
// TODO: should we handle this somehow??
// Who logs for the logger? 🤔
_, _ = l.write(buf.Bytes())
}
// print writes a simple string to the log writer
func (l *Logger) print(message string) {
buf := bytes.NewBufferString(message)
l.writeBuffer(buf)
}
// printf is roughly fmt.Fprintf against the log writer
func (l *Logger) printf(format string, args ...interface{}) {
buf := l.bufferPool.Get()
fmt.Fprintf(buf, format, args...)
l.writeBuffer(buf)
l.bufferPool.Put(buf)
}
// addDebugHeader inserts the debug line header to buf
func addDebugHeader(buf *bytes.Buffer) {
_, file, line, ok := runtime.Caller(3)
// lifted from klog
if !ok {
file = "???"
line = 1
} else {
if slash := strings.LastIndex(file, "/"); slash >= 0 {
path := file
file = path[slash+1:]
if dirsep := strings.LastIndex(path[:slash], "/"); dirsep >= 0 {
file = path[dirsep+1:]
}
}
}
buf.Grow(len(file) + 11) // we know at least this many bytes are needed
buf.WriteString("DEBUG: ")
buf.WriteString(file)
buf.WriteByte(':')
fmt.Fprintf(buf, "%d", line)
buf.WriteByte(']')
buf.WriteByte(' ')
}
// debug is like print but with a debug log header
func (l *Logger) debug(message string) {
buf := l.bufferPool.Get()
addDebugHeader(buf)
buf.WriteString(message)
l.writeBuffer(buf)
l.bufferPool.Put(buf)
}
// debugf is like printf but with a debug log header
func (l *Logger) debugf(format string, args ...interface{}) {
buf := l.bufferPool.Get()
addDebugHeader(buf)
fmt.Fprintf(buf, format, args...)
l.writeBuffer(buf)
l.bufferPool.Put(buf)
}
// Warn is part of the log.Logger interface
func (l *Logger) Warn(message string) {
l.print(message)
}
// Warnf is part of the log.Logger interface
func (l *Logger) Warnf(format string, args ...interface{}) {
l.printf(format, args...)
}
// Error is part of the log.Logger interface
func (l *Logger) Error(message string) {
l.print(message)
}
// Errorf is part of the log.Logger interface
func (l *Logger) Errorf(format string, args ...interface{}) {
l.printf(format, args...)
}
// V is part of the log.Logger interface
func (l *Logger) V(level log.Level) log.InfoLogger {
return infoLogger{
logger: l,
level: level,
enabled: level <= l.getVerbosity(),
}
}
// infoLogger implements log.InfoLogger for Logger
type infoLogger struct {
logger *Logger
level log.Level
enabled bool
}
// Enabled is part of the log.InfoLogger interface
func (i infoLogger) Enabled() bool {
return i.enabled
}
// Info is part of the log.InfoLogger interface
func (i infoLogger) Info(message string) {
if !i.enabled {
return
}
// for > 0, we are writing debug messages, include extra info
if i.level > 0 {
i.logger.debug(message)
} else {
i.logger.print(message)
}
}
// Infof is part of the log.InfoLogger interface
func (i infoLogger) Infof(format string, args ...interface{}) {
if !i.enabled {
return
}
// for > 0, we are writing debug messages, include extra info
if i.level > 0 {
i.logger.debugf(format, args...)
} else {
i.logger.printf(format, args...)
}
}
// bufferPool is a type safe sync.Pool of *byte.Buffer, guaranteed to be Reset
type bufferPool struct {
sync.Pool
}
// newBufferPool returns a new bufferPool
func newBufferPool() *bufferPool {
return &bufferPool{
sync.Pool{
New: func() interface{} {
// The Pool's New function should generally only return pointer
// types, since a pointer can be put into the return interface
// value without an allocation:
return new(bytes.Buffer)
},
},
}
}
// Get obtains a buffer from the pool
func (b *bufferPool) Get() *bytes.Buffer {
return b.Pool.Get().(*bytes.Buffer)
}
// Put returns a buffer to the pool, resetting it first
func (b *bufferPool) Put(x *bytes.Buffer) {
// only store small buffers to avoid pointless allocation
// avoid keeping arbitrarily large buffers
if x.Len() > 256 {
return
}
x.Reset()
b.Pool.Put(x)
}
|