In diesem Dokument wird beschrieben, wie Sie Schlummerfunktionen erstellen und verwalten. Durch die Schlummerfunktion wird verhindert, dass Cloud Monitoring in einem bestimmten Zeitraum Vorfälle erstellt und Benachrichtigungen sendet. Für jede Schlummerfunktion werden die Ressourcen angegeben, auf die sie sich bezieht.
Eine konzeptionelle Übersicht finden Sie unter Benachrichtigungen und Vorfälle aufschieben.
Sie können die Google Cloud Console oder die Cloud Monitoring API verwenden, um Schlummerfunktionen zu erstellen und zu verwalten.
Hinweise
Sie benötigen die folgenden Berechtigungen:
-
Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Monitoring Editor (
roles/monitoring.editor
) für Ihr Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie benötigen, um Schlummerfunktionen in der Google Cloud Console aufzurufen und zu bearbeiten. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.
-
Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Monitoring Snooze Editor (
roles/monitoring.snoozeEditor
) für Ihr Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie benötigen, um Schlummerfunktionen mit der Cloud Monitoring API aufzurufen und zu bearbeiten. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.
Weitere Informationen zu Cloud Monitoring-Rollen finden Sie unter Zugriff mit Identity and Access Management steuern.
-
Wenn Sie die Cloud Monitoring API-Beispiele in diesem Dokument verwenden möchten, gehen Sie so vor:
Erstellen Sie eine Umgebungsvariable namens
PROJECT_ID
, die die ID Ihres Google Cloud-Projekts enthält:PROJECT_ID=PROJECT_ID
Authentifizieren Sie sich in der Google Cloud CLI:
gcloud auth login
Legen Sie das Google Cloud-Standardprojekt fest:
gcloud config set project ${PROJECT_ID}
So erstellst du ein Autorisierungstoken:
ACCESS_TOKEN=`gcloud auth print-access-token`
Sie müssen das Zugriffstoken regelmäßig aktualisieren. Wenn vorher funktionierende Befehle plötzlich melden, dass Sie nicht authentifiziert sind, geben Sie diesen Befehl noch einmal ein.
Schlummerfunktion erstellen
Wenn Sie verhindern möchten, dass Benachrichtigungsrichtlinien Vorfälle erstellen und Benachrichtigungen senden, können Sie eine Schlummerfunktion einrichten.
Sie können eine Schlummerfunktion mit der Google Cloud Console, der gcloud CLI oder der Cloud Monitoring API erstellen.
Console
-
Rufen Sie in der Google Cloud Console die Seite notifications Benachrichtigungen auf:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.
- So erstellen Sie eine Schlummerfunktion für einen offenen Fall:
- Suchen Sie auf der Seite „Benachrichtigungen“ im Bereich Vorfälle den gewünschten Vorfall und klicken Sie auf die Vorfallzusammenfassung.
- Klicken Sie auf der Seite Vorfalldetails auf Schlummern und wählen Sie die Schlummerdauer aus. Andere Felder können nicht konfiguriert werden.
Gehen Sie andernfalls so vor:
- Klicken Sie auf der Seite Benachrichtigungen auf Schludermann erstellt.
- Geben Sie einen aussagekräftigen Namen für die Schlummerfunktion ein. Dieser Name wird auf der Seite Benachrichtigungen angezeigt.
- Wählen Sie eine Startzeit aus. Sie können eine bestimmte Zeit eingeben oder die Schlummerfunktion starten, wenn sie erstellt wird.
- Geben Sie die Dauer ein. Der Wert dieses Felds bestimmt, wie lange die Schlummerfunktion aktiv ist.
Füllen Sie den Abschnitt Kriterien für Schlummerfunktion aus. Im Menü Benachrichtigungsrichtlinien können Sie die Benachrichtigungsrichtlinien auswählen, auf die die Schlummerfunktion angewendet werden soll.
Sie können einer Schlummerfunktion bis zu 16 Benachrichtigungsrichtlinien hinzufügen.
Nachdem Sie den Abschnitt Kriterien für die Schlummerfunktion ausgefüllt haben, werden im Bereich Schlummerfunktion erstellen bisherige Vorfälle aufgelistet, die den Kriterien entsprechen.
Klicken Sie auf Erstellen.
Cloud Monitoring API
Wenn Sie eine Schlummerfunktion erstellen möchten, rufen Sie die Methode snoozes.create
auf, indem Sie eine POST
-Anfrage an den Endpunkt Snooze
senden.
Sie müssen ein snooze
-Objekt angeben:
curl -d @my-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \ -H 'Content-Type: application/json' \ -X POST https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes
Die Methode gibt ein snooze
-Objekt zurück. Das Feld "name"
, das die von Monitoring generierte Schlummer-ID enthält, ist der einzige Unterschied zwischen dem zurückgegebenen Objekt und dem Inhalt von my-snooze.json
:
{
"name": "projects/my-project/snoozes/2986666341878464512",
"criteria": {
"policies": [
"projects/my-project/alertPolicies/787884840895011889"
]
},
"interval": {
"startTime": "2022-11-12T19:00:20Z",
"endTime": "2022-11-12T19:05:20Z"
},
"displayName": "Snooze2"
}
gcloud-CLI
Führen Sie den Befehl gcloud monitoring snoozes create
aus, um eine Schlummerfunktion zu erstellen:
gcloud monitoring snoozes create --criteria-policies=LIST_OF_POLICIES --display-name=DISPLAY_NAME --start-time=START_TIME --end-time=END_TIME
Im vorherigen Befehl muss der end-time
mindestens eine Minute nach dem start-time
liegen. Sie müssen den Formatierungsregeln von ISO 8601 folgen. Sie können jedoch absolute oder relative Zeiten angeben. Im folgenden Beispiel werden absolute Zeiten angegeben. Wenn Sie eine Schlummerfunktion 30 Minuten nach der aktuellen Uhrzeit starten möchten, verwenden Sie --start-time="+PTM30M"
.
Wenn Sie mehrere Projekte angeben, trennen Sie sie durch Kommas.
Mit dem folgenden Befehl wird beispielsweise eine Schlummerfunktion mit dem Anzeigenamen „Wartungswoche“ erstellt. Die Schlummerfunktion gilt für zwei Benachrichtigungsrichtlinien und umfasst den Zeitraum vom 1. März bis zum 7. März:
gcloud monitoring snoozes create --display-name="Maintenance Week" \ --criteria-policies="projects/my-project/alertPolicies/12345,projects/my-project/alertPolicies/23451" \ --start-time="2023-03-01T03:00:00.0-0500" \ --end-time="2023-03-07T23:59:59.5-0500"
Im vorherigen Beispiel wird in my-project
die folgende Schlummerfunktion erstellt:
{ "name": "projects/my-project/snoozes/98765", "displayName": "Maintenance Week", "interval": { "startTime": "2023-03-01T08:00:00Z", "endTime": "2023-03-08T04:59:59Z" }, "criteria": { "policies": [ "projects/my-project/alertPolicies/12345", "projects/my-project/alertPolicies/23451", ] } }
Wenn der Vorgang erfolgreich war, sieht die Antwort auf diesen Befehl in etwa so aus:
Created snooze [projects/my-project/snoozes/98765]
Der Name einer Benachrichtigungsrichtlinie wird in der Google Cloud Console nicht angezeigt. So ermitteln Sie den Namen einer Benachrichtigungsrichtlinie:
- Führen Sie den Befehl
gcloud alpha monitoring policies list
aus: Die Antwortdaten dieses Befehls enthalten den Namen Ihrer Benachrichtigungsrichtlinien. - JSON-Darstellung einer Benachrichtigungsrichtlinie aufrufen Sie können die JSON-Darstellung über eine Option auf der Seite Richtliniendetails auf Ihr lokales System herunterladen.
Wiederkehrende Schlummerfunktionen erstellen
Wenn Sie Schlummerfunktionen für wiederkehrende Intervalle erstellen möchten, können Sie ein Script schreiben, das einen Schlummer für eine Benachrichtigungsrichtlinie erstellt. Verwenden Sie dann einen Job-Scheduler wie cron
oder Cloud Scheduler, um das Script nach dem gewünschten Zeitplan auszuführen.
Schlummerfunktionen auflisten
Wenn Sie eine Schlummerfunktion erstellen, wird sie dem Verlauf der Schlummerfunktionen für Ihr Projekt hinzugefügt. In diesem Eintrag werden abgelaufene, aktive und anstehende Schlummerfunktionen angezeigt. Sie können keine Einträge aus diesem Eintrag entfernen, d. h., Sie können eine Schlummerfunktion nicht löschen. In dieser Ansicht können Sie jedoch die Details zu einer Schlummerfunktion anzeigen und Aktionen wie das Bearbeiten oder Kopieren der Schlummerfunktion ausführen.
Console
So rufen Sie eine Liste der Schlummerfunktionen auf:
-
Rufen Sie in der Google Cloud Console die Seite notifications Benachrichtigungen auf:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.
Klicken Sie im Bereich Aufschieben auf Alle Aufschiebungen ansehen.
Auf der Seite Schlummern sehen Sie eine Liste der Schlummerfunktionen und eine Zeitachse, auf der Ihre bisherigen, anstehenden und aktiven Schlummerfunktionen grafisch dargestellt werden.
- Wenn Sie eine Schlummerfunktion bearbeiten, kopieren, abbrechen oder beenden möchten, verwenden Sie das Dreipunkt-Menü more_vert Mehr Optionen. Je nach Schlummerstatus sind unterschiedliche Optionen verfügbar.
- Wenn Sie alle Schlummerfunktionen auflisten möchten, aktivieren Sie Vergangene Schlummerfunktionen einblenden. Standardmäßig werden nur aktive und anstehende Schlummerfunktionen aufgeführt.
- Wenn Sie den Anzeigezeitraum für die Tabelle Zeitachse ändern möchten, verwenden Sie das Menü Zeitraum. Standardmäßig werden in der Tabelle Daten für die nächste Stunde angezeigt. Sie können dieses Feld jedoch ändern, um vergangene oder zukünftige Zeiträume anzugeben. Abgelaufene Schlummerfunktionen werden 13 Monate lang aufbewahrt.
- Wenn Sie Details zu einer bestimmten Schlummerfunktion aufrufen möchten, klicken Sie auf Details ansehen.
- Wenn Sie eine Zusammenfassung der aktiven Schlummerfunktionen aufrufen möchten, bewegen Sie den Mauszeiger auf den schattierten Bereich der Zeile Aktiv in der Tabelle Zeitachse. In der Kurzinfo werden die zusammengefassten Informationen angezeigt.
- Wenn Sie eine grafische Darstellung der aktiven Schlummerfunktionen sehen möchten, maximieren Sie die Zeile Aktiv in der Tabelle Zeitachse.
Cloud Monitoring API
Rufen Sie die Methode snoozes.list
auf, um alle Schlummerfunktionen aufzulisten, die zu einem Google Cloud-Projekt gehören:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes
Die Methode gibt eine Liste von snooze
-Objekten zurück. Wenn für ein Projekt beispielsweise eine Schlummerfunktion aktiviert ist, sieht die Antwort auf den Befehl snoozes.list
in etwa so aus:
{
"snoozes": [
{
"name": "projects/my-project/snoozes/2986663705844383744",
"criteria": {
"policies": [
"projects/my-project/alertPolicies/787884840895011889"
]
},
"interval": {
"startTime": "2022-11-08T19:00:20Z",
"endTime": "2022-11-08T19:05:20Z"
},
"displayName": "Snooze1"
}
]
}
Wenn Sie Informationen zu einer bestimmten Schlummerfunktion abrufen möchten, rufen Sie die Methode snoozes.get
auf und geben Sie die Projekt-ID und die Schlummerfunktions-ID an. In der vorherigen Antwort lautet die Schlummer-ID 2986663705844383744
:
curl -H "Authorization: Bearer $ACCESS_TOKEN" \ https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}
Die Methode gibt ein einzelnes snooze
-Objekt zurück:
{
"name": "projects/my-project/snoozes/2986663705844383744",
"criteria": {
"policies": [
"projects/my-project/alertPolicies/787884840895011889"
]
},
"interval": {
"startTime": "2022-11-08T19:00:20Z",
"endTime": "2022-11-08T19:05:20Z"
},
"displayName": "Snooze1"
}
gcloud-CLI
Führen Sie den Befehl gcloud monitoring snoozes list
aus, um die Schlummerfunktionen in Ihrem aktuellen Projekt aufzulisten:
gcloud monitoring snoozes list OPTIONAL_FLAGS
Informationen zu den optionalen Flags finden Sie auf der Referenzseite für gcloud monitoring snoozes list
.
Die Antwort auf diesen Befehl ist eine Liste der Namen der Schlummerfunktionen im Projekt, formatiert als YAML. Die Antwort auf diesen Befehl für das Google Cloud-Projekt mit der ID my-project
besteht beispielsweise aus einem einzelnen Eintrag:
criteria: policies: - projects/my-project/alertPolicies/12345 - projects/my-project/alertPolicies/23451 displayName: Maintenance Week interval: endTime: '2023-03-08T04:59:59Z' startTime: '2023-03-01T08:00:00Z' name: projects/my-project/snoozes/98765
Führen Sie den Befehl gcloud monitoring snoozes describe
aus, um Details zu einer bestimmten Schlummerfunktion aufzurufen:
gcloud monitoring snoozes describe NAME
Wenn Sie beispielsweise die Details zum Schlummer mit dem Namen projects/my-project/snoozes/98765
aufrufen möchten, führen Sie den folgenden Befehl aus:
gcloud monitoring snoozes describe projects/my-project/snoozes/98765
Wenn Sie für einen describe
-Befehl eine ungültige NAME angeben, enthält die Antwort den Fehlercode 500
und die folgende Meldung:
Internal error encountered. Please retry after a few seconds. If internal errors persist, contact support at https://cloud.google.com/support/docs.
Schlummerfunktion bearbeiten
Sie können den Namen und die Dauer einer bevorstehenden Schlummerfunktion sowie den Namen und das Enddatum einer aktiven Schlummerfunktion bearbeiten. Wenn ein Wartungsfenster beispielsweise verschoben wird, müssen Sie möglicherweise eine Schlummerfunktion bearbeiten.
Sie können eine vergangene Schlummerfunktion oder die Kriterien einer Schlummerfunktion nicht bearbeiten. Wenn Sie eine frühere Schlummerfunktion jedoch für einen zukünftigen Zeitraum planen möchten, kopieren Sie die Funktion und nehmen Sie Änderungen an der Kopie vor, bevor Sie Erstellen auswählen.
Console
So bearbeiten Sie eine Schlummerfunktion:
-
Rufen Sie in der Google Cloud Console die Seite notifications Benachrichtigungen auf:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.
- Klicken Sie im Bereich Aufschieben auf Alle Aufschiebungen ansehen.
- Suchen Sie in der Liste der Schlummerfunktionen nach der Funktion, die Sie bearbeiten möchten, und wählen Sie dann im Dreipunkt-Menü more_vert Weitere Optionen die Option Schlummerfunktion bearbeiten aus.
- Klicken Sie auf Speichern, nachdem Sie die Änderungen vorgenommen haben.
Cloud Monitoring API
Wenn Sie eine vorhandene Schlummerfunktion ändern möchten, rufen Sie die Methode snoozes.patch
auf, indem Sie eine PATCH
-Anfrage an den Endpunkt Snooze
senden.
Sie müssen das überarbeitete snooze
-Objekt angeben und Abfrageparameter angeben, die angeben, welche Felder geändert werden. Bei der Verwendung von curl müssen Suchparameter URL-codiert sein.
Bei anstehenden Schlummerfunktionen können Sie den Namen und den Zeitraum ändern. Bei aktiven Schlummerfunktionen können Sie den Namen und das Endzeitpunkt ändern. Vergangene Schlummerfunktionen können nicht geändert werden.
Wenn Sie den displayName
eines Schlummers aktualisieren möchten, erstellen Sie eine JSON-Datei namens my-updated-snooze.json
, in der das Schlummerobjekt beschrieben und der Anzeigename aktualisiert wird. Führen Sie dann den folgenden Befehl aus:
curl -d @my-updated-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \ -H 'Content-Type: application/json' \ -X PATCH https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}?updateMask=displayName
Die Methode gibt ein snooze
-Objekt zurück, das mit dem Inhalt der Datei my-updated-snooze.json
identisch ist:
{
"name": "projects/my-project/snoozes/2986665388391530496",
"criteria": {
"policies": [
"projects/my-project/alertPolicies/7164333552684403347"
]
},
"interval": {
"startTime": "2022-11-08T22:26:05Z",
"endTime": "2022-11-08T22:31:05Z"
},
"displayName": "Updated snooze name"
}
gcloud-CLI
Führen Sie den Befehl gcloud monitoring snoozes update
aus, um eine Schlummerfunktion zu bearbeiten. Sie können den Anzeigenamen, den Beginn und das Ende aktualisieren:
gcloud monitoring snoozes update NAME OPTIONAL_FLAGS
Eine Liste der Optionen für den Befehl update
finden Sie auf der Referenzseite für gcloud monitoring snoozes update
.
Wenn Sie beispielsweise den Anzeigenamen der Schlummerfunktion mit dem Namen projects/my-project/snoozes/98765
ändern möchten, führen Sie den folgenden Befehl aus:
gcloud monitoring snoozes update projects/my-project/snoozes/98765 --display-name="March Maintenance"
Schlummermodus beenden oder abbrechen
Wenn Sie Benachrichtigungen für Ressourcen erhalten möchten, die den Kriterien einer aktiven Schlummerfunktion entsprechen, beenden Sie die Schlummerfunktion. Wenn die geplante Wartung beispielsweise schneller als erwartet abgeschlossen ist, können Sie die Schlummerfunktion beenden.
Wenn Sie eine anstehende Schlummerfunktion nicht mehr benötigen, können Sie sie abbrechen. Durch den Abbruch wird die Dauer auf null gesetzt und die Schlummerfunktion wechselt in den Status Vergangen.
Console
So beenden Sie eine aktive Schlummerfunktion oder brechen eine bevorstehende Schlummerfunktion ab:
-
Rufen Sie in der Google Cloud Console die Seite notifications Benachrichtigungen auf:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.
- Klicken Sie im Bereich Aufschieben auf Alle Aufschiebungen ansehen.
Suchen Sie in der Liste der Schlummerfunktionen nach der Funktion, die Sie beenden oder abbrechen möchten, und führen Sie dann einen der folgenden Schritte aus:
- Wenn Sie eine aktive Schlummerfunktion beenden möchten, wählen Sie im Menü more_vert Weitere Optionen die Option Jetzt beenden aus.
- Wenn Sie eine bevorstehende Schlummerfunktion abbrechen möchten, wählen Sie im Menü more_vert Weitere Optionen die Option Schlummerfunktion abbrechen aus.
Cloud Monitoring API
Wenn Sie eine aktive Schlummerfunktion beenden möchten, bearbeiten Sie sie und legen Sie die Endzeit auf die aktuelle Uhrzeit fest. Weitere Informationen finden Sie unter Ruhemodus bearbeiten.
Wenn Sie eine anstehende Schlummerfunktion abbrechen möchten, bearbeiten Sie sie und legen Sie die Endzeit auf die Startzeit der Schlummerfunktion fest. Der Beginn muss in der Zukunft liegen. Weitere Informationen finden Sie unter Ruhemodus bearbeiten.
gcloud-CLI
Wenn Sie eine aktive Schlummerfunktion beenden oder eine bevorstehende Schlummerfunktion abbrechen möchten, führen Sie den Befehl gcloud monitoring snoozes cancel
aus:
gcloud monitoring snoozes cancel NAME
Wenn Sie beispielsweise die Schlummerfunktion mit dem Namen projects/my-project/snoozes/98765
abbrechen möchten, führen Sie den folgenden Befehl aus:
gcloud monitoring snoozes cancel projects/my-project/snoozes/98765
Schlummerfunktion kopieren
Wenn Sie eine vorhandene Schlummerfunktion als Vorlage für eine andere verwenden möchten, erstellen Sie eine Kopie. Wenn Sie eine Schlummerfunktion kopieren, wird der Editor für Schlummerfunktionen geöffnet. Alle Felder sind mit den Werten der ursprünglichen Schlummerfunktion ausgefüllt, mit Ausnahme des Felds für den Beginn. Sie können alle Felder ändern, bevor Sie auf Erstellen klicken.
So kopieren Sie eine Schlummerfunktion mithilfe der Console:
-
Rufen Sie in der Google Cloud Console die Seite notifications Benachrichtigungen auf:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.
- Klicken Sie im Bereich Aufschieben auf Alle Aufschiebungen ansehen.
- Suchen Sie in der Liste der Schlummerfunktionen nach der Funktion, die Sie bearbeiten möchten, und wählen Sie dann im Dreipunkt-Menü more_vert Weitere Optionen die Option Schlummerfunktion kopieren aus.
- Wenden Sie Ihre Änderungen auf den Text an und klicken Sie dann auf Erstellen.
Nächste Schritte
Eine Übersicht über Benachrichtigungen finden Sie unter Benachrichtigungen.
Informationen zur Benachrichtigungslatenz und zu den Auswirkungen der Parameter für eine Benachrichtigungsrichtlinie beim Senden von Benachrichtigungen finden Sie unter Verhalten von messwertbasierten Benachrichtigungsrichtlinien.
Weitere Informationen zu Vorfällen finden Sie in den folgenden Dokumenten: