Beschriftungen und Anmerkungen

Dieses Dokumentationsthema wurde für Grafana-Workspaces entwickelt, die Grafana-Version 9.x unterstützen.

Informationen zu Grafana-Arbeitsbereichen, die Grafana-Version 10.x unterstützen, finden Sie unter. Arbeitet in Grafana-Version 10

Informationen zu Grafana-Arbeitsbereichen, die Grafana-Version 8.x unterstützen, finden Sie unter. Arbeitet in Grafana-Version 8

Beschriftungen und Anmerkungen enthalten Informationen zu einer Warnung. Sowohl Beschriftungen als auch Anmerkungen haben dieselbe Struktur: eine Reihe benannter Werte; ihre Verwendungszwecke sind jedoch unterschiedlich. Ein Beispiel für eine Bezeichnung oder eine entsprechende Anmerkung könnte seinalertname="test".

Der Hauptunterschied zwischen einer Bezeichnung und einer Anmerkung besteht darin, dass Beschriftungen verwendet werden, um eine Warnung von allen anderen Warnungen zu unterscheiden, während Anmerkungen dazu verwendet werden, einer vorhandenen Warnung zusätzliche Informationen hinzuzufügen.

Stellen Sie sich zum Beispiel zwei Warnmeldungen mit hohem CPU-Wert vor: eine für server1 und eine weitere fürserver2. In einem solchen Beispiel könnten wir eine Bezeichnung haben, server bei der die erste Warnung die Bezeichnung server="server1" und die zweite Warnung die Bezeichnung trägtserver="server2". Möglicherweise möchten wir jedoch auch jeder Warnung eine Beschreibung hinzufügen"The CPU usage for server1 is above 75%.", z. B. wo server1 und 75% werden durch den Namen und die CPU-Auslastung des Servers ersetzt (Informationen dazu finden Sie in der Dokumentation). Vorlagen für Beschriftungen und Anmerkungen erstellen Diese Art von Beschreibung wäre besser als Anmerkung geeignet.

Labels

Beschriftungen enthalten Informationen, anhand derer eine Warnung identifiziert werden kann. Ein Beispiel für ein Etikett könnte seinserver=server1. Jede Warnung kann mehr als ein Label haben, und der komplette Satz von Labels für eine Warnung wird als Labelsatz bezeichnet. Es ist dieser Labelsatz, der die Warnung identifiziert.

Beispielsweise kann für eine Warnung die Bezeichnung festgelegt sein, {alertname="High CPU usage",server="server1"} während für eine andere Warnung die Bezeichnung festgelegt sein könnte{alertname="High CPU usage",server="server2"}. Dabei handelt es sich um zwei separate Benachrichtigungen, da ihre alertname Beschriftungen zwar identisch sind, ihre server Beschriftungen jedoch unterschiedlich sind.

Die für eine Warnung festgelegte Bezeichnung ist eine Kombination aus den Bezeichnungen aus der Datenquelle, benutzerdefinierten Bezeichnungen aus der Warnungsregel und einer Reihe von reservierten Bezeichnungen wie. alertname

Benutzerdefinierte Beschriftungen

Benutzerdefinierte Beschriftungen sind zusätzliche Beschriftungen aus der Warnungsregel. Wie Anmerkungen müssen benutzerdefinierte Beschriftungen einen Namen haben, und ihr Wert kann eine Kombination aus Text und Vorlagencode enthalten, der ausgewertet wird, wenn eine Warnung ausgelöst wird. Eine Dokumentation zur Erstellung von Vorlagen für benutzerdefinierte Beschriftungen finden Sie hier.

Wenn Sie benutzerdefinierte Beschriftungen mit Vorlagen verwenden, müssen Sie sicherstellen, dass sich der Labelwert zwischen aufeinanderfolgenden Auswertungen der Warnmeldungsregel nicht ändert, da dies zu einer großen Anzahl unterschiedlicher Benachrichtigungen führen kann. Es ist jedoch in Ordnung, wenn die Vorlage unterschiedliche Labelwerte für verschiedene Warnungen erzeugt. Fügen Sie den Wert der Abfrage beispielsweise nicht in ein benutzerdefiniertes Label ein, da dadurch bei jeder Änderung des Werts ein neuer Satz von Benachrichtigungen erstellt wird. Verwenden Sie stattdessen Anmerkungen.

Es ist auch wichtig sicherzustellen, dass das für eine Warnung festgelegte Label nicht zwei oder mehr Labels mit demselben Namen enthält. Wenn ein benutzerdefiniertes Label denselben Namen wie ein Label aus der Datenquelle hat, wird es dieses Label ersetzen. Sollte ein benutzerdefiniertes Label jedoch denselben Namen wie ein reserviertes Label haben, wird das benutzerdefinierte Label in der Warnung weggelassen.

Anmerkungen

Bei Anmerkungen handelt es sich um benannte Paare, die vorhandenen Warnungen zusätzliche Informationen hinzufügen. In Grafana gibt es eine Reihe von vorgeschlagenen Anmerkungen wiedescription, summaryrunbook_url, dashboardUId und. panelId Wie benutzerdefinierte Beschriftungen müssen Anmerkungen einen Namen haben, und ihr Wert kann eine Kombination aus Text und Vorlagencode enthalten, die ausgewertet wird, wenn eine Warnung ausgelöst wird. Wenn eine Anmerkung Vorlagencode enthält, wird die Vorlage einmal ausgewertet, wenn die Warnung ausgelöst wird. Sie wird nicht erneut bewertet, auch wenn die Warnung behoben ist. Eine Dokumentation zur Erstellung von Vorlagen für Anmerkungen finden Sie hier.