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

lightningnetwork / lnd / 19924300449

04 Dec 2025 09:35AM UTC coverage: 53.479% (-1.9%) from 55.404%
19924300449

Pull #10419

github

web-flow
Merge f811805c6 into 20473482d
Pull Request #10419: [docs] Document use-native-sql=true for SQL migration step 2

110496 of 206616 relevant lines covered (53.48%)

21221.61 hits per line

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

6.06
/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/onionmessage"
50
        paymentsdb "github.com/lightningnetwork/lnd/payments/db"
51
        "github.com/lightningnetwork/lnd/peer"
52
        "github.com/lightningnetwork/lnd/peernotifier"
53
        "github.com/lightningnetwork/lnd/protofsm"
54
        "github.com/lightningnetwork/lnd/routing"
55
        "github.com/lightningnetwork/lnd/routing/blindedpath"
56
        "github.com/lightningnetwork/lnd/routing/localchans"
57
        "github.com/lightningnetwork/lnd/rpcperms"
58
        "github.com/lightningnetwork/lnd/signal"
59
        "github.com/lightningnetwork/lnd/sqldb"
60
        "github.com/lightningnetwork/lnd/sweep"
61
        "github.com/lightningnetwork/lnd/tor"
62
        "github.com/lightningnetwork/lnd/watchtower"
63
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
64
)
65

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

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

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

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

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

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

119
                interceptor.RequestShutdown()
×
120
        }
121

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

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

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

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

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

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

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

×
216
        AddSubLogger(root, onionmessage.Subsystem, interceptor, onionmessage.UseLogger)
×
217
}
218

219
// AddSubLogger is a helper method to conveniently create and register the
220
// logger of one or more sub systems.
221
func AddSubLogger(root *build.SubLoggerManager, subsystem string,
222
        interceptor signal.Interceptor, useLoggers ...func(btclog.Logger)) {
×
223

×
224
        // genSubLogger will return a callback for creating a logger instance,
×
225
        // which we will give to the root logger.
×
226
        genLogger := genSubLogger(root, interceptor)
×
227

×
228
        // Create and register just a single logger to prevent them from
×
229
        // overwriting each other internally.
×
230
        logger := build.NewSubLogger(subsystem, genLogger)
×
231
        SetSubLogger(root, subsystem, logger, useLoggers...)
×
232
}
×
233

234
// SetSubLogger is a helper method to conveniently register the logger of a
235
// sub system.
236
func SetSubLogger(root *build.SubLoggerManager, subsystem string,
237
        logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
×
238

×
239
        root.RegisterSubLogger(subsystem, logger)
×
240
        for _, useLogger := range useLoggers {
×
241
                useLogger(logger)
×
242
        }
×
243
}
244

245
// AddV1SubLogger is a helper method to conveniently create and register the
246
// logger of one or more sub systems.
247
func AddV1SubLogger(root *build.SubLoggerManager, subsystem string,
248
        interceptor signal.Interceptor, useLoggers ...func(btclogv1.Logger)) {
×
249

×
250
        // genSubLogger will return a callback for creating a logger instance,
×
251
        // which we will give to the root logger.
×
252
        genLogger := genSubLogger(root, interceptor)
×
253

×
254
        // Create and register just a single logger to prevent them from
×
255
        // overwriting each other internally.
×
256
        logger := build.NewSubLogger(subsystem, genLogger)
×
257
        SetV1SubLogger(root, subsystem, logger, useLoggers...)
×
258
}
×
259

260
// SetV1SubLogger is a helper method to conveniently register the logger of a
261
// sub system. Note that the btclog v2 logger implements the btclog v1 logger
262
// which is why we can pass the v2 logger to the UseLogger call-backs that
263
// expect the v1 logger.
264
func SetV1SubLogger(root *build.SubLoggerManager, subsystem string,
265
        logger btclog.Logger, useLoggers ...func(btclogv1.Logger)) {
×
266

×
267
        root.RegisterSubLogger(subsystem, logger)
×
268
        for _, useLogger := range useLoggers {
×
269
                useLogger(logger)
×
270
        }
×
271
}
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