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 in Metrics Explorer aufrufen.
  • Traces und Spans in Trace Explorer aufrufen.

Wichtige Konzepte

In diesem Abschnitt werden die wichtigsten 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 darstellt, während sie verschiedene Dienste und Komponenten durchläuft.

Ein Trace stellt beispielsweise den gesamten Lebenszyklus einer Anfrage dar. Dazu gehören eine Frage eines Nutzers 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 Traces. Er stellt eine spezifische Operation 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 Nachrichten oder Ereignisse in Freiform, die mit einem bestimmten Span verknüpft sind. Sie enthalten 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 von Systemen im Laufe der Zeit erfasst werden. Diese Messungen stellen die Leistung, die 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 dazu, wer welche Aktion wann und von wo aus ausgeführt hat. Diese Logs sind unerlässlich für Sicherheitsaudits, Compliance und das Verständnis der Nutzung Ihrer Ressourcen.
Fehlerlogs für Gemini Enterprise-Connectors In Fehlerlogs für Gemini Enterprise-Connectors werden Fehler und Ausfälle erfasst, die bei der Integration von Gemini Enterprise mit Datenquellen von Drittanbietern wie Jira und Microsoft OneDrive auftreten. Diese Logs enthalten Informationen zu Verbindungsproblemen , Problemen bei der Datentransformation und API-Fehlern.

Hinweis

Sie benötigen Folgendes:

Einstellungen für die Beobachtbarkeit aktivieren

Sie können die Beobachtbarkeit für Ihre Gemini Enterprise-App entweder über die Google Cloud Console oder die REST API aktivieren.

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 die 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 aufrufen, die mit Ihren Logs verknüpft sind.
    Logging von Prompt-Eingaben und Antwortausgaben aktivieren Wenn diese Option aktiviert ist, protokolliert Cloud Logging den vollständigen Inhalt von Nutzer-Prompts und ‑Antworten. 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 der 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 zu erstellen, bei der die Beobachtbarkeit aktiviert ist:

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 finden Sie unter 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 Beobachtbarkeit 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 finden Sie unter 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 die Beobachtbarkeit deaktivieren

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

    Console

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

    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 die 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 deaktiviert, sodass keine Logs an Cloud Logging gesendet werden.
      Logging von Prompt-Eingaben und Antwortausgaben aktivieren Wenn diese Einstellung deaktiviert ist, protokolliert Cloud Logging keine Prompt-Eingaben und Antwortausgaben.

    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 finden Sie unter 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