Repolode
grofers

grofers/legend

よく使われるサービスやインフラ向けのGrafanaダッシュボードと初期設定済みアラートを作成・管理し、クエリを手書きする手間を省きます。

スター
238
フォーク
20
未解決の Issue
21
最終コミット
10 か月前

これは何?

Legendは、EC2、S3、Kubernetes cronjobs、データベース、メッセージキュー、Webフレームワークなどのサービスやインフラコンポーネント向けに、Grafanaダッシュボードを生成します。各ダッシュボードにはメトリクスと基本的なアラートがあらかじめ設定されているため、パネルを手動で作成したり、CloudWatch、Prometheus、InfluxDBのクエリを手書きしたりする必要はありません。

ダッシュボードは、サービスのコンポーネントを列挙した入力ファイルで定義します。LegendはKubernetes上にCRDとしてデプロイし、Helmでインストールできます。また、コマンドラインツールとしても使用できます。メトリクスのレイアウトには、USEとREDの監視手法が採用されています。

対応するメトリクスソースはCloudWatch、InfluxDB、Loki、Prometheusです。組み込みクエリは特定のexporterを前提としているため、別のexporterを使う場合はクエリの変更が必要になることがあります。

主な機能

  • 01よく使われる多くのコンポーネント向けに、メトリクス設定済みのGrafanaダッシュボードを生成
  • 02優先度とサービスの紐付けを含む基本的なアラートを自動設定
  • 03アラートとパネルをカスタマイズ可能
  • 04HelmでインストールするKubernetes CRD、またはCLIとして実行可能
  • 05メトリクスストアとしてCloudWatch、InfluxDB、Loki、Prometheusに対応

ユースケース

  • ダッシュボードを手作業で作成せずに、EC2、S3、RDSリソースを監視
  • Kubernetesクラスター内の多数のマイクロサービスに統一されたダッシュボードを提供
  • 既成のパネルを使ってKubernetes CronJobsやHPAの挙動を追跡

クイックスタート

  1. 1

    Helm リポジトリを追加する

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

    編集した values ファイルを使ってチャートをデプロイする

    helm install legend legend/legend -f values.yaml

使う前に知っておきたいこと

  • CLI ではダッシュボードを作成できますが、削除はできません。
  • 用意済みのクエリは特定の exporter を前提としているため、ほかの exporter を使う場合はクエリの変更が必要になることがあります。
  • Kubernetes のデプロイにはバージョン 1.16 以降が必要です。

トピック

よくある質問

legend とは?
よく使われるサービスやインフラ向けのGrafanaダッシュボードと初期設定済みアラートを作成・管理し、クエリを手書きする手間を省きます。 Legendは、EC2、S3、Kubernetes cronjobs、データベース、メッセージキュー、Webフレームワークなどのサービスやインフラコンポーネント向けに、Grafanaダッシュボードを生成します。各ダッシュボードにはメトリクスと基本的なアラートがあらかじめ設定されているため、パネルを手動で作成したり、CloudWatch、Prometheus、InfluxDBのクエリを手書きしたりする必要はありません。
legend は無料で使えますか?ライセンスは?
legend は GPL-3.0 ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
legend は今もメンテナンスされていますか?
半年以上コミットなし。legend の最終コミットは 2025年12月11日 です。
legend は何に使えますか?
ダッシュボードを手作業で作成せずに、EC2、S3、RDSリソースを監視 Kubernetesクラスター内の多数のマイクロサービスに統一されたダッシュボードを提供 既成のパネルを使ってKubernetes CronJobsやHPAの挙動を追跡
legend のインストール方法は?
Helm リポジトリを追加する: helm repo add legend https://grofers.github.io/legend 編集した values ファイルを使ってチャートをデプロイする: helm install legend legend/legend -f values.yaml
legend はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/grofers/legend

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト