/
logs.go
155 lines (127 loc) · 3.7 KB
/
logs.go
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
/*
Copyright 2019 The Jetstack cert-manager contributors.
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 logs
import (
"context"
"flag"
"log"
"time"
"github.com/go-logr/logr"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/klog"
"k8s.io/klog/klogr"
"github.com/jetstack/cert-manager/pkg/api"
)
var (
Log = klogr.New().WithName("cert-manager")
ErrorLevel = 0
WarnLevel = 1
InfoLevel = 2
DebugLevel = 3
)
var logFlushFreq = flag.Duration("log-flush-frequency", 5*time.Second, "Maximum number of seconds between log flushes")
// GlogWriter serves as a bridge between the standard log package and the glog package.
type GlogWriter struct{}
// Write implements the io.Writer interface.
func (writer GlogWriter) Write(data []byte) (n int, err error) {
klog.Info(string(data))
return len(data), nil
}
// InitLogs initializes logs the way we want for kubernetes.
func InitLogs(fs *flag.FlagSet) {
if fs == nil {
fs = flag.CommandLine
}
klog.InitFlags(fs)
fs.Set("logtostderr", "true")
log.SetOutput(GlogWriter{})
log.SetFlags(0)
// The default glog flush interval is 30 seconds, which is frighteningly long.
go wait.Until(klog.Flush, *logFlushFreq, wait.NeverStop)
}
// FlushLogs flushes logs immediately.
func FlushLogs() {
klog.Flush()
}
const (
ResourceNameKey = "resource_name"
ResourceNamespaceKey = "resource_namespace"
ResourceKindKey = "resource_kind"
RelatedResourceNameKey = "related_resource_name"
RelatedResourceNamespaceKey = "related_resource_namespace"
RelatedResourceKindKey = "related_resource_kind"
)
func WithResource(l logr.Logger, obj metav1.Object) logr.Logger {
var gvk schema.GroupVersionKind
if runtimeObj, ok := obj.(runtime.Object); ok {
gvks, _, _ := api.Scheme.ObjectKinds(runtimeObj)
if len(gvks) > 0 {
gvk = gvks[0]
}
}
// TODO: add resource apiVersion
return l.WithValues(
ResourceNameKey, obj.GetName(),
ResourceNamespaceKey, obj.GetNamespace(),
ResourceKindKey, gvk.Kind,
)
}
func WithRelatedResource(l logr.Logger, obj metav1.Object) logr.Logger {
var gvk schema.GroupVersionKind
if runtimeObj, ok := obj.(runtime.Object); ok {
gvks, _, _ := api.Scheme.ObjectKinds(runtimeObj)
if len(gvks) > 0 {
gvk = gvks[0]
}
}
// TODO: add resource apiVersion
return l.WithValues(
RelatedResourceNameKey, obj.GetName(),
RelatedResourceNamespaceKey, obj.GetNamespace(),
RelatedResourceKindKey, gvk.Kind,
)
}
func WithRelatedResourceName(l logr.Logger, name, namespace, kind string) logr.Logger {
return l.WithValues(
RelatedResourceNameKey, name,
RelatedResourceNamespaceKey, namespace,
RelatedResourceKindKey, kind,
)
}
var contextKey = &struct{}{}
func FromContext(ctx context.Context, names ...string) logr.Logger {
l := ctx.Value(contextKey)
if l == nil {
return Log
}
lT := l.(logr.Logger)
for _, n := range names {
lT = lT.WithName(n)
}
return lT
}
func NewContext(ctx context.Context, l logr.Logger, names ...string) context.Context {
if ctx == nil {
ctx = context.Background()
}
if l == nil {
l = FromContext(ctx)
}
for _, n := range names {
l = l.WithName(n)
}
return context.WithValue(ctx, contextKey, l)
}