-
Notifications
You must be signed in to change notification settings - Fork 110
/
net_appender.go
417 lines (347 loc) · 11.3 KB
/
net_appender.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
package logging
import (
"context"
"fmt"
"net/url"
"os"
"sync"
"time"
"github.com/pkg/errors"
"go.uber.org/zap/zapcore"
apppb "go.viam.com/api/app/v1"
commonpb "go.viam.com/api/common/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"
)
var (
defaultMaxQueueSize = 20000
writeBatchSize = 100
)
// CloudConfig contains the necessary inputs to send logs to the app backend over grpc.
type CloudConfig struct {
AppAddress string
ID string
Secret string
}
// NewNetAppender creates a NetAppender to send log events to the app backend. NetAppenders ought to
// be `Close`d prior to shutdown to flush remaining logs.
func NewNetAppender(config *CloudConfig) (*NetAppender, error) {
hostname, err := os.Hostname()
if err != nil {
return nil, err
}
logWriter := &remoteLogWriterGRPC{
cfg: config,
}
cancelCtx, cancel := context.WithCancel(context.Background())
nl := &NetAppender{
hostname: hostname,
cancelCtx: cancelCtx,
cancel: cancel,
remoteWriter: logWriter,
maxQueueSize: defaultMaxQueueSize,
loggerWithoutNet: NewLogger("netlogger"),
}
nl.activeBackgroundWorkers.Add(1)
utils.ManagedGo(nl.backgroundWorker, nl.activeBackgroundWorkers.Done)
return nl, nil
}
// NetAppender can send log events to the app backend.
type NetAppender struct {
hostname string
remoteWriter *remoteLogWriterGRPC
// toLogMutex guards toLog and toLogOverflowsSinceLastSync.
toLogMutex sync.Mutex
toLog []*commonpb.LogEntry
toLogOverflowsSinceLastSync int
maxQueueSize int
cancelCtx context.Context
cancel func()
activeBackgroundWorkers sync.WaitGroup
// the netLogger causing a recursive loop.
loggerWithoutNet Logger
}
func (nl *NetAppender) queueSize() int {
nl.toLogMutex.Lock()
defer nl.toLogMutex.Unlock()
return len(nl.toLog)
}
// Close the NetAppender. This makes a best effort at sending all logs before returning.
func (nl *NetAppender) Close() {
// try for up to 10 seconds for log queue to clear before cancelling it
for i := 0; i < 1000; i++ {
// A batch can be popped from the queue for a sync by the background worker, and re-enqueued
// due to an error. This check does not account for this case. It will cancel the background
// worker once the last batch is in flight. Successful or not.
if nl.queueSize() == 0 {
break
}
time.Sleep(10 * time.Millisecond)
}
nl.cancel()
nl.activeBackgroundWorkers.Wait()
nl.remoteWriter.close()
}
// Mirrors zapcore.EntryCaller but leaves out the pointer address.
type wrappedEntryCaller struct {
Defined bool
File string
Line int
Function string
}
func (nl *NetAppender) Write(e zapcore.Entry, f []zapcore.Field) error {
log := &commonpb.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
}
// addToQueue adds a LogEntry to the net appender's queue, discarding the
// oldest entry in the queue if the size of the queue has overflowed.
func (nl *NetAppender) addToQueue(logEntry *commonpb.LogEntry) {
nl.toLogMutex.Lock()
defer nl.toLogMutex.Unlock()
if len(nl.toLog) >= nl.maxQueueSize {
// TODO(RSDK-7000): Selectively kick logs out of the queue based on log
// content (i.e. don't maintain 20000 trivial logs of "Foo" when other,
// potentially important information is being logged).
nl.toLog = nl.toLog[1:]
nl.toLogOverflowsSinceLastSync++
}
nl.toLog = append(nl.toLog, logEntry)
}
// addBatchToQueue adds a slice of LogEntrys to the net appender's queue,
// trimming the front of the batch to be less than maxQueueSize, and discarding
// the oldest len(batch) entries in the queue if the queue has overflowed.
func (nl *NetAppender) addBatchToQueue(batch []*commonpb.LogEntry) {
if len(batch) == 0 {
return
}
nl.toLogMutex.Lock()
defer nl.toLogMutex.Unlock()
if len(batch) > nl.maxQueueSize {
batch = batch[len(batch)-nl.maxQueueSize:]
}
if len(nl.toLog)+len(batch) >= nl.maxQueueSize {
// TODO(RSDK-7000): Selectively kick logs out of the queue based on log
// content (i.e. don't maintain 20000 trivial logs of "Foo" when other,
// potentially important information is being logged).
overflow := len(nl.toLog) + len(batch) - nl.maxQueueSize
nl.toLog = nl.toLog[overflow:]
nl.toLogOverflowsSinceLastSync += overflow
}
nl.toLog = append(nl.toLog, batch...)
}
func (nl *NetAppender) 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
}
}
}
// Returns whether there is more work to do or if an error was encountered
// while trying to ship logs over the network.
func (nl *NetAppender) syncOnce() (bool, error) {
nl.toLogMutex.Lock()
if len(nl.toLog) == 0 {
nl.toLogMutex.Unlock()
return false, nil
}
batchSize := writeBatchSize
if len(nl.toLog) < writeBatchSize {
batchSize = len(nl.toLog)
}
// Read a batch from the queue, unlock mutex, and return an error if write
// fails. Lock mutex again to remove batch from queue only if write succeeded
// and front of queue was not mutated by addToQueue/addBatchToQueue throwing
// away the oldest logs due to overflows beyond maxQueueSize.
batch := nl.toLog[:batchSize]
nl.toLogMutex.Unlock()
if err := nl.remoteWriter.write(batch); err != nil {
return false, err
}
nl.toLogMutex.Lock()
defer nl.toLogMutex.Unlock()
// Remove successfully synced logs from the queue. If we've overflowed more times than the size of the batch
// we wrote, do not mutate toLog at all. If we've synced more logs than there are logs left, set idx to length
// of array to prevent panics.
if batchSize > nl.toLogOverflowsSinceLastSync {
idx := min(batchSize-nl.toLogOverflowsSinceLastSync, len(nl.toLog))
nl.toLog = nl.toLog[idx:]
}
nl.toLogOverflowsSinceLastSync = 0
return len(nl.toLog) > 0, nil
}
// sync will flush the internal buffer of logs. This is not exposed as multiple calls to sync at
// the same time will cause double logs and panics.
func (nl *NetAppender) sync() error {
for {
moreToDo, err := nl.syncOnce()
if err != nil {
return err
}
if !moreToDo {
return nil
}
}
}
// Sync is a no-op. sync is not exposed as multiple calls at the same time will cause double logs and panics.
func (nl *NetAppender) Sync() error {
return nil
}
type remoteLogWriterGRPC struct {
cfg *CloudConfig
// `service` and `rpcClient` are lazily initialized on first call to `write`. The `clientMutex`
// serializes access to ensure that only one caller creates them.
service apppb.RobotServiceClient
rpcClient rpc.ClientConn
clientMutex sync.Mutex
}
func (w *remoteLogWriterGRPC) write(logs []*commonpb.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) {
w.clientMutex.Lock()
defer w.clientMutex.Unlock()
if w.service != nil {
return w.service, nil
}
client, err := CreateNewGRPCClient(ctx, w.cfg)
if err != nil {
return nil, err
}
w.rpcClient = client
w.service = apppb.NewRobotServiceClient(w.rpcClient)
return w.service, nil
}
func (w *remoteLogWriterGRPC) close() {
w.clientMutex.Lock()
defer w.clientMutex.Unlock()
if w.rpcClient != nil {
utils.UncheckedErrorFunc(w.rpcClient.Close)
}
}
// CreateNewGRPCClient creates a new grpc cloud configured to communicate with the robot service
// based on the cloud config given.
func CreateNewGRPCClient(ctx context.Context, cloudCfg *CloudConfig) (rpc.ClientConn, error) {
grpcURL, err := url.Parse(cloudCfg.AppAddress)
if err != nil {
return nil, err
}
dialOpts := make([]rpc.DialOption, 0, 2)
// Only add credentials when secret is set.
if cloudCfg.Secret != "" {
dialOpts = append(dialOpts, rpc.WithEntityCredentials(cloudCfg.ID,
rpc.Credentials{
Type: "robot-secret",
Payload: cloudCfg.Secret,
},
))
}
if grpcURL.Scheme == "http" {
dialOpts = append(dialOpts, rpc.WithInsecure())
}
return rpc.DialDirectGRPC(ctx, grpcURL.Host, NewLogger("netlogger").AsZap(), dialOpts...)
}
// A NetAppender must implement a zapcore such that it gets copied when downconverting on
// `Logger.AsZap`. The methods below are only invoked when passed as a zap.SugaredLogger to external
// libraries.
var _ zapcore.Core = &NetAppender{}
// Check checks if the entry should be logged. If so, add it to the CheckedEntry list of cores.
func (nl *NetAppender) Check(entry zapcore.Entry, checkedEntry *zapcore.CheckedEntry) *zapcore.CheckedEntry {
if GlobalLogLevel.Enabled(entry.Level) {
return checkedEntry.AddCore(entry, nl)
}
return checkedEntry
}
// Enabled returns if the NetAppender serving as a `zapcore.Core` should log.
func (nl *NetAppender) Enabled(level zapcore.Level) bool {
return GlobalLogLevel.Enabled(level)
}
// With creates a zapcore.Core that will log like a `NetAppender` but with extra fields attached.
func (nl *NetAppender) With(f []zapcore.Field) zapcore.Core {
return &wrappedLogger{nl, f}
}
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()
}