• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

lightningnetwork / lnd / 11393106485

17 Oct 2024 09:10PM UTC coverage: 57.848% (-1.0%) from 58.81%
11393106485

Pull #9148

github

ProofOfKeags
lnwire: convert DynPropose and DynCommit to use typed tlv records
Pull Request #9148: DynComms [2/n]: lnwire: add authenticated wire messages for Dyn*

142 of 177 new or added lines in 4 files covered. (80.23%)

18983 existing lines in 242 files now uncovered.

99003 of 171143 relevant lines covered (57.85%)

36968.25 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

7.77
/log.go
1
package lnd
2

3
import (
4
        "github.com/btcsuite/btcd/connmgr"
5
        "github.com/btcsuite/btcd/rpcclient"
6
        "github.com/btcsuite/btclog"
7
        "github.com/lightninglabs/neutrino"
8
        sphinx "github.com/lightningnetwork/lightning-onion"
9
        "github.com/lightningnetwork/lnd/autopilot"
10
        "github.com/lightningnetwork/lnd/build"
11
        "github.com/lightningnetwork/lnd/chainntnfs"
12
        "github.com/lightningnetwork/lnd/chainreg"
13
        "github.com/lightningnetwork/lnd/chanacceptor"
14
        "github.com/lightningnetwork/lnd/chanbackup"
15
        "github.com/lightningnetwork/lnd/chanfitness"
16
        "github.com/lightningnetwork/lnd/channeldb"
17
        "github.com/lightningnetwork/lnd/channelnotifier"
18
        "github.com/lightningnetwork/lnd/cluster"
19
        "github.com/lightningnetwork/lnd/contractcourt"
20
        "github.com/lightningnetwork/lnd/discovery"
21
        "github.com/lightningnetwork/lnd/funding"
22
        "github.com/lightningnetwork/lnd/graph"
23
        "github.com/lightningnetwork/lnd/healthcheck"
24
        "github.com/lightningnetwork/lnd/htlcswitch"
25
        "github.com/lightningnetwork/lnd/invoices"
26
        "github.com/lightningnetwork/lnd/lncfg"
27
        "github.com/lightningnetwork/lnd/lnrpc/autopilotrpc"
28
        "github.com/lightningnetwork/lnd/lnrpc/chainrpc"
29
        "github.com/lightningnetwork/lnd/lnrpc/devrpc"
30
        "github.com/lightningnetwork/lnd/lnrpc/invoicesrpc"
31
        "github.com/lightningnetwork/lnd/lnrpc/neutrinorpc"
32
        "github.com/lightningnetwork/lnd/lnrpc/peersrpc"
33
        "github.com/lightningnetwork/lnd/lnrpc/routerrpc"
34
        "github.com/lightningnetwork/lnd/lnrpc/signrpc"
35
        "github.com/lightningnetwork/lnd/lnrpc/verrpc"
36
        "github.com/lightningnetwork/lnd/lnrpc/walletrpc"
37
        "github.com/lightningnetwork/lnd/lnwallet"
38
        "github.com/lightningnetwork/lnd/lnwallet/btcwallet"
39
        "github.com/lightningnetwork/lnd/lnwallet/chancloser"
40
        "github.com/lightningnetwork/lnd/lnwallet/chanfunding"
41
        "github.com/lightningnetwork/lnd/lnwallet/rpcwallet"
42
        "github.com/lightningnetwork/lnd/monitoring"
43
        "github.com/lightningnetwork/lnd/netann"
44
        "github.com/lightningnetwork/lnd/peer"
45
        "github.com/lightningnetwork/lnd/peernotifier"
46
        "github.com/lightningnetwork/lnd/routing"
47
        "github.com/lightningnetwork/lnd/routing/blindedpath"
48
        "github.com/lightningnetwork/lnd/rpcperms"
49
        "github.com/lightningnetwork/lnd/signal"
50
        "github.com/lightningnetwork/lnd/sweep"
51
        "github.com/lightningnetwork/lnd/tor"
52
        "github.com/lightningnetwork/lnd/watchtower"
53
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
54
)
55

56
// replaceableLogger is a thin wrapper around a logger that is used so the
57
// logger can be replaced easily without some black pointer magic.
58
type replaceableLogger struct {
59
        btclog.Logger
60
        subsystem string
61
}
62

63
// Loggers can not be used before the log rotator has been initialized with a
64
// log file. This must be performed early during application startup by
65
// calling InitLogRotator() on the main log writer instance in the config.
66
var (
67
        // lndPkgLoggers is a list of all lnd package level loggers that are
68
        // registered. They are tracked here so they can be replaced once the
69
        // SetupLoggers function is called with the final root logger.
70
        lndPkgLoggers []*replaceableLogger
71

72
        // addLndPkgLogger is a helper function that creates a new replaceable
73
        // main lnd package level logger and adds it to the list of loggers that
74
        // are replaced again later, once the final root logger is ready.
75
        addLndPkgLogger = func(subsystem string) *replaceableLogger {
12✔
76
                l := &replaceableLogger{
12✔
77
                        Logger:    build.NewSubLogger(subsystem, nil),
12✔
78
                        subsystem: subsystem,
12✔
79
                }
12✔
80
                lndPkgLoggers = append(lndPkgLoggers, l)
12✔
81
                return l
12✔
82
        }
12✔
83

84
        // Loggers that need to be accessible from the lnd package can be placed
85
        // here. Loggers that are only used in sub modules can be added directly
86
        // by using the addSubLogger method. We declare all loggers so we never
87
        // run into a nil reference if they are used early. But the SetupLoggers
88
        // function should always be called as soon as possible to finish
89
        // setting them up properly with a root logger.
90
        ltndLog = addLndPkgLogger("LTND")
91
        rpcsLog = addLndPkgLogger("RPCS")
92
        srvrLog = addLndPkgLogger("SRVR")
93
        atplLog = addLndPkgLogger("ATPL")
94
)
95

96
// genSubLogger creates a logger for a subsystem. We provide an instance of
97
// a signal.Interceptor to be able to shutdown in the case of a critical error.
98
func genSubLogger(root *build.RotatingLogWriter,
UNCOV
99
        interceptor signal.Interceptor) func(string) btclog.Logger {
×
UNCOV
100

×
UNCOV
101
        // Create a shutdown function which will request shutdown from our
×
UNCOV
102
        // interceptor if it is listening.
×
UNCOV
103
        shutdown := func() {
×
UNCOV
104
                if !interceptor.Listening() {
×
105
                        return
×
106
                }
×
107

UNCOV
108
                interceptor.RequestShutdown()
×
109
        }
110

111
        // Return a function which will create a sublogger from our root
112
        // logger without shutdown fn.
UNCOV
113
        return func(tag string) btclog.Logger {
×
UNCOV
114
                return root.GenSubLogger(tag, shutdown)
×
UNCOV
115
        }
×
116
}
117

118
// SetupLoggers initializes all package-global logger variables.
UNCOV
119
func SetupLoggers(root *build.RotatingLogWriter, interceptor signal.Interceptor) {
×
UNCOV
120
        genLogger := genSubLogger(root, interceptor)
×
UNCOV
121

×
UNCOV
122
        // Now that we have the proper root logger, we can replace the
×
UNCOV
123
        // placeholder lnd package loggers.
×
UNCOV
124
        for _, l := range lndPkgLoggers {
×
UNCOV
125
                l.Logger = build.NewSubLogger(l.subsystem, genLogger)
×
UNCOV
126
                SetSubLogger(root, l.subsystem, l.Logger)
×
UNCOV
127
        }
×
128

129
        // Initialize loggers from packages outside of `lnd` first. The
130
        // packages below will overwrite the names of the loggers they import.
131
        // For instance, the logger in `neutrino.query` is overwritten by
132
        // `btcwallet.chain`, which is overwritten by `lnwallet`. To ensure the
133
        // overwriting works, we need to initialize the loggers here so they
134
        // can be overwritten later.
UNCOV
135
        AddSubLogger(root, "BTCN", interceptor, neutrino.UseLogger)
×
UNCOV
136
        AddSubLogger(root, "CMGR", interceptor, connmgr.UseLogger)
×
UNCOV
137
        AddSubLogger(root, "RPCC", interceptor, rpcclient.UseLogger)
×
UNCOV
138

×
UNCOV
139
        // Some of the loggers declared in the main lnd package are also used
×
UNCOV
140
        // in sub packages.
×
UNCOV
141
        signal.UseLogger(ltndLog)
×
UNCOV
142
        autopilot.UseLogger(atplLog)
×
UNCOV
143

×
UNCOV
144
        AddSubLogger(root, "LNWL", interceptor, lnwallet.UseLogger)
×
UNCOV
145
        AddSubLogger(root, "DISC", interceptor, discovery.UseLogger)
×
UNCOV
146
        AddSubLogger(root, "NTFN", interceptor, chainntnfs.UseLogger)
×
UNCOV
147
        AddSubLogger(root, "CHDB", interceptor, channeldb.UseLogger)
×
UNCOV
148
        AddSubLogger(root, "HSWC", interceptor, htlcswitch.UseLogger)
×
UNCOV
149
        AddSubLogger(root, "CNCT", interceptor, contractcourt.UseLogger)
×
UNCOV
150
        AddSubLogger(root, "UTXN", interceptor, contractcourt.UseNurseryLogger)
×
UNCOV
151
        AddSubLogger(root, "BRAR", interceptor, contractcourt.UseBreachLogger)
×
UNCOV
152
        AddSubLogger(root, "SPHX", interceptor, sphinx.UseLogger)
×
UNCOV
153
        AddSubLogger(root, "SWPR", interceptor, sweep.UseLogger)
×
UNCOV
154
        AddSubLogger(root, "SGNR", interceptor, signrpc.UseLogger)
×
UNCOV
155
        AddSubLogger(root, "WLKT", interceptor, walletrpc.UseLogger)
×
UNCOV
156
        AddSubLogger(root, "ARPC", interceptor, autopilotrpc.UseLogger)
×
UNCOV
157
        AddSubLogger(root, "NRPC", interceptor, neutrinorpc.UseLogger)
×
UNCOV
158
        AddSubLogger(root, "DRPC", interceptor, devrpc.UseLogger)
×
UNCOV
159
        AddSubLogger(root, "INVC", interceptor, invoices.UseLogger)
×
UNCOV
160
        AddSubLogger(root, "NANN", interceptor, netann.UseLogger)
×
UNCOV
161
        AddSubLogger(root, "WTWR", interceptor, watchtower.UseLogger)
×
UNCOV
162
        AddSubLogger(root, "NTFR", interceptor, chainrpc.UseLogger)
×
UNCOV
163
        AddSubLogger(root, "IRPC", interceptor, invoicesrpc.UseLogger)
×
UNCOV
164
        AddSubLogger(root, "CHNF", interceptor, channelnotifier.UseLogger)
×
UNCOV
165
        AddSubLogger(root, "CHBU", interceptor, chanbackup.UseLogger)
×
UNCOV
166
        AddSubLogger(root, "PROM", interceptor, monitoring.UseLogger)
×
UNCOV
167
        AddSubLogger(root, "WTCL", interceptor, wtclient.UseLogger)
×
UNCOV
168
        AddSubLogger(root, "PRNF", interceptor, peernotifier.UseLogger)
×
UNCOV
169
        AddSubLogger(root, "CHFD", interceptor, chanfunding.UseLogger)
×
UNCOV
170
        AddSubLogger(root, "PEER", interceptor, peer.UseLogger)
×
UNCOV
171
        AddSubLogger(root, "CHCL", interceptor, chancloser.UseLogger)
×
UNCOV
172

×
UNCOV
173
        AddSubLogger(root, routing.Subsystem, interceptor, routing.UseLogger)
×
UNCOV
174
        AddSubLogger(root, routerrpc.Subsystem, interceptor, routerrpc.UseLogger)
×
UNCOV
175
        AddSubLogger(root, chanfitness.Subsystem, interceptor, chanfitness.UseLogger)
×
UNCOV
176
        AddSubLogger(root, verrpc.Subsystem, interceptor, verrpc.UseLogger)
×
UNCOV
177
        AddSubLogger(root, healthcheck.Subsystem, interceptor, healthcheck.UseLogger)
×
UNCOV
178
        AddSubLogger(root, chainreg.Subsystem, interceptor, chainreg.UseLogger)
×
UNCOV
179
        AddSubLogger(root, chanacceptor.Subsystem, interceptor, chanacceptor.UseLogger)
×
UNCOV
180
        AddSubLogger(root, funding.Subsystem, interceptor, funding.UseLogger)
×
UNCOV
181
        AddSubLogger(root, cluster.Subsystem, interceptor, cluster.UseLogger)
×
UNCOV
182
        AddSubLogger(root, rpcperms.Subsystem, interceptor, rpcperms.UseLogger)
×
UNCOV
183
        AddSubLogger(root, tor.Subsystem, interceptor, tor.UseLogger)
×
UNCOV
184
        AddSubLogger(root, btcwallet.Subsystem, interceptor, btcwallet.UseLogger)
×
UNCOV
185
        AddSubLogger(root, rpcwallet.Subsystem, interceptor, rpcwallet.UseLogger)
×
UNCOV
186
        AddSubLogger(root, peersrpc.Subsystem, interceptor, peersrpc.UseLogger)
×
UNCOV
187
        AddSubLogger(root, graph.Subsystem, interceptor, graph.UseLogger)
×
UNCOV
188
        AddSubLogger(root, lncfg.Subsystem, interceptor, lncfg.UseLogger)
×
UNCOV
189
        AddSubLogger(
×
UNCOV
190
                root, blindedpath.Subsystem, interceptor, blindedpath.UseLogger,
×
UNCOV
191
        )
×
192
}
193

194
// AddSubLogger is a helper method to conveniently create and register the
195
// logger of one or more sub systems.
196
func AddSubLogger(root *build.RotatingLogWriter, subsystem string,
UNCOV
197
        interceptor signal.Interceptor, useLoggers ...func(btclog.Logger)) {
×
UNCOV
198

×
UNCOV
199
        // genSubLogger will return a callback for creating a logger instance,
×
UNCOV
200
        // which we will give to the root logger.
×
UNCOV
201
        genLogger := genSubLogger(root, interceptor)
×
UNCOV
202

×
UNCOV
203
        // Create and register just a single logger to prevent them from
×
UNCOV
204
        // overwriting each other internally.
×
UNCOV
205
        logger := build.NewSubLogger(subsystem, genLogger)
×
UNCOV
206
        SetSubLogger(root, subsystem, logger, useLoggers...)
×
UNCOV
207
}
×
208

209
// SetSubLogger is a helper method to conveniently register the logger of a sub
210
// system.
211
func SetSubLogger(root *build.RotatingLogWriter, subsystem string,
UNCOV
212
        logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
×
UNCOV
213

×
UNCOV
214
        root.RegisterSubLogger(subsystem, logger)
×
UNCOV
215
        for _, useLogger := range useLoggers {
×
UNCOV
216
                useLogger(logger)
×
UNCOV
217
        }
×
218
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc