Skip to content

fix: use counter instead of gauge for metrics that only increase over time #3355

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.

Sign up for GitHub

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
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

fix: use counter instead of gauge for metrics that only increase over time #3355

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61e32b6
fix: use counter for metrics that only increase over time
chaitanyaprem Apr 2, 2025
e565cb9
fix nph error
chaitanyaprem Jun 16, 2025
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
2 changes: 1 addition & 1 deletion waku/discovery/waku_discv5.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import ../node/peer_manager/peer_manager, ../waku_core, ../waku_enr
export protocol, waku_enr

declarePublicGauge waku_discv5_discovered, "number of nodes discovered"
declarePublicGauge waku_discv5_errors, "number of waku discv5 errors", ["type"]
declarePublicCounter waku_discv5_errors, "number of waku discv5 errors", ["type"]

logScope:
topics = "waku discv5"
Expand Down
2 changes: 1 addition & 1 deletion waku/discovery/waku_dnsdisc.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import ../waku_core
export client

declarePublicGauge waku_dnsdisc_discovered, "number of nodes discovered"
declarePublicGauge waku_dnsdisc_errors, "number of waku dnsdisc errors", ["type"]
declarePublicCounter waku_dnsdisc_errors, "number of waku dnsdisc errors", ["type"]

logScope:
topics = "waku dnsdisc"
Expand Down
2 changes: 1 addition & 1 deletion waku/node/peer_manager/peer_manager.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ declareCounter waku_peers_dials, "Number of peer dials", ["outcome"]
# TODO: Populate from PeerStore.Source when ready
declarePublicCounter waku_node_conns_initiated,
"Number of connections initiated", ["source"]
declarePublicGauge waku_peers_errors, "Number of peer manager errors", ["type"]
declarePublicCounter waku_peers_errors, "Number of peer manager errors", ["type"]
declarePublicGauge waku_connected_peers,
"Number of physical connections per direction and protocol",
labels = ["direction", "protocol"]
Expand Down
2 changes: 1 addition & 1 deletion waku/node/waku_node.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ declarePublicHistogram waku_histogram_message_size,

declarePublicGauge waku_version,
"Waku version info (in git describe format)", ["version"]
declarePublicGauge waku_node_errors, "number of wakunode errors", ["type"]
declarePublicCounter waku_node_errors, "number of wakunode errors", ["type"]
declarePublicGauge waku_lightpush_peers, "number of lightpush peers"
declarePublicGauge waku_filter_peers, "number of filter peers"
declarePublicGauge waku_store_peers, "number of store peers"
Expand Down
4 changes: 2 additions & 2 deletions waku/waku_archive/archive_metrics.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
import metrics

declarePublicGauge waku_archive_messages, "number of historical messages", ["type"]
declarePublicGauge waku_archive_errors, "number of store protocol errors", ["type"]
declarePublicGauge waku_archive_queries, "number of store queries received"
declarePublicCounter waku_archive_errors, "number of store protocol errors", ["type"]
declarePublicCounter waku_archive_queries, "number of store queries received"
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not used so I think it can be removed

declarePublicHistogram waku_archive_insert_duration_seconds,
"message insertion duration"
declarePublicHistogram waku_archive_query_duration_seconds, "history query duration"
Expand Down
4 changes: 2 additions & 2 deletions waku/waku_archive_legacy/archive_metrics.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import metrics

declarePublicGauge waku_legacy_archive_messages,
"number of historical messages", ["type"]
declarePublicGauge waku_legacy_archive_errors,
declarePublicCounter waku_legacy_archive_errors,
"number of store protocol errors", ["type"]
declarePublicGauge waku_legacy_archive_queries, "number of store queries received"
declarePublicCounter waku_legacy_archive_queries, "number of store queries received"
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is not used either and can also be removed

declarePublicHistogram waku_legacy_archive_insert_duration_seconds,
"message insertion duration"
declarePublicHistogram waku_legacy_archive_query_duration_seconds,
Expand Down
4 changes: 2 additions & 2 deletions waku/waku_filter_v2/protocol_metrics.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import metrics

export metrics

declarePublicGauge waku_filter_errors, "number of filter protocol errors", ["type"]
declarePublicGauge waku_filter_requests,
declarePublicCounter waku_filter_errors, "number of filter protocol errors", ["type"]
declarePublicCounter waku_filter_requests,
"number of filter subscribe requests received", ["type"]
declarePublicGauge waku_filter_subscriptions, "number of subscribed filter clients"
declarePublicHistogram waku_filter_request_duration_seconds,
Expand Down
4 changes: 2 additions & 2 deletions waku/waku_lightpush/protocol_metrics.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

import metrics

declarePublicGauge waku_lightpush_v3_errors,
declarePublicCounter waku_lightpush_v3_errors,
"number of lightpush protocol errors", ["type"]
declarePublicGauge waku_lightpush_v3_messages,
declarePublicCounter waku_lightpush_v3_messages,
"number of lightpush messages received", ["type"]

# Error types (metric label values)
Expand Down
4 changes: 2 additions & 2 deletions waku/waku_lightpush_legacy/protocol_metrics.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

import metrics

declarePublicGauge waku_lightpush_errors,
declarePublicCounter waku_lightpush_errors,
"number of lightpush protocol errors", ["type"]
declarePublicGauge waku_lightpush_messages,
declarePublicCounter waku_lightpush_messages,
"number of lightpush messages received", ["type"]

# Error types (metric label values)
Expand Down
4 changes: 2 additions & 2 deletions waku/waku_store/protocol_metrics.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

import metrics

declarePublicGauge waku_store_errors, "number of store protocol errors", ["type"]
declarePublicGauge waku_store_queries, "number of store queries received"
declarePublicCounter waku_store_errors, "number of store protocol errors", ["type"]
declarePublicCounter waku_store_queries, "number of store queries received"

## "query-db-time" phase considers the time when node performs the query to the database.
## "send-store-resp-time" phase is the time when node writes the store response to the store-client.
Expand Down
5 changes: 3 additions & 2 deletions waku/waku_store_legacy/protocol_metrics.nim
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

import metrics

declarePublicGauge waku_legacy_store_errors,
declarePublicCounter waku_legacy_store_errors,
"number of legacy store protocol errors", ["type"]
declarePublicGauge waku_legacy_store_queries, "number of legacy store queries received"
declarePublicCounter waku_legacy_store_queries,
"number of legacy store queries received"

## "query-db-time" phase considers the time when node performs the query to the database.
## "send-store-resp-time" phase is the time when node writes the store response to the store-client.
Expand Down
Loading