mirror of
https://github.com/lightningnetwork/lnd.git
synced 2024-11-19 01:43:16 +01:00
214 lines
9.1 KiB
Go
214 lines
9.1 KiB
Go
package lnd
|
|
|
|
import (
|
|
"github.com/btcsuite/btcd/connmgr"
|
|
"github.com/btcsuite/btclog"
|
|
"github.com/lightninglabs/neutrino"
|
|
sphinx "github.com/lightningnetwork/lightning-onion"
|
|
"github.com/lightningnetwork/lnd/autopilot"
|
|
"github.com/lightningnetwork/lnd/build"
|
|
"github.com/lightningnetwork/lnd/chainntnfs"
|
|
"github.com/lightningnetwork/lnd/chainreg"
|
|
"github.com/lightningnetwork/lnd/chanacceptor"
|
|
"github.com/lightningnetwork/lnd/chanbackup"
|
|
"github.com/lightningnetwork/lnd/chanfitness"
|
|
"github.com/lightningnetwork/lnd/channeldb"
|
|
"github.com/lightningnetwork/lnd/channelnotifier"
|
|
"github.com/lightningnetwork/lnd/cluster"
|
|
"github.com/lightningnetwork/lnd/contractcourt"
|
|
"github.com/lightningnetwork/lnd/discovery"
|
|
"github.com/lightningnetwork/lnd/funding"
|
|
"github.com/lightningnetwork/lnd/healthcheck"
|
|
"github.com/lightningnetwork/lnd/htlcswitch"
|
|
"github.com/lightningnetwork/lnd/invoices"
|
|
"github.com/lightningnetwork/lnd/lnrpc/autopilotrpc"
|
|
"github.com/lightningnetwork/lnd/lnrpc/chainrpc"
|
|
"github.com/lightningnetwork/lnd/lnrpc/devrpc"
|
|
"github.com/lightningnetwork/lnd/lnrpc/invoicesrpc"
|
|
"github.com/lightningnetwork/lnd/lnrpc/routerrpc"
|
|
"github.com/lightningnetwork/lnd/lnrpc/signrpc"
|
|
"github.com/lightningnetwork/lnd/lnrpc/verrpc"
|
|
"github.com/lightningnetwork/lnd/lnrpc/walletrpc"
|
|
"github.com/lightningnetwork/lnd/lnwallet"
|
|
"github.com/lightningnetwork/lnd/lnwallet/btcwallet"
|
|
"github.com/lightningnetwork/lnd/lnwallet/chancloser"
|
|
"github.com/lightningnetwork/lnd/lnwallet/chanfunding"
|
|
"github.com/lightningnetwork/lnd/lnwallet/rpcwallet"
|
|
"github.com/lightningnetwork/lnd/monitoring"
|
|
"github.com/lightningnetwork/lnd/netann"
|
|
"github.com/lightningnetwork/lnd/peer"
|
|
"github.com/lightningnetwork/lnd/peernotifier"
|
|
"github.com/lightningnetwork/lnd/routing"
|
|
"github.com/lightningnetwork/lnd/rpcperms"
|
|
"github.com/lightningnetwork/lnd/signal"
|
|
"github.com/lightningnetwork/lnd/sweep"
|
|
"github.com/lightningnetwork/lnd/tor"
|
|
"github.com/lightningnetwork/lnd/watchtower"
|
|
"github.com/lightningnetwork/lnd/watchtower/wtclient"
|
|
)
|
|
|
|
// replaceableLogger is a thin wrapper around a logger that is used so the
|
|
// logger can be replaced easily without some black pointer magic.
|
|
type replaceableLogger struct {
|
|
btclog.Logger
|
|
subsystem string
|
|
}
|
|
|
|
// Loggers can not be used before the log rotator has been initialized with a
|
|
// log file. This must be performed early during application startup by
|
|
// calling InitLogRotator() on the main log writer instance in the config.
|
|
var (
|
|
// lndPkgLoggers is a list of all lnd package level loggers that are
|
|
// registered. They are tracked here so they can be replaced once the
|
|
// SetupLoggers function is called with the final root logger.
|
|
lndPkgLoggers []*replaceableLogger
|
|
|
|
// addLndPkgLogger is a helper function that creates a new replaceable
|
|
// main lnd package level logger and adds it to the list of loggers that
|
|
// are replaced again later, once the final root logger is ready.
|
|
addLndPkgLogger = func(subsystem string) *replaceableLogger {
|
|
l := &replaceableLogger{
|
|
Logger: build.NewSubLogger(subsystem, nil),
|
|
subsystem: subsystem,
|
|
}
|
|
lndPkgLoggers = append(lndPkgLoggers, l)
|
|
return l
|
|
}
|
|
|
|
// Loggers that need to be accessible from the lnd package can be placed
|
|
// here. Loggers that are only used in sub modules can be added directly
|
|
// by using the addSubLogger method. We declare all loggers so we never
|
|
// run into a nil reference if they are used early. But the SetupLoggers
|
|
// function should always be called as soon as possible to finish
|
|
// setting them up properly with a root logger.
|
|
ltndLog = addLndPkgLogger("LTND")
|
|
rpcsLog = addLndPkgLogger("RPCS")
|
|
srvrLog = addLndPkgLogger("SRVR")
|
|
atplLog = addLndPkgLogger("ATPL")
|
|
)
|
|
|
|
// genSubLogger creates a logger for a subsystem. We provide an instance of
|
|
// a signal.Interceptor to be able to shutdown in the case of a critical error.
|
|
func genSubLogger(root *build.RotatingLogWriter,
|
|
interceptor signal.Interceptor) func(string) btclog.Logger {
|
|
|
|
// Create a shutdown function which will request shutdown from our
|
|
// interceptor if it is listening.
|
|
shutdown := func() {
|
|
if !interceptor.Listening() {
|
|
return
|
|
}
|
|
|
|
interceptor.RequestShutdown()
|
|
}
|
|
|
|
// Return a function which will create a sublogger from our root
|
|
// logger without shutdown fn.
|
|
return func(tag string) btclog.Logger {
|
|
return root.GenSubLogger(tag, shutdown)
|
|
}
|
|
}
|
|
|
|
// SetupLoggers initializes all package-global logger variables.
|
|
func SetupLoggers(root *build.RotatingLogWriter, interceptor signal.Interceptor) {
|
|
genLogger := genSubLogger(root, interceptor)
|
|
|
|
// Now that we have the proper root logger, we can replace the
|
|
// placeholder lnd package loggers.
|
|
for _, l := range lndPkgLoggers {
|
|
l.Logger = build.NewSubLogger(l.subsystem, genLogger)
|
|
SetSubLogger(root, l.subsystem, l.Logger)
|
|
}
|
|
|
|
// Some of the loggers declared in the main lnd package are also used
|
|
// in sub packages.
|
|
signal.UseLogger(ltndLog)
|
|
autopilot.UseLogger(atplLog)
|
|
|
|
AddSubLogger(root, "LNWL", interceptor, lnwallet.UseLogger)
|
|
AddSubLogger(root, "DISC", interceptor, discovery.UseLogger)
|
|
AddSubLogger(root, "NTFN", interceptor, chainntnfs.UseLogger)
|
|
AddSubLogger(root, "CHDB", interceptor, channeldb.UseLogger)
|
|
AddSubLogger(root, "HSWC", interceptor, htlcswitch.UseLogger)
|
|
AddSubLogger(root, "CMGR", interceptor, connmgr.UseLogger)
|
|
AddSubLogger(root, "BTCN", interceptor, neutrino.UseLogger)
|
|
AddSubLogger(root, "CNCT", interceptor, contractcourt.UseLogger)
|
|
AddSubLogger(root, "UTXN", interceptor, contractcourt.UseNurseryLogger)
|
|
AddSubLogger(root, "BRAR", interceptor, contractcourt.UseBreachLogger)
|
|
AddSubLogger(root, "SPHX", interceptor, sphinx.UseLogger)
|
|
AddSubLogger(root, "SWPR", interceptor, sweep.UseLogger)
|
|
AddSubLogger(root, "SGNR", interceptor, signrpc.UseLogger)
|
|
AddSubLogger(root, "WLKT", interceptor, walletrpc.UseLogger)
|
|
AddSubLogger(root, "ARPC", interceptor, autopilotrpc.UseLogger)
|
|
AddSubLogger(root, "DRPC", interceptor, devrpc.UseLogger)
|
|
AddSubLogger(root, "INVC", interceptor, invoices.UseLogger)
|
|
AddSubLogger(root, "NANN", interceptor, netann.UseLogger)
|
|
AddSubLogger(root, "WTWR", interceptor, watchtower.UseLogger)
|
|
AddSubLogger(root, "NTFR", interceptor, chainrpc.UseLogger)
|
|
AddSubLogger(root, "IRPC", interceptor, invoicesrpc.UseLogger)
|
|
AddSubLogger(root, "CHNF", interceptor, channelnotifier.UseLogger)
|
|
AddSubLogger(root, "CHBU", interceptor, chanbackup.UseLogger)
|
|
AddSubLogger(root, "PROM", interceptor, monitoring.UseLogger)
|
|
AddSubLogger(root, "WTCL", interceptor, wtclient.UseLogger)
|
|
AddSubLogger(root, "PRNF", interceptor, peernotifier.UseLogger)
|
|
AddSubLogger(root, "CHFD", interceptor, chanfunding.UseLogger)
|
|
AddSubLogger(root, "PEER", interceptor, peer.UseLogger)
|
|
AddSubLogger(root, "CHCL", interceptor, chancloser.UseLogger)
|
|
|
|
AddSubLogger(root, routing.Subsystem, interceptor, routing.UseLogger)
|
|
AddSubLogger(root, routerrpc.Subsystem, interceptor, routerrpc.UseLogger)
|
|
AddSubLogger(root, chanfitness.Subsystem, interceptor, chanfitness.UseLogger)
|
|
AddSubLogger(root, verrpc.Subsystem, interceptor, verrpc.UseLogger)
|
|
AddSubLogger(root, healthcheck.Subsystem, interceptor, healthcheck.UseLogger)
|
|
AddSubLogger(root, chainreg.Subsystem, interceptor, chainreg.UseLogger)
|
|
AddSubLogger(root, chanacceptor.Subsystem, interceptor, chanacceptor.UseLogger)
|
|
AddSubLogger(root, funding.Subsystem, interceptor, funding.UseLogger)
|
|
AddSubLogger(root, cluster.Subsystem, interceptor, cluster.UseLogger)
|
|
AddSubLogger(root, rpcperms.Subsystem, interceptor, rpcperms.UseLogger)
|
|
AddSubLogger(root, tor.Subsystem, interceptor, tor.UseLogger)
|
|
AddSubLogger(root, btcwallet.Subsystem, interceptor, btcwallet.UseLogger)
|
|
AddSubLogger(root, rpcwallet.Subsystem, interceptor, rpcwallet.UseLogger)
|
|
}
|
|
|
|
// AddSubLogger is a helper method to conveniently create and register the
|
|
// logger of one or more sub systems.
|
|
func AddSubLogger(root *build.RotatingLogWriter, subsystem string,
|
|
interceptor signal.Interceptor, useLoggers ...func(btclog.Logger)) {
|
|
|
|
// genSubLogger will return a callback for creating a logger instance,
|
|
// which we will give to the root logger.
|
|
genLogger := genSubLogger(root, interceptor)
|
|
|
|
// Create and register just a single logger to prevent them from
|
|
// overwriting each other internally.
|
|
logger := build.NewSubLogger(subsystem, genLogger)
|
|
SetSubLogger(root, subsystem, logger, useLoggers...)
|
|
}
|
|
|
|
// SetSubLogger is a helper method to conveniently register the logger of a sub
|
|
// system.
|
|
func SetSubLogger(root *build.RotatingLogWriter, subsystem string,
|
|
logger btclog.Logger, useLoggers ...func(btclog.Logger)) {
|
|
|
|
root.RegisterSubLogger(subsystem, logger)
|
|
for _, useLogger := range useLoggers {
|
|
useLogger(logger)
|
|
}
|
|
}
|
|
|
|
// logClosure is used to provide a closure over expensive logging operations so
|
|
// don't have to be performed when the logging level doesn't warrant it.
|
|
type logClosure func() string
|
|
|
|
// String invokes the underlying function and returns the result.
|
|
func (c logClosure) String() string {
|
|
return c()
|
|
}
|
|
|
|
// newLogClosure returns a new closure over a function that returns a string
|
|
// which itself provides a Stringer interface so that it can be used with the
|
|
// logging system.
|
|
func newLogClosure(c func() string) logClosure {
|
|
return logClosure(c)
|
|
}
|