Repolode
grofers

grofers/legend

Cria e gerencia dashboards do Grafana e alertas pré-configurados para serviços e infraestruturas comuns, sem precisar escrever queries manualmente.

Estrelas
238
Forks
20
Issues abertas
21
Último commit
há 10 meses

O que é?

Legend gera dashboards do Grafana para seus serviços e componentes de infraestrutura, como EC2, S3, cronjobs do Kubernetes, bancos de dados, filas de mensagens e frameworks web. Cada dashboard já vem com métricas e alertas básicos pré-configurados, então você não precisa criar painéis manualmente nem escrever queries de CloudWatch, Prometheus ou InfluxDB por conta própria.

Os dashboards são descritos em um arquivo de entrada que lista os componentes de um serviço. O Legend é implantado no Kubernetes como um CRD e instalado com Helm, e também pode ser usado como uma ferramenta de linha de comando. Os layouts das métricas seguem os métodos de monitoramento USE e RED.

As fontes de métricas compatíveis incluem CloudWatch, InfluxDB, Loki e Prometheus. As queries integradas pressupõem exporters específicos; portanto, outros exporters podem exigir alterações nas queries.

Recursos principais

  • 01Gera dashboards do Grafana com métricas pré-configuradas para vários componentes comuns
  • 02Configura automaticamente alertas básicos com prioridade e associação a serviços
  • 03Permite personalizar alertas e painéis
  • 04Funciona como um CRD do Kubernetes instalado via Helm ou como CLI
  • 05É compatível com CloudWatch, InfluxDB, Loki e Prometheus como repositórios de métricas

Casos de uso

  • Monitorar recursos EC2, S3 ou RDS sem montar dashboards manualmente
  • Oferecer dashboards padronizados para vários microsserviços em um cluster Kubernetes
  • Acompanhar CronJobs do Kubernetes e o comportamento do HPA com painéis prontos

Início rápido

  1. 1

    Adicione o repositório do Helm

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

    Implante o chart com o arquivo values editado

    helm install legend legend/legend -f values.yaml

Antes de usar

  • A CLI pode criar dashboards, mas não pode excluí-los.
  • As consultas pré-criadas pressupõem exporters específicos; portanto, talvez seja necessário alterá-las se você usar outros exporters.
  • A implantação no Kubernetes requer a versão 1.16 ou posterior.

Tópicos

Perguntas frequentes

O que é legend?
Cria e gerencia dashboards do Grafana e alertas pré-configurados para serviços e infraestruturas comuns, sem precisar escrever queries manualmente. Legend gera dashboards do Grafana para seus serviços e componentes de infraestrutura, como EC2, S3, cronjobs do Kubernetes, bancos de dados, filas de mensagens e frameworks web. Cada dashboard já vem com métricas e alertas básicos pré-configurados, então você não precisa criar painéis manualmente nem escrever queries de CloudWatch, Prometheus ou InfluxDB por conta própria.
legend é gratuito? Qual é a licença?
legend é open source sob a licença GPL-3.0. Confira os termos da licença antes de usá-lo em produtos comerciais.
legend ainda é mantido?
Sem commits há mais de 6 meses. O último commit de legend foi em 11 de dez. de 2025.
Para que posso usar legend?
Monitorar recursos EC2, S3 ou RDS sem montar dashboards manualmente Oferecer dashboards padronizados para vários microsserviços em um cluster Kubernetes Acompanhar CronJobs do Kubernetes e o comportamento do HPA com painéis prontos
Como instalar legend?
Adicione o repositório do Helm: helm repo add legend https://grofers.github.io/legend Implante o chart com o arquivo values editado: helm install legend legend/legend -f values.yaml
Onde consigo legend?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/grofers/legend

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados