-
Notifications
You must be signed in to change notification settings - Fork 18
/
logging.go
176 lines (157 loc) · 4.99 KB
/
logging.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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/***************************************************************
*
* Copyright (C) 2024, Pelican Project, Morgridge Institute for Research
*
* 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 config
import (
"io"
"os"
"regexp"
"sync/atomic"
"github.com/go-kit/log/term"
log "github.com/sirupsen/logrus"
"github.com/sirupsen/logrus/hooks/writer"
)
type (
RegexpFilter struct {
Regexp *regexp.Regexp
Name string
Levels []log.Level
Fire func(*log.Entry) error
}
// A logrus hook that carries a list of regexp-based "filters".
// If any of the filters matches the incoming log line, the corresponding
// callback is invoked.
RegexpFilterHook struct {
filters atomic.Pointer[[]*RegexpFilter]
}
// A logrus hook that censors the contents of the logs.
// If any of the log messages matches one of the regexps, then the corresponding
// expansions are made.
//
// Intended to be used to censor or transform logs
regexpTransformHook struct {
replacements []replacement
hook *writer.Hook
}
replacement struct {
regex *regexp.Regexp
template string
}
)
var (
globalFilters RegexpFilterHook
addedGlobalFilters bool
globalTransform *regexpTransformHook = ®expTransformHook{
hook: &writer.Hook{
Writer: os.Stderr,
LogLevels: log.AllLevels,
},
replacements: []replacement{
{
regex: regexp.MustCompile(`(?P<prefix>Bearer%20)?(?P<header>ey[A-Za-z0-9_=-]{18,})[.](?P<payload>ey[A-Za-z0-9_=-]{18,})[.]([A-Za-z0-9_=-]{64,})`),
template: "$prefix$header.$payload.REDACTED",
},
},
}
)
func (fh *RegexpFilterHook) Levels() []log.Level {
return log.AllLevels
}
func (rt *regexpTransformHook) Levels() []log.Level {
return rt.hook.LogLevels
}
// Process a single log entry coming from logrus; iterate through the
// internal list of regexp filters and invoke any callbacks for regexps
// that match the entry.Message.
func (fh *RegexpFilterHook) Fire(entry *log.Entry) (err error) {
filters := fh.filters.Load()
for _, filter := range *filters {
if filter.Regexp.MatchString(entry.Message) {
curErr := filter.Fire(entry)
if curErr != nil && err == nil {
err = curErr
}
}
}
return
}
// Process a single log entry, updating it as necessary
func (rt *regexpTransformHook) Fire(entry *log.Entry) (err error) {
for _, replace := range rt.replacements {
entry.Message = replace.regex.ReplaceAllString(entry.Message, replace.template)
}
return rt.hook.Fire(entry)
}
func initFilterLogging() {
// Our filters may want to see every log message, even those that
// are not otherwise printed. Have the log levels printed via a hook
// (instead of the typical output mechanism) so we can crank up the
// global log.
filters := make([]*RegexpFilter, 0)
globalFilters.filters.Store(&filters)
configLevel := log.GetLevel()
log.SetLevel(log.DebugLevel)
hookLevel := make([]log.Level, 0)
for _, lvl := range log.AllLevels {
if lvl <= configLevel {
hookLevel = append(hookLevel, lvl)
}
}
// Unit tests may initialize the server multiple times; avoid configuring
// the global logging multiple times
if !addedGlobalFilters {
log.AddHook(&globalFilters)
addedGlobalFilters = true
// Set the writer to what logrus has
globalTransform.hook.Writer = log.StandardLogger().Out
globalTransform.hook.LogLevels = hookLevel
log.SetOutput(io.Discard)
log.AddHook(globalTransform)
}
}
func AddFilter(newFilter *RegexpFilter) {
filters := globalFilters.filters.Load()
var newFilters []*RegexpFilter
if filters == nil {
newFilters = make([]*RegexpFilter, 0)
} else {
newFilters = *filters
}
newFilters = append(newFilters, newFilter)
globalFilters.filters.Store(&newFilters)
}
func RemoveFilter(name string) {
filters := *globalFilters.filters.Load()
result := make([]*RegexpFilter, 0)
for _, filter := range filters {
if filter.Name != name {
result = append(result, filter)
}
}
globalFilters.filters.Store(&result)
}
func SetLogging(logLevel log.Level) {
textFormatter := log.TextFormatter{}
textFormatter.DisableLevelTruncation = true
textFormatter.FullTimestamp = true
// Since we redirect log.Out to io.Discard, logrus will treat the output as non-terminal
// and won't format logs with color. Here we bypass logrus check by forcing the color
// and provide our check. Note that when calling SetLogging, io.Out hasn't been changed yet.
textFormatter.ForceColors = term.IsTerminal(log.StandardLogger().Out)
log.SetFormatter(&textFormatter)
log.SetLevel(logLevel)
}