Gérer les paramètres d'observabilité

Ce document explique comment configurer les paramètres d'observabilité de votre application Gemini Enterprise à l'aide de la Google Cloud console. Une fois les paramètres activés, vous pouvez afficher les données suivantes à partir de vos interactions avec l'assistant dans votre application Web Gemini Enterprise :

  • Afficher les métriques dans l'explorateur de métriques
  • Afficher les traces et les segments dans l'explorateur de traces

Concepts clés

Cette section présente les concepts clés liés à l'observabilité dans Gemini Enterprise.

Concept Description
Trace Une trace est un ensemble de segments qui représente une seule requête ou transaction lorsqu'elle transite par différents services et composants.

Par exemple, une trace représente l'ensemble du cycle de vie d'une requête. Cela inclut un utilisateur posant une question à l' assistant Gemini Enterprise, l'assistant Gemini Enterprise répondant, et toutes les actions ultérieures déclenchées par la réponse, comme l'envoi d'un e-mail.
Segment Un segment est une unité de travail unique et chronométrée dans une trace. Il représente une opération spécifique, telle qu'un appel de fonction, une requête API ou une requête de base de données. Chaque segment inclut des détails tels que ses heures de début et de fin, un ID unique et sa relation avec d'autres segments. Ensemble, ces relations ensemble forment une trace.
Journaux de segments Les journaux de segments sont des messages ou des événements de forme libre horodatés associés à un segment spécifique. Ils fournissent des informations contextuelles détaillées sur l'exécution d'un segment, ce qui aide les utilisateurs à déboguer les problèmes et à comprendre le flux d'une requête.
Métriques Les métriques sont des mesures numériques que les systèmes collectent au fil du temps. Ces mesures représentent les performances, l'utilisation des ressources ou le comportement d'un système. Les ingénieurs utilisent les métriques pour surveiller l'état du système, identifier les tendances et déclencher des alertes.
Journaux d'audit d'utilisation Les journaux d'audit d'utilisation sont des enregistrements des activités administratives et des accès au sein de vos Google Cloud ressources. Ils fournissent des informations détaillées sur l'auteur de l'action, le moment où elle a été effectuée et l'endroit où elle a été effectuée. Ces journaux sont essentiels pour l'audit de sécurité, la conformité et la compréhension de l'utilisation de vos ressources.
Journaux d'erreurs du connecteur Gemini Enterprise Les journaux d'erreurs du connecteur Gemini Enterprise capturent les erreurs et les échecs rencontrés lors de l'intégration de Gemini Enterprise à des sources de données tierces telles que Jira et Microsoft OneDrive. Ces journaux incluent les problèmes de connexion , les problèmes de transformation des données et les erreurs d'API.

Avant de commencer

Assurez-vous de disposer des éléments suivants :

Activer les paramètres d'observabilité

Pour activer l'observabilité de votre application Gemini Enterprise, vous pouvez utiliser la Google Cloud console ou l'API REST.

Console

Pour activer les paramètres d'observabilité à l'aide de la Google Cloud console, procédez comme suit :

  1. Dans la Google Cloud console, accédez à la page Gemini Enterprise.

    Gemini Enterprise

  2. Cliquez sur le nom de l'application que vous souhaitez configurer.

  3. Cliquez sur Configurations , puis sur l'onglet Observabilité.

  4. Vous pouvez activer ou désactiver les paramètres suivants :

    Paramètre d'observabilité Description
    Activer l'instrumentation des traces et des journaux OpenTelemetry Lorsque cette option est activée, vous pouvez afficher les traces, les segments, les journaux de segments et les métriques associés à vos journaux dans Cloud Logging.
    Activer la journalisation des entrées de prompt et des sorties de réponse Lorsque cette option est activée, Cloud Logging enregistre le contenu complet des prompts et des réponses des utilisateurs. Cela inclut les données sensibles ou les informations permettant d'identifier personnellement l'utilisateur. Pour activer ce paramètre, vous devez d'abord activer Activer l'instrumentation des traces et des journaux OpenTelemetry.

REST

Pour configurer les paramètres d'observabilité à l'aide de l'API REST, consultez les sections suivantes :

Activer l'observabilité lors de la création d'une application

Pour créer une application avec l'observabilité activée, exécutez la commande suivante :

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
  }
}'

Remplacez les éléments suivants :

  • ENDPOINT_LOCATION : emplacement multirégional de votre requête API. Spécifiez l'une des valeurs suivantes :
    • us pour l'emplacement multirégional US
    • eu pour l'emplacement multirégional EU
    • global pour l'emplacement mondial
    Pour en savoir plus, consultez Spécifier un emplacement multirégional pour votre datastore.
  • PROJECT_ID : ID de votre projet.
  • LOCATION : emplacement multirégional de votre data store : global, us ou eu.
  • APP_ID : ID de l'application que vous souhaitez créer.
  • APP_DISPLAY_NAME : nom à afficher de l'application que vous souhaitez créer.

Activer l'observabilité pour une application existante

Pour activer l'observabilité sur une application existante, exécutez la commande suivante :

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
  }
}'

Remplacez les éléments suivants :

  • ENDPOINT_LOCATION : emplacement multirégional de votre requête API. Spécifiez l'une des valeurs suivantes :
    • us pour l'emplacement multirégional US
    • eu pour l'emplacement multirégional EU
    • global pour l'emplacement mondial
    Pour en savoir plus, consultez Spécifier un emplacement multirégional pour votre datastore.
  • PROJECT_ID : ID de votre projet.
  • LOCATION : emplacement multirégional de votre data store : global, us ou eu.
  • APP_ID : ID de l'application.

Désactiver les paramètres d'observabilité

Pour désactiver les paramètres d'observabilité de votre application Gemini Enterprise, vous pouvez utiliser la Google Cloud console ou l'API REST.

Console

Pour désactiver les paramètres d'observabilité à l'aide de la Google Cloud console, procédez comme suit :

  1. Dans la Google Cloud console, accédez à la page Gemini Enterprise.

    Gemini Enterprise

  2. Cliquez sur le nom de l'application pour laquelle vous souhaitez désactiver les paramètres d'observabilité.

  3. Cliquez sur Configurations , puis sur l'onglet Observabilité.

  4. Vous pouvez désactiver les paramètres suivants :

    Paramètre d'observabilité Description
    Activer l'instrumentation des traces et des journaux OpenTelemetry Lorsque cette option est désactivée, ce paramètre arrête la collecte des traces, des segments, des journaux de segments et des métriques. Il désactive également le paramètre Activer la journalisation des entrées de prompt et des sorties de réponse, ce qui signifie qu'aucun journal n'est envoyé à Cloud Logging.
    Activer la journalisation des entrées de prompt et des sorties de réponse Lorsque cette option est désactivée, Cloud Logging n'enregistre pas les entrées de prompt ni les sorties de réponse.

REST

Pour désactiver les paramètres d'observabilité à l'aide de l'API REST, exécutez la commande suivante :

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
  }
}'

Remplacez les éléments suivants :

  • ENDPOINT_LOCATION : emplacement multirégional de votre requête API. Spécifiez l'une des valeurs suivantes :
    • us pour l'emplacement multirégional US
    • eu pour l'emplacement multirégional EU
    • global pour l'emplacement mondial
    Pour en savoir plus, consultez Spécifier un emplacement multirégional pour votre datastore.
  • PROJECT_ID : ID de votre projet.
  • LOCATION : emplacement multirégional de votre data store : global, us ou eu.
  • APP_ID : ID de l'application.

Étape suivante