-
Notifications
You must be signed in to change notification settings - Fork 109
/
net_logger.go
425 lines (354 loc) · 9.41 KB
/
net_logger.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
// Package server implements the entry point for running a robot web server.
package server
import (
"bytes"
"context"
"encoding/json"
"fmt"
"net/http"
"os"
"sync"
"time"
"github.com/edaniels/golog"
"github.com/pkg/errors"
"go.uber.org/zap"
"go.uber.org/zap/zapcore"
apppb "go.viam.com/api/app/v1"
"go.viam.com/utils"
"go.viam.com/utils/protoutils"
"go.viam.com/utils/rpc"
"google.golang.org/protobuf/types/known/structpb"
"google.golang.org/protobuf/types/known/timestamppb"
"go.viam.com/rdk/config"
)
const (
defaultMaxQueueSize = 20000
writeBatchSize = 100
)
type wrappedLogger struct {
base zapcore.Core
extra []zapcore.Field
}
func (l *wrappedLogger) Enabled(level zapcore.Level) bool {
return l.base.Enabled(level)
}
func (l *wrappedLogger) With(f []zapcore.Field) zapcore.Core {
return &wrappedLogger{l, f}
}
func (l *wrappedLogger) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry {
return l.base.Check(e, ce)
}
func (l *wrappedLogger) Write(e zapcore.Entry, f []zapcore.Field) error {
field := []zapcore.Field{}
field = append(field, l.extra...)
field = append(field, f...)
return l.base.Write(e, field)
}
func (l *wrappedLogger) Sync() error {
return l.base.Sync()
}
func newNetLogger(config *config.Cloud, loggerWithoutNet golog.Logger, logLevel zap.AtomicLevel) (*netLogger, error) {
hostname, err := os.Hostname()
if err != nil {
return nil, err
}
var logWriter remoteLogWriter
if config.AppAddress == "" {
logWriter = &remoteLogWriterHTTP{
cfg: config,
}
} else {
logWriter = &remoteLogWriterGRPC{
loggerWithoutNet: loggerWithoutNet,
cfg: config,
}
}
cancelCtx, cancel := context.WithCancel(context.Background())
nl := &netLogger{
hostname: hostname,
cancelCtx: cancelCtx,
cancel: cancel,
remoteWriter: logWriter,
maxQueueSize: defaultMaxQueueSize,
loggerWithoutNet: loggerWithoutNet,
logLevel: logLevel,
}
nl.activeBackgroundWorkers.Add(1)
utils.ManagedGo(nl.backgroundWorker, nl.activeBackgroundWorkers.Done)
return nl, nil
}
type netLogger struct {
hostname string
remoteWriter remoteLogWriter
toLogMutex sync.Mutex
toLog []*apppb.LogEntry
maxQueueSize int
cancelCtx context.Context
cancel func()
activeBackgroundWorkers sync.WaitGroup
// Use this logger for library errors that will not be reported through
// the netLogger causing a recursive loop.
loggerWithoutNet golog.Logger
// Log level of the rdk system
logLevel zap.AtomicLevel
}
func (nl *netLogger) queueSize() int {
nl.toLogMutex.Lock()
defer nl.toLogMutex.Unlock()
return len(nl.toLog)
}
func (nl *netLogger) Close() {
// try for up to 10 seconds for log queue to clear before cancelling it
for i := 0; i < 1000; i++ {
if nl.queueSize() == 0 {
break
}
time.Sleep(10 * time.Millisecond)
}
nl.cancel()
nl.activeBackgroundWorkers.Wait()
nl.remoteWriter.close()
}
func (nl *netLogger) Enabled(l zapcore.Level) bool {
return nl.logLevel.Enabled(l)
}
func (nl *netLogger) With(f []zapcore.Field) zapcore.Core {
return &wrappedLogger{nl, f}
}
func (nl *netLogger) Check(e zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry {
if nl.logLevel.Enabled(e.Level) {
return ce.AddCore(e, nl)
}
return ce
}
// Mirrors zapcore.EntryCaller but leaves out the pointer address.
type wrappedEntryCaller struct {
Defined bool
File string
Line int
Function string
}
func (nl *netLogger) Write(e zapcore.Entry, f []zapcore.Field) error {
// TODO(erh): should we put a _id uuid on here so we don't log twice?
log := &apppb.LogEntry{
Host: nl.hostname,
Level: e.Level.String(),
Time: timestamppb.New(e.Time),
LoggerName: e.LoggerName,
Message: e.Message,
Stack: e.Stack,
}
wc := wrappedEntryCaller{
Defined: e.Caller.Defined,
File: e.Caller.File,
Line: e.Caller.Line,
Function: e.Caller.Function,
}
caller, err := protoutils.StructToStructPb(wc)
if err != nil {
return err
}
log.Caller = caller
fields := make([]*structpb.Struct, 0, len(f))
for _, ff := range f {
if ff.String == "" && ff.Interface != nil {
ff.String = fmt.Sprintf("%v", ff.Interface)
}
field, err := protoutils.StructToStructPb(ff)
if err != nil {
return err
}
fields = append(fields, field)
}
log.Fields = fields
nl.addToQueue(log)
if e.Level == zapcore.FatalLevel || e.Level == zapcore.DPanicLevel || e.Level == zapcore.PanicLevel {
// program is going to go away, let's try and sync all our messages before then
return nl.Sync()
}
return nil
}
func (nl *netLogger) addToQueue(x *apppb.LogEntry) {
nl.toLogMutex.Lock()
defer nl.toLogMutex.Unlock()
if len(nl.toLog) >= nl.maxQueueSize {
// TODO(erh): sample?
nl.toLog = nl.toLog[1:]
}
nl.toLog = append(nl.toLog, x)
}
func (nl *netLogger) addBatchToQueue(x []*apppb.LogEntry) {
if len(x) == 0 {
return
}
nl.toLogMutex.Lock()
defer nl.toLogMutex.Unlock()
if len(x) > nl.maxQueueSize {
x = x[len(x)-nl.maxQueueSize:]
}
if len(nl.toLog)+len(x) >= nl.maxQueueSize {
// TODO(erh): sample?
nl.toLog = nl.toLog[len(nl.toLog)+len(x)-nl.maxQueueSize:]
}
nl.toLog = append(nl.toLog, x...)
}
func (nl *netLogger) backgroundWorker() {
normalInterval := 100 * time.Millisecond
abnormalInterval := 5 * time.Second
interval := normalInterval
for {
cancelled := false
if !utils.SelectContextOrWait(nl.cancelCtx, interval) {
cancelled = true
}
err := nl.Sync()
if err != nil && !errors.Is(err, context.Canceled) {
interval = abnormalInterval
nl.loggerWithoutNet.Infof("error logging to network: %s", err)
} else {
interval = normalInterval
}
if cancelled {
return
}
}
}
func (nl *netLogger) Sync() error {
for {
x := func() []*apppb.LogEntry {
nl.toLogMutex.Lock()
defer nl.toLogMutex.Unlock()
if len(nl.toLog) == 0 {
return nil
}
batchSize := writeBatchSize
if len(nl.toLog) < writeBatchSize {
batchSize = len(nl.toLog)
}
x := nl.toLog[:batchSize]
nl.toLog = nl.toLog[batchSize:]
return x
}()
if len(x) == 0 {
return nil
}
err := nl.remoteWriter.write(x)
if err != nil {
nl.addBatchToQueue(x)
return err
}
}
}
func addCloudLogger(logger golog.Logger, logLevel zap.AtomicLevel, cfg *config.Cloud) (golog.Logger, func(), error) {
nl, err := newNetLogger(cfg, logger, logLevel)
if err != nil {
return nil, nil, err
}
l := logger.Desugar()
l = l.WithOptions(zap.WrapCore(func(c zapcore.Core) zapcore.Core {
return zapcore.NewTee(c, nl)
}))
return l.Sugar(), nl.Close, nil
}
type remoteLogWriter interface {
write(logs []*apppb.LogEntry) error
close()
}
type remoteLogWriterHTTP struct {
cfg *config.Cloud
client http.Client
}
func (w *remoteLogWriterHTTP) write(logs []*apppb.LogEntry) error {
for _, log := range logs {
err := w.writeToServer(log)
if err != nil {
return err
}
}
return nil
}
func (w *remoteLogWriterHTTP) writeToServer(log *apppb.LogEntry) error {
level, err := zapcore.ParseLevel(log.Level)
if err != nil {
return errors.Wrap(err, "error creating log request")
}
e := zapcore.Entry{
Level: level,
LoggerName: log.LoggerName,
Message: log.Message,
Stack: log.Stack,
Time: log.Time.AsTime(),
}
x := map[string]interface{}{
"id": w.cfg.ID,
"host": log.Host,
"log": e,
"fields": log.Fields,
}
js, err := json.Marshal(x)
if err != nil {
return err
}
// we specifically don't use a parented cancellable context here so we can make sure we finish writing but
// we will only give it up to 5 seconds to do so in case we are trying to shutdown.
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
defer cancel()
r, err := http.NewRequestWithContext(ctx, http.MethodPost, w.cfg.LogPath, bytes.NewReader(js))
if err != nil {
return errors.Wrap(err, "error creating log request")
}
r.Header.Set("Secret", w.cfg.Secret)
resp, err := w.client.Do(r)
if err != nil {
return err
}
defer func() {
utils.UncheckedError(resp.Body.Close())
}()
return nil
}
func (w *remoteLogWriterHTTP) close() {
w.client.CloseIdleConnections()
}
type remoteLogWriterGRPC struct {
cfg *config.Cloud
service apppb.RobotServiceClient
rpcClient rpc.ClientConn
clientMutex sync.Mutex
// Use this logger for library errors that will not be reported through
// the netLogger causing a recursive loop.
loggerWithoutNet golog.Logger
}
func (w *remoteLogWriterGRPC) write(logs []*apppb.LogEntry) error {
// we specifically don't use a parented cancellable context here so we can make sure we finish writing but
// we will only give it up to 5 seconds to do so in case we are trying to shutdown.
ctx, cancel := context.WithTimeout(context.Background(), time.Second*5)
defer cancel()
client, err := w.getOrCreateClient(ctx)
if err != nil {
return err
}
_, err = client.Log(ctx, &apppb.LogRequest{Id: w.cfg.ID, Logs: logs})
if err != nil {
return err
}
return nil
}
func (w *remoteLogWriterGRPC) getOrCreateClient(ctx context.Context) (apppb.RobotServiceClient, error) {
if w.service == nil {
w.clientMutex.Lock()
defer w.clientMutex.Unlock()
client, err := config.CreateNewGRPCClient(ctx, w.cfg, w.loggerWithoutNet)
if err != nil {
return nil, err
}
w.rpcClient = client
w.service = apppb.NewRobotServiceClient(w.rpcClient)
}
return w.service, nil
}
func (w *remoteLogWriterGRPC) close() {
if w.rpcClient != nil {
utils.UncheckedErrorFunc(w.rpcClient.Close)
}
}