-
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
Open
Jontified
wants to merge
5
commits into
lightninglabs:master
Choose a base branch
from
Jontified:add-wt-metrics
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
563a08e
mod: upgrade lnd and lndclient dependencies
Jontified 13ae20f
collectors: fix spelling mistake in comment
Jontified 74c5a71
log: Add watchtower client logger
Jontified a419bdf
collectors: add wt_client_collector.go
Jontified 125bea3
collectors: instantiate wtclientcollector
Jontified File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
errChan chan<- error | ||
} | ||
|
||
// NewWalletCollector returns a new instance of the WalletCollector. | ||
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 | ||
// 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 { | ||
// If the watchtower client is not active, we'll just return. | ||
if strings.Contains( | ||
err.Error(), "watchtower client not active", | ||
) { | ||
|
||
watchtowerLogger.Debug("Watchtower client not active") | ||
return | ||
} | ||
|
||
c.errChan <- fmt.Errorf("WtClientCollector ListTowers failed "+ | ||
"with: %v", err) | ||
return | ||
} | ||
|
||
for _, tower := range towers { | ||
pubkey := hex.EncodeToString(tower.Pubkey) | ||
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, | ||
) | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.