Elige un enfoque de instrumentación

En esta página, se incluyen recomendaciones para instrumentar tu app en diferentesGoogle Cloud plataformas, como Google Kubernetes Engine (GKE) y Cloud Run. Si tu app aún no está instrumentada, usa estas recomendaciones para obtener orientación sobre cómo instrumentar tu app para enviar datos de telemetría a Google Cloud. Las recomendaciones de esta página no son las únicas soluciones, y otros enfoques pueden funcionar. Para obtener orientación adicional, comunícate con el equipo de asistencia deGoogle Cloud .

Hay recomendaciones para lo siguiente:

Para obtener más información sobre los ejemplos de instrumentación, consulta los documentos enumerados en la sección Muestras de código.

GKE

Para obtener información general sobre GKE, consulta la Descripción general de GKE.

Tipo Recomendación
Métricas

Te recomendamos usar Google Cloud Managed Service para Prometheus.

Para la instrumentación, realiza una de las siguientes acciones:
Seguimiento

Haz lo siguiente:

  1. Implementa el recopilador de OpenTelemetry compilado por Google en Google Kubernetes Engine.

    El recopilador recibe datos de seguimiento del exportador de OTLP en proceso del SDK, procesa esos datos y, luego, envía los datos procesados a tu Google Cloud proyecto a través de la API de Telemetry (OTLP).

  2. Usa el SDK de OpenTelemetry y el exportador de OTLP para tu lenguaje.
Registros

Configura la app para que genere registros estructurados en JSON en stdout y stderr. Para obtener una lista de frameworks, consulta frameworks de registro recomendados.

GKE recopila los registros escritos en stdout y stderr de forma automática. Para obtener más información, consulta Acerca de los registros de GKE.

Compute Engine

Para obtener información general sobre Compute Engine, consulta Instancias de máquina virtual.

Tipo Recomendación
Métricas y seguimientos

Haz lo siguiente:

  1. Usar el agente de operaciones para recopilar métricas y seguimientos

    Para ver un ejemplo, consulta Recopila métricas y registros del protocolo OpenTelemetry (OTLP). En esta guía, se describe cómo configurar el agente de operaciones para recibir datos de métricas y de seguimiento de los exportadores de OTLP integrados en el SDK, transformar esos datos y, luego, enviarlos a tu proyecto de Google Cloud . Los datos de métricas se envían con la API de Cloud Monitoring y los datos de seguimiento, con la API de Cloud Trace.

  2. Usa el SDK de OpenTelemetry y el exportador de OTLP para tu lenguaje.

Como alternativa, si solo deseas configurar la recopilación de métricas de formato Prometheus, usa el receptor de Prometheus del agente de operaciones para recopilar métricas instrumentadas con Bibliotecas cliente de Prometheus o el SDK de OpenTelemetry.
Registros

Puedes hacer lo siguiente:

  1. Configura tu aplicación para que envíe registros estructurados JSON a un archivo. Para obtener una lista de frameworks, consulta frameworks de registro recomendados.
  2. Instalar el agente de operaciones y configurar un receptor. Para ver un ejemplo, consulta Receptores de registros.

Cloud Run

Para obtener información general sobre Cloud Run, consulta Qué es Cloud Run.

Tipo Recomendación
Métricas y seguimientos

Puedes hacer lo siguiente:

  1. Usa el SDK de OpenTelemetry y el exportador de OTLP para tu lenguaje.

  2. Implementar un archivo adicional de OpenTelemetry para recopilar métricas y seguimientos

    Para ver ejemplos, consulta los siguientes documentos:

  3. Para tu servicio de Cloud Run, usa la facturación basada en instancias. Con la facturación basada en instancias, la CPU se asigna durante todo el ciclo de vida de la instancia, lo que es necesario porque la instrumentación de OpenTelemetry realiza el procesamiento en segundo plano. Para obtener más información, consulta Configuración de facturación para los servicios de Cloud Run.

Como alternativa, si solo deseas configurar la recopilación de métricas de formato Prometheus, usa el sidecar de Prometheus para Cloud Run para recopilar métricas instrumentadas con Bibliotecas cliente de Prometheus o el SDK de OpenTelemetry.
Registros

Configura la app para que genere registros estructurados en JSON en stdout y stderr. Para obtener una lista de frameworks, consulta frameworks de registro recomendados.

Cloud Run recopila los registros escritos en stdout y stderr de forma automática. Para obtener más información, consulta Escribe registros de contenedores.

Funciones de Cloud Run

Para obtener información general sobre Cloud Run Functions, consulta la Descripción general de Cloud Run Functions.

Tipo Recomendación
Métricas La escritura directa de métricas no es compatible con las funciones de Cloud Run. Puedes generar métricas basadas en registros.
Seguimiento Usa el SDK de OpenTelemetry y el exportador de Cloud Trace para tu lenguaje.
Registros

Configura la app para que genere registros estructurados en JSON en stdout y stderr. Para obtener una lista de frameworks, consulta frameworks de registro recomendados.

Cloud Run Functions recopila los registros escritos en stdout y stderr de forma automática. Para obtener más información, consulta Cloud Run Functions: Descripción general del registro y la supervisión.

App Engine

Para obtener información general sobre App Engine, consulta Descripción general de App Engine.

Tipo Recomendación
Métricas Usa el SDK de OpenTelemetry y el exportador de Cloud Monitoring para tu lenguaje.
Seguimiento Usa el SDK de OpenTelemetry y el exportador de Cloud Trace para tu lenguaje.
Registros

Configura la app para que genere registros estructurados en JSON en stdout y stderr. Para obtener una lista de frameworks, consulta frameworks de registro recomendados.

App Engine recopila los registros escritos en stdout y stderr de forma automática. Para obtener más información, consulta Cómo escribir y ver registros.

Frameworks de registro recomendados

Para recopilar registros, te recomendamos que uses un framework que se pueda configurar a fin de enviar objetos JSON serializados a stdout, stderr o a un archivo. El agente de Logging, ya sea integrado o instalado, recopila el archivo y escribe registros estructurados para Cloud Logging. Para escribir datos de registro, te recomendamos lo siguiente:

Muestras de código

Cuando instrumentas una aplicación con las bibliotecas de OpenTelemetry, decides cómo se envían tus datos de telemetría a tu proyecto de Google Cloud . Existen dos enfoques fundamentales:

  • Instrumentas el código de tu aplicación con el SDK de OpenTelemetry y usas el exportador de OTLP integrado en el SDK para enviar datos a un recopilador de OpenTelemetry. El recopilador recibe datos del exportador en proceso y, luego, los envía a tu proyecto de Google Cloud . Los cambios que realices en el código de tu aplicación son independientes del proveedor. El recopilador contiene la lógica para enviar la telemetría a tu proyecto de Google Cloud .

  • Instrumentas el código de tu aplicación con el SDK de OpenTelemetry y usas un exportador integrado en el proceso que envía datos directamente a tu proyecto de Google Cloud . Algunos cambios que realices en tu aplicación son específicos del proveedor. Sin embargo, no es necesario que configures ni implementes un recopilador.

Te recomendamos que uses un recopilador de OpenTelemetry para exportar tus datos de telemetría cuando tu entorno admita el uso de un recopilador. En algunos entornos, debes usar un exportador integrado en el proceso que envíe datos directamente a tu proyecto deGoogle Cloud .

Muestras para la exportación basada en recopiladores

Para obtener muestras de instrumentación específicas del lenguaje, consulta los siguientes documentos:

Si te interesa saber cómo se definen y se implementan los recopiladores, consulta la Descripción general de la muestra.

Muestras para la exportación directa con exportadores integrados en el proceso

  • Migra del exportador de Trace al extremo de OTLP. En este documento, se describe la instrumentación en proceso para exportar directamente los datos de seguimiento a tu proyecto de Google Cloud . Se proporcionan muestras para Go, Java, Node.js y Python.

  • Instrumenta aplicaciones basadas en IA generativa. En este documento, se proporciona información sobre cómo instrumentar o habilitar agentes de IA generativa creados con los frameworks de LangGraph o el Kit de desarrollo de agentes (ADK).

Referencias a OpenTelemetry

En esta sección, se proporcionan vínculos al SDK de OpenTelemetry y los exportadores de OTLP, Cloud Trace y Cloud Monitoring.

Referencias generales:

Go

Java

JavaScript

Python