Skip to content
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

feat: add chainName for clientExpiry #33

Merged
merged 3 commits into from
Jan 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# relayer_exporter

Prometheus exporter for ibc clients and wallet balance.
Returns metrics about clients expiration date.
Returns wallet balance for configured addresses.

## Configuration

Exporter needs config file in yaml format like following

```yaml
Expand Down Expand Up @@ -41,11 +43,16 @@ without having it defined.
For provided accounts it fetches wallet balances using endpoints defined in rpc list.

## Metrics

```
# HELP cosmos_ibc_client_expiry Returns light client expiry in unixtime.
# TYPE cosmos_ibc_client_expiry gauge
cosmos_ibc_client_expiry{client_id="07-tendermint-23",host_chain_id="archway-1",status="success",target_chain_id="agoric-3"} 1.698153269e+09
cosmos_ibc_client_expiry{client_id="07-tendermint-75",host_chain_id="agoric-3",status="success",target_chain_id="archway-1"} 1.698153256e+09
cosmos_ibc_client_expiry{client_id="07-tendermint-0",discord_ids="400514913505640451",dst_chain_id="cosmoshub-4",dst_chain_name="cosmoshub",src_chain_id="archway-1",src_chain_name="archway",status="success"} 1.706270594e+09
cosmos_ibc_client_expiry{client_id="07-tendermint-1152",discord_ids="400514913505640451",dst_chain_id="archway-1",dst_chain_name="archway",src_chain_id="cosmoshub-4",src_chain_name="cosmoshub",status="success"} 1.706270401e+09
# HELP cosmos_ibc_stuck_packets Returns stuck packets for a channel.
# TYPE cosmos_ibc_stuck_packets gauge
cosmos_ibc_stuck_packets{discord_ids="400514913505640451",dst_chain_id="archway-1",dst_chain_name="archway",dst_channel_id="channel-0",src_chain_id="cosmoshub-4",src_chain_name="cosmoshub",src_channel_id="channel-623",status="success"} 0
cosmos_ibc_stuck_packets{discord_ids="400514913505640451",dst_chain_id="cosmoshub-4",dst_chain_name="cosmoshub",dst_channel_id="channel-623",src_chain_id="archway-1",src_chain_name="archway",src_channel_id="channel-0",status="success"} 0
# HELP cosmos_wallet_balance Returns wallet balance for an address on a chain
# TYPE cosmos_wallet_balance gauge
cosmos_wallet_balance{account="archway1l2al7y78500h5akvgt8exwnkpmf2zmk8ky9ht3",chain_id="constantine-3",denom="aconst",status="success"} 4.64e+18
Expand Down
14 changes: 10 additions & 4 deletions pkg/collector/ibc_collector.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,11 @@ var (
clientExpiryMetricName,
"Returns light client expiry in unixtime.",
[]string{
"host_chain_id",
"src_chain_id",
"dst_chain_id",
"src_chain_name",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a bit inconsistency with host_chain_id and src_chain_name, maybe better to change also host_chain_id -> src_chain_id and target_chain_id -> dst_chain_id?
Also docs with metrics samples needs to be updated if we adding new labels.

"dst_chain_name",
"client_id",
"target_chain_id",
"discord_ids",
"status",
},
Expand Down Expand Up @@ -93,8 +95,10 @@ func (cc IBCCollector) Collect(ch chan<- prometheus.Metric) {
float64(ci.ChainAClientExpiration.Unix()),
[]string{
(*cc.RPCs)[path.Chain1.ChainName].ChainID,
path.Chain1.ClientID,
(*cc.RPCs)[path.Chain2.ChainName].ChainID,
path.Chain1.ChainName,
path.Chain2.ChainName,
path.Chain1.ClientID,
discordIDs,
status,
}...,
Expand All @@ -106,8 +110,10 @@ func (cc IBCCollector) Collect(ch chan<- prometheus.Metric) {
float64(ci.ChainBClientExpiration.Unix()),
[]string{
(*cc.RPCs)[path.Chain2.ChainName].ChainID,
path.Chain2.ClientID,
(*cc.RPCs)[path.Chain1.ChainName].ChainID,
path.Chain2.ChainName,
path.Chain1.ChainName,
path.Chain2.ClientID,
discordIDs,
status,
}...,
Expand Down