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

lightningnetwork / lnd / 14358372723

09 Apr 2025 01:26PM UTC coverage: 56.696% (-12.3%) from 69.037%
14358372723

Pull #9696

github

web-flow
Merge e2837e400 into 867d27d68
Pull Request #9696: Add `development_guidelines.md` for both human and machine

107055 of 188823 relevant lines covered (56.7%)

22721.56 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 {
12✔
84
                l := &replaceableLogger{
12✔
85
                        Logger:    build.NewSubLogger(subsystem, nil),
12✔
86
                        subsystem: subsystem,
12✔
87
                }
12✔
88
                lndPkgLoggers = append(lndPkgLoggers, l)
12✔
89
                return l
12✔
90
        }
12✔
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
)
103

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

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

116
                interceptor.RequestShutdown()
×
117
        }
118

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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