Benachrichtigungen mit benutzerdefinierter Dokumentation versehen

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

Dokumentationsstruktur

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

Betreffzeilen

Der Betreff Ihrer Dokumentation wird im Betreff von Benachrichtigungen für Vorfälle angezeigt, die sich auf Ihre Benachrichtigungsrichtlinie beziehen. Benachrichtigungsempfänger können ihre Benachrichtigungen nach Thema verwalten und sortieren.

Betreffzeilen dürfen maximal 255 Zeichen lang sein. Wenn Sie in Ihrer Dokumentation keinen Betreff definieren, wird die Betreffzeile von Cloud Monitoring festgelegt. Betreffzeilen unterstützen Nur-Text und Variablen.

Inhalt

Der Inhalt Ihrer Dokumentation wird in den folgenden Benachrichtigungstypen angezeigt:

• E-Mail im Abschnitt Richtliniendokumentation
• Logo: PagerDuty
• Pub/Sub
• Slack
• Webhooks

Wir empfehlen, Ihre Inhalte so zu konfigurieren, dass Einsatzkräfte in Benachrichtigungen im Zusammenhang mit Ihrer Benachrichtigungsrichtlinie Schritte zur Behebung und Informationen zum Vorfall sehen können. Sie können beispielsweise die Dokumentation so konfigurieren, dass sie eine Zusammenfassung des Vorfalls und Informationen zu relevanten Ressourcen enthält.

Dokumentationsinhalte unterstützen Folgendes:

• Nur Text
• Variablen
• Kanalspezifische Einstellungen

• Markdown

Links

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

Mit der Cloud Monitoring API können Sie ein Objekt definieren, das die wichtigsten Links für Reaktionsverantwortliche enthält. In der Google Cloud -Konsole gibt es zwar kein Feld speziell für Links, Sie können aber einen Abschnitt für Links in den Text Ihrer Dokumentation einfügen.

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

### Troubleshooting and Debug References

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

Markdown in Dokumentationsinhalten

Sie können Markdown verwenden, um den Inhalt Ihrer Dokumentation zu formatieren. Dokumentationsinhalte unterstützen die folgende Teilmenge von Markdown-Tagging:

• 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). Wenn Sie Ihrer Benachrichtigung Links hinzufügen möchten, empfehlen wir, die Cloud Monitoring API zu verwenden und das Objekt Link 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 den Text in Ihrer Dokumentation mit Variablen der Form ${varname} anpassen. 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.

¹ 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.
² Verwenden Sie ${resource.project}, um den Wert des Labels project_id für eine mit der Benachrichtigungsrichtlinie überwachte Ressource abzurufen.
³ 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 die Dokumentation in der Google Cloud Console angezeigt wird, sehen Sie nicht die Werte, sondern die Variablen. Beispiele in der Konsole sind die Beschreibungen von Vorfällen und die Vorschau der Dokumentation beim Erstellen einer Benachrichtigungsrichtlinie.
• Prüfen Sie, ob das Label durch die Aggregationseinstellungen der Bedingung entfernt wird. 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.

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 in Ihrer Benachrichtigungsrichtlinie eine achsenübergreifende Aggregation (Reduzierung) verwendet wird, z. B. die Summe für jede der Zeitachsen, die einem Filter entsprechen. Bei Verwendung einer achsenübergreifenden Zusammenfassung werden alle nicht in der Gruppierung berücksichtigten Labels verworfen. Wenn die Variable durch ihren Wert ersetzt wird, werden sie daher als null gerendert. Alle Labels werden beibehalten, wenn es keine achsenübergreifende Zusammenfassung gibt. Weitere Informationen finden Sie unter 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, die über die folgenden Benachrichtigungskanäle gesendet werden:

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

Kanalsteuerelemente

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 solchen String in das Dokumentationsfeld ein:

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

Wenn das Dokumentationsfeld als Teil der Benachrichtigung vom relevanten Slack-Kanal empfangen wird, bewirkt der vorherige String, dass Slack eine zusätzliche Nachricht an die Nutzer-ID backendoncall sendet. Die von Slack an den Nutzer gesendete Nachricht kann relevante Informationen aus der Benachrichtigung enthalten, z. B. „Vorfall 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

Im folgenden Beispiel sehen Sie die Google Cloud -Konsolen- und Cloud Monitoring API-Versionen der Vorlagendokumentation für eine Benachrichtigungsrichtlinie zur CPU-Auslastung. In diesen Beispielen wird eine E-Mail-Adresse für den Benachrichtigungskanaltyp verwendet. Die Dokumentationsvorlagen enthalten mehrere Variablen, mit denen der Vorfall zusammengefasst und auf die REST-Ressourcen für Benachrichtigungsrichtlinie und Bedingung verwiesen werden kann.

  "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"
      }
    ]
  }

### 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