libp2p / libp2p/go-libp2p-pubsub

feature: Metrics for GossipSub

Open
#534 7 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
364
Forks
221
PR merge metrics
No merged PRs in 30d

Description

Metrics such as:
* Peer prune rate per topic. How often a peer is pruning us per topic.
* Peer counts per topic. How many peers do we have per topic.
* Peer churn rate per topic. The sum of grafts+prunes per topic.

We should also include some grafana dashboards.

This should help node operators identify when their node is running into issues, or when GossipSub is limping along but still working.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the GossipSub implementation and locating any existing metrics conventions in the repository. Use the issue’s three requested per-topic measurements to define the metric scope, then review the Grafana dashboard requirement; the work is done when operators can inspect prune rate, peer counts, and churn per topic.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, grafana
Domain
data-visualization, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
28/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.