Ergebnisse von SQL-Abfrage mit einer Benachrichtigungsrichtlinie überwachen

SQL-basierte Benachrichtigungsrichtlinien in Observability Analytics führen regelmäßig SQL-Abfragen für Ihre Cloud Trace-Daten aus und senden Ihnen Benachrichtigungen, wenn die Ergebnisse die von Ihnen angegebenen Bedingungen erfüllen. Diese Richtlinien werden in der BigQuery-Engine ausgeführt und erfordern ein verknüpftes BigQuery-Dataset. Allgemeine Informationen zu Observability Analytics finden Sie unter Traces mit Observability Analytics abfragen und analysieren.

Funktionsweise von Benachrichtigungsrichtlinien

In einer Benachrichtigungsrichtlinie wird beschrieben, unter welchen Umständen Sie benachrichtigt werden möchten und wie Sie über eine Benachrichtigung informiert werden möchten. Es gibt verschiedene Möglichkeiten, sich benachrichtigen zu lassen, wenn Inhalte oder Muster in Ihren Tracedaten erscheinen:

  • Wenn Sie die Anzahl der monatlich aufgenommenen Cloud Trace-Spans, Ihre Kontingentnutzung und die Rate der Span-Aufnahme überwachen möchten, erstellen Sie Benachrichtigungsrichtlinien in Cloud Monitoring. Wenn Sie noch nie eine Benachrichtigungsrichtlinie erstellt haben, finden Sie unter Benachrichtigungsrichtlinien erstellen ausführliche Informationen zur Verwendung der Cloud Monitoring Console.

  • Wenn Sie einzelne Traces oder Spans aufrufen oder untersuchen oder Attribute ansehen möchten, die mit Spans verknüpft sind, verwenden Sie die Seite Trace Explorer. Informationen zu dieser Seite finden Sie unter Traces finden und ansehen.

  • Wenn Sie die aggregierte Analyse Ihrer Trace-Daten im Blick behalten möchten, kombinieren Sie Observability Analytics mit Benachrichtigungsrichtlinien. In diesem Szenario verwenden Sie SQL-Abfragen, um die Ansicht _AllSpans im Observability-Bucket mit dem Namen _Trace abzufragen. Zum Schluss erstellen Sie die Benachrichtigungsrichtlinie, um die Ergebnisse der SQL-Abfrage zu überwachen. Diese Art von Benachrichtigungsrichtlinie wird als SQL-basierte Benachrichtigungsrichtlinie bezeichnet.

    Weitere Informationen zum Speichern von Tracedaten finden Sie unter Speicher – Übersicht.

    Im Rest dieses Dokuments wird beschrieben, wie Sie SQL-basierte Benachrichtigungsrichtlinien verwenden.

Komponenten von Benachrichtigungsrichtlinien

Eine SQL-basierte Benachrichtigungsrichtlinie enthält eine Bedingung und einen Zeitplan:

  • Die Bedingung enthält die Abfrage, eine SQL-Abfrage, mit der Ihre Daten abgefragt werden. Die Bedingung definiert auch die Umstände, unter denen durch das Abfrageergebnis eine Benachrichtigung in Monitoring erstellt wird.

  • Mit dem Zeitplan wird festgelegt, wie oft die Abfrage der Benachrichtigungsrichtlinie ausgeführt wird. Im Zeitplan wird auch die Größe des Lookback-Windows definiert. Das ist ein Filter, mit dem nur Daten ausgewählt werden, die seit der letzten Auswertung der Abfrage empfangen wurden. Wenn Sie den Zeitplan beispielsweise auf 60 Minuten festlegen, wird die Abfrage alle 60 Minuten mit einem Lookback-Window ausgeführt, in dem die Daten der letzten 60 Minuten ausgewählt werden.

Benachrichtigungsrichtlinien enthalten auch eine Liste mit Benachrichtigungskanälen. Wenn die Bedingung der Benachrichtigungsrichtlinie erfüllt ist, erstellt Cloud Monitoring eine Benachrichtigung und sendet dann Benachrichtigungen zu dieser Benachrichtigung über diese Kanäle. Eine Benachrichtigung ist ein Datensatz mit den Daten, die dazu geführt haben, dass die Bedingung erfüllt wurde, sowie anderen relevanten Informationen. Diese Informationen können Ihnen bei der Fehlerbehebung der Probleme helfen, die den Hinweis ausgelöst haben. Sie können die Benachrichtigung über die Google Cloud Console aufrufen.

Auswertungstypen für SQL-basierte Benachrichtigungsrichtlinien

Bedingungen, die das Ergebnis einer SQL-Abfrage überwachen, unterstützen zwei Arten der Auswertung:

  • Grenzwert für die Zeilenanzahl: Die Bedingung wird erfüllt, wenn die Anzahl der Zeilen im Abfrageergebnis größer als, gleich oder kleiner als ein Grenzwert ist.

  • Boolesch: Die Bedingung ist erfüllt, wenn eine bestimmte boolesche Spalte in der Abfrageergebnistabelle eine Zeile mit dem Wert true enthält.

Benachrichtigungsrichtlinien, die das Ergebnis einer SQL-Abfrage überwachen, dürfen nur eine Bedingung haben.

Benachrichtigungsrichtlinien und BigQuery

Damit eine Benachrichtigungsrichtlinie Ihre Tracedaten abfragen kann, müssen Sie ein verknüpftes BigQuery-Dataset konfigurieren. Mit verknüpften BigQuery-Datasets kann BigQuery Ihre Tracedaten lesen und Sie können BigQuery-Funktionen für die von Ihrer SQL-Abfrage zurückgegebenen Daten ausführen.

Wenn eine Benachrichtigungsrichtlinie eine SQL-Abfrage ausführt, wird diese Abfrage in der BigQuery-Engine im Google Cloud Projekt ausgeführt, in dem die Benachrichtigungsrichtlinie definiert ist. Standardmäßig werden Abfragen, die in der BigQuery-Engine ausgeführt werden, mit On-Demand-Slots ausgeführt. Für On-Demand-Slots und reservierte Slots gelten die BigQuery-Preise.

Sie können auch dedizierte BigQuery-Slotreservierungen für Ihr Projekt konfigurieren:

  1. Erstellen Sie eine Reservierung mit dedizierten Slots oder identifizieren Sie eine vorhandene Reservierung.
  2. Reservierungszuweisungen für Ihr Projekt erstellen

Lookback-Window und Benachrichtigungszeit

Wenn eine Benachrichtigungsrichtlinie so geplant ist, dass ihr Zustand ausgewertet wird, verzögert Observability Analytics die Ausführung der SQL-Abfrage um fünf Minuten, damit Cloud Logging Zeit hat, die während des Lookback-Windows empfangenen Daten zu indexieren. Wenn die Benachrichtigungsrichtlinie beispielsweise ein Lookback-Window verwendet, das um 14:00 Uhr endet, wird die SQL-Abfrage in Observability Analytics erst um 14:05 Uhr ausgeführt.

Wenn die Benachrichtigungsbedingung nach der Ausführung der Abfrage erfüllt ist, kann es bis zu zwei weitere Minuten dauern, bis die Benachrichtigung im System weitergegeben wird.

Fehler bei Abfragen

Abfragen, die von SQL-basierten Benachrichtigungsrichtlinien ausgegeben werden, können aus verschiedenen Gründen fehlschlagen, darunter:

  • Das Monitoring-Dienstkonto ist nicht mehr vorhanden oder hat nicht mehr die erforderlichen Berechtigungen zum Lesen der abgefragten Tracedaten.

  • Die Ausführungszeit der Abfrage überschreitet fünf Minuten.

  • Ein interner Fehler ist aufgetreten.

Bei einer fehlgeschlagenen Abfrage wird ein Logeintrag mit der ID der Benachrichtigungsrichtlinie und dem Fehlerstatus generiert. Sie können eine logbasierte Benachrichtigungsrichtlinie verwenden, um eine Benachrichtigung zu erstellen, wenn ein Fehler protokolliert wird.

Hinweis

In diesem Abschnitt wird davon ausgegangen, dass Sie ein mit BigQuery verknüpftes Dataset für Ihre Tracedaten haben.

Führen Sie die folgenden Schritte aus, bevor Sie eine SQL-basierte Benachrichtigungsrichtlinie erstellen:

  1. Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen für Ihr Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Abfragen von Tracedaten und zum Erstellen von SQL-basierten Benachrichtigungsrichtlinien benötigen:

  2. Prüfen Sie, ob das Monitoring-Dienstkonto vorhanden ist und die folgenden Rollen hat:

    1. Monitoring Service Agent (roles/monitoring.notificationServiceAgent) für Ihr Projekt.
    2. BigQuery-Datenbetrachter (roles/bigquery.dataViewer) für Ihr verknüpftes BigQuery-Dataset.

    Wenn das Monitoring-Dienstkonto nicht vorhanden ist, lesen Sie den Abschnitt Fehlerbehebung: Kein Monitoring-Dienstkonto.

  3. Konfigurieren Sie die Benachrichtigungskanäle, über die Sie Benachrichtigungen erhalten möchten. Aus Redundanzgründen empfehlen wir, mehrere Arten von Benachrichtigungskanälen zu konfigurieren. Weitere Informationen finden Sie unter Benachrichtigungskanäle erstellen und verwalten.

SQL-basierte Benachrichtigungsrichtlinie erstellen

So erstellen Sie eine SQL-basierte Benachrichtigungsrichtlinie:

Console

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

    Zu Observability Analytics

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis mit der Zwischenüberschrift Logging aus.

  2. Geben Sie auf der Seite Observability Analytics im Abfrageeditor eine SQL-Abfrage ein, mit der Ihre Tracedaten abgefragt werden.

  3. Klicken Sie in der Symbolleiste auf In BigQuery ausführen.

    Bei Observability Analytics wird Ihre Abfrage in der BigQuery-Engine ausgeführt und die Ergebnisse werden in der Tabelle Results (Ergebnisse) angezeigt.

    Wenn In BigQuery ausführen nicht angezeigt wird, klicken Sie auf  Abfrage-Engine auswählen und dann auf BigQuery. Der Button Abfrage ausführen ändert sich zu In BigQuery ausführen.

  4. Klicken Sie auf der Seite Beobachtbarkeitsanalyse in der Tabelle Ergebnisse auf  Benachrichtigung erstellen.

    Auf der Seite Observability Analytics wird das Fenster SQL-Benachrichtigungsrichtlinie erstellen angezeigt. Ihre Abfrage wird im Bereich SQL-Abfrage angezeigt.

  5. Konfigurieren Sie im Bereich Benachrichtigungsbedingung die Bedingung und den Zeitplan Ihrer Benachrichtigungsrichtlinie.

  6. Konfigurieren Sie die Benachrichtigungsdetails Ihrer Benachrichtigungsrichtlinie.

    1. Benachrichtigungskanäle hinzufügen und Benachrichtigungsinhalte konfigurieren, z. B. eine benutzerdefinierte Betreffzeile.

    2. Optional: Fügen Sie Labels für Benachrichtigungsrichtlinien und Dokumentation hinzu.

    3. Klicken Sie auf Weiter.

  7. Prüfen Sie die Benachrichtigungsrichtlinie und klicken Sie dann auf Speichern, um sie zu erstellen.

Terraform

  1. Installieren und konfigurieren Sie Terraform für Ihr Projekt. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt aus.

  2. Wechseln Sie in Cloud Shell zu dem Verzeichnis, das Ihre Terraform-Konfiguration enthält.

  3. Konfigurieren Sie in Ihrer Terraform-Konfiguration eine Instanz der Ressource google_monitoring_alert_policy, einschließlich condition_sql.

  4. Geben Sie in Cloud Shell terraform apply ein.

Wenn Sie Ihre Benachrichtigungsrichtlinie ändern möchten, nehmen Sie die gewünschten Änderungen vor und wenden Sie die Terraform-Konfiguration noch einmal an. Weitere Informationen finden Sie unter Benachrichtigungsrichtlinien mit Terraform verwalten.

Allgemeine Informationen zur Verwendung von Google Cloud mit Terraform finden Sie unter Terraform mit Google Cloud.

REST

Verwenden Sie die Methode alertPolicies.create, um Benachrichtigungsrichtlinien programmatisch zu erstellen. Der Typ Condition Ihrer Benachrichtigungsrichtlinie muss MonitoringQueryLanguageCondition sein, eine Instanz von SqlCondition. Mit diesem Bedingungstyp können die Bedingungen Ihrer Benachrichtigungsrichtlinie mit SQL definiert werden.

Legen Sie einen periodicity-Wert für eines der Felder minutes, hours oder days fest, um den Zeitplan zu definieren. Wenn die Abfrage beispielsweise alle 12 Stunden ausgeführt werden soll, legen Sie die Periodizität des Felds hours auf 12 fest.

Verwenden Sie die folgenden Felder, um die Bedingung zu definieren:

  • boolean_test: Konfiguriert die Benachrichtigungsrichtlinie so, dass ihre Bedingung erfüllt ist, wenn eine Zeile einer booleschen Spalte in der Abfrageergebnistabelle den Wert „true“ enthält.
  • row_count_test: Konfiguriert die Benachrichtigungsrichtlinie so, dass ihre Bedingung erfüllt ist, wenn die Anzahl der Zeilen in der Abfrageergebnistabelle einen bestimmten Grenzwert erreicht.

Eine vollständige Liste der Felder und Definitionen finden Sie in der Cloud Monitoring API-Dokumentation unter SqlCondition.

Weitere Informationen zur Monitoring API für Benachrichtigungsrichtlinien finden Sie unter Benachrichtigungsrichtlinien über API verwalten.

Beschränkungen

  • Jede SQL-basierte Benachrichtigungsrichtlinie kann nur eine Bedingung enthalten.
  • SQL-basierte Benachrichtigungsrichtlinien können keine Analyseansicht abfragen.

  • Abfragen, die von SQL-basierten Benachrichtigungsrichtlinien ausgegeben werden, schlagen fehl, wenn ihre Ausführungszeit fünf Minuten überschreitet.

  • Zwischen dem Zeitpunkt, zu dem eine Abfrage geplant wird, und dem Zeitpunkt, zu dem eine Benachrichtigung erstellt wird, kann es zu einer Verzögerung von bis zu sieben Minuten plus der Abfrageausführungszeit kommen.

Eine vollständige Liste der Grenzwerte für Benachrichtigungsrichtlinien finden Sie unter Monitoring-Grenzwerte.

Nächste Schritte