Repolode
Submit
grofers

grofers/legend

Builds and manages Grafana dashboards and prefilled alerts for common services and infrastructure, so you don't write queries by hand.

View on GitHub
Stars
238
Forks
20
Open issues
21
Last commit
10 months ago

What is it?

Legend generates Grafana dashboards for your services and infrastructure components, such as EC2, S3, Kubernetes cronjobs, databases, message queues and web frameworks. Each dashboard comes with prefilled metrics and basic alerts, so you don't need to build panels manually or write CloudWatch, Prometheus or InfluxDB queries by hand.

Dashboards are described by an input file that lists the components of a service. Legend is deployed in Kubernetes as a CRD and installed with Helm, and it can also be used as a command-line tool. Its metric layouts follow the USE and RED monitoring methods.

Supported metric sources include CloudWatch, InfluxDB, Loki and Prometheus. The built-in queries assume specific exporters, so other exporters may require query changes.

Key features

  • 01Generates Grafana dashboards with prefilled metrics for many common components
  • 02Sets up basic alerts with priority and service mapping automatically
  • 03Lets you customize alerts and panels
  • 04Runs as a Kubernetes CRD installed via Helm, or as a CLI
  • 05Works with CloudWatch, InfluxDB, Loki and Prometheus as metric stores

Use cases

  • Monitoring EC2, S3 or RDS resources without hand-building dashboards
  • Providing uniform dashboards for many microservices in a Kubernetes cluster
  • Tracking Kubernetes CronJobs and HPA behavior with ready-made panels

Quick start

  1. 1

    Add the Helm repo

    helm repo add legend https://grofers.github.io/legend
  2. 2

    Deploy the chart with your edited values file

    helm install legend legend/legend -f values.yaml

Things to know

  • The CLI can create dashboards but cannot delete them.
  • Pre-built queries assume specific exporters, so other exporters may require query changes.
  • Kubernetes deployment requires version 1.16 or newer.

Topics

#grafana#monitoring#observability#prometheus#kubernetes#alerting#grafana-dashboard#monitoring-tool

FAQ

What is legend?
Builds and manages Grafana dashboards and prefilled alerts for common services and infrastructure, so you don't write queries by hand. Legend generates Grafana dashboards for your services and infrastructure components, such as EC2, S3, Kubernetes cronjobs, databases, message queues and web frameworks. Each dashboard comes with prefilled metrics and basic alerts, so you don't need to build panels manually or write CloudWatch, Prometheus or InfluxDB queries by hand.
Is legend free to use? What license does it have?
legend is open source under the GPL-3.0 license. Check the license terms before using it in commercial products.
Is legend still maintained?
No commits for 6+ months. The last commit to legend was on Dec 11, 2025.
What can I use legend for?
Monitoring EC2, S3 or RDS resources without hand-building dashboards Providing uniform dashboards for many microservices in a Kubernetes cluster Tracking Kubernetes CronJobs and HPA behavior with ready-made panels
How do I install legend?
Add the Helm repo: helm repo add legend https://grofers.github.io/legend Deploy the chart with your edited values file: helm install legend legend/legend -f values.yaml
Where can I get legend?
The source code and installation instructions are on GitHub: https://github.com/grofers/legend

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects