|
1 | | -// Kube controller-runtime client uses structured logr.Logger under the hood. |
2 | | -// ACSCS services use glog unstructured logging. |
3 | | -// This file contains a wrapper which helps to send structured logr.Logger logs to glog logSink. |
4 | | -// This wrapper can be removed once ACSCS service move to structured logging instead of glog |
| 1 | +// Kube controller-runtime and client-go clients use different logger libraries (zap and klog respectively). |
| 2 | +// This is a logr.Logger (common interface) adapter for glog to forward the logs from kubernetes libraries to glog. |
5 | 3 |
|
6 | 4 | package logger |
7 | 5 |
|
8 | 6 | import ( |
| 7 | + "fmt" |
| 8 | + "strings" |
| 9 | + |
9 | 10 | "github.com/go-logr/logr" |
10 | | - "github.com/go-logr/logr/funcr" |
11 | 11 | "github.com/golang/glog" |
12 | | - "strings" |
13 | 12 | ) |
14 | 13 |
|
15 | | -const msgKeyPattern = "msg\"=" |
| 14 | +// glogSink implements logr.LogSink and forwards logs to glog with appropriate levels. |
| 15 | +type glogSink struct { |
| 16 | + name string |
| 17 | + keysAndValues []interface{} |
| 18 | +} |
| 19 | + |
| 20 | +var _ logr.LogSink = &glogSink{} |
16 | 21 |
|
17 | | -// NewKubeAPILogger creates a new logr.Logger instance which uses a glog.Warning as log message sink. |
18 | | -// This logger should be passed to controller-runtime client. The client will use it to print log messages. |
19 | | -func NewKubeAPILogger() logr.Logger { |
20 | | - return funcr.New(func(prefix, args string) { |
21 | | - logMsg := sanitizeLog(args) |
22 | | - if prefix != "" { |
23 | | - glog.Warningf("%s: %s\n", prefix, logMsg) |
24 | | - } else { |
25 | | - glog.Warningln(logMsg) |
26 | | - } |
27 | | - }, funcr.Options{}) |
| 22 | +// Init implements logr.LogSink. |
| 23 | +func (g *glogSink) Init(_ logr.RuntimeInfo) { |
| 24 | + // No initialization needed |
| 25 | +} |
| 26 | + |
| 27 | +// Enabled implements logr.LogSink. |
| 28 | +// Always returns true and lets glog do the verbosity filtering in Info(). |
| 29 | +func (g *glogSink) Enabled(_ int) bool { |
| 30 | + // Always return true - let glog.V() filter in the Info() method |
| 31 | + return true |
| 32 | +} |
| 33 | + |
| 34 | +// Info implements logr.LogSink. |
| 35 | +// Maps to glog.Info() for level 0, and glog.V() for higher verbosity levels. |
| 36 | +func (g *glogSink) Info(level int, msg string, keysAndValues ...interface{}) { |
| 37 | + allKVs := make([]interface{}, 0, len(g.keysAndValues)+len(keysAndValues)) |
| 38 | + allKVs = append(allKVs, g.keysAndValues...) |
| 39 | + allKVs = append(allKVs, keysAndValues...) |
| 40 | + logMsg := formatMessage(g.name, msg, allKVs) |
| 41 | + if level == 0 { |
| 42 | + glog.InfoDepth(1, logMsg) |
| 43 | + } else { |
| 44 | + glog.V(glog.Level(level)).InfoDepth(1, logMsg) |
| 45 | + } |
28 | 46 | } |
29 | 47 |
|
30 | | -// sanitizeLog removes redundant builtin logr.Logger log keys from the log message. |
31 | | -// Only `msg` value is worth to log eventually |
32 | | -func sanitizeLog(log string) string { |
33 | | - at := strings.Index(log, msgKeyPattern) |
34 | | - if at > 0 { |
35 | | - return log[at+len(msgKeyPattern):] |
| 48 | +// Error implements logr.LogSink. |
| 49 | +// Maps to glog.Error(). |
| 50 | +func (g *glogSink) Error(err error, msg string, keysAndValues ...interface{}) { |
| 51 | + allKVs := make([]interface{}, 0, len(g.keysAndValues)+len(keysAndValues)+2) |
| 52 | + allKVs = append(allKVs, g.keysAndValues...) |
| 53 | + allKVs = append(allKVs, keysAndValues...) |
| 54 | + if err != nil { |
| 55 | + allKVs = append(allKVs, "error", err) |
36 | 56 | } |
37 | | - return log |
| 57 | + logMsg := formatMessage(g.name, msg, allKVs) |
| 58 | + glog.ErrorDepth(1, logMsg) |
| 59 | +} |
| 60 | + |
| 61 | +// WithValues implements logr.LogSink. |
| 62 | +func (g *glogSink) WithValues(keysAndValues ...interface{}) logr.LogSink { |
| 63 | + newKVs := make([]interface{}, 0, len(g.keysAndValues)+len(keysAndValues)) |
| 64 | + newKVs = append(newKVs, g.keysAndValues...) |
| 65 | + newKVs = append(newKVs, keysAndValues...) |
| 66 | + return &glogSink{ |
| 67 | + name: g.name, |
| 68 | + keysAndValues: newKVs, |
| 69 | + } |
| 70 | +} |
| 71 | + |
| 72 | +// WithName implements logr.LogSink. |
| 73 | +func (g *glogSink) WithName(name string) logr.LogSink { |
| 74 | + newName := name |
| 75 | + if g.name != "" { |
| 76 | + newName = g.name + "." + name |
| 77 | + } |
| 78 | + return &glogSink{ |
| 79 | + name: newName, |
| 80 | + keysAndValues: g.keysAndValues, |
| 81 | + } |
| 82 | +} |
| 83 | + |
| 84 | +// formatMessage formats the log message with name and key-value pairs. |
| 85 | +func formatMessage(name, msg string, keysAndValues []interface{}) string { |
| 86 | + var builder strings.Builder |
| 87 | + |
| 88 | + if name != "" { |
| 89 | + builder.WriteString(name) |
| 90 | + builder.WriteString(": ") |
| 91 | + } |
| 92 | + |
| 93 | + builder.WriteString(msg) |
| 94 | + |
| 95 | + // Format key-value pairs |
| 96 | + for i := 0; i < len(keysAndValues); i += 2 { |
| 97 | + if i+1 < len(keysAndValues) { |
| 98 | + builder.WriteString(fmt.Sprintf(" %v=%v", keysAndValues[i], keysAndValues[i+1])) |
| 99 | + } |
| 100 | + } |
| 101 | + |
| 102 | + return builder.String() |
| 103 | +} |
| 104 | + |
| 105 | +// NewKubeAPILogger creates a new logr.Logger instance that forwards logs to glog. |
| 106 | +// Log levels are mapped as follows: |
| 107 | +// - Info(level=0) -> glog.Info() |
| 108 | +// - Info(level>0) -> glog.V(level).Info() |
| 109 | +// - Error() -> glog.Error() |
| 110 | +func NewKubeAPILogger() logr.Logger { |
| 111 | + return logr.New(&glogSink{}) |
38 | 112 | } |
0 commit comments