Schlummerfunktion erstellen und verwalten

In diesem Dokument wird beschrieben, wie Sie Schlummerfunktionen erstellen und verwalten. Eine Schlummerfunktion verhindert, dass Cloud Monitoring während eines bestimmten Zeitraums Vorfälle erstellt und Benachrichtigungen ausgibt. Jede Schlummerfunktion gibt die Ressourcen an, für die sie gilt.

Eine konzeptionelle Übersicht finden Sie unter Benachrichtigungen und Vorfälle pausieren.

Zum Erstellen und Verwalten von Schlummerfunktionen verwenden Sie die Google Cloud Console oder die Cloud Monitoring API.

Hinweise

  1. Prüfen Sie, ob Sie die erforderlichen Berechtigungen haben:

    • Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Monitoring-Bearbeiter (roles/monitoring.editor) für Ihr Projekt zu gewähren, damit Sie die Berechtigungen erhalten, die Sie zum Aufrufen und Bearbeiten von Schlummerfunktionen über die Google Cloud Console benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten.

      Möglicherweise können Sie die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

    • Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Bearbeiter für Schlummerfunktionen (roles/monitoring.snoozeEditor) für Ihr Projekt zu gewähren, damit Sie die Berechtigungen erhalten, die Sie zum Aufrufen und Bearbeiten von Schlummerfunktionen mit der Cloud Monitoring API benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff verwalten.

      Möglicherweise können Sie 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.

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

    1. Erstellen Sie die Umgebungsvariable PROJECT_ID für die ID Ihres Google Cloud-Projekts:

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

Wenn Sie verhindern möchten, dass Benachrichtigungsrichtlinien Vorfälle erstellen und Benachrichtigungen senden, erstellen Sie eine Schlummerfunktion.

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 Vorfall:
    1. Suchen Sie auf der Seite "Benachrichtigungen" im Bereich Vorfälle nach dem Vorfall und klicken Sie auf die Zusammenfassung des Vorfalls.
    2. Klicken Sie auf der Seite Vorfalldetails auf Zurückstellen und wählen Sie dann die Dauer der Schlummerfunktion aus. 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 Seite Benachrichtigungen angezeigt.
    3. Wählen Sie eine Startzeit aus. Sie können eine bestimmte Zeit eingeben oder die Schlummerfunktion beim Erstellen der Schlummerfunktion starten.
    4. Geben Sie die Dauer ein. Der Wert dieses Feldes bestimmt, wie lange die Schlummerfunktion dauert.
    5. Füllen Sie den Abschnitt Kriterien für die Schlummerfunktion aus. Im Menü Benachrichtigungsrichtlinien können Sie die Benachrichtigungsrichtlinien auswählen, für die die Schlummerfunktion gilt.

      Sie können einer Schlummerfunktion bis zu 16 Benachrichtigungsrichtlinien hinzufügen.

      Nachdem Sie die Schritte im Abschnitt Kriterien für die Schlummerfunktion abgeschlossen haben, werden im Bereich Schlummerfunktion erstellen vergangene Vorfälle aufgelistet, die den Kriterien entsprechen.

    6. Klicken Sie auf Erstellen.

Cloud Monitoring API

Zum Erstellen einer Schlummerfunktion rufen Sie die Methode snoozes.create auf. Senden Sie dazu eine POST-Anfrage an den Endpunkt Snooze. 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 zum Erstellen einer Schlummerfunktion den Befehl gcloud monitoring snoozes create aus:

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 einhalten. Sie können jedoch absolute oder relative Zeiten angeben. Im folgenden Beispiel werden absolute Zeiten angegeben. Verwenden Sie --start-time="+PTM30M", um 30 Minuten ab der aktuellen Uhrzeit eine Schlummerfunktion zu starten.

Wenn Sie mehrere Projekte angeben, trennen Sie die Projekte durch Kommas.

Der folgende Befehl erstellt beispielsweise eine Schlummerfunktion mit dem Anzeigenamen "Wartungswoche". Die Schlummerfunktion gilt für zwei Benachrichtigungsrichtlinien und erstreckt sich über das Zeitintervall vom ersten März bis zum siebten 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. Führen Sie einen der folgenden Schritte aus, um den Namen einer Benachrichtigungsrichtlinie zu ermitteln:

  • Führen Sie den Befehl gcloud alpha monitoring policies list aus: Die Antwortdaten dieses Befehls enthalten den Namen Ihrer Benachrichtigungsrichtlinien.
  • Sehen Sie sich die JSON-Darstellung einer Benachrichtigungsrichtlinie an. Sie können die JSON-Darstellung mithilfe einer Option auf der Seite Richtliniendetails in Ihr lokales System herunterladen.

Wiederkehrende Schlummerfunktion erstellen

Zum Erstellen von Schlummerfunktionen in wiederkehrenden Intervallen können Sie ein Skript schreiben, das eine Schlummerfunktion für eine Benachrichtigungsrichtlinie erstellt. Verwenden Sie dann einen Jobplaner wie cron oder Cloud Scheduler, um das Skript nach dem gewünschten Zeitplan auszuführen.

Schlummerfunktion auflisten

Wenn Sie eine Schlummerfunktion erstellen, wird sie dem historischen Datensatz für Ihr Projekt hinzugefügt. Dieser Eintrag zeigt die abgelaufenen, aktiven und anstehenden Schlummerfunktionen. Sie können keine Einträge aus diesem Datensatz entfernen, d. h. keine Schlummerfunktion löschen. In dieser Ansicht können Sie jedoch die Details zu einer Schlummerfunktion aufrufen 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 Zurückstellen auf Alle Schlummerfunktionen ansehen.

    Die Seite Zurückstellen enthält eine Liste der Schlummerfunktionen und eine Zeitachse, auf der vergangene, anstehende und aktive Schlummervorgänge grafisch dargestellt sind.

    • Wenn Sie eine Schlummerfunktion bearbeiten, kopieren, abbrechen oder beenden möchten, verwenden Sie dafür das Menü Weitere 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 aufgeführt.
    • Über das Menü Zeitraum können Sie den Anzeigezeitraum für die Tabelle Zeitachse ändern. 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. Die Kurzinfo zeigt die zusammengefassten Informationen an.
    • Maximieren Sie die Zeile Aktiv der Tabelle Zeitachse, um eine grafische Darstellung der aktiven Schlummerfunktionen zu sehen.

Cloud Monitoring API

Rufen Sie die Methode snoozes.list auf, um alle Schlummervorgänge 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 ein Projekt beispielsweise eine Schlummerfunktion hat, 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 sowie die Schlummer-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 im aktuellen Projekt aufzulisten:

gcloud monitoring snoozes list OPTIONAL_FLAGS

Informationen zu den optionalen Flags finden Sie auf der Referenzseite zu gcloud monitoring snoozes list.

Die Antwort auf diesen Befehl ist eine Liste von Namen der Schlummerfunktionen im Projekt im YAML-Format. Die Antwort auf diesen Befehl für das Google Cloud-Projekt mit der ID my-project ist beispielsweise 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 aus, um Details zu einer bestimmten Schlummerfunktion aufzulisten:

gcloud monitoring snoozes describe NAME

Wenn Sie beispielsweise die Details zur Schlummerfunktion 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 Namen und das Ende einer aktiven Schlummerfunktion bearbeiten. Wenn beispielsweise ein Wartungsfenster neu geplant 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 eine frühere Schlummerfunktion für einen zukünftigen Zeitraum planen möchten, kopieren Sie die Schlummerfunktion und wenden Sie Änderungen auf die Kopie an, 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. Wählen Sie in der Liste der Schlummerfunktionen die Schlummerfunktion aus, die Sie bearbeiten möchten, und wählen Sie dann im Menü Weitere Optionen die Option Zurückstellen bearbeiten aus.
  4. Klicken Sie abschließend auf Speichern.

Cloud Monitoring API

Zum Ändern einer vorhandenen Schlummerfunktion rufen Sie die Methode snoozes.patch auf. Stellen Sie dazu eine PATCH-Anfrage an den Endpunkt Snooze. Sie müssen das überarbeitete snooze-Objekt und Abfrageparameter angeben, die angeben, welche Felder geändert werden. Wenn Sie „curl“ verwenden, müssen Abfrageparameter URL-codiert sein.

Bei anstehenden Schlummerfunktionen können Sie den Namen und den Punkt ändern. Bei aktiven Schlummerfunktionen können Sie den Namen und das Ende ändern. Frühere Schlummerfunktionen können nicht geändert werden.

Zum Aktualisieren des displayName einer Schlummerfunktion erstellen Sie die JSON-Datei 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 zum Bearbeiten einer Schlummerfunktion den Befehl gcloud monitoring snoozes update aus. Sie können den Anzeigenamen sowie die Start- und Endzeit aktualisieren:

gcloud monitoring snoozes update NAME OPTIONAL_FLAGS

Eine Liste der Optionen für den Befehl update finden Sie auf der Referenzseite zu gcloud monitoring snoozes update.

Führen Sie beispielsweise den folgenden Befehl aus, um den Anzeigenamen der Schlummerfunktion mit dem Namen projects/my-project/snoozes/98765 zu ändern:

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 in einer aktiven Schlummerfunktion festgelegten Kriterien erfüllen, beenden Sie die Schlummerfunktion. Wenn beispielsweise geplante Wartungsarbeiten schneller als erwartet abgeschlossen sind, sollten Sie eine Schlummerfunktion beenden.

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 dazu, dass die Schlummerfunktion in den Status Past wechselt.

Console

So beenden Sie eine aktive Schlummerfunktion oder brechen eine anstehende 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 Zurückstellen auf Alle Schlummerfunktionen ansehen.
  3. 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 aktive Schlummerfunktion zu beenden, wählen Sie Jetzt beenden im Menü Weitere Optionen aus.
    • Wenn Sie eine anstehende Schlummerfunktion abbrechen möchten, wählen Sie im Menü Weitere Optionen die Option Zurückstellen abbrechen aus.

Cloud Monitoring API

Um eine aktive Schlummerfunktion zu beenden, bearbeiten Sie die Schlummerfunktion und legen Sie die Endzeit auf die aktuelle Uhrzeit fest. Weitere Informationen finden Sie unter Schlummerfunktion bearbeiten.

Wenn Sie eine anstehende Schlummerfunktion abbrechen möchten, bearbeiten Sie die Schlummerfunktion und legen Sie das Ende auf den Beginn der Schlummerfunktion fest. Der Beginn muss in der Zukunft liegen. Weitere Informationen finden Sie unter Schlummerfunktion bearbeiten.

gcloud-CLI

Führen Sie den Befehl gcloud monitoring snoozes cancel aus, um eine aktive Schlummerfunktion zu beenden oder eine bevorstehende Schlummerfunktion abzubrechen:

gcloud monitoring snoozes cancel NAME

Führen Sie beispielsweise den folgenden Befehl aus, um die Schlummerfunktion namens projects/my-project/snoozes/98765 abzubrechen:

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

Schlummerfunktion kopieren

Wenn Sie eine vorhandene Schlummerfunktion als Vorlage für eine weitere Schlummerfunktion verwenden möchten, erstellen Sie eine Kopie. Wenn Sie eine Schlummerfunktion kopieren, wird der Editor für die Schlummerfunktion mit allen Feldern geöffnet, mit Ausnahme der Startzeit, die auf die Werte der ursprünglichen Schlummerfunktion festgelegt ist. 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. Wählen Sie in der Liste der Schlummerfunktionen die Schlummerfunktion aus, die Sie bearbeiten möchten, und wählen Sie dann im Menü Weitere Optionen die Option Zurückstellen kopieren aus.
  4. Übernehmen Sie die Änderungen in der Kopie und klicken Sie dann auf Erstellen.

Nächste Schritte