blob: e684cc1797240dcf122ddcef75713e8b8867b8ac (
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
|
// 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 messagetracer
import (
"github.com/algorand/go-algorand/config"
"github.com/algorand/go-algorand/logging"
)
// MessageTracer interface for configuring trace client and sending trace messages
type MessageTracer interface {
// Init configures trace client or returns nil.
// Caller is expected to check for nil, e.g. `if t != nil {t.HashTrace(...)}`
Init(cfg config.Local) MessageTracer
// HashTrace submits a trace message to the statistics server.
HashTrace(prefix string, data []byte)
}
var implFactory func(logging.Logger) MessageTracer
type nopMessageTracer struct {
}
func (gmt *nopMessageTracer) Init(cfg config.Local) MessageTracer {
return nil
}
func (gmt *nopMessageTracer) HashTrace(prefix string, data []byte) {
}
var singletonNopMessageTracer nopMessageTracer
// NewTracer constructs a new MessageTracer if that has been compiled in with the build tag `msgtrace`
func NewTracer(log logging.Logger) MessageTracer {
if implFactory != nil {
log.Info("graphtrace factory enabled")
return implFactory(log)
}
log.Info("graphtrace factory DISabled")
return &singletonNopMessageTracer
}
// Proposal is a prefix for HashTrace()
const Proposal = "prop"
|
