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

lightningnetwork / lnd / 11219354629

07 Oct 2024 03:56PM UTC coverage: 58.585% (-0.2%) from 58.814%
11219354629

Pull #9147

github

ziggie1984
fixup! sqlc: migration up script for payments.
Pull Request #9147: [Part 1|3] Introduce SQL Payment schema into LND

130227 of 222287 relevant lines covered (58.59%)

29106.19 hits per line

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

98.06
/log.go
1
package lnd
2

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

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

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

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

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

95
// genSubLogger creates a logger for a subsystem. We provide an instance of
96
// a signal.Interceptor to be able to shutdown in the case of a critical error.
97
func genSubLogger(root *build.RotatingLogWriter,
98
        interceptor signal.Interceptor) func(string) btclog.Logger {
99

2✔
100
        // Create a shutdown function which will request shutdown from our
2✔
101
        // interceptor if it is listening.
2✔
102
        shutdown := func() {
2✔
103
                if !interceptor.Listening() {
4✔
104
                        return
2✔
105
                }
×
106

×
107
                interceptor.RequestShutdown()
108
        }
2✔
109

110
        // Return a function which will create a sublogger from our root
111
        // logger without shutdown fn.
112
        return func(tag string) btclog.Logger {
113
                return root.GenSubLogger(tag, shutdown)
4✔
114
        }
2✔
115
}
2✔
116

117
// SetupLoggers initializes all package-global logger variables.
118
func SetupLoggers(root *build.RotatingLogWriter, interceptor signal.Interceptor) {
119
        genLogger := genSubLogger(root, interceptor)
2✔
120

2✔
121
        // Now that we have the proper root logger, we can replace the
2✔
122
        // placeholder lnd package loggers.
2✔
123
        for _, l := range lndPkgLoggers {
2✔
124
                l.Logger = build.NewSubLogger(l.subsystem, genLogger)
4✔
125
                SetSubLogger(root, l.subsystem, l.Logger)
2✔
126
        }
2✔
127

2✔
128
        // Initialize loggers from packages outside of `lnd` first. The
129
        // packages below will overwrite the names of the loggers they import.
130
        // For instance, the logger in `neutrino.query` is overwritten by
131
        // `btcwallet.chain`, which is overwritten by `lnwallet`. To ensure the
132
        // overwriting works, we need to initialize the loggers here so they
133
        // can be overwritten later.
134
        AddSubLogger(root, "BTCN", interceptor, neutrino.UseLogger)
135
        AddSubLogger(root, "CMGR", interceptor, connmgr.UseLogger)
2✔
136

2✔
137
        // Some of the loggers declared in the main lnd package are also used
2✔
138
        // in sub packages.
2✔
139
        signal.UseLogger(ltndLog)
2✔
140
        autopilot.UseLogger(atplLog)
2✔
141

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

2✔
171
        AddSubLogger(root, routing.Subsystem, interceptor, routing.UseLogger)
2✔
172
        AddSubLogger(root, routerrpc.Subsystem, interceptor, routerrpc.UseLogger)
2✔
173
        AddSubLogger(root, chanfitness.Subsystem, interceptor, chanfitness.UseLogger)
2✔
174
        AddSubLogger(root, verrpc.Subsystem, interceptor, verrpc.UseLogger)
2✔
175
        AddSubLogger(root, healthcheck.Subsystem, interceptor, healthcheck.UseLogger)
2✔
176
        AddSubLogger(root, chainreg.Subsystem, interceptor, chainreg.UseLogger)
2✔
177
        AddSubLogger(root, chanacceptor.Subsystem, interceptor, chanacceptor.UseLogger)
2✔
178
        AddSubLogger(root, funding.Subsystem, interceptor, funding.UseLogger)
2✔
179
        AddSubLogger(root, cluster.Subsystem, interceptor, cluster.UseLogger)
2✔
180
        AddSubLogger(root, rpcperms.Subsystem, interceptor, rpcperms.UseLogger)
2✔
181
        AddSubLogger(root, tor.Subsystem, interceptor, tor.UseLogger)
2✔
182
        AddSubLogger(root, btcwallet.Subsystem, interceptor, btcwallet.UseLogger)
2✔
183
        AddSubLogger(root, rpcwallet.Subsystem, interceptor, rpcwallet.UseLogger)
2✔
184
        AddSubLogger(root, peersrpc.Subsystem, interceptor, peersrpc.UseLogger)
2✔
185
        AddSubLogger(root, graph.Subsystem, interceptor, graph.UseLogger)
2✔
186
        AddSubLogger(root, lncfg.Subsystem, interceptor, lncfg.UseLogger)
2✔
187
        AddSubLogger(
2✔
188
                root, blindedpath.Subsystem, interceptor, blindedpath.UseLogger,
2✔
189
        )
2✔
190
}
2✔
191

2✔
192
// AddSubLogger is a helper method to conveniently create and register the
193
// logger of one or more sub systems.
194
func AddSubLogger(root *build.RotatingLogWriter, subsystem string,
195
        interceptor signal.Interceptor, useLoggers ...func(btclog.Logger)) {
196

197
        // genSubLogger will return a callback for creating a logger instance,
2✔
198
        // which we will give to the root logger.
2✔
199
        genLogger := genSubLogger(root, interceptor)
2✔
200

2✔
201
        // Create and register just a single logger to prevent them from
2✔
202
        // overwriting each other internally.
2✔
203
        logger := build.NewSubLogger(subsystem, genLogger)
2✔
204
        SetSubLogger(root, subsystem, logger, useLoggers...)
2✔
205
}
2✔
206

2✔
207
// SetSubLogger is a helper method to conveniently register the logger of a sub
2✔
208
// system.
209
func SetSubLogger(root *build.RotatingLogWriter, subsystem string,
210
        logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
211

212
        root.RegisterSubLogger(subsystem, logger)
2✔
213
        for _, useLogger := range useLoggers {
2✔
214
                useLogger(logger)
2✔
215
        }
4✔
216
}
2✔
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