In diesem Dokument wird beschrieben, wie Sie ein Dashboard so konfigurieren, dass Ereignisannotationen angezeigt werden. Ein Ereignis ist eine Aktivität, z. B. eine Bereitstellung oder ein Absturz, die sich auf den Betrieb eines Systems auswirkt. Wenn Sie Ereignisannotationen anzeigen, können Sie Daten aus verschiedenen Quellen korrelieren, wenn Sie ein Problem beheben.
Diese Funktion wird nur für Google Cloud Projekte unterstützt. Wählen Sie für App Hub Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt aus.
Ereignisannotationen
Sie können Ereignisse auf den meisten Dashboards anzeigen, die auf der Dashboards Seite der Google Cloud Console aufgeführt sind. Ebenso können Sie einige dienstspezifische Beobachtbarkeit -Tabs, z. B. für Compute Engine und Google Kubernetes Engine, so konfigurieren, dass Ereignisse angezeigt werden. In der Google Cloud Console können Sie die Ereignistypen konfigurieren, die auf einem Dashboard oder auf einem Beobachtbarkeit -Tab angezeigt werden. Für Dashboards, die Sie erstellen und die als benutzerdefinierte Dashboards klassifiziert sind, können Sie auch die Cloud Monitoring API verwenden.
Wenn Sie die Cloud Monitoring API nicht verwenden oder keine Aktion ausführen, um Ihre Auswahl der Ereignistypen zu speichern, gilt Ihre Auswahl nur für die aktuelle Sitzung. Wenn Sie die Google Cloud Console verwenden, werden Ihre Auswahlmöglichkeiten durch das Anpinnen gespeichert.
Eine Liste der Ereignistypen, Referenzen zur Fehlerbehebung und weitere Informationen, finden Sie auf der Seite Ereignistypen.
Empfohlene Ereignistypen
Möglicherweise werden die folgenden Ereignistypen auf einem Dashboard oder einem Beobachtbarkeit -Tab aktiviert angezeigt, obwohl Sie keine Ereignistypen ausgewählt haben:
- Benachrichtigung geöffnet.
- Personalized Service Health-Vorfall, wenn die Service Health API aktiviert ist.
- Für jeden Typ von Ressource mit Daten, die auf dem Dashboard angezeigt werden, ein Ereignistyp.
Wenn ein Ereignistyp automatisch hinzugefügt wird, handelt es sich um einen empfohlenen Ereignistyp. Sie können diese Ereignistypen im empfohlenen Zustand belassen, sie im Dashboard-JSON speichern oder sie ablehnen, wodurch die Empfehlung entfernt wird. Wenn Sie festlegen möchten, welche Ereignistypen gespeichert werden, maximieren Sie das Menü Annotationen und rufen Sie den Bereich Angepinnt auf.
Ereignisse identifizieren
Dashboards fragen verschiedene Datenquellen ab, um die Ereignisse zu identifizieren, die auf Ihrem Dashboard angezeigt werden sollen:
Benachrichtigungsereignisse werden von Monitoring identifiziert. Benachrichtigungsereignisse enthalten Informationen dazu, wann Vorfälle erstellt wurden.
Personalisierte Service Health-Ereignisse werden durch Abfragen identifiziert, die von Monitoring an die Service Health API gesendet werden. Diese Ereignisse geben an, wann es zu einer Unterbrechung in einem Google Cloud Dienst kommt.
Alle anderen Ereignistypen werden durch die Analyse der Logeinträge identifiziert, die die Cloud Logging-Senken in Ihrem Google Cloud Projekt durchlaufen. Diese Logeinträge umfassen Einträge, die von Ihrem Projekt generiert wurden, und Einträge, die an Ihr Projekt weitergeleitet wurden. Wenn Sie benachrichtigt werden möchten, wenn eines dieser Ereignisse eintritt, können Sie eine logbasierte Benachrichtigungsrichtlinie erstellen. Verwenden Sie in der Benachrichtigungsrichtlinie die Abfragen, die auf der Seite Ereignistypen bereitgestellt werden.
Ereignisse anzeigen
Alle Ereignisse werden bei ihrem Eintreten in den Diagrammen auf Ihrem Dashboard mit Annotationen versehen. Ereignisse, die durch die Analyse von Logeinträgen identifiziert werden, werden mit einer einzelnen Zeitreferenz angezeigt. Im Gegensatz dazu werden Service Health-Ereignisse mit einer Startzeit angezeigt. Der Hintergrund des Diagramms wird für die Dauer des Ereignisses geändert. Für diese Ereignisse wird auch ein Herzsymbol angezeigt.
Der folgende Screenshot zeigt ein Diagramm mit mehreren Ereignissen, die durch die Analyse von Logeinträgen identifiziert wurden, und einem Service Health-Ereignis:
Wie im vorherigen Screenshot dargestellt, enthält die Kurzinfo für ein Ereignis Informationen wie die folgenden:
- Ereignisname
- Datum und Startzeit des Ereignisses
- Für Service Health-Ereignisse Chips mit der Anzahl der betroffenen Produkte und Standorte Wenn Sie die betroffenen Produkte oder Standorte auflisten möchten, setzen Sie den Mauszeiger auf den entsprechenden Chip.
- Eine Schaltfläche Ansehen, die beim Auswählen eine Seite mit weiteren Informationen zum Ereignis öffnet. Beispielsweise kann der Log-Explorer geöffnet werden, damit Sie Logeinträge aufrufen können, oder die Detailseite für ein Service Health-Ereignis.
Dashboardfilter, die die auf einem Dashboard angezeigten Daten einschränken, filtern in der Regel sowohl Zeitachsendaten als auch Ereignisse.
Hinweis
Führen Sie die folgenden Schritte für das Google Cloud Projekt aus, in dem Sie Ereignisse auf Dashboards aufrufen möchten:
-
Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für Ihr Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Aufrufen und Anzeigen von Ereignissen auf Dashboards und zum Erstellen von Benachrichtigungsrichtlinien benötigen:
-
Dashboards und Benachrichtigungsrichtlinien aufrufen und erstellen:
Monitoring-Bearbeiter (
roles/monitoring.editor). -
Ereignisse aufrufen und anzeigen, die aus Logeinträgen ohne Datenzugriff identifiziert wurden, die in Ihrem Google Cloud Projekt:
Logbetrachter (
roles/logging.viewer). -
Ereignisse aufrufen und anzeigen, die aus beliebigen Logeinträgen identifiziert wurden, die in Ihrem Google Cloud Projekt erstellt wurden:
Betrachter privater Logs (
roles/logging.privateLogViewer). -
Service Health-Ereignisse aufrufen:
Betrachter von Personalized Service Health (
roles/servicehealth.viewer)
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.
-
Dashboards und Benachrichtigungsrichtlinien aufrufen und erstellen:
Monitoring-Bearbeiter (
Wenn Sie Service Health-Ereignisse auf Ihrem Dashboard anzeigen möchten, aktivieren Sie die Service Health API:
Rollen, die zum Aktivieren von APIs erforderlich sind
Zum Aktivieren von APIs benötigen Sie die IAM-Rolle „Service Usage-Administrator“ (
roles/serviceusage.serviceUsageAdmin), die die Berechtigungserviceusage.services.enableenthält. Informationen zum Zuweisen von Rollen.
Ereignisse anzeigen
In diesem Abschnitt wird beschrieben, wie Sie ein Dashboard oder einen Beobachtbarkeit -Tab so konfigurieren, dass Ereignisse angezeigt werden.
Dashboards so konfigurieren, dass Ereignisse angezeigt werden
In diesem Abschnitt wird beschrieben, wie Sie Dashboards, die in der Dashboards Seite der Google Cloud Console aufgeführt sind, so konfigurieren, dass Ereignisse angezeigt werden.
Eine Liste der Ereignistypen, Referenzen zur Fehlerbehebung und Abfragen, die mit dem Log-Explorer oder mit logbasierten Benachrichtigungsrichtlinien verwendet werden können, finden Sie auf der Seite Ereignistypen.
Console
So zeigen Sie Ereignisse auf einem Dashboard an:
-
Öffnen Sie in der Google Cloud Console die Dashboards Seite:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.
- Wählen Sie in der Symbolleiste der Google Cloud Console Ihr Google Cloud -Projekt aus. Wählen Sie für App Hub Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt aus.
- Wählen Sie das Dashboard aus, das Sie aufrufen möchten.
- Klicken Sie in der Symbolleiste des Dashboards auf
Annotationen und wählen Sie die Ereignistypen aus, die auf Ihrem Dashboard angezeigt werden sollen.
Führen Sie einen der folgenden Schritte aus:
Wenn Sie Ihre Auswahl speichern möchten, damit Ereignisse angezeigt werden, wenn Sie das Dashboard neu laden, klicken Sie auf Ausgewählte anpinnen. Wenn die automatische Speicherung auf Ihrem Dashboard deaktiviert ist, rufen Sie die Symbolleiste des Dashboards auf und klicken Sie auf Speichern.
Wenn Sie Ihre Auswahl anpinnen, ändern Sie die JSON-Definition des Dashboards. Wenn das Dashboard wieder geöffnet wird, werden Ihre Auswahlmöglichkeiten geladen und auf dem Dashboard werden Annotationen für die entsprechenden Ereignistypen angezeigt.
Wenn Sie Ihre Ereignistypen nur für die aktuelle Sitzung anzeigen möchten, klicken Sie auf Anwenden.
Nachdem Sie die Liste der anzuzeigenden Ereignistypen aktualisiert haben, führt Cloud Monitoring Abfragen aus. Dies dauert einige Augenblicke. Anschließend werden die Annotationen den Diagrammen auf dem Dashboard hinzugefügt.
Wenn Sie eine Zusammenfassung eines Ereignisses aufrufen oder auf Links zu zusätzlichen Informationen zugreifen möchten, aktivieren Sie die Kurzinfo mit dem Mauszeiger.
API
Wenn Sie ein benutzerdefiniertes Dashboard so konfigurieren möchten, dass Ereignisse angezeigt werden,
fügen Sie dem Dashboard-Objekt ein Feld annotations hinzu.
Das Feld annotations enthält eine Instanz eines DashboardAnnotations-Objekts, das zwei Felder enthält:
Im Feld
defaultResourceNamesind die Standardwerte auf Dashboardebene für die Google Cloud Projekte aufgeführt, in denen nach Ereignissen gesucht werden soll. Wenn Sie dieses Feld nicht angeben, wird in Ihrem ausgewählten Projekt gesucht.Ein Array von
EventAnnotation-Objekten. Jedes Objekt enthält Folgendes:- Ein Feld
displayName, mit dem Sie das Label für die ereignisspezifische Umschaltfläche definieren können. Wenn dieses Feld nicht angegeben ist oder der Wert dieses Felds ein leerer String ist, wird der Standardname für das Ereignis angezeigt. - Ein Feld
enabled, das den Wert der Umschaltfläche des Ereignisses steuert. Wenntrue, befindet sich die Umschaltfläche in der Positiononund Ereignisse werden auf dem Dashboard angezeigt. Wennfalse, befindet sich die Umschaltfläche in der Positionoff. - Ein Feld
eventType, das einen Wert aus derEventType-Enumeration enthält. - Ein Feld
filter, mit dem Sie eine Abfrage angeben können, die an die ereignisspezifische Abfrage angehängt werden soll. Wenn der Wert dieses Felds ein leerer String ist, wird die ereignisspezifische Abfrage verwendet. - Ein Feld
resourceNames, mit dem Sie eine Liste von Google Cloud Projekten definieren können, in denen nach Ereignissen gesucht werden soll. Wenn dieses Feld ein leeres Array ist, wird in Ihrem ausgewählten Projekt gesucht.
- Ein Feld
Im Folgenden sehen Sie ein Beispiel für ein annotations-Objekt für ein Clusteraktualisierungsereignis. Das Feld filter in diesem Beispiel beschränkt die Ereignisse auf einen bestimmten Cluster:
"annotations": {
"defaultResourceNames": [],
"eventAnnotations": [
{
"displayName": "",
"enabled": true,
"eventType": "GKE_CLUSTER_UPDATE",
"filter": "resource.labels.cluster_name=my-cluster",
"resourceNames": []
}
]
}
Ausführliche Informationen zur Verwendung der Cloud Monitoring API zum Erstellen von Dashboards finden Sie unter Dashboards mithilfe der API erstellen und verwalten und Beispiel: Ereignisse auf Dashboards aktivieren.
Beobachtbarkeit -Tab so konfigurieren, dass Ereignisse angezeigt werden
In diesem Abschnitt wird beschrieben, wie Sie den Beobachtbarkeit -Tab so konfigurieren, dass Ereignisse angezeigt werden. Einige Dienste wie Compute Engine und Google Kubernetes Engine bieten einen Beobachtbarkeit -Tab, auf dem Messwert- und Logdaten angezeigt werden.
Console
So konfigurieren Sie den Beobachtbarkeit -Tab so, dass Ereignisse angezeigt werden:
Rufen Sie den Beobachtbarkeit -Tab für einen Dienst oder ein Produkt auf.
Sie können beispielsweise die Seite Kubernetes-Cluster aufrufen und dann den Tab Beobachtbarkeit auswählen. Ebenso können Sie die Seite Kubernetes-Arbeitslasten oder die Detailseite für eine VM-Instanz (virtuelle Maschine) aufrufen und dann den Tab Beobachtbarkeit auswählen.
Achten Sie darauf, dass das Menü Dashboard auf Vordefiniert eingestellt ist. Ereignisse können nicht auf benutzerdefinierten Dashboards angezeigt werden.
Klicken Sie in der Symbolleiste auf
Annotationen, und füllen Sie das Dialogfeld aus.
Nachdem Sie die Liste der anzuzeigenden Ereignisse aktualisiert haben, werden Abfragen ausgeführt, um die Ereignisdaten abzurufen. Anschließend wird das Dashboard aktualisiert.
Wenn das Menü
Annotationen nicht angezeigt wird, kann der Tab nicht so konfiguriert werden, dass Ereignisse angezeigt werden.
API
Nicht verfügbar.
Termindetails ansehen
Wenn Sie ein Diagramm mit Ereignisannotationen aufrufen, können Sie über die Links in der Kurzinfo auf zusätzliche Informationen zugreifen.
Wenn Sie Details zu einem bestimmten Ereignis aufrufen möchten, klicken Sie auf Ansehen.
Die Google Cloud Console-Seite, die über die Schaltfläche Ansehen geöffnet wird, wird durch den Ereignistyp bestimmt. Bei einem Ereignis für eine Verfügbarkeitsdiagnose wird beispielsweise das Dashboard für die Verfügbarkeitsdiagnose geöffnet. Bei einem anderen Ereignistyp wird möglicherweise der Log-Explorer geöffnet.
Benachrichtigungsrichtlinien erstellen
Wenn Ereignisse durch die Analyse der Logeinträge identifiziert werden, die die Cloud Logging-Senken in Ihrem Google Cloud Projekt durchlaufen, können Sie benachrichtigt werden, wenn diese Ereignisse eintreten. Konfigurieren Sie dazu eine logbasierte Benachrichtigung. Logbasierte Benachrichtigungsrichtlinien fragen Ihre Logeinträge ab, sobald sie empfangen werden. Wenn die Abfrage ein nicht leeres Ergebnis zurückgibt, wird ein Vorfall erstellt und Benachrichtigungen werden gesendet.
Console
So erstellen Sie eine logbasierte Benachrichtigung:
Wenn Sie keinen Benachrichtigungskanal konfiguriert haben, gehen Sie so vor:
-
Rufen Sie in der Google Cloud Console die notifications Benachrichtigungen Seite auf:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.
- Wählen Sie in der Symbolleiste der Google Cloud Console Ihr Google Cloud -Projekt aus. Wählen Sie für App Hub Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt aus.
- Klicken Sie auf Benachrichtigungskanal bearbeiten.
- Rufen Sie den Typ des Benachrichtigungskanals auf, den Sie konfigurieren möchten, klicken Sie auf Neu hinzufügen und füllen Sie dann das Dialogfeld aus.
-
-
Rufen Sie in der Google Cloud Console das Segment und die Seite Log-Explorer auf:
Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis mit der Zwischenüberschrift Logging aus.
Wählen Sie in der Symbolleiste der Google Cloud Console, Ihr Google Cloud Projekt aus.
Wählen Sie in der Symbolleiste Benachrichtigung erstellen aus.
Geben Sie einen Namen für die Benachrichtigungsrichtlinie ein und klicken Sie auf Weiter.
Geben Sie im Bereich Logeinträge für Benachrichtigungen definieren eine Abfrage ein oder aktualisieren Sie die Abfrage, die aus dem Bereich Abfrage kopiert wurde, als Sie Benachrichtigung erstellen ausgewählt haben.
Auf der Seite Ereignistypen ist für jeden Ereignistyp eine Abfrage aufgeführt, die für die Verwendung in einer logbasierten Benachrichtigungsrichtlinie geeignet ist.
Schließen Sie das Dialogfeld ab und klicken Sie auf Speichern.
API
So erstellen Sie eine logbasierte Benachrichtigungsrichtlinie mit der Cloud Monitoring API:
Identifizieren Sie die Abfrage, die in die Bedingung der Benachrichtigungsrichtlinie aufgenommen werden soll. Auf der Seite Ereignistypen ist für jeden Ereignistyp eine Abfrage aufgeführt, die für die Verwendung in einer logbasierten Benachrichtigungsrichtlinie geeignet ist.
Erstellen Sie die JSON-Datei, die die Darstellung der Benachrichtigungsrichtlinie enthält. Weitere Informationen zu diesem Schritt und ein Beispiel finden Sie unter Benachrichtigungsrichtlinie entwerfen.
Rufen Sie die API-Methode alertPolicies.create auf. Sie können beispielsweise den
gcloud monitoring policies createBefehl ausführen.
Ereignisse ausblenden
Console
Wenn Sie alle Ereignisse ausblenden möchten, klicken Sie in der Dashboard-Symbolleiste auf
Annotationen, wählen Sie Löschen und dann
Anwenden aus.
Wenn Sie einen Ereignistyp ausblenden möchten, klicken Sie auf Annotationen,
heben Sie die Auswahl für diesen Ereignistyp auf und wählen Sie dann Anwenden aus.
API
Wenn Sie einen Ereignistyp auf einem benutzerdefinierten Dashboard ausblenden möchten, suchen Sie das
EventAnnotation-Objekt für den Ereignistyp,
und legen Sie dann das enabled-Feld auf false fest.
Ausführliche Informationen zur Verwendung der Cloud Monitoring API finden Sie unter Dashboards mithilfe der API erstellen und verwalten.
Nächste Schritte
- Benutzerdefiniertes Dashboard freigeben
- Im Diagramm aufgeführte Daten untersuchen
- Ressourcenspezifische Dashboards aufrufen
- Benutzerdefinierten Dashboards temporäre Filter hinzufügen
- Benutzerdefinierten Dashboards dauerhafte Filter hinzufügen