Skip to content

chore: track total metric for mesh inclusion/churn events #466

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

chore: track total metric for mesh inclusion/churn events #466

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3196b3c
chore: track total metric for mesh inclusion/churn events
twoeths Aug 30, 2023
5d06d58
chore: fix metric descriptions
twoeths Aug 30, 2023
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
12 changes: 12 additions & 0 deletions src/metrics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,11 @@ export function getMetrics(
help: 'Number of times we include peers in a topic mesh for random reasons',
labelNames: ['topic']
}),
meshPeerInclusionEventsTotal: register.gauge<{ topic: TopicLabel }>({
Copy link
Member

Choose a reason for hiding this comment

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

maybe we can rename these metrics. I think "inclusion/churn" is a bit more confusing than "add/remove"

name: 'gossipsub_mesh_peer_inclusion_events_total',
help: 'Number of times we include peers in a topic mesh for all reasons',
labelNames: ['topic']
}),
meshPeerInclusionEventsSubscribed: register.gauge<{ topic: TopicLabel }>({
name: 'gossipsub_mesh_peer_inclusion_events_subscribed_total',
help: 'Number of times we include peers in a topic mesh for subscribed reasons',
Expand Down Expand Up @@ -240,6 +245,11 @@ export function getMetrics(
}),
/** Number of times we remove peers in a topic mesh for different reasons.
* = rust-libp2p `mesh_peer_churn_events` */
meshPeerChurnEventsTotal: register.gauge<{ topic: TopicLabel }>({
name: 'gossipsub_peer_churn_events_total',
help: 'Number of times we remove peers in a topic mesh for all reasons',
labelNames: ['topic']
}),
meshPeerChurnEventsDisconnected: register.gauge<{ topic: TopicLabel }>({
name: 'gossipsub_peer_churn_events_disconnected_total',
help: 'Number of times we remove peers in a topic mesh for disconnected reasons',
Expand Down Expand Up @@ -700,6 +710,7 @@ export function getMetrics(
/** Register the inclusion of peers in our mesh due to some reason. */
onAddToMesh(topicStr: TopicStr, reason: InclusionReason, count: number): void {
const topic = this.toTopic(topicStr)
this.meshPeerInclusionEventsTotal.inc({ topic }, count)
switch (reason) {
case InclusionReason.Fanout:
this.meshPeerInclusionEventsFanout.inc({ topic }, count)
Expand Down Expand Up @@ -732,6 +743,7 @@ export function getMetrics(
// - on_disconnect() Churn::Ds
onRemoveFromMesh(topicStr: TopicStr, reason: ChurnReason, count: number): void {
const topic = this.toTopic(topicStr)
this.meshPeerChurnEventsTotal.inc({ topic }, count)
switch (reason) {
case ChurnReason.Dc:
this.meshPeerChurnEventsDisconnected.inc({ topic }, count)
Expand Down