lightninglabs / lightninglabs/lndmon

Prometheus monitoring mixin

Open
#90 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

config dashboards enhancement
Dominant language
Go
Stars
160
Forks
53
PR merge metrics
No merged PRs in 30d

Description

The [sample dashboards](https://github.com/lightninglabs/lndmon/tree/master/grafana/provisioning/dashboards) are great, and they seem to be used as a starting point by the majority of lndmon users. Unfortunately the fully rendered dashboards are difficult to iterate on, especially in terms of contributing changes back to this repo.

One solution could be to package the dashboards and rules+alerts as a [Prometheus Monitoring Mixin](https://monitoring.mixins.dev/), which is designed to be reusable and extendable. Grafana dashboards can be generated by [grafonnet](https://grafana.github.io/grafonnet-lib/) for better modularity.

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 with the sample dashboards in grafana/provisioning/dashboards and read the Prometheus Monitoring Mixin and grafonnet references linked in the issue. Determine how the dashboards and rules+alerts should be packaged for reuse and extension. Done means this repository provides the monitoring mixin and a reproducible way to generate its Grafana dashboards.

Written by the indexing model from the issue text.

Assessment

Tech stack
grafana, prometheus
Domain
observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.