blob: 41a13d949719fb308a71c14bff67adb9c2789a56 (
plain)
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
|
// 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 (
"github.com/algorand/go-deadlock"
"github.com/sirupsen/logrus"
"sync"
)
type telemetryHook interface {
Fire(entry *logrus.Entry) error
Levels() []logrus.Level
Close()
Flush()
UpdateHookURI(uri string) (err error)
appendEntry(entry *logrus.Entry) bool
waitForEventAndReady() bool
}
type telemetryState struct {
history *logBuffer
hook telemetryHook
telemetryConfig TelemetryConfig
}
// TelemetryConfig represents the configuration of Telemetry logging
type TelemetryConfig struct {
Enable bool
SendToLog bool
URI string
Name string
GUID string
MinLogLevel logrus.Level `json:"-"` // these are the logrus.Level, but we can't use it directly since on logrus version 1.4.2 they added
ReportHistoryLevel logrus.Level `json:"-"` // text marshalers which breaks our backward compatibility.
FilePath string // Path to file on disk, if any
ChainID string `json:"-"`
SessionGUID string `json:"-"`
Version string `json:"-"`
UserName string
Password string
}
// MarshalingTelemetryConfig is used for json serialization of the TelemetryConfig
// so that we could replace the MinLogLevel/ReportHistoryLevel with our own types.
type MarshalingTelemetryConfig struct {
TelemetryConfig
MinLogLevel uint32
ReportHistoryLevel uint32
}
type asyncTelemetryHook struct {
deadlock.Mutex
wrappedHook logrus.Hook
wg sync.WaitGroup
pending []*logrus.Entry
entries chan *logrus.Entry
quit chan struct{}
maxQueueDepth int
levels []logrus.Level
ready bool
urlUpdate chan bool
}
// A dummy noop type to get rid of checks like telemetry.hook != nil
type dummyHook struct{}
type hookFactory func(cfg TelemetryConfig) (logrus.Hook, error)
|