Skip to content

feat: Add metrics dash #689

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

Merged
mergify merged 12 commits into from
Oct 16, 2025
Merged

feat: Add metrics dash #689

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
27fa14e
Add metrics dash
AgeManning Oct 15, 2025
92fa6d4
Slight doc update
AgeManning Oct 15, 2025
ca06d03
Update image
AgeManning Oct 15, 2025
37b3006
Actually add the image
AgeManning Oct 15, 2025
be66e3d
Display the image
AgeManning Oct 15, 2025
71df070
Update image
AgeManning Oct 15, 2025
e2adfe2
Update image again
AgeManning Oct 15, 2025
1fcf566
Update metrics/README.md
AgeManning Oct 15, 2025
f752f57
Update metrics/README.md
AgeManning Oct 15, 2025
5e35560
Thanks, Claude
AgeManning Oct 15, 2025
1cd658b
Spellcheck
AgeManning Oct 15, 2025
500ac89
Merge branch 'unstable' into metrics
AgeManning Oct 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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ Anchor maintains two permanent branches:
- [`unstable`][unstable]: Used for development, contains the latest PRs.
- Developers should base their PRs on this branch.

## Metrics

Anchor has a suite of metrics that can be accessed via prometheus and grafana. See the
Copy link

@claude-code-actions-sigp claude-code-actions-sigp bot Oct 15, 2025

Choose a reason for hiding this comment

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

Good addition! This properly directs users to the metrics documentation. Consider adding a brief one-line description of what metrics are available (e.g., "Anchor exposes Prometheus metrics for monitoring node health, consensus performance, and network statistics.") to give users context before they click through.

[metrics](https://github.com/sigp/anchor/tree/stable/metrics) page for more information and how to
Copy link

@claude-code-actions-sigp claude-code-actions-sigp bot Oct 15, 2025

Choose a reason for hiding this comment

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

📝 Minor: Link may break

This link points to stable/metrics which might not contain this new dashboard until this PR is merged to stable. Consider if you need to update this link or add a note about availability.

Copy link

@claude-code-actions-sigp claude-code-actions-sigp bot Oct 15, 2025

Choose a reason for hiding this comment

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

Consider: Branch-agnostic link

This link points to the stable branch, but developers working on unstable (as recommended above) might expect to see their branch's version of the metrics documentation.

Consider either:

  1. Using a branch-agnostic GitHub link (without /tree/stable/)
  2. Or using a relative link: [metrics](./metrics) (though this only works when viewing from the repo root)
  3. Or adding a note that the link always points to stable documentation

Not a blocker, but something to consider for user experience.

setup.

## Contributing

Anchor welcomes contributors.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/pages/metrics.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Once docker is installed, a metrics server can be run locally via the following
- Password: `changeme`
1. Import some dashboards from the `metrics/dashboards` directory in this repo:
- In the Grafana UI, go to `Dashboards` -> `Manage` -> `Import` -> `Upload .json file`.
- The `Summary.json` dashboard is a good place to start.
- The `anchor-dash.json` dashboard is a good place to start.
Copy link

@claude-code-actions-sigp claude-code-actions-sigp bot Oct 15, 2025

Choose a reason for hiding this comment

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

✅ Correct update - properly references the new anchor-dash.json dashboard. However, metrics/README.md:24 still references the old Summary.json and should be updated to match.


## Dashboards

Expand Down
4 changes: 2 additions & 2 deletions metrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Anchor Metrics

[![metrics.png](https://i.postimg.cc/Jh7rxtgp/metrics.png)](https://postimg.cc/4YMRN4Xc)
![](img/metrics.png)
Copy link

@claude-code-actions-sigp claude-code-actions-sigp bot Oct 15, 2025

Choose a reason for hiding this comment

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

Nice improvement! Moving from external image hosting (postimg.cc) to local repo storage (img/metrics.png) improves reliability and security.

Copy link

@claude-code-actions-sigp claude-code-actions-sigp bot Oct 15, 2025

Choose a reason for hiding this comment

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

✅ Excellent improvement! Switching from an external image host (postimg.cc) to a local image file improves:

  • Reliability (no dependency on external services)
  • Privacy (no external requests when viewing README)
  • Control (image can't be modified or removed by third parties)
  • Performance (served directly from GitHub)


Here we provides a `docker-compose` environment which scrapes metrics from Anchor
Here we provide a `docker-compose` environment which scrapes metrics from Anchor
Copy link

@claude-code-actions-sigp claude-code-actions-sigp bot Oct 15, 2025

Choose a reason for hiding this comment

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

✅ Good fix! The grammar correction from "Here we provides" to "Here we provide" is correct.

nodes using Prometheus and presents them in a browser-based Grafana GUI.

For in-depth details on running metrics, please see the [anchor
Expand Down
Loading
Loading