ラベルと注釈
このドキュメントのトピックは、Grafana バージョン 9.x をサポートする Grafana ワークスペース向けです。
Grafana バージョン 10.x をサポートする Grafana ワークスペースについては、「Grafana バージョン 10 での作業」を参照してください。
Grafana バージョン 8.x をサポートする Grafana ワークスペースについては、「Grafana バージョン 8 での作業」を参照してください。
ラベルと注釈には、アラートに関する情報が含まれています。ラベルと注釈はどちらも同じ構造であり、名前付き値のセットですが、用途は異なります。ラベルまたは同等の注釈の例は、alertname="test"
である場合があります。
ラベルと注釈の主な違いは、ラベルはアラートを他のすべてのアラートと区別するために使用され、注釈は既存のアラートに追加情報を追加するために使用されるという点です。
例えば、2 つの高 CPU アラートを考えてみましょう。1 つは server1
用、もう 1 つは server2
用です。このような例では、最初のアラートに server="server1"
というラベルがあり、2 番目のアラートに server="server2"
というラベルがある、server
というラベルがある場合があります。ただし、 server1
や 75%
がサーバーの名前と CPU 使用率に置き換えられる "The CPU usage for server1 is above 75%."
などの各アラートに説明を追加することもできます (これを行う方法については、ラベルと注釈のテンプレート作成 のドキュメントを参照してください)。このような説明は、注釈としてより適しています。
ラベル
ラベルには、アラートを識別する情報が含まれます。ラベルの例は server=server1
です。各アラートには複数のラベルを含めることができ、アラートのラベルの完全なセットはラベルセットと呼ばれます。アラートを識別するのはこのラベルセットです。
例えば、アラートにラベルセット {alertname="High CPU usage",server="server1"}
が設定されているのに対し、別のアラートにラベルセット {alertname="High CPU usage",server="server2"}
が設定されている場合があります。alertname
ラベルは同じですが、server
ラベルは異なるため、これらは 2 つの別々のアラートです。
アラートのラベルセットは、データソースのラベル、アラートルールのカスタムラベル、alertname
などの予約済みラベルの組み合わせです。
カスタムラベル
カスタムラベルは、アラートルールからの追加ラベルです。注釈と同様に、カスタムラベルには名前が必要です。その値には、アラートが発射したときに評価されるテキストコードとテンプレートコードの組み合わせを含めることができます。カスタムラベルをテンプレート化する方法については、 こちらを参照してください。
テンプレートでカスタムラベルを使用する場合、多数の個別のアラートが生成されるのを避けるため、ラベルの値がアラートルールの連続した評価間で変化しないようにすることが重要です。ただし、テンプレートが異なるアラートに対して異なるラベル値を生成しても問題ありません。例えば、値が変更されるたびに新しいアラートセットが作成されてしまうため、クエリの値をカスタムラベルに入れないでください。代わりに注釈を使用します。
また、アラートのラベルセットに同じ名前のラベルが 2 つ以上ないことを確認することも重要です。カスタムラベルの名前がデータソースのラベルと同じ場合は、そのラベルが置き換えられます。ただし、カスタムラベルの名前が予約済みラベルと同じ場合、カスタムラベルはアラートから省略されます。
注釈
注釈は、既存のアラートに追加情報を追加する名前付きペアです。Grafana には、description
、summary
、runbook_url
、dashboardUId
、panelId
など、推奨される注釈が多数あります。カスタムラベルと同様に、注釈には名前が必要です。その値には、アラートが発射したときに評価されるテキストコードとテンプレートコードの組み合わせを含めることができます。注釈にテンプレートコードが含まれている場合は、アラートが発生したときにテンプレートが 1 回評価されます。アラートが解決されても、再評価されません。注釈をテンプレートする方法については、こちらを参照してください。