liquidmetal-dev / liquidmetal-dev/battery

Add example Grafana dashboard for existing Prometheus metrics

Open Beginner friendly
#58 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

priority/low
Dominant language
Go
Stars
1
Forks
0
Avg merge
2h 13m
Merged PRs (30d)
33

Description

`internal/metrics` already exposes a solid set of Prometheus metrics: claim/release counters, provision/hook/lease duration histograms, per-pool size/available/leased/provisioning/quarantined gauges (`PoolCollector`), and gRPC server metrics, all served on `/metrics`.

There's no documented example dashboard for operators to use these. Add an example Grafana dashboard (JSON, checked into `docs/` or similar) covering pool health, claim/lease latency, and hook failures, plus a short doc on how to import it.

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 metrics exposed from internal/metrics and the /metrics endpoint to map the existing claim, lease, pool, and gRPC measurements. Add the example Grafana dashboard under docs/ or a similar documented location, then write the import instructions; done means the dashboard covers pool health, claim/lease latency, and hook failures.

Written by the indexing model from the issue text.

Assessment

Tech stack
grafana, prometheus
Domain
documentation, observability
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.