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
|
// Copyright (C) 2019-2023 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand. If not, see <https://www.gnu.org/licenses/>.
package logging
import (
"errors"
"strings"
"github.com/sirupsen/logrus"
)
type telemetryFilteredHook struct {
telemetryConfig TelemetryConfig
wrappedHook logrus.Hook
reportLogLevel logrus.Level
history *logBuffer
sessionGUID string
factory hookFactory
levels []logrus.Level
}
// newFilteredTelemetryHook creates a hook filter for ensuring telemetry events are
// always included by the wrapped log hook.
func newTelemetryFilteredHook(cfg TelemetryConfig, hook logrus.Hook, reportLogLevel logrus.Level, history *logBuffer, sessionGUID string, factory hookFactory, levels []logrus.Level) (logrus.Hook, error) {
filteredHook := &telemetryFilteredHook{
cfg,
hook,
reportLogLevel,
history,
sessionGUID,
factory,
levels,
}
return filteredHook, nil
}
// Fire is required to implement logrus hook interface
func (hook *telemetryFilteredHook) Fire(entry *logrus.Entry) error {
// Just in case
if hook.wrappedHook == nil {
return errors.New("the wrapped hook has not been initialized")
}
// Don't include log history when logging debug.Stack() - just pass it through.
if entry.Level == logrus.ErrorLevel && strings.HasPrefix(entry.Message, stackPrefix) {
return hook.wrappedHook.Fire(entry)
}
if entry.Level <= hook.reportLogLevel {
// Logging entry at a level which should include log history
// Create a new entry augmented with the history field.
newEntry := entry.WithFields(Fields{"log": hook.history.string(), "session": hook.sessionGUID, "v": hook.telemetryConfig.Version})
newEntry.Time = entry.Time
newEntry.Level = entry.Level
newEntry.Message = entry.Message
hook.history.trim() // trim history log so we don't keep sending a lot of redundant logs
return hook.wrappedHook.Fire(newEntry)
}
// If we're not including log history and session GUID, create a new
// entry that includes the session GUID, unless it is already present
// (which it will be for regular telemetry events)
var newEntry *logrus.Entry
if _, has := entry.Data["session"]; has {
newEntry = entry
} else {
newEntry = entry.WithField("session", hook.sessionGUID)
}
// Also add version field, if not already present.
if _, has := entry.Data["v"]; !has {
newEntry = newEntry.WithField("v", hook.telemetryConfig.Version)
}
return hook.wrappedHook.Fire(newEntry)
}
// Levels Required for logrus hook interface
func (hook *telemetryFilteredHook) Levels() []logrus.Level {
if hook.wrappedHook != nil {
return hook.wrappedHook.Levels()
}
return hook.levels
}
|
