In diesem Dokument wird beschrieben, wie Sie die Schlummerfunktion. Eine Schlummerfunktion verhindert, dass Cloud Monitoring Erstellen von Vorfällen und Senden von Benachrichtigungen während für einen bestimmten Zeitraum. Jede Schlummerfunktion gibt die Ressourcen an, für die sie gilt.
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
Prüfen Sie, ob Sie die erforderlichen Berechtigungen haben:
-
So erhalten Sie die Berechtigungen, die Sie zum Ansehen und Bearbeiten von Schlummerfunktionen über die Google Cloud Console benötigen: bitten Sie Ihren Administrator, Ihnen IAM-Rolle Monitoring-Bearbeiter (
roles/monitoring.editor
) für Ihr Projekt. 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.
-
So erhalten Sie die Berechtigungen, die Sie zum Aufrufen und Bearbeiten von Schlummerfunktionen mit der Cloud Monitoring API benötigen: bitten Sie Ihren Administrator, Ihnen IAM-Rolle Bearbeiter der Schlummerfunktion in Monitoring (
roles/monitoring.snoozeEditor
) für Ihr Projekt. 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 die Umgebungsvariable
PROJECT_ID
für die ID Ihres Google Cloud-Projekt:PROJECT_ID=PROJECT_ID
Authentifizieren Sie sich bei der Google Cloud CLI:
gcloud auth login
Legen Sie das Google Cloud-Standardprojekt fest:
gcloud config set project ${PROJECT_ID}
Erstellen Sie 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
Um zu verhindern, dass Benachrichtigungsrichtlinien Vorfälle erstellen und Benachrichtigungen senden, eine Schlummerfunktion erstellen.
Sie können eine Schlummerfunktion in der Google Cloud Console erstellen: gcloud CLI oder der Cloud Monitoring API verwenden.
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 Vorfall:
- Suchen Sie auf der Seite „Benachrichtigungen“ im Bereich Vorfälle nach dem Vorfall. und klicken Sie auf die Vorfallzusammenfassung.
- Klicken Sie auf der Seite Details zum Vorfall auf Zurückstellen und wählen Sie Dauer der Schlummerfunktion. Andere Felder können nicht konfiguriert werden.
Gehen Sie andernfalls so vor:
- Klicken Sie auf der Seite Benachrichtigungen auf Schlummerfunktion erstellen.
- Geben Sie einen aussagekräftigen Namen für die Schlummerfunktion ein. Dieser Name wird auf der Benachrichtigungen.
- Wählen Sie eine Startzeit aus. Sie können eine bestimmte Uhrzeit eingeben oder die Schlummerfunktion aktivieren, wenn die Schlummerfunktion erstellt wird.
- Geben Sie die Dauer ein. Der Wert in diesem Feld bestimmt, wie lange die Schlummerfunktion hält.
Füllen Sie den Abschnitt Kriterien für die Schlummerfunktion aus. Sie können die Benachrichtigungsrichtlinien, um die Benachrichtigungsrichtlinien auszuwählen, für die der wird die Schlummerfunktion angewendet.
Sie können bis zu 16 Benachrichtigungsrichtlinien Schlummerfunktion.
Nachdem Sie die Kriterien für die Schlummerfunktion ausgefüllt haben, erscheint das Dialogfeld Schlummerfunktion erstellen werden vergangene 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"
einschließlich der von Monitoring generierten Schlummer-ID,
ist der einzige Unterschied zwischen dem zurückgegebenen -Objekt und dem
Inhalte 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 zum Erstellen einer Schlummerfunktion den
gcloud monitoring snoozes create
-Befehl:
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 die Formatierungsregeln nach ISO 8601 beachten. Allerdings
können Sie absolute oder relative Zeiten angeben. Im folgenden Beispiel wird angegeben,
absolute Zeitangaben
verwendet werden. Um 30 Minuten ab der aktuellen Uhrzeit eine Schlummerfunktion zu aktivieren, verwenden Sie
--start-time="+PTM30M"
Wenn Sie mehrere Projekte angeben, trennen Sie diese durch Kommas.
Der folgende Befehl erstellt beispielsweise eine Schlummerfunktion mit dem Anzeigenamen „Wartungswoche“. 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 die folgende Schlummerfunktion in my-project
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 Befehl erfolgreich ist, sieht die Antwort auf diesen Befehl in etwa so aus:
Created snooze [projects/my-project/snoozes/98765]
Der Name einer Benachrichtigungsrichtlinie wird nicht in der Google Cloud Console angezeigt. So ermitteln Sie den Namen einer Benachrichtigungsrichtlinie:
- Führen Sie den Befehl
gcloud alpha monitoring policies list
aus: Die Antwortdaten enthält den Namen Ihrer Benachrichtigungsrichtlinien. - Sehen Sie sich die JSON-Darstellung einer Benachrichtigungsrichtlinie an. Sie können die JSON-Darstellung in Ihrem lokalen System mithilfe einer -Option auf der Seite Richtliniendetails
Wiederkehrende Schlummerfunktionen erstellen
Zum Erstellen von Schlummerfunktionen in wiederkehrenden Intervallen können Sie ein Skript schreiben,
die eine Schlummerfunktion für
eine Benachrichtigungsrichtlinie erstellt. Verwenden Sie dann einen Jobplaner wie
cron
oder Cloud Scheduler, um das Skript auf der erforderlichen
ein.
Schlummerfunktion auflisten
Wenn Sie eine Schlummerfunktion erstellen, wird sie zum bisherigen Verlauf der Schlummerfunktion hinzugefügt. für Ihr Projekt. Dieser Eintrag zeigt die abgelaufenen, aktiven und zukünftigen die Schlummerfunktion. Sie können keine Einträge aus diesem Datensatz entfernen, das heißt, Sie können keine Einträge löschen eine Pause einlegen. In dieser Ansicht können Sie jedoch die Details Außerdem können Sie die Schlummerfunktion bearbeiten oder kopieren.
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 Zurückstellen auf Alle Schlummerfunktionen ansehen.
Die Seite Zurückstellen enthält eine Liste der Schlummerfunktionen und eine Zeitachse, die die zurückgestellten, 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. Der Status der Schlummerfunktion bestimmt, welche Optionen verfügbar sind.
- Wenn Sie alle Schlummerfunktionen auflisten möchten, aktivieren Sie Letzte Schlummerfunktionen anzeigen. Standardmäßig werden nur aktive und anstehende Schlummerfunktionen werden aufgelistet.
- 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.
- Um eine Zusammenfassung der aktiven Schlummerfunktionen zu sehen, platzieren Sie Ihren Mauszeiger auf dem schattierten Bereich der Zeile Aktiv in der Tabelle Zeitachse an. Kurzinfo werden die zusammengefassten Informationen angezeigt.
- So rufen Sie eine grafische Darstellung aktiver Schlummerfunktionen auf: Maximieren Sie die Zeile Aktiv 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. Beispiel:
Wenn in einem Projekt eine Schlummerfunktion vorhanden ist, wird die Antwort auf den Befehl snoozes.list
sieht 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
Die Schlummer-ID lautet 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
-Befehl:
gcloud monitoring snoozes list OPTIONAL_FLAGS
Informationen zu den optionalen Flags finden Sie in der
Referenzseite für gcloud monitoring snoozes list
Die Antwort auf diesen Befehl ist eine Liste der Namen der Schlummerfunktionen im Projekt.
als YAML formatiert. Die Antwort auf diesen Befehl für den
Das Google Cloud-Projekt mit der ID my-project
ist ein einzelner 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
-Befehl:
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 den Zeitraum einer bevorstehenden Schlummerfunktion sowie den Name und Endzeit einer aktiven Schlummerfunktion. Zum Beispiel, wenn ein Wartungsfenster verschoben wurde, müssen Sie möglicherweise eine Schlummerfunktion bearbeiten.
Sie können eine Schlummerfunktion in der Vergangenheit oder die Kriterien einer Schlummerfunktion bearbeiten. Wenn Sie jedoch um eine Schlummerfunktion für einen zukünftigen Zeitraum zu planen. Kopieren Sie dann die Schlummerfunktion und Änderungen erst auf die Kopie anwenden, bevor Sie auf Erstellen klicken.
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 die Schlummerfunktion, die Sie bearbeiten möchten, und Wählen Sie im Menü Weitere Optionen more_vert die Option Zurückstellen bearbeiten aus.
- Klicken Sie abschließend auf Speichern.
Cloud Monitoring API
Um eine vorhandene Schlummerfunktion zu ändern, rufen Sie den snoozes.patch
auf.
durch Senden einer PATCH
-Anfrage an den Endpunkt Snooze
.
Sie müssen das überarbeitete snooze
-Objekt bereitstellen und Folgendes angeben:
Abfrageparameter, die angeben, welche Felder geändert werden. Wenn Sie curl verwenden,
Suchparameter müssen URL-codiert sein.
Bei anstehenden Schlummerfunktionen können Sie den Namen und den Zeitraum ändern. Für aktive Schlummerfunktionen verwenden, können Sie den Namen und das Ende ändern. Sie können keine Änderungen vornehmen, Schlummerfunktion.
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
:
{
"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
Um eine Schlummerfunktion zu bearbeiten, führen Sie den
gcloud monitoring snoozes update
-Befehl. Sie können
den Anzeigenamen, die Start- und Endzeit:
gcloud monitoring snoozes update NAME OPTIONAL_FLAGS
Eine Liste der Optionen für den Befehl update
finden Sie in der
Referenzseite für gcloud monitoring snoozes update
Um beispielsweise den Anzeigenamen der Schlummerfunktion mit dem Namen
projects/my-project/snoozes/98765
, führen Sie den folgenden Befehl aus:
gcloud monitoring snoozes update projects/my-project/snoozes/98765 --display-name="March Maintenance"
Schlummerfunktion beenden oder abbrechen
Wenn Sie Benachrichtigungen für Ressourcen erhalten möchten, die die Kriterien erfüllen in einer aktiven Schlummerfunktion angegeben ist, und beenden Sie die Schlummerfunktion. Wenn beispielsweise Wartung schneller als erwartet abgeschlossen haben, möchten Sie vielleicht Schlummerfunktion.
Wenn eine Schlummerfunktion bevorsteht, die Sie nicht mehr verwenden möchten, brechen Sie sie ab. Der Abbruchvorgang setzt die Dauer auf null und führt zu einer Schlummerfunktion. in den Status Vergangen wechselt.
Console
So beenden Sie eine aktive Schlummerfunktion oder brechen Sie eine anstehende 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 Zurückstellen auf Alle Schlummerfunktionen ansehen.
Suchen Sie in der Liste die Schlummerfunktion, die Sie beenden oder abbrechen möchten. und führen Sie dann einen der folgenden Schritte aus:
- Um eine Schlummerfunktion zu beenden, wählen Sie Jetzt beenden im more_vert Weitere Optionen.
- Um eine bevorstehende Schlummerfunktion abzubrechen, wählen Sie Schlummerfunktion abbrechen more_vert Weitere Optionen.
Cloud Monitoring API
Um eine aktive Schlummerfunktion zu beenden, bearbeiten Sie die Schlummerfunktion und legen Sie das Ende auf den in der aktuellen Uhrzeit. Weitere Informationen finden Sie unter Schlummerfunktion bearbeiten.
Um eine bevorstehende Schlummerfunktion abzubrechen, bearbeiten Sie die Schlummerfunktion und legen Sie das Ende auf den den Beginn der Schlummerfunktion. Der Beginn muss in der Zukunft liegen. Weitere Informationen finden Sie unter Schlummerfunktion 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
Um beispielsweise die Schlummerfunktion mit dem Namen
projects/my-project/snoozes/98765
, 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 weitere Schlummerfunktion, 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 die Schlummerfunktion, die Sie bearbeiten möchten, und Wählen Sie im Menü Weitere Optionen more_vert Schlummerfunktion kopieren aus.
- Wenden Sie Ihre Änderungen auf die Kopie an und klicken Sie dann auf Erstellen.
Nächste Schritte
Eine Übersicht über Benachrichtigungen finden Sie unter Benachrichtigungen – Übersicht.
Informationen zur Benachrichtigungslatenz und zu den Auswirkungen der Parameter für eine Benachrichtigungsrichtlinie beim Senden von Benachrichtigungen finden Sie unter Verhalten von messwertbasierten Benachrichtigungsrichtlinien.
Informationen zu Vorfällen finden Sie in den folgenden Dokumenten: