Speichern und Teilen von Abfragen.

Sie können SQL-Abfragen in Observability Analytics speichern und freigeben. So können Sie häufige Trace-Untersuchungen wiederholen und mit Teammitgliedern in Ihrem Projekt zusammenarbeiten. Gespeicherte Abfragen können privat für Ihre eigene Verwendung bleiben oder für andere Projektmitglieder freigegeben werden. Wenn Sie noch keine Abfragen in Observability Analytics geschrieben haben, lesen Sie zuerst Traces abfragen und analysieren.

Hinweis

Konfigurieren Sie Ihr Projekt und Ihre IAM-Rollen und wählen Sie die Oberfläche aus, die Sie verwenden möchten.

Projekt und Rollen konfigurieren

  1. Melden Sie sich in Ihrem Google Cloud Konto an. Wenn Sie noch nicht mit Google Cloudvertraut sind, erstellen Sie ein Konto, um die Leistungsfähigkeit unserer Produkte in der Praxis sehen und bewerten zu können. Neukunden erhalten außerdem ein Guthaben von 300 $, um Arbeitslasten auszuführen, zu testen und bereitzustellen.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Roles required to select or create a project

    • Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
    • Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. Enable the Observability API.

    Roles required to enable APIs

    To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

    Enable the API

  8. Bitten Sie Ihren Administrator, Ihnen die folgenden IAM-Rollen zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Laden der Seite Observability Analytics und zum Schreiben, Ausführen und Speichern privater Abfragen für Ihre Trace-Daten benötigen:

    • Observability View Accessor (roles/observability.viewAccessor) für die Observability-Ansichten, die Sie abfragen möchten. Diese Rolle unterstützt IAM-Bedingungen, mit denen Sie die Zuweisung auf eine bestimmte Ansicht beschränken können. Wenn Sie der Rollenzuweisung keine Bedingung hinzufügen, kann das Hauptkonto auf alle Observability-Ansichten zugreifen.
    • Observability Analytics User (roles/observability.analyticsUser) für Ihr Projekt. Diese Rolle enthält die Berechtigungen, die zum Speichern und Ausführen privater Abfragen sowie zum Ausführen freigegebener Abfragen erforderlich sind.

    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.

Oberfläche auswählen, die Sie verwenden möchten

Console

Wenn Sie über die Google Cloud Console auf Google Cloud Dienste und APIs zugreifen, müssen Sie die Authentifizierung nicht einrichten.

gcloud

Aktivieren Sie Cloud Shell in der Google Cloud Console.

Cloud Shell aktivieren

Unten in der Google Cloud Console wird eine Cloud Shell Sitzung gestartet und eine Eingabeaufforderung angezeigt. Cloud Shell ist eine Shell-Umgebung in der das Google Cloud CLI bereits installiert ist und Werte für Ihr aktuelles Projekt bereits festgelegt sind. Das Initialisieren der Sitzung kann einige Sekunden dauern.

REST

Wenn Sie die REST API-Beispiele auf dieser Seite in einer lokalen Entwicklungsumgebung verwenden möchten, verwenden Sie die Anmeldedaten, die Sie der gcloud CLI bereitstellen.

    Installieren Sie die Google Cloud CLI.

    Wenn Sie einen externen Identitätsanbieter (IdP) verwenden, müssen Sie sich zuerst mit Ihrer föderierten Identität in der gcloud CLI anmelden.

Weitere Informationen finden Sie in der Google Cloud Authentifizierungsdokumentation unter Für die Verwendung von REST authentifizieren.

Abfrage speichern

Alle von Ihnen ausgeführten Abfragen werden automatisch 30 Tage lang gespeichert und sind auf der Seite Observability Analytics auf dem Tab Letzte verfügbar. Sie können die Abfragen auf dem Tab Letzte suchen, ansehen, ausführen und freigeben.

Wenn Sie eine Abfrage wiederverwenden, benutzerdefinierte Beschreibungen hinzufügen oder sie für Teammitglieder freigeben möchten, speichern Sie sie. Sie können Ihre gespeicherten Abfragen nach Name, Beschreibung und Sichtbarkeitslabel suchen und sortieren. Außerdem können Sie diese Abfragen bearbeiten und löschen. Gespeicherte Abfragen bleiben so lange erhalten, bis Sie sie löschen.

Sie können pro Google Cloud Projekt 10.000 Abfragen speichern.

Console

So speichern Sie eine Abfrage:

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

    Zu Observability Analytics

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

  2. Füllen Sie den Bereich Abfrage mit einer Abfrage.

    Sie können den Bereich Abfrage füllen, indem Sie eine neue Abfrage eingeben, eine Abfrage auf dem Tab Letzte auswählen oder eine Abfrage auf dem Tab Gespeichert auswählen.

    Ihre Abfrage kann eine beliebige gültige Ansicht, mehrere Ansichten und Analyseansichten enthalten.

    Wenn die Abfrage im Bereich Abfrage gültig ist, ist die Schaltfläche Speichern aktiviert.

  3. Klicken Sie auf Speichern und wählen Sie Abfrage speichern aus. Füllen Sie die Felder Name und Beschreibung aus. Die Werte, die Sie für diese Felder festlegen, werden auf dem Tab Gespeichert angezeigt.

  4. Optional: Wenn alle Nutzer mit Zugriff auf die Observability Analytics Seite für das Google Cloud Projekt Ihre gespeicherte Abfrage ansehen und ausführen können sollen, aktivieren Sie die Option Für Projekt freigeben.

    Diese Option ist standardmäßig deaktiviert und die Sichtbarkeit ist auf Sie beschränkt.

  5. Klicken Sie auf Abfrage speichern.

  6. Optional: Wenn Sie gespeicherte Abfragen ansehen, sortieren und ausführen möchten, die für Sie sichtbar sind, wählen Sie den Tab Gespeichert aus.

    Sie können Ihre gespeicherten Abfragen nach Name, Beschreibung und Sichtbarkeitslabel sortieren und filtern. Außerdem können Sie nach dem Inhalt der Abfrage filtern.

Sie können Abfragen, die Sie mit den Optionen auf dem Tab Gespeichert erstellt haben, bearbeiten und löschen:

  • Klicken Sie zum Bearbeiten einer Abfrage auf das Dreipunkt-Menü Mehr Optionen und wählen Sie Bearbeiten aus. Sie können die Werte für die Felder Name und Beschreibung ändern. Die Abfrage selbst kann jedoch nicht geändert werden.

  • Klicken Sie zum Löschen einer gespeicherten Abfrage auf das Dreipunkt-Menü Mehr Optionen und wählen Sie Löschen aus.

gcloud

So erstellen und speichern Sie eine Abfrage:

  1. Ersetzen Sie folgende Werte, bevor sie einen der Befehlsdaten verwenden:

    • DISPLAY_NAME: Der Anzeigename der gespeicherten Abfrage.
    • LOCATION: Der Standort für die gespeicherte Abfrage.
    • VISIBILITY: Legen Sie private oder shared fest.
    • SQL_QUERY: Eine SQL-Abfrage. Wenn der Pfad oder die Felder im Pfad in einfache Backticks (`) eingeschlossen sind, müssen Sie diese Backticks mit einem Escapezeichen versehen:
          "SELECT * FROM \`PROJECT_ID.LOCATION.my-log-bucket._AllLogs\`"
          

      oder

          "SELECT * FROM \`PROJECT_ID.LOCATION._Trace.Spans._AllSpans\`"
          

      Backticks (`) sind erforderlich, wenn ein Pfadelement einen Punkt (.) enthält.

    • ID: Die ID der gespeicherten Abfrage. Diese ID ist eine erforderliche Eingabe für Befehle mit denen eine gespeicherte Abfrage beschrieben, aktualisiert oder gelöscht wird. Wenn Sie beim Erstellen einer gespeicherten Abfrage keine ID angeben, generiert das System eine numerische ID.
    • DESCRIPTION: Eine Textbeschreibung der Abfrage. Optional.
    • PROJECT_ID: Die Kennung des Projekts.

    Führen Sie den gcloud logging saved-queries create Befehl aus:

    Linux, macOS oder Cloud Shell

    gcloud logging saved-queries create --display-name=DISPLAY_NAME \
     --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY \
     --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Windows (PowerShell)

    gcloud logging saved-queries create --display-name=DISPLAY_NAME `
     --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY `
     --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Windows (cmd.exe)

    gcloud logging saved-queries create --display-name=DISPLAY_NAME ^
     --location=LOCATION --visibility=VISIBILITY --sql-query-text=SQL_QUERY ^
     --id=ID --description=DESCRIPTION --project=PROJECT_ID

    Im Folgenden sehen Sie ein Beispiel für eine Antwort, wenn die im Befehl angegebene ID my-saved-query war:

    Created saved query [projects/PROJECT_ID/locations/LOCATION/savedQueries/my-saved-query].
    

    Die Antwort auf den Befehl create enthält den vollständigen Namen der Abfrage, einschließlich der ID der Abfrage. Die Abfrage-ID, die in diesem Beispiel my-saved-query ist, ist eine erforderliche Eingabe für Google Cloud CLI-Befehle, mit denen eine gespeicherte Abfrage beschrieben, gelöscht oder aktualisiert wird.

  2. Führen Sie den folgenden Befehl aus, um die gespeicherte Abfrage zu prüfen:

     gcloud logging saved-queries list --location=- --project=PROJECT_ID
    

    Im vorherigen Ausdruck ist der Wert für den Standort ein Bindestrich (-), der als Platzhalter fungiert. Sie können auch einen bestimmten Standort angeben.

Es gibt Google Cloud CLI-Befehle zum Löschen, Auflisten, Beschreiben und Aktualisieren gespeicherter Abfragen. Weitere Informationen finden Sie unter gcloud logging saved-queries Übersicht.

REST

Sie können eine Abfrage mit der Cloud Logging API speichern. Verwenden Sie dazu die savedQueries.create Methode.

So führen Sie diese Methode aus:

  1. Wählen Sie savedQueries.create aus.
  2. Verwenden Sie auf der Referenzseite den API Explorer, um einen Befehl auszugeben. Sie müssen das Feld opsAnalyticsQuery angeben.

Das folgende Beispiel zeigt einen Beispielanfragetext, der eine Instanz von SavedQuery enthält:

{
   "parent": "projects/my-project/locations/global"
   "saved_query":
   {
      "ops_analytics_query":
      {
         "sql_query_text" :
            "SELECT
            timestamp, log_name, severity, json_payload, resource, labels
            FROM
            `VIEW`
            WHERE
            timestamp > TIMESTAMP_SUB(CURRENT_TIMESTAMP(), INTERVAL 1 HOUR)
            ORDER BY timestamp ASC
            LIMIT 100"
      }
   "visibility": "PRIVATE"
   }
}

Abfrage freigeben

Sie können eine gespeicherte Abfrage für alle Nutzer freigeben, die Zugriff auf Ihr Google Cloud Projekt haben. Die IAM-Rollen des Hauptkontos bestimmen jedoch, ob die Abfrage ausgeführt werden kann und welche Daten sie zurückgibt.

Console

Wenn Sie ein Problem beheben oder ungewöhnliche Ergebnisse sehen, möchten Sie möglicherweise eine Abfrage und ihre Ergebnisse für ein Teammitglied freigeben. Wenn Sie sich die Abfrageergebnisse auf der Seite Observability Analytics ansehen, können Sie eine URL kopieren, die beim Öffnen die von Ihnen ausgeführte Abfrage und ihre Ergebnisse anzeigt.

So geben Sie eine Abfrage und Ergebnisse für ein Teammitglied frei:

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

    Zu Observability Analytics

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

  2. Füllen Sie den Bereich Abfrage mit einer Abfrage und klicken Sie dann auf Abfrage ausführen.

    Sie können den Bereich Abfrage füllen, indem Sie eine neue Abfrage eingeben, eine Abfrage auf dem Tab Letzte auswählen oder eine Abfrage auf dem Tab Gespeichert auswählen.

  3. Klicken Sie auf Link freigeben.

  4. Senden Sie den Link an Ihr Teammitglied.

    Wenn Ihr Teammitglied den Link öffnet, wird die Seite Observability Analytics geöffnet und die Abfrage angezeigt, aber nicht ausgeführt. Ihr Teammitglied muss die Abfrage manuell ausführen.

    Auf der Seite Observability Analytics wird ein Warnungsdialogfeld angezeigt, wenn die Abfrage in der BigQuery-Engine ausgeführt wird und sich die abgefragten Ressourcen nicht in derselben Eigentümerschaftsgrenze befinden. Eigentümerschaftsgrenzen werden durch mehrere Faktoren bestimmt, darunter die Hierarchie der Ressourcen, die von der Abfrage verwendet werden.

    Damit Ihr Teammitglied die URL öffnen kann, muss die IAM-Rolle für das Google Cloud Projekt die Berechtigungen enthalten, die zum Aufrufen der Observability Analytics Seite erforderlich sind.

gcloud

Wenn Sie eine gespeicherte Abfrage erstellen möchten, die von anderen ausgeführt werden kann, legen Sie den Wert des Felds visibility auf shared fest:

--visibility=shared

Verwenden Sie den Befehl update, um die Sichtbarkeit einer vorhandenen gespeicherten Abfrage zu ändern. Weitere Informationen zu den verfügbaren Befehlen finden Sie unter gcloud logging saved-queries Übersicht.

REST

Mit der Logging API können Sie eine freigegebene Abfrage erstellen, indem Sie die Methode savedQueries.create verwenden und im Feld visibility den Wert SHARED angeben. Weitere Informationen finden Sie auf der Referenzseite für savedQueries.create.

Letzte oder gespeicherte Abfragen ansehen und ausführen

Wenn Sie eine Abfrage ansehen oder noch einmal ausführen möchten, wählen Sie auf der Seite Observability Analytics den Tab Letzte aus und suchen Sie die Abfrage:

  • Klicken Sie zum Ausführen der Abfrage auf Ausführen.
  • Verwenden Sie die Optionen im Mehr Optionen Menü, um die Abfrage anzusehen.

Wenn Sie eine gespeicherte Abfrage ansehen, bearbeiten oder ausführen möchten, wählen Sie auf der Seite Observability Analytics den Tab Gespeichert aus und suchen Sie die Abfrage:

  • Klicken Sie zum Ausführen der Abfrage auf Ausführen.
  • Verwenden Sie die Optionen im Mehr Optionen -Menü, um die Abfrage zu bearbeiten, anzusehen oder zu löschen.

Nächste Schritte