Benachrichtigungen mit benutzerdefinierter Dokumentation annotieren

Auf dieser Seite wird beschrieben, wie Sie die Dokumentation Ihrer Benachrichtigungsrichtlinien so konfigurieren, dass Benachrichtigungen Ressourcen und zusätzliche Informationen zur Behebung von Vorfällen enthalten.

Dokumentationsstruktur

Die Dokumentation einer Benachrichtigungsrichtlinie besteht aus einem Thema, Inhalten und Links. Sie können die Dokumentation in der Google Cloud Console konfigurieren. Cloud Monitoring API und Google Cloud CLI.

Betreffzeilen

Der Betreff Ihrer Dokumentation erscheint im Betreff Ihrer Benachrichtigungen zu Vorfällen im Zusammenhang mit Ihrer Benachrichtigungsrichtlinie erhalten. Benachrichtigungsempfänger können ihre Benachrichtigungen nach Betreff verwalten und sortieren.

Betreffzeilen dürfen maximal 255 Zeichen lang sein. Wenn Sie in Ihrer Dokumentation kein Betreff angeben, wird die Betreffzeile von Cloud Monitoring festgelegt. In Betreffzeilen sind nur Text und variables zulässig.

Cloud Monitoring API

Konfigurieren Sie die Betreffzeile der Benachrichtigung mithilfe des Felds subject der Benachrichtigungsrichtlinie documentation.

Google Cloud Console

Konfigurieren Sie die Betreffzeile der Benachrichtigung mithilfe der Notification subject line (Betreff der Benachrichtigung) in der Abschnitt Benachrichtigungen und Name auf der Seite Benachrichtigungsrichtlinie erstellen.

Inhalt

Der Inhalt Ihrer Dokumentation wird in den folgenden Benachrichtigungstypen angezeigt:

• Email (E-Mail) unter der Überschrift Policy Documentation (Richtliniendokumentation)
• Logo: PagerDuty
• Pub/Sub
• Slack
• Webhooks

Wir empfehlen, den Inhalt so zu konfigurieren, Mitarbeiter können Abhilfemaßnahmen und Informationen zum Vorfall in Benachrichtigungen sehen in Bezug auf Ihre Benachrichtigungsrichtlinie. Sie können die Dokumentation beispielsweise so konfigurieren, dass sie eine Zusammenfassung des Vorfalls und Informationen zu relevanten Ressourcen enthält.

Dokumentationsinhalte unterstützen Nur-Text, Markdown, Variablen und channelspezifische Einstellungen zu implementieren.

Cloud Monitoring API

Dokumentationsinhalt mithilfe des Felds content konfigurieren der Benachrichtigungsrichtlinie documentation.

Google Cloud Console

Konfigurieren Sie den Dokumentationsinhalt mithilfe des Felds Documentation im Abschnitt Benachrichtigungen und Name auf der Seite Benachrichtigungsrichtlinie erstellen.

Links

Sie können Ihrer Dokumentation Links hinzufügen, damit Einsatzteams über eine Benachrichtigung auf Ressourcen wie Playbooks, Repositories und Google Cloud-Dashboards zugreifen können.

Cloud Monitoring API

In der Cloud Monitoring API konfigurierte Dokumentationslinks werden in den folgenden Benachrichtigungstypen angezeigt:

• E-Mail (unter der Überschrift Quick Links)
• Logo: PagerDuty
• Pub/Sub
• Webhooks

Wenn Sie einen Link konfigurieren möchten, fügen Sie der documentation Ihrer Benachrichtigungsrichtlinie ein Link hinzu. Jeder Link wird durch ein display_name und ein url dargestellt. Sie können bis zu drei Links in Ihrer Dokumentation.

In der folgenden Konfiguration wird links mit einer URL verwendet, um eine Verknüpfung zu einem Incident-Playbook herzustellen. Die URL enthält eine Variable, damit die Benachrichtigungsempfänger je nach überwachter Ressource, an der der Vorfall aufgetreten ist, auf das richtige Playbook zugreifen können:

"links" [
  {
    "displayName": "Playbook",
    "url": "https://myownpersonaldomain.com/playbook?name=${resource.type}"
  }
]

Google Cloud Console

In der Google Cloud Console konfigurierte Dokumentationslinks werden zusammen mit dem Rest Ihrer Dokumentationsinhalte in den folgenden Benachrichtigungstypen angezeigt:

• Email (E-Mail) unter der Überschrift Policy Documentation (Richtliniendokumentation)
• Logo: PagerDuty
• Pub/Sub
• Slack
• Webhooks

Sie können Links zu Ihren Dokumentationsinhalten hinzufügen, indem Sie sie einfügen im Feld Dokumentation Ihrer Benachrichtigungsrichtlinie ein. Beispiel: Der Parameter Die folgende Dokumentation enthält eine URL für ein Kunden-Playbook:

### Troubleshooting and Debug References

Playbook: https://myownpersonaldomain.com/playbook?name=${resource.type}

Hinweis: Die Google Cloud Console unterstützt nicht die Konfiguration des Links-Objekts für Benachrichtigungsrichtlinien.

Markdown im Dokumentationsinhalt

Sie können Markdown zur Formatierung Ihrer Dokumentationsinhalte verwenden. Für Dokumentationsinhalte wird die folgende Teilmenge von Markdown-Tagging unterstützt:

• Header, dargestellt durch Anfangs-Hashzeichen.
• Unsortierte Listen, gekennzeichnet durch anfängliche Plus-, Minus- oder Sternchenzeichen.
• Sortierte Listen, gekennzeichnet durch eine anfängliche Zahl gefolgt von einem Punkt.
• Iterischer Text, gekennzeichnet durch einzelne Unterstriche oder Sternchen um eine Wortgruppe.
• Fettdruck, der durch doppelte Unterstriche oder Sternchen um eine Wortgruppe gekennzeichnet ist.
• Links, gekennzeichnet durch die Syntax [link text](url). Wir empfehlen jedoch, das Objekt Link zu verwenden, um Links für Ihre Inhalte zu konfigurieren.

Weitere Informationen zu diesem Tagging finden Sie in der Markdown-Referenz, z. B. in der Markdown-Anleitung.

Variablen in der Dokumentation

Sie können Variablen verwenden, um den Text in Ihrer Dokumentation anzupassen im Format ${varname}. Wenn die Dokumentation mit einer Benachrichtigung gesendet wird, wird der String ${varname} durch einen Wert aus der entsprechenden Google Cloud-Ressource ersetzt, wie in der folgenden Tabelle beschrieben.

Variable	Wert
condition.name	Der REST-Ressourcenname der Bedingung, z. B. projects/foo/alertPolicies/1234/conditions/5678
condition.display_name	Der Anzeigename einer Bedingung, z. B. CPU usage increasing rapidly
log.extracted_label.KEY	Der Wert des Labels KEY, der aus einem Logeintrag extrahiert wurde. Nur für logbasierte Benachrichtigungsrichtlinien: für weitere Informationen Informationen, Siehe Logbasierte Benachrichtigungsrichtlinie mit der Monitoring API erstellen
metadata.system_label.KEY	Der Wert des vom System bereitgestellten Ressourcenmetadatenlabels KEY.^1
metadata.user_label.KEY	Der Wert des benutzerdefinierten Labels für Ressourcenmetadaten KEY.^1,3
metric.type	Der Messwerttyp, z. B. compute.googleapis.com/instance/cpu/utilization
metric.display_name	Der Anzeigename für den Messwerttyp, z. B. CPU utilization
metric.label.KEY	Der Wert des Messwertlabels KEY.^1 Die mit dem Messwerttyp verknüpften Labels finden Sie in der Messwertliste. Wenn der Wert der Variablen ${metric.label.KEY} nicht mit einer Ziffer, einem Buchstaben, einem Schrägstrich (/) beginnt, oder ein Gleichheitszeichen (=) haben, lasst Monitoring aus Benachrichtigungen entfernen. Wenn Sie eine Prometheus-Benachrichtigungsregel migrieren, werden die Prometheus-Benachrichtigungsfelder {{$value}} und {{humanize $value}} in der Konfiguration der Benachrichtigungsrichtlinie als ${metric.label.VALUE} angezeigt. In diesem Fall enthält VALUE den Wert der PromQL-Abfrage. Sie können auch ${metric.label.VALUE} verwenden, wenn Sie PromQL erstellen Abfragen in Google Cloud durchführen.
metric_or_resource.labels	Diese Variable gibt alle Messwert- und Ressourcenlabelwerte als sortierte Liste von key-value-Paaren aus. Wenn ein Messwertlabel und ein Ressourcenlabel denselben Namen haben, wird nur das Messwertlabel gerendert. Wenn Sie eine Prometheus-Benachrichtigungsregel migrieren, werden die Vorlagen für das Prometheus-Benachrichtigungsfeld {{$labels}} und {{humanize $labels}} werden in der Benachrichtigungsrichtlinie als ${metric_or_resource.labels} angezeigt Dokumentationskonfiguration.
metric_or_resource.label.KEY	Wenn KEY ein gültiges Label ist, wird diese Variable in der Benachrichtigung als Wert von ${metric.label.KEY} gerendert. Wenn KEY eine gültige Ressource ist, wird diese Variable in der Benachrichtigung als Wert von ${resource.label.KEY} gerendert. Wenn KEY weder ein gültiges Label noch eine gültige Ressource ist, wird diese Variable in der Benachrichtigung als leerer String gerendert. Wenn Sie eine Prometheus-Benachrichtigungsregel migrieren, werden die Vorlagen für das Prometheus-Benachrichtigungsfeld {{$labels.KEY}} und {{humanize $labels.KEY}} werden angezeigt. als ${metric_or_resource.labels.KEY} in der Benachrichtigung Konfiguration der Richtliniendokumentation.
policy.name	Der REST-Ressourcenname der Richtlinie, z. B. projects/foo/alertPolicies/1234
policy.display_name	Der Anzeigename einer Richtlinie, z. B. High CPU rate of change
policy.user_label.KEY	Der Wert des Nutzerlabels KEY.^1 Schlüssel müssen mit einem Kleinbuchstaben beginnen. Schlüssel und Werte können folgende Zeichen enthalten: Nur Kleinbuchstaben, Ziffern, Unterstriche und Bindestriche.
project	Die ID des Bereichprojekts des Messwertbereichs, z. B. a-gcp-project.
resource.type	Der Typ der überwachten Ressource, z. B. gce_instance.
resource.project	Die Projekt-ID der überwachten Ressource der Benachrichtigungsrichtlinie
resource.label.KEY	Der Wert des Ressourcenlabels KEY.^1,2,3 Die mit dem Typ der überwachten Ressource verknüpften Labels finden Sie in der Ressourcenliste.

¹ Beispielsweise wird ${resource.label.zone} durch den Wert des zone-Labels ersetzt. Die Werte dieser Variablen unterliegen einer Gruppierung. Weitere Informationen finden Sie unter null-Werte.
² So rufen Sie den Wert des Labels project_id für eine überwachte Ressource in der Benachrichtigungsrichtlinie mit ${resource.project}.
³ Sie können nicht auf benutzerdefinierte Metadatenlabels von Ressourcen zugreifen, indem Sie resource.label.KEY. verwenden. Verwenden Sie stattdessen metadata.user_label.KEY.

Verwendungshinweise

• Nur die Variablen in der Tabelle werden unterstützt. Sie können sie nicht zu komplexeren Ausdrücken wie etwa ${varname1 + varname2} kombinieren.
• Wenn Sie den literalen String ${ in Ihre Dokumentation aufnehmen möchten, verwenden Sie das $-Symbol mit einem zweiten $-Symbol als Escapezeichen. Dadurch wird $${ in Ihrer Dokumentation als ${ gerendert.
• Diese Variablen werden nur in Benachrichtigungen, die über Benachrichtigungskanäle gesendet werden, durch ihre Werte ersetzt. Wenn in der Google Cloud Console sehen Sie die Variablen, nicht die Werte. Beispiele in der Konsole sind die Beschreibungen von Vorfällen und die Vorschau der Dokumentation beim Erstellen einer Benachrichtigungsrichtlinie.
• Achten Sie darauf, dass in den Aggregationseinstellungen der Bedingung das Feld . Wenn das Label entfernt wird, ist der Wert des Labels in der Benachrichtigung null. Weitere Informationen finden Sie unter Variable für ein Messwertlabel ist null.

Hinweis: Labels, die Sie logbasierten Messwerten hinzufügen, können nicht in Vorlagenausdrücken verwendet werden. Sie können diese Labels jedoch in Diagrammlegenden anzeigen und Zeitreihen nach den Labelwerten filtern.

null values

Die Werte für die Variablen metric.*, resource.* und metadata.* werden aus Zeitachsen abgeleitet. Ihre Werte können null sein, wenn von der Zeitachsenabfrage keine Werte zurückgegeben werden.

• Die Variablen resource.label.KEY und metric.label.KEY können null-Werte haben, wenn Ihre Benachrichtigungsrichtlinie eine serverbasierte Aggregation (Reduzierung) verwendet, z. B. die Summe für jede der Zeitachsen, die einem Filter entsprechen. Wenn Sie die reihenübergreifende Aggregation verwenden, Alle nicht in der Gruppierung verwendeten Labels werden verworfen und daher als null, wenn die Variable durch ihren Wert ersetzt wird. Alle Labels werden beibehalten, wenn keine reihenübergreifende Aggregation vorhanden ist. Weitere Informationen Siehe Variable für ein Messwertlabel ist null.

• Werte für metadata.*-Variablen sind nur verfügbar, wenn die Labels explizit im Filter einer Bedingung oder Gruppierung für eine achsenübergreifende Zusammenfassung enthalten sind. Das heißt, Sie müssen auf das Metadatenlabel im Filter oder in der Gruppierung verweisen, damit es einen Wert für die Vorlage hat.

Variable Auflösung

Variablen in Dokumentationsvorlagen werden nur in den Benachrichtigungen aufgelöst gesendet über die folgenden Benachrichtigungskanäle:

• E-Mail
• Google Chat
• Slack
• Pub/Sub, JSON-Schemaversion 1.2
• Webhooks, JSON-Schemaversion 1.2
• PagerDuty, JSON-Schemaversion 1.2

Hinweis: Variablen werden nicht aufgelöst, sondern erscheinen in anderen Kontexten und in Benachrichtigungen, die über andere Benachrichtigungskanäle gesendet werden, als Strings wie ${varname}.

Kanaleinstellungen

Der Text im Dokumentationsfeld kann auch Sonderzeichen enthalten, die vom Benachrichtigungskanal selbst zur Steuerung von Formatierungen und Benachrichtigungen verwendet werden.

Zum Beispiel verwendet Slack @ für Erwähnungen. Sie können @ verwenden, um die Benachrichtigung mit einer bestimmten Nutzer-ID zu verknüpfen. Erwähnungen dürfen keine Namen enthalten. Angenommen, Sie fügen einen String wie diesen in das Dokumentationsfeld ein:

<@backendoncall> Incident created based on policy ${policy.display_name}

Wenn der entsprechende Slack-Kanal das Dokumentationsfeld als Teil des der Benachrichtigung führt der vorherige String dazu, dass Slack eine an die Nutzer-ID senden, backendoncall Die von Slack an den Nutzer gesendete Nachricht kann relevante Informationen aus der Benachrichtigung enthalten, z. B. „Incident created based on policy High CPU rate of change“ (Problem aufgrund der Richtlinie „Hohe CPU-Änderungsrate“ erstellt).

Diese zusätzlichen Optionen sind kanalspezifisch. Weitere Informationen zu den verfügbaren Optionen finden Sie in der Dokumentation des Kanalanbieters.

Beispiel

Das folgende Beispiel zeigt die Google Cloud Console- und Cloud Monitoring API-Versionen der Vorlagendokumentation für eine Benachrichtigungsrichtlinie für die CPU-Auslastung. In diesen Beispielen wird eine E-Mail-Adresse als Benachrichtigungskanaltyp verwendet. Die Dokumentationsvorlagen enthalten mehrere Variablen, um den Vorfall zusammenzufassen und auf die Benachrichtigungsrichtlinie und die REST-Ressourcen für Bedingungen zu verweisen.

Cloud Monitoring API

  "documentation": {
    "content": "### CPU utilization exceeded\n\n### Summary\n\nThe ${metric.display_name} of the ${resource.type} ${resource.label.instance_id} in the project ${resource.project} has exceeded 5% for over 60 seconds.\n\n#### Additional resource information\n\nCondition resource name: ${condition.name}  \nAlerting policy resource name: ${policy.name}",
    "mimeType": "text/markdown",
    "subject": "Alert: ${metric.display_name} exceeded",
    "links": [
      {
        "displayName": "Playbook",
        "url": "https://myownpersonaldomain.com/playbook?name=${resource.type}"
      },
      {
        "displayName": "Repository with debug scripts",
        "url": "https://altostrat.com"
      },
      {
        "displayName": "Google Cloud dashboard",
        "url": "https://example.com"
      }
    ]
  }

Die folgende Abbildung zeigt, wie diese Vorlage in einer E-Mail aussieht. Benachrichtigung:

Google Cloud Console

### CPU utilization exceeded

#### Summary

The ${metric.display_name} of the ${resource.type}
${resource.label.instance_id} in the project ${resource.project} has
exceeded 5% for over 60 seconds.

#### Additional resource information

Condition resource name: ${condition.name}  
Alerting policy resource name: ${policy.name}  

#### Troubleshooting and Debug References

Playbook: https://myownpersonaldomain.com/playbook?name=${resource.type}  
Repository with debug scripts: https://altostrat.com  
${resource.type} dashboard: https://example.com

Die folgende Abbildung zeigt, wie diese Vorlage in einer E-Mail-Benachrichtigung angezeigt wird: