Update guide with new metric

informalsystems · Nov 24, 2023 · bf6cda6 · bf6cda6
1 parent bf8d3da
commit bf6cda6
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/crates/relayer/src/foreign_client.rs b/crates/relayer/src/foreign_client.rs
@@ -1146,7 +1146,6 @@ impl<DstChain: ChainHandle, SrcChain: ChainHandle> ForeignClient<DstChain, SrcCh
 
             // If the client already stores a consensus state for the target height,
             // there is no need to update the client
-
             telemetry!(
                 client_updates_skipped,
                 &self.src_chain.id(),

diff --git a/guide/src/documentation/telemetry/integration.md b/guide/src/documentation/telemetry/integration.md
@@ -34,6 +34,10 @@ backlog_size{chain="ibc-1",channel="channel-0",counterparty="ibc-0",port="transf
 # TYPE client_updates_submitted_total counter
 client_updates_submitted_total{client="07-tendermint-0",dst_chain="ibc-0",service_name="unknown_service",src_chain="ibc-1",otel_scope_name="hermes",otel_scope_version=""} 2
 client_updates_submitted_total{client="07-tendermint-0",dst_chain="ibc-1",service_name="unknown_service",src_chain="ibc-0",otel_scope_name="hermes",otel_scope_version=""} 2
+# HELP client_updates_skipped_total Number of client update messages skipped
+# TYPE client_updates_skipped_total counter
+client_updates_skipped_total{client="07-tendermint-0",dst_chain="ibc-0",service_name="unknown_service",src_chain="ibc-1",otel_scope_name="hermes",otel_scope_version=""} 0
+client_updates_skipped_total{client="07-tendermint-0",dst_chain="ibc-1",service_name="unknown_service",src_chain="ibc-0",otel_scope_name="hermes",otel_scope_version=""} 0
 # HELP ics29_period_fees Amount of ICS29 fees rewarded over the past 7 days
 # TYPE ics29_period_fees gauge
 ics29_period_fees{chain="ibc-0",denom="stake",receiver="cosmos1j6z6q9d2gf2suav88z8g3zf726vz9ehg4hkr8x",service_name="unknown_service",otel_scope_name="hermes",otel_scope_version=""} 0

diff --git a/guide/src/documentation/telemetry/operators.md b/guide/src/documentation/telemetry/operators.md
@@ -34,6 +34,7 @@ The metrics in the table below are design to answer this question on multiple di
 | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | -------------------------- |
 | `workers`                  | Number of workers per type                                                                                                                                                  | `i64` UpDownCounter | Corresponding workers enabled |
 | `client_updates_submitted_total` | Number of client update messages submitted, per sending chain, receiving chain and client                                                                                                            | `u64` Counter       | Client, Connection, Channel or Packet workers enabled |
+| `client_updates_skipped_total` | Number of client update messages skipped because the consensus state already exists, per sending chain, receiving chain and client                                                                                                            | `u64` Counter       | Client, Connection, Channel or Packet workers enabled |
 | `wallet_balance`           | The balance of each wallet Hermes uses per chain                                                                                                                            | `f64` ValueRecorder | None                       |
 | `tx_latency_submitted`     | Latency for all transactions submitted to a chain | `u64` ValueRecorder | None                       |
 | `messages_submitted_total` | Number of messages submitted to a specific chain                                                                                                                            | `u64` Counter       | None                       |