Schlummerfunktion erstellen und verwalten

In diesem Dokument wird beschrieben, wie Sie Schlummerfunktionen erstellen und verwalten. Eine Schlummerfunktion verhindert, dass Cloud Monitoring Erstellen von Vorfällen und Senden von Benachrichtigungen während für einen bestimmten Zeitraum. Für jede Schlummerfunktion werden die Ressourcen angegeben, auf die sie sich bezieht.

Einen konzeptionellen Überblick finden Sie unter Benachrichtigungen und Vorfälle pausieren

Zum Erstellen und Verwalten von Schlummerfunktionen können Sie die Google Cloud Console oder das Cloud Monitoring API

Hinweis

  1. Sie benötigen die folgenden Berechtigungen:

    Weitere Informationen zu Cloud Monitoring-Rollen finden Sie unter Zugriff mit Identity and Access Management steuern.

  2. Wenn Sie die Cloud Monitoring API-Beispiele in diesem Dokument verwenden möchten, gehen Sie so vor:

    1. Erstellen Sie eine Umgebungsvariable namens PROJECT_ID, die die ID Ihres Google Cloud-Projekts enthält:

      PROJECT_ID=PROJECT_ID

    2. Authentifizieren Sie sich bei der Google Cloud CLI:

      gcloud auth login

    3. Legen Sie das Google Cloud-Standardprojekt fest:

      gcloud config set project ${PROJECT_ID}

    4. 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 verwenden.

Sie können eine Schlummerfunktion mit der Google Cloud Console, der gcloud CLI oder der Cloud Monitoring API erstellen.

Console

  1. Rufen Sie in der Google Cloud Console die Seite  Benachrichtigungen auf:

    Zu Benachrichtigungen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. So erstellen Sie eine Schlummerfunktion für einen offenen Fall:
    1. Suchen Sie auf der Seite „Benachrichtigungen“ im Bereich Vorfälle nach dem Vorfall. und klicken Sie auf die Vorfallzusammenfassung.
    2. 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.

  3. Gehen Sie andernfalls so vor:

    1. Klicken Sie auf der Seite Benachrichtigungen auf Schlummerfunktion erstellen.
    2. Geben Sie einen aussagekräftigen Namen für die Schlummerfunktion ein. Dieser Name wird auf der Benachrichtigungen.
    3. Wählen Sie eine Startzeit aus. Sie können eine bestimmte Uhrzeit eingeben oder die Schlummerfunktion aktivieren, wenn die Schlummerfunktion erstellt wird.
    4. Geben Sie die Dauer ein. Der Wert in diesem Feld bestimmt, wie lange die Schlummerfunktion hält.

    5. 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 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.

    6. 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 später sein als die start-time. Sie müssen die Formatierungsregeln nach ISO 8601 beachten. Allerdings können Sie absolute oder relative Zeiten angeben. Im folgenden Beispiel werden absolute Zeiten angegeben. Um 30 Minuten ab der aktuellen Uhrzeit eine Schlummerfunktion zu aktivieren, 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 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",
   ]
 }
}

Bei Erfolg 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. Bis Um den Namen einer Benachrichtigungsrichtlinie zu ermitteln, führen Sie einen der folgenden Schritte aus:

  • 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 mit einer Option auf der Seite Richtliniendetails auf Ihr lokales System herunterladen.

Wiederkehrende Schlummerfunktion 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. Dieser Eintrag zeigt die abgelaufenen, aktiven und zukünftigen die Schlummerfunktion. Sie können keine Einträge aus diesem Datensatz entfernen, d. h. keine Einträge löschen eine Pause einlegen. 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:

  1. Rufen Sie in der Google Cloud Console die Seite  Benachrichtigungen auf:

    Zu Benachrichtigungen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Klicken Sie im Bereich Aufschieben auf Alle Aufschiebungen ansehen.

    Auf der Seite Schlummern finden 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ü  Mehr Optionen. Der Status der Schlummerfunktion bestimmt, welche Optionen verfügbar sind.
    • Wenn Sie alle Schlummerfunktionen auflisten möchten, aktivieren Sie Vergangene Schlummerfunktionen einblenden. Standardmäßig werden nur aktive und anstehende Schlummerfunktionen angezeigt.
    • Um den Anzeigezeitraum für die Tabelle Zeitachse zu ändern, verwenden Sie die 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 in der Tabelle Zeitachse auf den schattierten Bereich der Zeile Aktiv. 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

Zum Auflisten aller Schlummerfunktionen, die zu einem Google Cloud-Projekt gehören, rufen Sie die Methode snoozes.list-Methode:

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 festgelegt 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 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 aus, um die Schlummerfunktionen in Ihrem aktuellen Projekt aufzulisten:

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, 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-Befehl:

gcloud monitoring snoozes describe NAME

Um beispielsweise Details zur Schlummerfunktion mit Namen anzuzeigen, projects/my-project/snoozes/98765, führen Sie den folgenden Befehl aus:

gcloud monitoring snoozes describe projects/my-project/snoozes/98765

Wenn Sie für einen describe-Befehl einen ungültigen NAME-Wert angeben, gibt der Antwort enthält 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 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:

  1. Rufen Sie in der Google Cloud Console die Seite  Benachrichtigungen auf:

    Zu Benachrichtigungen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Klicken Sie im Bereich Zurückstellen auf Alle Schlummerfunktionen ansehen.
  3. Suchen Sie in der Liste der Schlummerfunktionen nach der Funktion, die Sie bearbeiten möchten, und wählen Sie dann im Dreipunkt-Menü  Weitere Optionen die Option Schlummerfunktion bearbeiten aus.
  4. Klicken Sie auf Speichern, wenn Sie alle Änderungen vorgenommen haben.

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.

Erstellen Sie eine JSON-Datei, um den displayName einer Schlummerfunktion zu aktualisieren. my-updated-snooze.json, die das Schlummerobjekt beschreibt und die Anzeigename. 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

Um eine Schlummerfunktion zu bearbeiten, führen Sie den gcloud monitoring snoozes update-Befehl. 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 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"

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 beispielsweise Wartungsarbeiten 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. 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:

  1. Rufen Sie in der Google Cloud Console die Seite  Benachrichtigungen auf:

    Zu Benachrichtigungen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Klicken Sie im Bereich Aufschieben auf Alle Aufschiebungen ansehen.

  3. 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:

    • Um eine Schlummerfunktion zu beenden, wählen Sie Jetzt beenden im Weitere Optionen.
    • Wenn Sie eine bevorstehende Schlummerfunktion abbrechen möchten, wählen Sie im Menü  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.

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 Ruhemodus bearbeiten.

gcloud-CLI

Um eine aktive Schlummerfunktion zu beenden oder eine bevorstehende Schlummerfunktion abzubrechen, gcloud monitoring snoozes cancel-Befehl:

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, Der Schlummereditor wird mit allen Feldern außer der Startzeit geöffnet. auf die Werte in der ursprünglichen Schlummerfunktion eingestellt. Sie können alle Felder ändern, bevor Sie auf Erstellen klicken.

So kopieren Sie eine Schlummerfunktion über die Console:

  1. Rufen Sie in der Google Cloud Console die Seite  Benachrichtigungen auf:

    Zu Benachrichtigungen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Klicken Sie im Bereich Zurückstellen auf Alle Schlummerfunktionen ansehen.
  3. Suchen Sie in der Liste die Schlummerfunktion, die Sie bearbeiten möchten, und Wählen Sie im Menü Weitere Optionen Schlummerfunktion kopieren aus.
  4. Wenden Sie Ihre Änderungen auf den Text an und klicken Sie dann auf Erstellen.

Nächste Schritte