graphprotocol / graphprotocol/indexer-rs

Human Readable Indexer Metrics

Open
#545 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

pgk:service pgk:tap-agent size:medium type:feature
Dominant language
Rust
Stars
31
Forks
29
Avg merge
13h 9m
Merged PRs (30d)
13

Description

Feature Request: Human-Readable Indexer Metrics

Problem Statement

Currently, the metrics provided for indexers display raw Deployment IDs. This makes it difficult to quickly identify which subgraph is responsible for a given metric.

Current Workflow

1.	Check indexer metrics.
2.	Copy/Paste the Deployment ID into an explorer or third-party tools.
3.	Manually identify the associated subgraph.

This process is cumbersome and time-consuming, especially when managing multiple deployments.

Proposed Solution

Enhance indexer metrics by including the human-readable display name of the subgraph alongside the Deployment ID. This would make the metrics more intuitive and eliminate the need for external lookups.

Data Source

The subgraph display name can be fetched using the following query on the network subgraph:

{
  allocations {
    subgraphDeployment {
      versions {
        subgraph {
          metadata {
            displayName
          }
        }
      }
    }
  }
}

Benefits

•	Simplifies workflow for indexers.
•	Reduces reliance on external tools to identify subgraphs.
•	Improves metric visibility and debugging efficiency.

Implementation Considerations

•	Extend the metric output to include the displayName from the network subgraph query.
•	Ensure backward compatibility so existing workflows relying on raw Deployment IDs remain unaffected.

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 locating the indexer metrics output and the network subgraph query described in the issue. Trace how Deployment IDs are emitted, then determine how the subgraph displayName can be included while preserving the existing IDs; done means metrics identify subgraphs without breaking current consumers.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend, observability
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.