wallet: add keyCount metric

Signed-off-by: Gustavo Chain <[email protected]>

Author: qustavo

collectors/errors.go

@@ -0,0 +1,13 @@
+package collectors
+
+import (
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
+)
+
+// isUnimplemented returns true if the given error is a grpc unimplemented
+// error.
+func isUnimplemented(err error) bool {
+	code := status.Code(err)
+	return code == codes.Unimplemented
+}

collectors/wallet_collector.go

@@ -30,6 +30,12 @@ type WalletCollector struct {
 	confirmedBalanceDesc   *prometheus.Desc
 	unconfirmedBalanceDesc *prometheus.Desc
 
+	// We'll use two gauges to keep track of both internal and external key
+	// count.
+	internalKeyCountDesc *prometheus.Desc
+	externalKeyCountDesc *prometheus.Desc
+
+	// We'll use two gauges to keep track of the accounts internal and external
 	// errChan is a channel that we send any errors that we encounter into.
 	// This channel should be buffered so that it does not block sends.
 	errChan chan<- error
@@ -39,6 +45,8 @@ type WalletCollector struct {
 func NewWalletCollector(lnd *lndclient.LndServices,
 	errChan chan<- error) *WalletCollector {
 
+	// these labels are specific for key_count metrics
+	keyCountLabels := []string{"account_name", "address_type"}
 	return &WalletCollector{
 		lnd: lnd,
 		numUtxosConfDesc: prometheus.NewDesc(
@@ -71,6 +79,18 @@ func NewWalletCollector(lnd *lndclient.LndServices,
 			"unconfirmed wallet balance",
 			nil, nil,
 		),
+		internalKeyCountDesc: prometheus.NewDesc(
+			"lnd_wallet_key_count_internal",
+			"internal key count",
+			keyCountLabels, nil,
+		),
+
+		externalKeyCountDesc: prometheus.NewDesc(
+			"lnd_wallet_key_count_external",
+			"external key count",
+			keyCountLabels, nil,
+		),
+
 		errChan: errChan,
 	}
 }
@@ -88,6 +108,8 @@ func (u *WalletCollector) Describe(ch chan<- *prometheus.Desc) {
 	ch <- u.avgUtxoSizeDesc
 	ch <- u.confirmedBalanceDesc
 	ch <- u.unconfirmedBalanceDesc
+	ch <- u.internalKeyCountDesc
+	ch <- u.externalKeyCountDesc
 }
 
 // Collect is called by the Prometheus registry when collecting metrics.
@@ -169,4 +191,25 @@ func (u *WalletCollector) Collect(ch chan<- prometheus.Metric) {
 		u.unconfirmedBalanceDesc, prometheus.GaugeValue,
 		float64(walletBal.Unconfirmed),
 	)
+
+	accounts, err := u.lnd.WalletKit.ListAccounts(context.Background(), "", 0)
+	// Nodes prior to version 0.13.0 don't implement ListAccounts and will
+	// return a Unimplemented error.
+	if err != nil && !isUnimplemented(err) {
+		u.errChan <- fmt.Errorf("WalletCollector ListAccounts"+
+			"failed with: %v", err)
+		return
+	}
+	for _, account := range accounts {
+		ch <- prometheus.MustNewConstMetric(
+			u.internalKeyCountDesc, prometheus.GaugeValue,
+			float64(account.InternalKeyCount),
+			account.GetName(), account.GetAddressType().String(),
+		)
+		ch <- prometheus.MustNewConstMetric(
+			u.externalKeyCountDesc, prometheus.GaugeValue,
+			float64(account.ExternalKeyCount),
+			account.GetName(), account.GetAddressType().String(),
+		)
+	}
 }

go.mod

@@ -3,16 +3,14 @@ module github.com/lightninglabs/lndmon
 require (
 	github.com/btcsuite/btclog v0.0.0-20170628155309-84c8d2346e9f
 	github.com/btcsuite/btcutil v1.0.3-0.20210527170813-e2ba6805a890
-	github.com/coreos/bbolt v1.3.3 // indirect
-	github.com/coreos/etcd v3.3.22+incompatible // indirect
 	github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf // indirect
 	github.com/jessevdk/go-flags v1.4.0
 	github.com/jrick/logrotate v1.0.0
 	github.com/lightninglabs/lndclient v1.0.1-0.20211001112454-5bb2b557e003
 	github.com/lightningnetwork/lnd v0.13.0-beta.rc5.0.20210920062527-d9f0f07142ea
 	github.com/prometheus/client_golang v1.11.0
 	github.com/stretchr/testify v1.7.0
-	go.uber.org/tools v0.0.0-20190618225709-2cfd321de3ee // indirect
+	google.golang.org/grpc v1.38.0
 )
 
 go 1.15