/
logfilter.go
296 lines (238 loc) · 6.49 KB
/
logfilter.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
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
package logfilter
import (
"bufio"
"context"
"io"
"io/ioutil"
"net"
"net/http"
"sync"
"github.com/hashicorp/go-multierror"
"github.com/sirupsen/logrus"
"golang.org/x/sync/errgroup"
"golang.org/x/xerrors"
"gopkg.in/natefinch/lumberjack.v2"
)
var newLine = []byte{'\n'}
type LogFilter struct {
config *Config
reader io.Reader
writer io.Writer
logger *logrus.Entry
ctx context.Context
cancel func()
errGroup *errgroup.Group
debugListener net.Listener
commander *Commander
debugServer *http.Server
stdoutReader io.ReadCloser
stdoutWriter io.WriteCloser
stderrReader io.ReadCloser
stderrWriter io.WriteCloser
linesChan chan []byte
jsonFilter JSONFilter
fullWriter io.Writer
lumberjackLogger *lumberjack.Logger
}
func NewLogFilter(
config *Config,
reader io.Reader,
writer io.Writer,
logger *logrus.Entry,
) *LogFilter {
return &LogFilter{
config: config,
reader: reader,
writer: writer,
logger: logger,
}
}
func (f *LogFilter) Init(ctx context.Context) error {
ctx, cancel := context.WithCancel(ctx)
errGroup, ctx := errgroup.WithContext(ctx)
f.ctx = ctx
f.cancel = cancel
f.errGroup = errGroup
var err error
f.debugListener, err = net.Listen("tcp", f.config.DebugListenAddr)
if err != nil {
return xerrors.Errorf("debug listener listen failed: %s: %w", f.config.DebugListenAddr, err)
}
if len(f.config.Cmd) > 0 {
f.stdoutReader, f.stdoutWriter = io.Pipe()
f.stderrReader, f.stderrWriter = io.Pipe()
f.commander = NewCommander(f.config.Cmd, f.config.CmdShutdownTimeout, f.stdoutWriter, f.stderrWriter, f.logger)
}
f.linesChan = make(chan []byte)
if f.config.ExcludeTemplate != "" && f.config.FilterQuery != "" {
return xerrors.Errorf("cannot use both exclude template and filter query")
}
if f.config.ExcludeTemplate != "" {
f.logger.WithField("excludeTemplate", f.config.ExcludeTemplate).Debug("Initializing template JSON filter")
jsonFilter, err := NewTemplateJSONFilter(f.config.ExcludeTemplate)
if err != nil {
return xerrors.Errorf("failed to build json filter: %w", err)
}
f.jsonFilter = jsonFilter
} else if f.config.FilterQuery != "" {
f.logger.WithField("filterQuery", f.config.FilterQuery).Debug("Initializing JQ JSON filter")
jsonFilter, err := NewJQJSONFilter(f.config.FilterQuery)
if err != nil {
return xerrors.Errorf("failed to build json filter: %w", err)
}
f.jsonFilter = jsonFilter
} else {
f.jsonFilter = StaticJSONFilter(true)
}
f.fullWriter = ioutil.Discard
if f.config.FullOutputFilename != "" {
f.lumberjackLogger = &lumberjack.Logger{
Filename: f.config.FullOutputFilename,
MaxSize: f.config.FullOutputMaxSizeMB,
MaxAge: f.config.FullOutputMaxAgeDays,
MaxBackups: f.config.FullOutputMaxBackups,
Compress: f.config.FullOutputCompress,
}
f.fullWriter = f.lumberjackLogger
}
f.debugServer = NewDebugServer()
return nil
}
func (f *LogFilter) Spawn(fn func(context.Context) error) {
f.errGroup.Go(func() error {
err := fn(f.ctx)
if err != nil {
f.cancel()
return err
}
return nil
})
}
func (f *LogFilter) Start() error {
f.Spawn(func(ctx context.Context) error {
f.logger.WithField("listenAddr", f.config.DebugListenAddr).Info("Starting debug HTTP server")
err := f.debugServer.Serve(f.debugListener)
if ctx.Err() == nil {
return err
}
return nil
})
linesDone := make(chan struct{})
if f.commander == nil {
scanErrChan := make(chan error, 1)
// scanning lines from f.reader must not be done in f.Spawn because stdin
// does not get closed on SIGINT
go func() {
err := f.scanLines(f.reader)
if err == nil {
err = xerrors.Errorf("reading stdin: %w", io.EOF)
}
scanErrChan <- err
}()
f.Spawn(func(ctx context.Context) error {
defer close(linesDone)
select {
case err := <-scanErrChan:
return err
case <-ctx.Done():
return nil
}
})
} else {
var cmdScanningDone sync.WaitGroup
cmdScanningDone.Add(2)
f.Spawn(func(_ context.Context) error {
defer cmdScanningDone.Done()
return f.scanLines(f.stdoutReader)
})
f.Spawn(func(_ context.Context) error {
defer cmdScanningDone.Done()
return f.scanLines(f.stderrReader)
})
f.Spawn(func(ctx context.Context) error {
err := f.commander.Start(ctx)
f.stdoutWriter.Close()
f.stderrWriter.Close()
if err == nil {
err = xerrors.Errorf("command exited")
}
return err
})
f.Spawn(func(_ context.Context) error {
cmdScanningDone.Wait()
close(linesDone)
return nil
})
}
f.Spawn(func(_ context.Context) error {
for {
select {
case line := <-f.linesChan:
if f.isLineIncluded(line) {
if _, err := f.writer.Write(line); err != nil {
return xerrors.Errorf("writer write failed: %w", err)
}
if _, err := f.writer.Write(newLine); err != nil {
return xerrors.Errorf("writer write failed: %w", err)
}
}
if _, err := f.fullWriter.Write(line); err != nil {
return xerrors.Errorf("full writer write failed: %w", err)
}
if _, err := f.fullWriter.Write(newLine); err != nil {
return xerrors.Errorf("full writer write failed: %w", err)
}
case <-linesDone:
return nil
}
}
})
<-f.ctx.Done()
f.logger.Info("Shutting down")
_ = f.debugServer.Shutdown(context.Background())
err := f.errGroup.Wait()
if err != nil {
return err
}
f.logger.Info("Shutdown")
return nil
}
func (f *LogFilter) Close() error {
var closeErr error
if f.lumberjackLogger != nil {
if err := f.lumberjackLogger.Close(); err != nil {
closeErr = multierror.Append(closeErr, xerrors.Errorf("failed to close lumberjack logger: %w", err))
}
}
if f.debugListener != nil {
if err := f.debugListener.Close(); err != nil {
closeErr = multierror.Append(closeErr, xerrors.Errorf("failed to close debug listener: %w", err))
}
}
return closeErr
}
func (f *LogFilter) scanLines(r io.Reader) error {
scanner := bufio.NewScanner(r)
scanner.Buffer(make([]byte, 4096), f.config.MaxScanLineSize)
for scanner.Scan() {
b := scanner.Bytes()
// scanner.Bytes() can return a slice of a bigger byte slice and is not safe to send in channels
bc := make([]byte, len(b))
copy(bc, b)
f.linesChan <- bc
}
if err := scanner.Err(); err != nil {
return xerrors.Errorf("scaning lines error: %w", err)
}
return nil
}
func (f *LogFilter) isLineIncluded(line []byte) bool {
ok, err := f.jsonFilter.IsIncluded(line)
if err != nil {
if f.logger.Level <= logrus.DebugLevel {
f.logger.WithField("line", string(line)).Debug("LogFilter failed to filter line")
}
return true
}
return ok
}