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

lightningnetwork / lnd / 15869455718

25 Jun 2025 06:53AM UTC coverage: 55.806% (-12.2%) from 67.978%
15869455718

Pull #9148

github

web-flow
Merge c64e3a6c3 into 4335d9cfb
Pull Request #9148: DynComms [2/n]: lnwire: add authenticated wire messages for Dyn*

232 of 270 new or added lines in 5 files covered. (85.93%)

23628 existing lines in 289 files now uncovered.

108377 of 194204 relevant lines covered (55.81%)

22552.93 hits per line

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

6.3
/log.go
1
package lnd
2

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

64
// replaceableLogger is a thin wrapper around a logger that is used so the
65
// logger can be replaced easily without some black pointer magic.
66
type replaceableLogger struct {
67
        btclog.Logger
68
        subsystem string
69
}
70

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

80
        // addLndPkgLogger is a helper function that creates a new replaceable
81
        // main lnd package level logger and adds it to the list of loggers that
82
        // are replaced again later, once the final root logger is ready.
83
        addLndPkgLogger = func(subsystem string) *replaceableLogger {
15✔
84
                l := &replaceableLogger{
15✔
85
                        Logger:    build.NewSubLogger(subsystem, nil),
15✔
86
                        subsystem: subsystem,
15✔
87
                }
15✔
88
                lndPkgLoggers = append(lndPkgLoggers, l)
15✔
89
                return l
15✔
90
        }
15✔
91

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

105
// genSubLogger creates a logger for a subsystem. We provide an instance of
106
// a signal.Interceptor to be able to shutdown in the case of a critical error.
107
func genSubLogger(root *build.SubLoggerManager,
UNCOV
108
        interceptor signal.Interceptor) func(string) btclog.Logger {
×
UNCOV
109

×
UNCOV
110
        // Create a shutdown function which will request shutdown from our
×
UNCOV
111
        // interceptor if it is listening.
×
UNCOV
112
        shutdown := func() {
×
113
                if !interceptor.Listening() {
×
114
                        return
×
115
                }
×
116

117
                interceptor.RequestShutdown()
×
118
        }
119

120
        // Return a function which will create a sublogger from our root
121
        // logger without shutdown fn.
UNCOV
122
        return func(tag string) btclog.Logger {
×
UNCOV
123
                return root.GenSubLogger(tag, shutdown)
×
UNCOV
124
        }
×
125
}
126

127
// SetupLoggers initializes all package-global logger variables.
128
//
129
//nolint:ll
UNCOV
130
func SetupLoggers(root *build.SubLoggerManager, interceptor signal.Interceptor) {
×
UNCOV
131
        genLogger := genSubLogger(root, interceptor)
×
UNCOV
132

×
UNCOV
133
        // Now that we have the proper root logger, we can replace the
×
UNCOV
134
        // placeholder lnd package loggers.
×
UNCOV
135
        for _, l := range lndPkgLoggers {
×
UNCOV
136
                l.Logger = build.NewSubLogger(l.subsystem, genLogger)
×
UNCOV
137
                SetSubLogger(root, l.subsystem, l.Logger)
×
UNCOV
138
        }
×
139

140
        // Initialize loggers from packages outside of `lnd` first. The
141
        // packages below will overwrite the names of the loggers they import.
142
        // For instance, the logger in `neutrino.query` is overwritten by
143
        // `btcwallet.chain`, which is overwritten by `lnwallet`. To ensure the
144
        // overwriting works, we need to initialize the loggers here so they
145
        // can be overwritten later.
UNCOV
146
        AddV1SubLogger(root, "BTCN", interceptor, neutrino.UseLogger)
×
UNCOV
147
        AddV1SubLogger(root, "CMGR", interceptor, connmgr.UseLogger)
×
UNCOV
148
        AddV1SubLogger(root, "RPCC", interceptor, rpcclient.UseLogger)
×
UNCOV
149

×
UNCOV
150
        // Some of the loggers declared in the main lnd package are also used
×
UNCOV
151
        // in sub packages.
×
UNCOV
152
        signal.UseLogger(ltndLog)
×
UNCOV
153
        autopilot.UseLogger(atplLog)
×
UNCOV
154

×
UNCOV
155
        AddSubLogger(root, "LNWL", interceptor, lnwallet.UseLogger)
×
UNCOV
156
        AddSubLogger(root, "DISC", interceptor, discovery.UseLogger)
×
UNCOV
157
        AddSubLogger(root, "NTFN", interceptor, chainntnfs.UseLogger)
×
UNCOV
158
        AddSubLogger(root, "CHDB", interceptor, channeldb.UseLogger)
×
UNCOV
159
        AddSubLogger(root, "SQLB", interceptor, sqlbase.UseLogger)
×
UNCOV
160
        AddSubLogger(root, "HSWC", interceptor, htlcswitch.UseLogger)
×
UNCOV
161
        AddSubLogger(root, "CNCT", interceptor, contractcourt.UseLogger)
×
UNCOV
162
        AddSubLogger(root, "UTXN", interceptor, contractcourt.UseNurseryLogger)
×
UNCOV
163
        AddSubLogger(root, "BRAR", interceptor, contractcourt.UseBreachLogger)
×
UNCOV
164
        AddV1SubLogger(root, "SPHX", interceptor, sphinx.UseLogger)
×
UNCOV
165
        AddSubLogger(root, "SWPR", interceptor, sweep.UseLogger)
×
UNCOV
166
        AddSubLogger(root, "SGNR", interceptor, signrpc.UseLogger)
×
UNCOV
167
        AddSubLogger(root, "WLKT", interceptor, walletrpc.UseLogger)
×
UNCOV
168
        AddSubLogger(root, "ARPC", interceptor, autopilotrpc.UseLogger)
×
UNCOV
169
        AddSubLogger(root, "NRPC", interceptor, neutrinorpc.UseLogger)
×
UNCOV
170
        AddSubLogger(root, "DRPC", interceptor, devrpc.UseLogger)
×
UNCOV
171
        AddSubLogger(root, "INVC", interceptor, invoices.UseLogger)
×
UNCOV
172
        AddSubLogger(root, "NANN", interceptor, netann.UseLogger)
×
UNCOV
173
        AddSubLogger(root, "WTWR", interceptor, watchtower.UseLogger)
×
UNCOV
174
        AddSubLogger(root, "NTFR", interceptor, chainrpc.UseLogger)
×
UNCOV
175
        AddSubLogger(root, "IRPC", interceptor, invoicesrpc.UseLogger)
×
UNCOV
176
        AddSubLogger(root, "CHNF", interceptor, channelnotifier.UseLogger)
×
UNCOV
177
        AddSubLogger(root, "CHBU", interceptor, chanbackup.UseLogger)
×
UNCOV
178
        AddSubLogger(root, "PROM", interceptor, monitoring.UseLogger)
×
UNCOV
179
        AddSubLogger(root, "WTCL", interceptor, wtclient.UseLogger)
×
UNCOV
180
        AddSubLogger(root, "PRNF", interceptor, peernotifier.UseLogger)
×
UNCOV
181
        AddSubLogger(root, "CHFD", interceptor, chanfunding.UseLogger)
×
UNCOV
182
        AddSubLogger(root, "PEER", interceptor, peer.UseLogger)
×
UNCOV
183
        AddSubLogger(root, "CHCL", interceptor, chancloser.UseLogger)
×
UNCOV
184
        AddSubLogger(root, "LCHN", interceptor, localchans.UseLogger)
×
UNCOV
185
        AddSubLogger(root, "PFSM", interceptor, protofsm.UseLogger)
×
UNCOV
186

×
UNCOV
187
        AddSubLogger(root, routing.Subsystem, interceptor, routing.UseLogger)
×
UNCOV
188
        AddSubLogger(root, routerrpc.Subsystem, interceptor, routerrpc.UseLogger)
×
UNCOV
189
        AddSubLogger(root, chanfitness.Subsystem, interceptor, chanfitness.UseLogger)
×
UNCOV
190
        AddSubLogger(root, verrpc.Subsystem, interceptor, verrpc.UseLogger)
×
UNCOV
191
        AddSubLogger(root, healthcheck.Subsystem, interceptor, healthcheck.UseLogger)
×
UNCOV
192
        AddSubLogger(root, chainreg.Subsystem, interceptor, chainreg.UseLogger)
×
UNCOV
193
        AddSubLogger(root, chanacceptor.Subsystem, interceptor, chanacceptor.UseLogger)
×
UNCOV
194
        AddSubLogger(root, funding.Subsystem, interceptor, funding.UseLogger)
×
UNCOV
195
        AddSubLogger(root, cluster.Subsystem, interceptor, cluster.UseLogger)
×
UNCOV
196
        AddSubLogger(root, rpcperms.Subsystem, interceptor, rpcperms.UseLogger)
×
UNCOV
197
        AddSubLogger(root, tor.Subsystem, interceptor, tor.UseLogger)
×
UNCOV
198
        AddSubLogger(root, btcwallet.Subsystem, interceptor, btcwallet.UseLogger)
×
UNCOV
199
        AddSubLogger(root, rpcwallet.Subsystem, interceptor, rpcwallet.UseLogger)
×
UNCOV
200
        AddSubLogger(root, peersrpc.Subsystem, interceptor, peersrpc.UseLogger)
×
UNCOV
201
        AddSubLogger(root, graph.Subsystem, interceptor, graph.UseLogger)
×
UNCOV
202
        AddSubLogger(root, lncfg.Subsystem, interceptor, lncfg.UseLogger)
×
UNCOV
203
        AddSubLogger(
×
UNCOV
204
                root, blindedpath.Subsystem, interceptor, blindedpath.UseLogger,
×
UNCOV
205
        )
×
UNCOV
206
        AddV1SubLogger(root, graphdb.Subsystem, interceptor, graphdb.UseLogger)
×
UNCOV
207
        AddSubLogger(root, chainio.Subsystem, interceptor, chainio.UseLogger)
×
UNCOV
208
        AddSubLogger(root, msgmux.Subsystem, interceptor, msgmux.UseLogger)
×
UNCOV
209
        AddSubLogger(root, sqldb.Subsystem, interceptor, sqldb.UseLogger)
×
210
}
211

212
// AddSubLogger is a helper method to conveniently create and register the
213
// logger of one or more sub systems.
214
func AddSubLogger(root *build.SubLoggerManager, subsystem string,
UNCOV
215
        interceptor signal.Interceptor, useLoggers ...func(btclog.Logger)) {
×
UNCOV
216

×
UNCOV
217
        // genSubLogger will return a callback for creating a logger instance,
×
UNCOV
218
        // which we will give to the root logger.
×
UNCOV
219
        genLogger := genSubLogger(root, interceptor)
×
UNCOV
220

×
UNCOV
221
        // Create and register just a single logger to prevent them from
×
UNCOV
222
        // overwriting each other internally.
×
UNCOV
223
        logger := build.NewSubLogger(subsystem, genLogger)
×
UNCOV
224
        SetSubLogger(root, subsystem, logger, useLoggers...)
×
UNCOV
225
}
×
226

227
// SetSubLogger is a helper method to conveniently register the logger of a
228
// sub system.
229
func SetSubLogger(root *build.SubLoggerManager, subsystem string,
UNCOV
230
        logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
×
UNCOV
231

×
UNCOV
232
        root.RegisterSubLogger(subsystem, logger)
×
UNCOV
233
        for _, useLogger := range useLoggers {
×
UNCOV
234
                useLogger(logger)
×
UNCOV
235
        }
×
236
}
237

238
// AddV1SubLogger is a helper method to conveniently create and register the
239
// logger of one or more sub systems.
240
func AddV1SubLogger(root *build.SubLoggerManager, subsystem string,
UNCOV
241
        interceptor signal.Interceptor, useLoggers ...func(btclogv1.Logger)) {
×
UNCOV
242

×
UNCOV
243
        // genSubLogger will return a callback for creating a logger instance,
×
UNCOV
244
        // which we will give to the root logger.
×
UNCOV
245
        genLogger := genSubLogger(root, interceptor)
×
UNCOV
246

×
UNCOV
247
        // Create and register just a single logger to prevent them from
×
UNCOV
248
        // overwriting each other internally.
×
UNCOV
249
        logger := build.NewSubLogger(subsystem, genLogger)
×
UNCOV
250
        SetV1SubLogger(root, subsystem, logger, useLoggers...)
×
UNCOV
251
}
×
252

253
// SetV1SubLogger is a helper method to conveniently register the logger of a
254
// sub system. Note that the btclog v2 logger implements the btclog v1 logger
255
// which is why we can pass the v2 logger to the UseLogger call-backs that
256
// expect the v1 logger.
257
func SetV1SubLogger(root *build.SubLoggerManager, subsystem string,
UNCOV
258
        logger btclog.Logger, useLoggers ...func(btclogv1.Logger)) {
×
UNCOV
259

×
UNCOV
260
        root.RegisterSubLogger(subsystem, logger)
×
UNCOV
261
        for _, useLogger := range useLoggers {
×
UNCOV
262
                useLogger(logger)
×
UNCOV
263
        }
×
264
}
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