Instrumenta aplicaciones del ADK con OpenTelemetry

En este documento, se explica cómo instrumentar un agente de IA que se creó con el framework del Kit de desarrollo de agentes (ADK). El framework del ADK incluye instrumentación de OpenTelemetry que recopila telemetría de las acciones clave del agente. Cuando habilitas la instrumentación integrada, esta envía información, como instrucciones de texto y respuestas del agente, a tu proyecto de Google Cloud . En este documento, se describen los cambios necesarios y se proporciona un vínculo a una aplicación de ejemplo.

Las aplicaciones que usan el ADK también pueden recopilar instrucciones y respuestas multimodales. En este documento, se describe cómo recopilar instrucciones de texto y respuestas. Si deseas recopilar datos multimodales, se requiere una configuración adicional. Para obtener más información, consulta Recopila y visualiza instrucciones y respuestas multimodales.

Es posible que la observabilidad predeterminada que proporciona ADK no sea suficiente para el caso de uso de tu aplicación. Puedes agregar bibliotecas de instrumentación adicionales con OpenTelemetry para capturar la telemetría de otras partes de tu app o tu propia instrumentación personalizada para capturar datos específicos de la aplicación y obtener una observabilidad más detallada. Por ejemplo, en tu aplicación, podrías escribir código de instrumentación para lo siguiente:

  • Realiza un seguimiento del consumo de recursos de las herramientas invocadas por el agente.
  • Realiza un seguimiento de las fallas de validación específicas de la aplicación, las infracciones de las reglas empresariales o los mecanismos personalizados de recuperación de errores.
  • Realiza un seguimiento de los niveles de calidad de las respuestas de los agentes según tus criterios específicos del dominio.

Instrumenta tu aplicación de IA generativa para recopilar datos de telemetría

Para instrumentar tu agente de IA para que recopile datos de registros, métricas y seguimientos, haz lo siguiente:

  1. Instala paquetes de OpenTelemetry.
  2. Configura tu entorno del ADK.

En el resto de esta sección, se describen los pasos anteriores.

Instala los paquetes de OpenTelemetry

Agrega los siguientes paquetes de instrumentación y exportador de OpenTelemetry:

uv add 'google-adk>=2.12.0' \
  'opentelemetry-instrumentation-google-genai>=0.7b1' \
  'opentelemetry-instrumentation-sqlite3>=0.63b1' \
  'opentelemetry-exporter-otlp-proto-grpc>=1.42.1' \
  'opentelemetry-exporter-otlp-proto-http>=1.42.1' \
  'opentelemetry-instrumentation-vertexai>=2.0b0'

Los datos de registros, métricas y seguimientos se envían a Google Cloud con la API de Telemetry (OTLP), que implementa el protocolo de OpenTelemetry. La biblioteca opentelemetry-exporter-otlp-proto-grpc invoca el extremo de API de Telemetry (OTLP).

Tus datos de seguimiento se almacenan en un formato que, en general, es coherente con los archivos proto definidos por el protocolo de OpenTelemetry. Sin embargo, los campos se pueden convertir de un tipo de datos específico de OpenTelemetry a un tipo de datos JSON antes del almacenamiento. Para obtener más información sobre el formato de almacenamiento, consulta Esquema para datos de seguimiento.

Configura tu entorno del ADK

Las versiones 1.17.0 y posteriores del framework de ADK incluyen compatibilidad integrada con OpenTelemetry y el envío de datos de telemetría de OpenTelemetry a Google Cloud Observability. Para habilitar esta opción, configura tu entorno del ADK:

  • Si ejecutas tu aplicación con el comando adk web, incluye la marca --otel_to_cloud.

  • En tu archivo opentelemetry.env, configura las siguientes variables de entorno:

    OTEL_SERVICE_NAME='adk-sql-agent'
OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED='true'

  • Configura OpenTelemetry para que use las convenciones semánticas más recientes para la IA generativa.

    OTEL_SEMCONV_STABILITY_OPT_IN='gen_ai_latest_experimental'

  • Configura OpenTelemetry para adjuntar mensajes como eventos.

    OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT='EVENT_ONLY'

    Para obtener más información sobre los valores de enumeración permitidos, consulta genai/types.py.

  • También te recomendamos que agregues la siguiente variable de entorno a tu archivo opentelemetry.env:

    ADK_CAPTURE_MESSAGE_CONTENT_IN_SPANS='false'

    Esta variable de entorno hace lo siguiente:

    • Impide que la instrumentación de ADK adjunte atributos de intervalo que superen el límite de tamaño de los atributos.
    • Evita que la información de identificación personal (PII) se adjunte a los intervalos como atributos.

  • Es posible que debas configurar otras variables de entorno. Por ejemplo, si implementas en Gemini Enterprise Agent Platform, también debes establecer la siguiente variable de entorno:

    GOOGLE_CLOUD_AGENT_ENGINE_ENABLE_TELEMETRY='true'

Descarga y ejecuta la aplicación de ejemplo

Este código de muestra implementa un agente de IA generativa que se compila con el ADK. El agente se instrumenta con OpenTelemetry, configurado para enviar métricas, seguimientos y registros a tu proyecto de Google Cloud . La telemetría que se envía a tu proyecto incluye instrucciones y respuestas de IA generativa.

Personificación del agente del ADK

El agente de IA generativa se define como un experto en SQL que tiene acceso completo a una base de datos de SQLite efímera. El agente se compila con el Kit de desarrollo de agentes y accede a una base de datos con el SQLDatabaseToolkit. La base de datos está vacía inicialmente.

Antes de comenzar

  1. Accede a tu cuenta de Google Cloud . Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

  2. Instala Google Cloud CLI.

  3. Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

  4. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

  5. Crea o selecciona un proyecto de Google Cloud .

    Roles necesarios para seleccionar o crear un proyecto

    • Seleccionar un proyecto: Para seleccionar un proyecto, no se requiere un rol de IAM específico. Puedes seleccionar cualquier proyecto en el que se te haya otorgado un rol.
    • Crea un proyecto: Para crear un proyecto, necesitas el rol de creador de proyectos (roles/resourcemanager.projectCreator), que contiene el permiso resourcemanager.projects.create. Obtén más información para otorgar roles.

    • Crea un proyecto de Google Cloud :

      gcloud projects create PROJECT_ID

      Reemplaza PROJECT_ID por un nombre para el proyecto de Google Cloud que estás creando.

    • Selecciona el proyecto de Google Cloud que creaste:

      gcloud config set project PROJECT_ID

      Reemplaza PROJECT_ID por el nombre de tu proyecto de Google Cloud .

  6. Verifica que la facturación esté habilitada para tu proyecto de Google Cloud .

  7. Habilita las APIs de Vertex AI, Service Usage, Telemetría, Cloud Logging, Cloud Monitoring y Cloud Trace, si aún no están habilitadas:

    Roles necesarios para habilitar las APIs

    Para habilitar las APIs, necesitas el permiso serviceusage.services.enable. Si creaste el proyecto, es probable que ya tengas este permiso a través del rol de propietario (roles/owner). De lo contrario, puedes obtenerlo a través del rol de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin). Obtén más información para otorgar roles. 

    gcloud services enable aiplatform.googleapis.com serviceusage.googleapis.com telemetry.googleapis.com logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com

  8. Instala Google Cloud CLI.

  9. Si usas un proveedor de identidad externo (IdP), primero debes acceder a la gcloud CLI con tu identidad federada.

  10. Para inicializar gcloud CLI, ejecuta el siguiente comando: 

    gcloud init

  11. Crea o selecciona un proyecto de Google Cloud .

    Roles necesarios para seleccionar o crear un proyecto

    • Seleccionar un proyecto: Para seleccionar un proyecto, no se requiere un rol de IAM específico. Puedes seleccionar cualquier proyecto en el que se te haya otorgado un rol.
    • Crea un proyecto: Para crear un proyecto, necesitas el rol de creador de proyectos (roles/resourcemanager.projectCreator), que contiene el permiso resourcemanager.projects.create. Obtén más información para otorgar roles.

    • Crea un proyecto de Google Cloud :

      gcloud projects create PROJECT_ID

      Reemplaza PROJECT_ID por un nombre para el proyecto de Google Cloud que estás creando.

    • Selecciona el proyecto de Google Cloud que creaste:

      gcloud config set project PROJECT_ID

      Reemplaza PROJECT_ID por el nombre de tu proyecto de Google Cloud .

  12. Verifica que la facturación esté habilitada para tu proyecto de Google Cloud .

  13. Habilita las APIs de Vertex AI, Service Usage, Telemetría, Cloud Logging, Cloud Monitoring y Cloud Trace, si aún no están habilitadas:

    Roles necesarios para habilitar las APIs

    Para habilitar las APIs, necesitas el permiso serviceusage.services.enable. Si creaste el proyecto, es probable que ya tengas este permiso a través del rol de propietario (roles/owner). De lo contrario, puedes obtenerlo a través del rol de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin). Obtén más información para otorgar roles. 

    gcloud services enable aiplatform.googleapis.com serviceusage.googleapis.com telemetry.googleapis.com logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com
    14.

  14. Para obtener los permisos que necesitas para que la aplicación de ejemplo escriba datos de registros, métricas y seguimientos, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

    Estos permisos son suficientes si ejecutas la muestra en Cloud Shell, en recursos de Google Cloud o en un entorno de desarrollo local.

  15. Asegúrate de especificar un proyecto de cuota. La API de Vertex AI (aiplatform.googleapis.com) requiere que se especifique un proyecto de cuota. Para obtener más información, consulta Configura el proyecto de cuota. Por ejemplo, el siguiente comando puede establecer un proyecto de cuota.

    gcloud config set billing/quota_project PROJECT_ID

Inicia la aplicación

Para iniciar la aplicación de ejemplo, haz lo siguiente:

  1. En Cloud Shell, clona el repositorio:

    git clone https://github.com/GoogleCloudPlatform/opentelemetry-samples.git

  2. Ve al directorio de muestra:

    cd opentelemetry-samples/python/adk-sql-agent

    La muestra contiene un archivo .env que establece dos variables de entorno. Una variable controla qué extremos usa el SDK. La otra variable establece una ubicación.

    Si prefieres usar un modelo diferente, edita main.py. Asegúrate de que el modelo que selecciones admita la ubicación especificada en el archivo .env. Para obtener información sobre los modelos, consulta Modelos de Google.

  3. Crea un entorno virtual y ejecuta la muestra:

    uv run --env-file opentelemetry.env adk web --otel_to_cloud

    La aplicación muestra un mensaje similar al siguiente:

    Application startup complete
Uvicorn running on http://127.0.0.1:8080

  4. Para interactuar con el agente, selecciona la URL que se muestra en el resultado del paso anterior.

  5. Expande Selecciona una app y elige sql_agent en la lista de agentes.

Interactúa con el agente

Para interactuar con el agente, hazle una pregunta o dale un comando. Por ejemplo, podrías hacer la siguiente pregunta:

What can you do for me ?

Del mismo modo, como sql_agent tiene la personalidad de un experto en SQL, puedes pedirle que cree tablas para tus aplicaciones y escriba consultas para operar en las tablas creadas. El agente solo puede crear una base de datos efímera respaldada por un archivo .db que se crea en la máquina que ejecuta la aplicación.

A continuación, se ilustra una interacción de ejemplo entre el sql_agent y el usuario:

Visualización de la interacción con sql_agent.

Las acciones que realizan los agentes de IA generativa no son determinísticas, por lo que es posible que veas una respuesta diferente para la misma instrucción.

Sal de la aplicación.

Para salir de la aplicación, ingresa Ctrl-C en la shell que se usó para iniciarla.

Visualiza los seguimientos, las métricas y los registros

En esta sección, se describe cómo puedes ver los eventos de IA generativa.

Antes de comenzar

Para obtener los permisos que necesitas para ver los datos de registros, métricas y seguimientos, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

También puedes obtener los permisos necesarios a través de roles personalizados o cualquier otro rol predefinido.

Visualiza la telemetría

Para ver los eventos de IA generativa que creó la aplicación, usa la página Explorador de seguimiento:

  1. En la consola de Google Cloud , ve a la página Explorador de seguimiento:

    Ve al Explorador de seguimiento

    También puedes usar la barra de búsqueda para encontrar esta página.

  2. En la barra de herramientas, selecciona Agregar filtro, selecciona Nombre del intervalo y, luego, selecciona call_llm.

    A continuación, se ilustra la página Explorador de Trace después de filtrar los datos:

    Visualización de intervalos de seguimiento.

    Si nunca usaste Cloud Trace, Google Cloud Observability debe crear una base de datos para almacenar tus datos de seguimiento. La creación de la base de datos puede tardar unos minutos y, durante ese período, no hay datos de seguimiento disponibles para ver.

  3. Para explorar los datos de intervalos y registros, selecciona un intervalo en la tabla Intervalos.

    Se abrirá la página Detalles. En esta página, se muestra el seguimiento asociado y sus intervalos. En la tabla de la página, se muestra información detallada del intervalo que seleccionaste. Esta información incluye lo siguiente:

    • En la pestaña Entradas/Salidas, se muestran los eventos de los agentes de IA generativa. Para obtener más información sobre estos eventos, consulta Visualiza eventos de IA generativa.

      En la siguiente captura de pantalla, se ilustra un seguimiento, en el que un intervalo tiene el nombre call_llm. Ese intervalo invoca el LLM (modelo de lenguaje grande) que potencia a este agente. Para este ejemplo, es Gemini. El intervalo de Gemini incluye eventos de IA generativa:

      Visualización de eventos de IA generativa.

    • En la pestaña Registros y eventos, se enumeran las entradas de registro y los eventos asociados con el intervalo. Si quieres ver los datos de registro en el Explorador de registros, en la barra de herramientas de esta pestaña, selecciona Ver registros.

      Los datos de registro incluyen la respuesta de sql_agent. Por ejemplo, para la ejecución de muestra, la carga útil de JSON incluye el siguiente contenido:

      {
  "logName": "projects/my-project/logs/otel_python_inprocess_log_name_temp",
  "jsonPayload": {
    "content": {
      "parts": [
        0: {
          "text": "Now I can create the table."
        }
        1: {1}
        ],
      "role": "model"
    }
  },
  ...
}