Administra la configuración de observabilidad

En este documento, se describe cómo configurar los parámetros de observabilidad para tu app de Gemini Enterprise o agentes individuales con la Google Cloud consola o la API de REST.

La lógica de habilitación depende del tipo de agente:

  • Agente de Asistente principal: Usa el botón de activación a nivel de la aplicación (nivel del motor) en las configuraciones.
  • Otros agentes (limitado a los agentes creados por empleados de Agent Designer y los agentes de Deep Research en este momento): Usa el botón de activación a nivel del agente dentro de la configuración del agente individual.

Después de habilitar la configuración, puedes ver los siguientes datos de tus interacciones con el asistente o los agentes en tu app web de Gemini Enterprise:

  • Visualiza métricas en el Explorador de métricas.
  • Visualiza seguimientos e intervalos en el Explorador de seguimiento.

Conceptos clave

En esta sección, se presentan conceptos clave relacionados con la observabilidad en Gemini Enterprise.

Concepto Descripción
Trace Un seguimiento es una colección de intervalos que representa una sola solicitud o transacción a medida que fluye a través de diferentes servicios y componentes.

Por ejemplo, un seguimiento representa todo el ciclo de vida de una solicitud. Esto incluye un usuario que hace una pregunta al asistente de Gemini Enterprise, el asistente de Gemini Enterprise que responde, y cualquier acción posterior que se active con la respuesta, como enviar un correo electrónico.
Intervalo Un intervalo es una unidad de trabajo única y cronometrada dentro de un seguimiento. Representa una operación específica, como una llamada a una función, una solicitud a la API o una consulta a la base de datos. Cada intervalo incluye detalles como sus horas de inicio y finalización, un ID único y su relación con otros intervalos. Estas relaciones juntas forman un seguimiento.
Registros de intervalos Los registros de intervalos son mensajes o eventos de formato libre con marca de tiempo asociados con un intervalo específico. Proporcionan información contextual detallada sobre a ejecución de un intervalo, lo que ayuda a los usuarios a depurar problemas y comprender el flujo de una solicitud.
Métricas Las métricas son mediciones numéricas que los sistemas recopilan con el tiempo. Estas mediciones representan el rendimiento, el uso de recursos o el comportamiento de un sistema. Los ingenieros usan métricas para supervisar el estado del sistema, identificar tendencias y activar alertas.
Registros de auditoría de uso Los registros de auditoría de uso son registros de actividades administrativas y accesos dentro de tus Google Cloud recursos. Proporcionan información detallada sobre quién realizó qué acción, cuándo y desde dónde. Estos registros son esenciales para la auditoría de seguridad, el cumplimiento y la comprensión de cómo se usan tus recursos.
Registros de errores del conector de Gemini Enterprise Los registros de errores del conector de Gemini Enterprise capturan los errores y las fallas que se producen cuando se integra Gemini Enterprise con fuentes de datos de terceros, como Jira y Microsoft OneDrive. Estos registros incluyen problemas de conexión , problemas de transformación de datos y errores de la API.

Antes de comenzar

Asegúrate de tener lo siguiente:

Activa la configuración de observabilidad

Para activar la observabilidad de tu app de Gemini Enterprise o agentes individuales, puedes usar la consola de o la API de REST. Google Cloud

Console

Para activar la configuración de observabilidad con la Google Cloud consola de, sigue estos pasos:

  1. En la Google Cloud consola de, ve a la página Gemini Enterprise.

    Gemini Enterprise

  2. Haz clic en el nombre de la app que deseas configurar.

  3. Según el tipo de agente que configures, realiza una de las siguientes acciones:

    • Agente de Asistente principal: Haz clic en Configuraciones y, luego, en la pestaña Observabilidad.
    • Otros agentes (agentes creados por empleados de Agent Designer y agentes de Deep Research agents): Haz clic en Agentes, en el nombre del agente que deseas configurar y, luego, en la pestaña Observabilidad.

  4. Puedes activar o desactivar los siguientes parámetros de configuración:

    Parámetro de configuración de observabilidad Descripción
    Habilitar la instrumentación de seguimientos y registros de OpenTelemetry Cuando está habilitado, puedes ver los seguimientos, los intervalos, los registros de intervalos y las métricas asociadas con tus registros en Cloud Logging.
    Habilitar el registro de las entradas de instrucciones y las salidas de respuestas Cuando está habilitado, Cloud Logging registra todo el contenido de las instrucciones y respuestas de los usuarios. Esto incluye datos sensibles o información de identificación personal (PII). Para habilitar este parámetro de configuración, primero debes habilitar Habilitar la instrumentación de seguimientos y registros de OpenTelemetry.

REST

Para configurar los parámetros de observabilidad con la API de REST, consulta las siguientes secciones:

Configura los parámetros de observabilidad para el Asistente principal (nivel de la app)

Para configurar los parámetros de observabilidad con la API de REST a nivel de la app (que se aplica al agente de Asistente principal), consulta las siguientes secciones:

Activa la observabilidad cuando crees una app

Para crear una app nueva con la observabilidad activada, ejecuta el siguiente comando:

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

Reemplaza lo siguiente:

  • ENDPOINT_LOCATION: Es la región múltiple para tu solicitud a la API. Especifica uno de los siguientes valores:
    • us para la multirregión de EE.UU.
    • eu para la multirregión de la UE
    • global para la ubicación global
    Para obtener más información, consulta Cómo especificar una región múltiple para tu almacén de datos.
  • PROJECT_ID: el ID de tu proyecto.
  • LOCATION: Es la multirregión de tu almacén de datos: global, us o eu.
  • APP_ID: Es el ID de la app que deseas crear.
  • APP_DISPLAY_NAME: Es el nombre visible de la app que deseas crear.

Activa la observabilidad para una app existente

Para activar la observabilidad en una app existente, ejecuta el siguiente comando:

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

Reemplaza lo siguiente:

  • ENDPOINT_LOCATION: Es la región múltiple para tu solicitud a la API. Especifica uno de los siguientes valores:
    • us para la multirregión de EE.UU.
    • eu para la multirregión de la UE
    • global para la ubicación global
    Para obtener más información, consulta Cómo especificar una región múltiple para tu almacén de datos.
  • PROJECT_ID: el ID de tu proyecto.
  • LOCATION: Es la multirregión de tu almacén de datos: global, us o eu.
  • APP_ID: Es el ID de la app.

Configura los parámetros de observabilidad para un agente individual

Para activar la observabilidad de un agente individual (como un agente de Agent Designer o un agente de Deep Research) con la API de REST, ejecuta el siguiente comando para actualizar el observabilityConfig del agente:

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

Reemplaza lo siguiente:

  • ENDPOINT_LOCATION: Es la región múltiple para tu solicitud a la API. Especifica uno de los siguientes valores:
    • us para la multirregión de EE.UU.
    • eu para la multirregión de la UE
    • global para la ubicación global
    Para obtener más información, consulta Cómo especificar una región múltiple para tu almacén de datos.
  • PROJECT_ID: el ID de tu proyecto.
  • LOCATION: Es la multirregión de tu almacén de datos: global, us o eu.
  • APP_ID: Es el ID de la app.
  • AGENT_ID: Es el ID del agente que deseas configurar.

Desactiva la configuración de observabilidad

Para desactivar la configuración de observabilidad de tu app de Gemini Enterprise o agentes individuales, usa la Google Cloud consola o la API de REST.

Console

Para desactivar la configuración de observabilidad con la Google Cloud consola de, sigue estos pasos:

  1. En la Google Cloud consola de, ve a la página Gemini Enterprise.

    Gemini Enterprise

  2. Haz clic en el nombre de la app para la que deseas desactivar la configuración de observabilidad.

  3. Según el tipo de agente que configures, realiza una de las siguientes acciones:

    • Agente de Asistente principal: Haz clic en Configuraciones y, luego, en la pestaña Observabilidad.
    • Otros agentes (incluidos los agentes creados por empleados de Agent Designer y los agentes de Deep Research): Haz clic en Agentes, en el nombre del agente que deseas configurar y, luego, en la pestaña Observabilidad.

  4. Puedes desactivar los siguientes parámetros de configuración:

    Parámetro de configuración de observabilidad Descripción
    Habilitar la instrumentación de seguimientos y registros de OpenTelemetry Cuando está desactivado, este parámetro de configuración detiene la recopilación de seguimientos, intervalos, registros de intervalos y métricas. También desactiva el parámetro de configuración Habilitar el registro de las entradas de instrucciones y las salidas de respuestas, lo que significa que no se envían registros a Cloud Logging.
    Habilitar el registro de las entradas de instrucciones y las salidas de respuestas Cuando está desactivado, Cloud Logging no registra las entradas de instrucciones ni las salidas de respuestas.

REST

Para desactivar los parámetros de observabilidad con la API de REST, consulta las siguientes secciones:

Desactiva la observabilidad a nivel de la app (Asistente principal)

Para desactivar la observabilidad a nivel de la aplicación (app), ejecuta el siguiente comando:

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

Reemplaza lo siguiente:

  • ENDPOINT_LOCATION: Es la región múltiple para tu solicitud a la API. Especifica uno de los siguientes valores:
    • us para la multirregión de EE.UU.
    • eu para la multirregión de la UE
    • global para la ubicación global
    Para obtener más información, consulta Cómo especificar una región múltiple para tu almacén de datos.
  • PROJECT_ID: el ID de tu proyecto.
  • LOCATION: Es la multirregión de tu almacén de datos: global, us o eu.
  • APP_ID: Es el ID de la app.

Desactiva la observabilidad para un agente individual

Para desactivar la observabilidad de un agente individual (como un agente de Agent Designer o un agente de Deep Research), ejecuta el siguiente comando:

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

Reemplaza lo siguiente:

  • ENDPOINT_LOCATION: Es la región múltiple para tu solicitud a la API. Especifica uno de los siguientes valores:
    • us para la multirregión de EE.UU.
    • eu para la multirregión de la UE
    • global para la ubicación global
    Para obtener más información, consulta Cómo especificar una región múltiple para tu almacén de datos.
  • PROJECT_ID: el ID de tu proyecto.
  • LOCATION: Es la multirregión de tu almacén de datos: global, us o eu.
  • APP_ID: Es el ID de la app.
  • AGENT_ID: Es el ID del agente que deseas configurar.

¿Qué sigue?