-
Notifications
You must be signed in to change notification settings - Fork 1
/
driver.go
451 lines (362 loc) · 10.6 KB
/
driver.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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
package main
import (
"context"
"errors"
"fmt"
"io"
"os"
"path/filepath"
"strings"
"sync"
"time"
"github.com/containerd/fifo"
"github.com/docker/docker/api/types/backend"
"github.com/docker/docker/api/types/plugins/logdriver"
"github.com/docker/docker/daemon/logger"
"github.com/docker/docker/daemon/logger/jsonfilelog"
"go.uber.org/zap"
"golang.org/x/sys/unix"
)
type telegramLogger interface {
Name() string
Log(msg *logger.Message) error
Close() error
}
type newTelegramLoggerFunc func(*zap.Logger, *ContainerDetails) (telegramLogger, error)
type Driver struct {
streams map[string]*logStream
containerStreams map[string]*logStream
mu sync.RWMutex
fs fileSystem
newTelegramLogger newTelegramLoggerFunc
processLogs func(stream *logStream)
zapLogger *zap.Logger
}
func NewDriver(zapLogger *zap.Logger) *Driver {
driver := &Driver{
streams: make(map[string]*logStream),
containerStreams: make(map[string]*logStream),
fs: osFS{},
newTelegramLogger: func(logger *zap.Logger, details *ContainerDetails) (telegramLogger, error) {
return NewTelegramLogger(logger, details)
},
zapLogger: zapLogger,
}
driver.processLogs = func(stream *logStream) {
driver.defaultProcessLogs(stream, nil)
}
return driver
}
func (d *Driver) StartLogging(streamPath string, containerDetails *ContainerDetails) (stream *logStream, err error) {
d.mu.RLock()
if _, ok := d.streams[streamPath]; ok {
d.mu.RUnlock()
return nil, errors.New("already logging")
}
d.mu.RUnlock()
name := "container:" + containerDetails.ContainerName
stream = &logStream{
streamPath: streamPath,
containerDetails: containerDetails,
logger: d.zapLogger.Named(name),
fs: d.fs,
stop: make(chan struct{}),
}
defer func(stream *logStream) {
if err != nil {
if err := stream.Close(); err != nil {
d.zapLogger.Error("failed to close stream", zap.Error(err))
}
stream = nil
}
}(stream)
noFile, err := parseBool(containerDetails.Config[cfgNoFileKey], false)
if err != nil {
return nil, fmt.Errorf("invalid value for %q option: %w", cfgNoFileKey, err)
}
stream.keepFile, err = parseBool(containerDetails.Config[cfgKeepFileKey], false)
if err != nil {
return nil, fmt.Errorf("invalid value for %q option: %w", cfgKeepFileKey, err)
}
if !noFile {
folder := filepath.Join(d.fs.BasePath(), "/var/log/docker", containerDetails.ContainerID)
if err := d.fs.MkdirAll(folder, 0755); err != nil {
return nil, fmt.Errorf("failed to create folder: %w", err)
}
stream.jsonLogger, err = newJSONLogger(containerDetails, folder)
if err != nil {
return nil, fmt.Errorf("failed to create json logger: %w", err)
}
}
stream.telegramLogger, err = d.newTelegramLogger(d.zapLogger, containerDetails)
if err != nil {
return nil, fmt.Errorf("failed to create telegram logger: %w", err)
}
stream.logFifo, err = fifo.OpenFifo(context.Background(), streamPath, unix.O_RDWR|unix.O_CREAT|unix.O_NONBLOCK, 0700)
if err != nil {
return nil, fmt.Errorf("failed to open fifo: %w", err)
}
d.mu.Lock()
defer d.mu.Unlock()
if _, exists := d.streams[streamPath]; exists {
return nil, errors.New("already logging")
}
if _, exists := d.containerStreams[containerDetails.ContainerID]; exists {
return nil, errors.New("already logging for container")
}
d.streams[streamPath] = stream
d.containerStreams[containerDetails.ContainerID] = stream
go d.processLogs(stream)
return stream, nil
}
// defaultProcessLogs reads logs from fifo file and forwards them to the loggers.
// The optional 'processedNotifier' channel is used exclusively for testing purposes to signal
// when a log entry has been processed. It can be left as 'nil' for non-testing use cases.
func (d *Driver) defaultProcessLogs(stream *logStream, processedNotifier chan<- struct{}) {
defer func() {
if err := stream.Close(); err != nil {
d.zapLogger.Error("failed to close stream", zap.Error(err))
}
}()
logs := NewLogs(stream)
for logs.Next() {
select {
case <-stream.stop:
return
default:
}
entry := logs.Log()
var partialLog *backend.PartialLogMetaData
if m := entry.GetPartialLogMetadata(); m != nil {
partialLog = &backend.PartialLogMetaData{
Last: m.GetLast(),
ID: m.GetId(),
Ordinal: int(m.GetOrdinal()),
}
}
log := &logger.Message{
Line: entry.GetLine(),
Source: entry.GetSource(),
Timestamp: time.Unix(0, entry.GetTimeNano()),
PLogMetaData: partialLog,
}
stream.logger.Debug(
"message",
zap.String("line", string(log.Line)),
zap.String("source", log.Source),
zap.Time("timestamp", log.Timestamp),
)
if err := stream.telegramLogger.Log(log); err != nil {
stream.logger.Error("failed to log to telegram logger", zap.Error(err))
}
if stream.jsonLogger != nil {
if err := stream.jsonLogger.Log(log); err != nil {
stream.logger.Error("failed to log to json logger", zap.Error(err))
}
}
// Notify that we have processed the log.
// It`s needs for tests.
if processedNotifier != nil {
processedNotifier <- struct{}{}
}
}
if err := logs.Err(); err != nil {
stream.logger.Error("failed to read logs", zap.Error(err))
}
}
func (d *Driver) ReadLogs(ctx context.Context, containerID string, readConfig *ReadConfig) (io.ReadCloser, error) {
d.mu.RLock()
stream, exists := d.containerStreams[containerID]
d.mu.RUnlock()
if !exists {
return nil, errors.New("not logging")
}
if stream.jsonLogger == nil {
return nil, fmt.Errorf("%q option is set to true, disabling reading capability", cfgNoFileKey)
}
jsonLogReader, ok := stream.jsonLogger.(logger.LogReader)
if !ok {
return nil, errors.New("logger does not support reading logs")
}
r, w := io.Pipe()
logReader := &logReader{
stream: stream,
config: readConfig,
r: jsonLogReader,
w: w,
zapLogger: d.zapLogger,
}
go logReader.ReadLogs(ctx)
return r, nil
}
func (d *Driver) StopLogging(streamPath string) error {
d.mu.Lock()
stream, exists := d.streams[streamPath]
if !exists {
d.mu.Unlock()
return errors.New("not logging")
}
delete(d.streams, streamPath)
delete(d.containerStreams, stream.containerDetails.ContainerID)
d.mu.Unlock()
if err := stream.Close(); err != nil {
return fmt.Errorf("failed to stop stream: %w", err)
}
return nil
}
// logReader is a wrapper around json-file logger that reads logs
// from it and writes them to the pipe.
type logReader struct {
stream *logStream
config *ReadConfig
r logger.LogReader
w *io.PipeWriter
zapLogger *zap.Logger
}
// ReadLogs reads logs from json-file logger and writes them to the pipe.
func (r *logReader) ReadLogs(ctx context.Context) {
defer r.w.Close()
logWatcher := r.r.ReadLogs(*r.config)
defer logWatcher.ConsumerGone()
encoder := logdriver.NewLogEntryEncoder(r.w)
var buf logdriver.LogEntry
for {
select {
case msg, ok := <-logWatcher.Msg:
if !ok {
return
}
buf.Line = msg.Line
buf.Partial = msg.PLogMetaData != nil && msg.PLogMetaData.Last
buf.Source = msg.Source
buf.TimeNano = msg.Timestamp.UnixNano()
if err := encoder.Encode(&buf); err != nil {
r.zapLogger.Error("failed to encode log entry", zap.Error(err))
return
}
case err := <-logWatcher.Err:
_ = r.w.CloseWithError(err)
r.zapLogger.Error("log watcher error", zap.Error(err))
return
case <-r.stream.stop:
return
case <-ctx.Done():
return
}
}
}
// logStream is a stream that forwards logs to the loggers.
type logStream struct {
streamPath string
containerDetails *ContainerDetails
logFifo io.ReadCloser
telegramLogger telegramLogger
jsonLogger logger.Logger
keepFile bool
logger *zap.Logger
fs fileSystem
stop chan struct{}
closedOnce sync.Once
}
// Close closes the stream.
func (s *logStream) Close() error {
var err error
s.closedOnce.Do(func() {
close(s.stop)
var errs []error
if s.logFifo != nil {
if err := s.logFifo.Close(); err != nil {
errs = append(errs, fmt.Errorf("failed to close stream: %w", err))
}
}
if s.jsonLogger != nil && !s.keepFile {
if err := s.jsonLogger.Close(); err != nil {
errs = append(errs, fmt.Errorf("failed to close json logger: %w", err))
}
folder := filepath.Dir(s.containerDetails.LogPath)
if err := s.fs.RemoveAll(folder); err != nil {
errs = append(errs, fmt.Errorf("failed to remove log dir: %w", err))
}
}
if s.telegramLogger != nil {
if err := s.telegramLogger.Close(); err != nil {
errs = append(errs, fmt.Errorf("failed to close telegram logger: %w", err))
}
}
err = errors.Join(errs...)
})
return err
}
// Logs represents an iterator for reading logs using logdriver.LogEntryDecoder.
type Logs struct {
decoder logdriver.LogEntryDecoder
stream *logStream
current logdriver.LogEntry
closed bool
lastErr error
}
// NewLogs creates a new Logs iterator instance for reading logs from the provided log stream.
func NewLogs(stream *logStream) *Logs {
return &Logs{
decoder: logdriver.NewLogEntryDecoder(stream.logFifo),
stream: stream,
}
}
// Next attempts to read the next log entry. It returns true if successful,
// or false if the end of the log is reached or an error occurs.
func (l *Logs) Next() bool {
if l.closed {
return false
}
var entry logdriver.LogEntry
if err := l.decoder.Decode(&entry); err != nil {
l.closed = true
if !isStreamClosed(err) {
l.lastErr = fmt.Errorf("failed to decode log entry: %w", err)
}
return false
}
l.current = entry
return true
}
// Log returns the current log entry read by the iterator.
func (l *Logs) Log() logdriver.LogEntry {
return l.current
}
// Err returns the last error encountered by the iterator.
func (l *Logs) Err() error {
return l.lastErr
}
// Close closes the Logs iterator and the underlying log stream.
func (l *Logs) Close() error {
l.closed = true
return l.stream.Close()
}
type osFS struct{}
var _ fileSystem = (*osFS)(nil)
func (osFS) BasePath() string {
return ""
}
func (osFS) MkdirAll(path string, perm os.FileMode) error {
path = filepath.Clean(path)
return os.MkdirAll(path, perm)
}
func (osFS) RemoveAll(path string) error {
path = filepath.Clean(path)
return os.RemoveAll(path)
}
func newJSONLogger(containerDetails *ContainerDetails, folder string) (logger.Logger, error) {
details := *containerDetails
details.LogPath = filepath.Join(folder, "json.log")
return jsonfilelog.New(details)
}
func isStreamClosed(err error) bool {
return errors.Is(err, io.EOF) ||
errors.Is(err, os.ErrClosed) ||
strings.Contains(err.Error(), "file already closed")
}
type fileSystem interface {
BasePath() string
MkdirAll(path string, perm os.FileMode) error
RemoveAll(path string) error
}