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 oder einzelne Agenten über die Google Cloud Console oder die REST API konfigurieren.

Die Aktivierungslogik hängt vom Agententyp ab:

  • Core Assistant-Agent: Verwenden Sie die Ein/Aus-Schaltfläche auf Anwendungsebene (Engine-Ebene) in den Konfigurationen.
  • Andere Agenten (derzeit auf von Mitarbeitern erstellte Workflow Builder-Agenten und Deep Research-Agenten beschränkt): Verwenden Sie den Schalter auf Agentenebene in den Einstellungen des jeweiligen Agenten.

Nachdem Sie die Einstellungen aktiviert haben, können Sie die folgenden Daten aus Ihren Interaktionen mit dem Assistenten oder den Agenten in Ihrer Gemini Enterprise-Web-App aufrufen:

  • Messwerte in 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 das Stellen einer Frage an den Gemini Enterprise-Assistenten, die Antwort 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 Trace. Er stellt einen bestimmten Vorgang dar, 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 Span-Logs sind mit Zeitstempeln versehene, freiformatige Nachrichten oder Ereignisse, die einem bestimmten Span zugeordnet sind. Sie liefern detaillierte, kontextbezogene Informationen zur Ausführung eines Spans, die Nutzern helfen, Probleme zu beheben und den Ablauf einer Anfrage zu verstehen.
Messwerte Messwerte sind numerische Messungen, die Systeme im Laufe der Zeit erfassen. Diese Messungen stellen die Leistung, Ressourcennutzung oder das Verhalten eines Systems dar. Entwickler verwenden Messwerte, um den Systemzustand zu überwachen, Trends zu erkennen und Benachrichtigungen auszulösen.
Audit-Logs zur Nutzung Audit-Logs zur Nutzung sind Aufzeichnungen von Verwaltungsaktivitäten und Zugriffen in Ihren Google Cloud -Ressourcen. Sie enthalten detaillierte Informationen darüber, wer welche Aktion wann und von wo aus ausgeführt hat. Diese Logs sind für Sicherheitsaudits, Compliance und das Verständnis der Nutzung Ihrer Ressourcen unerlässlich.
Gemini Enterprise-Connector-Fehlerlogs In den Fehlerprotokollen für Gemini Enterprise-Connectors werden Fehler und Ausfälle erfasst, die bei der Integration von Gemini Enterprise in Datenquellen von Drittanbietern wie Jira und Microsoft OneDrive auftreten. Diese Logs enthalten Verbindungsprobleme, Probleme bei der Datentransformation und API-Fehler.

Hinweis

Sie benötigen Folgendes:

Einstellungen für die Beobachtbarkeit aktivieren

Wenn Sie die Beobachtbarkeit für Ihre Gemini Enterprise-App oder einzelne Agenten aktivieren möchten, können Sie entweder die Google 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. Führen Sie je nach dem zu konfigurierenden Agententyp einen der folgenden Schritte aus:

    • Core Assistant-Agent: Klicken Sie auf Konfigurationen und dann auf den Tab Beobachtbarkeit.
    • Andere Agenten (von Mitarbeitern erstellte Workflow Builder-Agenten und Deep Research-Agenten): Klicken Sie auf Agenten, dann auf den Namen des Agenten, den Sie konfigurieren möchten, und anschließend auf den Tab Konfiguration.
  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 Traces, Spans, Span-Logs und Messwerte, die mit Ihren Logs verknüpft sind, in Cloud Logging ansehen.
    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.

REST

Informationen zum Konfigurieren von Beobachtbarkeitseinstellungen mit der REST API finden Sie in den folgenden Abschnitten:

Beobachtbarkeitseinstellungen für den Core Assistant konfigurieren (Anwendungsebene)

In den folgenden Abschnitten erfahren Sie, wie Sie die Beobachtbarkeitseinstellungen mit der REST API auf Anwendungsebene konfigurieren (gilt für den Core Assistant-Agenten):

Beobachtbarkeit beim Erstellen einer Anwendung aktivieren

Führen Sie den folgenden Befehl aus, um eine neue Anwendung mit aktivierter Beobachtbarkeit 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 Anwendung aktivieren

    Führen Sie den folgenden Befehl aus, um die Beobachtbarkeit für eine vorhandene Anwendung 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.
  • Beobachtbarkeitseinstellungen für einen einzelnen Agenten konfigurieren

    Wenn Sie die Beobachtbarkeit für einen einzelnen Agenten (z. B. einen Workflow Builder-Agenten oder einen Deep Research-Agenten) über die REST API aktivieren möchten, führen Sie den folgenden Befehl aus, um die observabilityConfig des Agenten zu aktualisieren:

    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/assistants/default_assistant/agents/AGENT_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.
  • AGENT_ID: die ID des KI-Agenten, den Sie konfigurieren möchten
  • Einstellungen für Beobachtbarkeit deaktivieren

    Wenn Sie die Beobachtbarkeitseinstellungen für Ihre Gemini Enterprise-App oder einzelne Agenten deaktivieren möchten, verwenden Sie entweder die Google Cloud Console oder die REST API.

    Console

    So deaktivieren Sie die Beobachtbarkeitseinstellungen ü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, für die Sie die Einstellungen für die Beobachtbarkeit deaktivieren möchten.

    3. Führen Sie je nach dem zu konfigurierenden Agententyp einen der folgenden Schritte aus:

      • Core Assistant-Agent: Klicken Sie auf Konfigurationen und dann auf den Tab Beobachtbarkeit.
      • Andere Agenten (einschließlich von Mitarbeitern erstellte Agenten im Workflow Builder und Deep Research-Agenten): Klicken Sie auf Agenten, dann auf den Namen des Agenten, den Sie konfigurieren möchten, und anschließend auf den Tab Konfiguration.
    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

    Informationen zum Deaktivieren von Beobachtbarkeitseinstellungen mit der REST API finden Sie in den folgenden Abschnitten:

    Beobachtbarkeit auf Anwendungsebene deaktivieren (Core Assistant)

    Führen Sie den folgenden Befehl aus, um die Beobachtbarkeit auf Anwendungsebene (App) 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.
  • Beobachtbarkeit für einen einzelnen Agenten deaktivieren

    Führen Sie den folgenden Befehl aus, um die Beobachtbarkeit für einen einzelnen Agenten (z. B. einen Workflow Builder-Agenten oder einen Deep Research-Agenten) 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/assistants/default_assistant/agents/AGENT_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.
  • AGENT_ID: die ID des KI-Agenten, den Sie konfigurieren möchten
  • Nächste Schritte