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

lightningnetwork / lnd / 13794368699

11 Mar 2025 05:26PM UTC coverage: 57.532%. First build
13794368699

Pull #9575

github

Roasbeef
peer: wait for state stub to start before sending event
Pull Request #9575: multi: integrate new RBF co-op flow into the server+peer

83 of 839 new or added lines in 9 files covered. (9.89%)

104063 of 180878 relevant lines covered (57.53%)

24638.47 hits per line

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

6.35
/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/sweep"
58
        "github.com/lightningnetwork/lnd/tor"
59
        "github.com/lightningnetwork/lnd/watchtower"
60
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
61
)
62

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

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

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

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

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

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

115
                interceptor.RequestShutdown()
×
116
        }
117

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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