-
Notifications
You must be signed in to change notification settings - Fork 49
Add watchtower client number of backup metrics #120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
36a81ea
8b12764
7ce0fdf
e8f20e1
96f3471
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
package collectors | ||
|
||
import ( | ||
"context" | ||
"encoding/hex" | ||
"fmt" | ||
"strings" | ||
|
||
"github.com/lightninglabs/lndclient" | ||
"github.com/prometheus/client_golang/prometheus" | ||
) | ||
|
||
// WtClientCollector is a collector that will export watchtower client related | ||
// metrics. | ||
type WtClientCollector struct { | ||
lnd *lndclient.LndServices | ||
|
||
numBackupsDesc *prometheus.Desc | ||
numPendingBackupsDesc *prometheus.Desc | ||
|
||
// 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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: does not block sending. |
||
errChan chan<- error | ||
} | ||
|
||
// NewWalletCollector returns a new instance of the WalletCollector. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/NewWalletCollector/NewWtClientCollector |
||
func NewWtClientCollector(lnd *lndclient.LndServices, | ||
errChan chan<- error) *WtClientCollector { | ||
|
||
return &WtClientCollector{ | ||
lnd: lnd, | ||
numBackupsDesc: prometheus.NewDesc( | ||
"lnd_wt_client_num_backups", | ||
"watchtower client number of backups", | ||
[]string{ | ||
"tower_pubkey", | ||
}, nil, | ||
), | ||
numPendingBackupsDesc: prometheus.NewDesc( | ||
"lnd_wt_client_num_pending_backups", | ||
"watchtower client number of pending backups", | ||
[]string{ | ||
"tower_pubkey", | ||
}, nil, | ||
), | ||
|
||
errChan: errChan, | ||
} | ||
} | ||
|
||
// Describe sends the super-set of all possible descriptors of metrics | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. s/super-set/superset |
||
// collected by this Collector to the provided channel and returns once the | ||
// last descriptor has been sent. | ||
// | ||
// NOTE: Part of the prometheus.Collector interface. | ||
func (c *WtClientCollector) Describe(ch chan<- *prometheus.Desc) { | ||
ch <- c.numBackupsDesc | ||
ch <- c.numPendingBackupsDesc | ||
} | ||
|
||
// Collect is called by the Prometheus registry when collecting metrics. | ||
// | ||
// NOTE: Part of the prometheus.Collector interface. | ||
func (c *WtClientCollector) Collect(ch chan<- prometheus.Metric) { | ||
towers, err := c.lnd.WtClient.ListTowers( | ||
context.Background(), true, false, | ||
) | ||
if err != nil { | ||
Jontified marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// If the watchtower client is not active, we'll just return. | ||
if strings.Contains( | ||
err.Error(), "watchtower client not active", | ||
) { | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. nit: remove extra line |
||
watchtowerLogger.Debug("Watchtower client not active") | ||
return | ||
} | ||
|
||
c.errChan <- fmt.Errorf("WtClientCollector ListTowers failed "+ | ||
"with: %v", err) | ||
return | ||
} | ||
|
||
for _, tower := range towers { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. tower could be |
||
pubkey := hex.EncodeToString(tower.Pubkey) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. move |
||
var ( | ||
numBackups uint32 | ||
numPendingBackups uint32 | ||
) | ||
for _, sessionInfo := range tower.SessionInfo { | ||
for _, session := range sessionInfo.Sessions { | ||
numBackups += session.NumBackups | ||
numPendingBackups += session.NumPendingBackups | ||
} | ||
} | ||
|
||
ch <- prometheus.MustNewConstMetric( | ||
c.numBackupsDesc, prometheus.GaugeValue, | ||
float64(numBackups), pubkey, | ||
) | ||
ch <- prometheus.MustNewConstMetric( | ||
c.numPendingBackupsDesc, prometheus.GaugeValue, | ||
float64(numPendingBackups), pubkey, | ||
) | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: client-related