summaryrefslogtreecommitdiff
path: root/txnsync/logger.go
blob: 80238716848e587a12650c4455b41fa4b271ef21 (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
85
86
87
88
// Copyright (C) 2019-2021 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 txnsync

import (
	"github.com/algorand/go-algorand/config"
	"github.com/algorand/go-algorand/data/basics"
	"github.com/algorand/go-algorand/logging"
)

// make a local alias of the type so that we can refer to it without '.'
type algodlogger = logging.Logger

type msgStats struct {
	sequenceNumber  uint64
	round           basics.Round
	transactions    int
	offsetModulator requestParams
	bloomSize       int
	nextMsgMinDelay uint64
	peerAddress     string
}

type msgLogger interface {
	outgoingMessage(mstat msgStats)
	incomingMessage(mstat msgStats)
}

// Logger is go-algorand/logging.Logger with some private additions for txnsync
type Logger interface {
	logging.Logger
	msgLogger
}

type basicMsgLogger struct {
	algodlogger
	config *config.Local
}

func wrapLogger(l logging.Logger, config *config.Local) Logger {
	if ll, ok := l.(Logger); ok {
		return ll
	}
	out := &basicMsgLogger{
		algodlogger: l,
		config:      config,
	}
	return out
}

func (l *basicMsgLogger) logMessage(mstat msgStats, mode, tofrom string) {
	if !l.config.EnableVerbosedTransactionSyncLogging {
		return
	}
	l.Infof(
		"%s Txsync #%d round %d transactions %d request [%d/%d] bloom %d nextTS %d %s '%s'",
		mode,
		mstat.sequenceNumber,
		mstat.round,
		mstat.transactions,
		mstat.offsetModulator.Offset,
		mstat.offsetModulator.Modulator,
		mstat.bloomSize,
		mstat.nextMsgMinDelay,
		tofrom,
		mstat.peerAddress,
	)
}
func (l *basicMsgLogger) outgoingMessage(mstat msgStats) {
	l.logMessage(mstat, "Outgoing", "to")
}
func (l *basicMsgLogger) incomingMessage(mstat msgStats) {
	l.logMessage(mstat, "Incoming", "from")
}