Einstellungen für die Beobachtbarkeit verwalten

In diesem Dokument wird beschrieben, wie Sie die Einstellungen für die Beobachtbarkeit für Ihre Gemini Enterprise-App über die Google Cloud Console konfigurieren. Nachdem Sie die Einstellungen aktiviert haben, können Sie die folgenden Daten aus Ihren Interaktionen mit dem Assistenten in Ihrer Gemini Enterprise-Webanwendung aufrufen:

  • Messwerte im Metrics Explorer aufrufen
  • Traces und Spans im Trace Explorer ansehen.

Wichtige Konzepte

In diesem Abschnitt werden wichtige Konzepte im Zusammenhang mit der Beobachtbarkeit in Gemini Enterprise vorgestellt.

Konzept Beschreibung
Trace Ein Trace ist eine Sammlung von Spans, die eine einzelne Anfrage oder Transaktion darstellen, während sie durch verschiedene Dienste und Komponenten fließt.

Ein Trace stellt beispielsweise den gesamten Lebenszyklus einer Anfrage dar. Dazu gehören Fragen, die Nutzer dem Gemini Enterprise-Assistenten stellen, Antworten des Gemini Enterprise-Assistenten und alle nachfolgenden Aktionen, die durch die Antwort ausgelöst werden, z. B. das Senden einer E‑Mail.
Span Ein Span ist eine einzelne, zeitlich begrenzte Arbeitseinheit innerhalb eines Traces. Sie steht für einen bestimmten Vorgang, z. B. einen Funktionsaufruf, eine API-Anfrage oder eine Datenbankabfrage. Jeder Span enthält Details wie Start- und Endzeit, eine eindeutige ID und die Beziehung zu anderen Spans. Diese Beziehungen bilden zusammen einen Trace.
Span-Logs Spannenlogs sind mit Zeitstempeln versehene Nachrichten oder Ereignisse im Freiformat, die einer bestimmten Spanne zugeordnet sind. Sie liefern detaillierte, kontextbezogene Informationen zur Ausführung eines Spans und helfen Nutzern so, Probleme zu beheben und den Ablauf einer Anfrage nachzuvollziehen.
Messwerte Messwerte sind numerische Messungen, die von Systemen im Laufe der Zeit erfasst werden. Diese Messungen geben die Leistung, Ressourcennutzung oder das Verhalten eines Systems an. Entwickler verwenden Messwerte, um den Systemzustand zu überwachen, Trends zu erkennen und Benachrichtigungen auszulösen.
Audit-Logs zur Nutzung Nutzungs-Audit-Logs sind Aufzeichnungen von Administratoraktivitäten und Zugriffen in Ihren Google Cloud -Ressourcen. Sie enthalten detaillierte Informationen dazu, wer welche Aktion wann und wo ausgeführt hat. Diese Logs sind für Sicherheitsprüfungen, Compliance und das Verständnis der Nutzung Ihrer Ressourcen unerlässlich.
Fehlerlogs für Gemini Enterprise-Connector In den Fehlerprotokollen für Gemini Enterprise-Connectors werden Fehler und Probleme erfasst, die bei der Integration von Gemini Enterprise mit Drittanbieter-Datenquellen wie Jira und Microsoft OneDrive auftreten. Diese Protokolle enthalten Verbindungsprobleme, Probleme bei der Datentransformation und API-Fehler.

Hinweis

Sie benötigen Folgendes:

Einstellungen für die Beobachtbarkeit aktivieren

Wenn Sie die Observability für Ihre Gemini Enterprise-App aktivieren möchten, können Sie entweder dieGoogle Cloud Console oder die REST API verwenden.

Console

So aktivieren Sie die Einstellungen für die Beobachtbarkeit über die Google Cloud Console:

  1. Rufen Sie in der Google Cloud Console die Seite Gemini Enterprise auf.

    Gemini Enterprise

  2. Klicken Sie auf den Namen der Anwendung, die Sie konfigurieren möchten.

  3. Klicken Sie auf Konfigurationen und dann auf den Tab Beobachtbarkeit.

  4. Sie können die folgenden Einstellungen aktivieren oder deaktivieren:

    Einstellung für Beobachtbarkeit Beschreibung
    Instrumentierung von OpenTelemetry-Traces und ‑Logs aktivieren Wenn diese Option aktiviert ist, können Sie in Cloud Logging Traces, Spans, Span-Logs und Messwerte ansehen, die mit Ihren Logs verknüpft sind.
    Logging von Prompt-Eingaben und Antwortausgaben aktivieren Wenn diese Option aktiviert ist, werden in Cloud Logging die vollständigen Inhalte von Nutzer-Prompts und ‑Antworten protokolliert. Dazu gehören vertrauliche Daten oder personenidentifizierbare Informationen. Wenn Sie diese Einstellung aktivieren möchten, müssen Sie zuerst Instrumentierung von OpenTelemetry-Traces und ‑Logs aktivieren aktivieren.

REST

Informationen zum Konfigurieren von Einstellungen für die Beobachtbarkeit mit der REST API finden Sie in den folgenden Abschnitten:

Beobachtbarkeit beim Erstellen einer App aktivieren

Führen Sie den folgenden Befehl aus, um eine neue App mit aktivierter Observability zu erstellen:

curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines?engineId=APP_ID" \
-d '{
  "name": "projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID",
  "displayName": "APP_DISPLAY_NAME",
  "solutionType": "SOLUTION_TYPE_SEARCH",
  "searchEngineConfig": {
    "searchTier": "SEARCH_TIER_ENTERPRISE",
    "searchAddOns": ["SEARCH_ADD_ON_LLM"],
    "requiredSubscriptionTier": "SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT"
  },
  "industryVertical": "GENERIC",
  "appType": "APP_TYPE_INTRANET",
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

Ersetzen Sie Folgendes:

  • ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Geben Sie einen der folgenden Werte an:
  • us für die Multiregion „USA“
  • eu für die Multiregion „EU“
  • global für den Standort „Global“
Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
  • PROJECT_ID: die Projekt-ID.
  • LOCATION: die Multiregion Ihres Datenspeichers: global, us oder eu
  • APP_ID: die ID der App, die Sie erstellen möchten.
  • APP_DISPLAY_NAME: der Anzeigename der App, die Sie erstellen möchten.

    • Beobachtbarkeit für eine vorhandene App aktivieren

    Führen Sie den folgenden Befehl aus, um die Observability für eine vorhandene App zu aktivieren:

    curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": true,
    "sensitiveLoggingEnabled": true
  }
}'

    Ersetzen Sie Folgendes:

    • ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Geben Sie einen der folgenden Werte an:
    • us für die Multiregion „USA“
    • eu für die Multiregion „EU“
    • global für den Standort „Global“
    Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
  • PROJECT_ID: die Projekt-ID.
  • LOCATION: die Multiregion Ihres Datenspeichers: global, us oder eu
  • APP_ID: die ID der App.

    • Einstellungen für Beobachtbarkeit deaktivieren

    Wenn Sie die Einstellungen für die Beobachtbarkeit für Ihre Gemini Enterprise-App deaktivieren möchten, können Sie entweder die Google Cloud Console oder die REST API verwenden.

    Console

    So deaktivieren Sie die Einstellungen für die Beobachtbarkeit über die Google Cloud Console:

    1. Rufen Sie in der Google Cloud Console die Seite Gemini Enterprise auf.

      Gemini Enterprise

    2. Klicken Sie auf den Namen der App, für die Sie die Einstellungen für die Beobachtbarkeit deaktivieren möchten.

    3. Klicken Sie auf Konfigurationen und dann auf den Tab Beobachtbarkeit.

    4. Sie können die folgenden Einstellungen deaktivieren:

      Einstellung für Beobachtbarkeit Beschreibung
      Instrumentierung von OpenTelemetry-Traces und ‑Logs aktivieren Wenn diese Einstellung deaktiviert ist, werden keine Traces, Spans, Span-Logs und Messwerte mehr erfasst. Außerdem wird die Einstellung Logging von Prompt-Eingaben und Antwortausgaben aktivieren deaktiviert. Das bedeutet, dass keine Logs an Cloud Logging gesendet werden.
      Logging von Prompt-Eingaben und Antwortausgaben aktivieren Wenn diese Option deaktiviert ist, werden Prompt-Eingaben und Antwortausgaben nicht in Cloud Logging protokolliert.

    REST

    Führen Sie den folgenden Befehl aus, um die Einstellungen für die Beobachtbarkeit mit der REST API zu deaktivieren:

    curl -X PATCH -H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json" \
-H "X-Goog-User-Project: PROJECT_ID" \
"https://ENDPOINT_LOCATION-discoveryengine.googleapis.com/v1alpha/projects/PROJECT_ID/locations/LOCATION/collections/default_collection/engines/APP_ID?updateMask=observabilityConfig" \
-d '{
  "observabilityConfig": {
    "observabilityEnabled": false,
    "sensitiveLoggingEnabled": false
  }
}'

    Ersetzen Sie Folgendes:

    • ENDPOINT_LOCATION: die Multiregion für Ihre API-Anfrage. Geben Sie einen der folgenden Werte an:
    • us für die Multiregion „USA“
    • eu für die Multiregion „EU“
    • global für den Standort „Global“
    Weitere Informationen zum Festlegen multiregionaler Standorte für Ihren Datenspeicher.
  • PROJECT_ID: die Projekt-ID.
  • LOCATION: die Multiregion Ihres Datenspeichers: global, us oder eu
  • APP_ID: die ID der App.

    • Nächste Schritte