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 festgelegt, unter welchen Umständen und wie Sie benachrichtigt werden möchten. Es gibt verschiedene Ansätze, um sich benachrichtigen zu lassen, wenn Inhalte oder Muster in Ihren Trace-Daten auftreten:

  • Wenn Sie die Anzahl der pro Monat aufgenommenen Cloud Trace-Spans, Ihre Kontingentnutzung und die Rate der Span-Aufnahme im Blick behalten möchten, erstellen Sie Benachrichtigungsrichtlinien in Cloud Monitoring. Wenn Sie noch nie eine Benachrichtigungsrichtlinie erstellt haben, finden Sie unter Benachrichtigungsrichtlinien erstellen detaillierte Informationen zur Verwendung der Cloud Monitoring-Konsole.

  • Wenn Sie einzelne Traces oder Spans aufrufen oder untersuchen oder Attribute aufrufen möchten, die an Spans angehängt 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. Schließlich erstellen Sie die Benachrichtigungsrichtlinie, um die SQL-Abfrageergebnisse zu überwachen. Diese Art von Benachrichtigungsrichtlinie wird als SQL-basierte Benachrichtigungsrichtlinie bezeichnet.

    Weitere Informationen zum Speichern Ihrer Trace-Daten finden Sie unter Speicher – Übersicht.

    Im weiteren Verlauf 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, die Ihre Daten abfragt. Die Bedingung definiert auch die Umstände, unter denen das Abfrageergebnis dazu führt, dass Monitoring eine Benachrichtigung erstellt.

  • Der Zeitplan definiert, wie oft die Benachrichtigungsrichtlinie ihre Abfrage ausführt. Der Zeitplan definiert auch die Größe des Lookback-Windows. Das ist ein Filter, der nur Daten auswählt, 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, das die letzten 60 Minuten der Daten auswählt.

Benachrichtigungsrichtlinien enthalten auch eine Liste von Benachrichtigungskanälen. Wenn die Bedingung der Benachrichtigungsrichtlinie erfüllt ist, erstellt Cloud Monitoring eine Benachrichtigung und sendet dann Benachrichtigungen über diese Kanäle. Eine Benachrichtigung ist ein Datensatz, der die Daten enthält, die die Bedingung erfüllt haben, sowie andere relevante Informationen. Diese Informationen können Ihnen bei der Behebung der Probleme helfen, die die Benachrichtigung ausgelöst haben. Sie können die Benachrichtigung in der Google Cloud Console aufrufen.

Bewertungstypen für SQL-basierte Benachrichtigungsrichtlinien

Bedingungen, die ein SQL-Abfrageergebnis überwachen, unterstützen zwei Arten der Auswertung:

  • Grenzwert für die Zeilenanzahl: Die Bedingung ist erfüllt, wenn die Anzahl der Zeilen im Abfrageergebnis größer, 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 Trace-Daten abfragen kann, müssen Sie ein verknüpftes BigQuery-Dataset konfigurieren. Mit verknüpften BigQuery-Datasets kann BigQuery Ihre Trace-Daten 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 Projekt Google Cloud 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-Slot-Reservierungen 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 Zeit bis zur Benachrichtigung

Wenn eine Benachrichtigungsrichtlinie so geplant ist, dass ihre Bedingung ausgewertet wird, verzögert Observability Analytics die Ausführung der SQL-Abfrage um fünf Minuten, damit Cloud Logging die im Lookback-Window empfangenen Daten indexieren kann. Wenn die Benachrichtigungsrichtlinie beispielsweise ein Lookback-Window verwendet, das um 14:00 Uhr endet, führt Observability Analytics die SQL-Abfrage erst um 14:05 Uhr aus.

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

Abfragefehler

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

  • Die Ausführungszeit der Abfrage beträgt mehr als fünf Minuten.

  • Ein interner Fehler ist aufgetreten.

Eine fehlgeschlagene Abfrage generiert einen Logeintrag, der die ID der Benachrichtigungsrichtlinie und den Fehlerstatus enthält. 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 verknüpftes BigQuery-Dataset für Ihre Trace-Daten 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 zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Abfragen von Trace-Daten 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-Dienst-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, die Sie für Benachrichtigungen verwenden 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 Trace-Daten abgefragt werden.

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

    Observability Analytics führt Ihre Abfrage in der BigQuery-Engine aus und zeigt die Ergebnisse in der Tabelle Ergebnisse an.

    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 in In BigQuery ausführen.

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

    Auf der Seite Observability Analytics wird das Fenster SQL-Benachrichtigungsrichtlinie erstellen angezeigt. Ihre Abfrage ist im Abschnitt SQL-Abfrage zu sehen.

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

  6. Konfigurieren Sie die Benachrichtigungsdetails Ihrer Benachrichtigungsrichtlinie.

    1. Fügen Sie Benachrichtigungskanäle hinzu und konfigurieren Sie den Benachrichtigungsinhalt, 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 erstellen Sie sie dann, indem Sie auf Speichern klicken.

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 dann 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 Condition-Typ Ihrer Benachrichtigungsrichtlinie muss conditionSql sein, eine Instanz von SqlCondition. Mit diesem Bedingungstyp können die Bedingungen Ihrer Benachrichtigungsrichtlinie mit SQL definiert werden.

Legen Sie zum Definieren des Zeitplans einen periodicity-Wert für eines der Felder minutes, hours oder days fest. 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 einen wahren Wert 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 Schwellenwert 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

  • Sie können eine Bedingung pro SQL-basierter Benachrichtigungsrichtlinie festlegen.
  • 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 der Planung einer Abfrage und der Erstellung einer Benachrichtigung kann es zu einer Verzögerung von bis zu sieben Minuten kommen, zuzüglich der Ausführungszeit der Abfrage.

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

Nächste Schritte