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

lightningnetwork / lnd / 12058234999

27 Nov 2024 09:06PM UTC coverage: 57.847% (-1.1%) from 58.921%
12058234999

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%)

19365 existing lines in 251 files now uncovered.

100876 of 174383 relevant lines covered (57.85%)

25338.28 hits per line

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

6.61
/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/chainntnfs"
13
        "github.com/lightningnetwork/lnd/chainreg"
14
        "github.com/lightningnetwork/lnd/chanacceptor"
15
        "github.com/lightningnetwork/lnd/chanbackup"
16
        "github.com/lightningnetwork/lnd/chanfitness"
17
        "github.com/lightningnetwork/lnd/channeldb"
18
        "github.com/lightningnetwork/lnd/channelnotifier"
19
        "github.com/lightningnetwork/lnd/cluster"
20
        "github.com/lightningnetwork/lnd/contractcourt"
21
        "github.com/lightningnetwork/lnd/discovery"
22
        "github.com/lightningnetwork/lnd/funding"
23
        "github.com/lightningnetwork/lnd/graph"
24
        "github.com/lightningnetwork/lnd/healthcheck"
25
        "github.com/lightningnetwork/lnd/htlcswitch"
26
        "github.com/lightningnetwork/lnd/invoices"
27
        "github.com/lightningnetwork/lnd/lncfg"
28
        "github.com/lightningnetwork/lnd/lnrpc/autopilotrpc"
29
        "github.com/lightningnetwork/lnd/lnrpc/chainrpc"
30
        "github.com/lightningnetwork/lnd/lnrpc/devrpc"
31
        "github.com/lightningnetwork/lnd/lnrpc/invoicesrpc"
32
        "github.com/lightningnetwork/lnd/lnrpc/neutrinorpc"
33
        "github.com/lightningnetwork/lnd/lnrpc/peersrpc"
34
        "github.com/lightningnetwork/lnd/lnrpc/routerrpc"
35
        "github.com/lightningnetwork/lnd/lnrpc/signrpc"
36
        "github.com/lightningnetwork/lnd/lnrpc/verrpc"
37
        "github.com/lightningnetwork/lnd/lnrpc/walletrpc"
38
        "github.com/lightningnetwork/lnd/lnwallet"
39
        "github.com/lightningnetwork/lnd/lnwallet/btcwallet"
40
        "github.com/lightningnetwork/lnd/lnwallet/chancloser"
41
        "github.com/lightningnetwork/lnd/lnwallet/chanfunding"
42
        "github.com/lightningnetwork/lnd/lnwallet/rpcwallet"
43
        "github.com/lightningnetwork/lnd/monitoring"
44
        "github.com/lightningnetwork/lnd/netann"
45
        "github.com/lightningnetwork/lnd/peer"
46
        "github.com/lightningnetwork/lnd/peernotifier"
47
        "github.com/lightningnetwork/lnd/routing"
48
        "github.com/lightningnetwork/lnd/routing/blindedpath"
49
        "github.com/lightningnetwork/lnd/routing/localchans"
50
        "github.com/lightningnetwork/lnd/rpcperms"
51
        "github.com/lightningnetwork/lnd/signal"
52
        "github.com/lightningnetwork/lnd/sweep"
53
        "github.com/lightningnetwork/lnd/tor"
54
        "github.com/lightningnetwork/lnd/watchtower"
55
        "github.com/lightningnetwork/lnd/watchtower/wtclient"
56
)
57

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

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

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

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

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

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

110
                interceptor.RequestShutdown()
×
111
        }
112

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

120
// SetupLoggers initializes all package-global logger variables.
121
//
122
//nolint:lll
UNCOV
123
func SetupLoggers(root *build.SubLoggerManager, interceptor signal.Interceptor) {
×
UNCOV
124
        genLogger := genSubLogger(root, interceptor)
×
UNCOV
125

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

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

×
UNCOV
143
        // Some of the loggers declared in the main lnd package are also used
×
UNCOV
144
        // in sub packages.
×
UNCOV
145
        signal.UseLogger(ltndLog)
×
UNCOV
146
        autopilot.UseLogger(atplLog)
×
UNCOV
147

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

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

199
// AddSubLogger is a helper method to conveniently create and register the
200
// logger of one or more sub systems.
201
func AddSubLogger(root *build.SubLoggerManager, subsystem string,
UNCOV
202
        interceptor signal.Interceptor, useLoggers ...func(btclog.Logger)) {
×
UNCOV
203

×
UNCOV
204
        // genSubLogger will return a callback for creating a logger instance,
×
UNCOV
205
        // which we will give to the root logger.
×
UNCOV
206
        genLogger := genSubLogger(root, interceptor)
×
UNCOV
207

×
UNCOV
208
        // Create and register just a single logger to prevent them from
×
UNCOV
209
        // overwriting each other internally.
×
UNCOV
210
        logger := build.NewSubLogger(subsystem, genLogger)
×
UNCOV
211
        SetSubLogger(root, subsystem, logger, useLoggers...)
×
UNCOV
212
}
×
213

214
// SetSubLogger is a helper method to conveniently register the logger of a
215
// sub system.
216
func SetSubLogger(root *build.SubLoggerManager, subsystem string,
UNCOV
217
        logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
×
UNCOV
218

×
UNCOV
219
        root.RegisterSubLogger(subsystem, logger)
×
UNCOV
220
        for _, useLogger := range useLoggers {
×
UNCOV
221
                useLogger(logger)
×
UNCOV
222
        }
×
223
}
224

225
// AddV1SubLogger is a helper method to conveniently create and register the
226
// logger of one or more sub systems.
227
func AddV1SubLogger(root *build.SubLoggerManager, subsystem string,
UNCOV
228
        interceptor signal.Interceptor, useLoggers ...func(btclogv1.Logger)) {
×
UNCOV
229

×
UNCOV
230
        // genSubLogger will return a callback for creating a logger instance,
×
UNCOV
231
        // which we will give to the root logger.
×
UNCOV
232
        genLogger := genSubLogger(root, interceptor)
×
UNCOV
233

×
UNCOV
234
        // Create and register just a single logger to prevent them from
×
UNCOV
235
        // overwriting each other internally.
×
UNCOV
236
        logger := build.NewSubLogger(subsystem, genLogger)
×
UNCOV
237
        SetV1SubLogger(root, subsystem, logger, useLoggers...)
×
UNCOV
238
}
×
239

240
// SetV1SubLogger is a helper method to conveniently register the logger of a
241
// sub system. Note that the btclog v2 logger implements the btclog v1 logger
242
// which is why we can pass the v2 logger to the UseLogger call-backs that
243
// expect the v1 logger.
244
func SetV1SubLogger(root *build.SubLoggerManager, subsystem string,
UNCOV
245
        logger btclog.Logger, useLoggers ...func(btclogv1.Logger)) {
×
UNCOV
246

×
UNCOV
247
        root.RegisterSubLogger(subsystem, logger)
×
UNCOV
248
        for _, useLogger := range useLoggers {
×
UNCOV
249
                useLogger(logger)
×
UNCOV
250
        }
×
251
}
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