En este documento, se describe la API de Telemetry (OTLP), que implementa el protocolo OTLP de OpenTelemetry. Esta API está diseñada para usarse con aplicaciones instrumentadas con uno de los SDKs de OpenTelemetry.
Por qué deberías usar la API de Telemetry
Cuando usas la API de Telemetry, tus datos se almacenan en un formato que suele ser coherente con los archivos .proto definidos por el protocolo OTLP 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. Además, se aplican los límites de la API de Telemetry. Estos límites suelen ser más generosos que los de la API de Cloud Trace. Por último, tu instrumentación no depende de un exportador específico de Google Cloud.
Para obtener más información sobre el formato de almacenamiento, consulta Esquema de los datos de seguimiento.
OpenTelemetry es un proyecto de código abierto compatible con Google Cloudque cuenta con ingenieros Google Cloudpara garantizar la compatibilidad con la transferencia y visualización de tus datos de seguimiento.
Cuándo usar la API de Telemetry
Te recomendamos que envíes tus datos de seguimiento a tu proyecto Google Cloud con la API de Telemetry. Esta API proporciona compatibilidad con el ecosistema de código abierto de OpenTelemetry y sus límites suelen ser más generosos que los de la API de Cloud Trace, que es una API deGoogle Cloud propietaria. Algunas funciones, como la supervisión de aplicaciones, dependen de la información que solo está disponible cuando los datos de seguimiento se envían a la API de Telemetry.
Cuando instrumentes tus aplicaciones para enviar datos de seguimiento a tu proyecto deGoogle Cloud , te recomendamos que realices una de las siguientes acciones:
- Usa un exportador que escriba OTLP en un Collector, que luego envía tus datos de seguimiento a la API de Telemetry.
- Usa un exportador de OTLP en el proceso compatible con una biblioteca de OpenTelemetry que envíe telemetría a la API de Telemetry. No hay ningún recopilador con esta configuración.
Para obtener información sobre cómo usar la API de Telemetry, consulta Migra del exportador de Cloud Trace al extremo de OTLP.
Dónde ver los datos transferidos
Los datos de seguimiento que se transfieren a través de la API de Telemetry se pueden ver en la página del Explorador de registros y en la página del Análisis de registros. Para obtener información sobre cómo ver tus datos de seguimiento, consulta Cómo consultar y ver seguimientos.
Autenticación
Los exportadores deben estar autorizados para enviar datos a tu proyecto Google Cloud . Por ejemplo, puedes configurar el exportador con tus Google Cloud credenciales predeterminadas de la aplicación (ADC) agregando una biblioteca de Google Auth específica del lenguaje a tu aplicación. Para obtener más información y código de muestra, consulta Configura la autenticación.
Compatibilidad con los Controles del servicio de VPC
El servicio de la API de Telemetry, cuyo nombre de servicio es telemetry.googleapis.com, es un servicio compatible con los Controles del servicio de VPC. Las restricciones de los Controles del servicio de VPC que crees para el servicio de la API de Telemetry solo se aplican a ese servicio. Esas restricciones no se aplican a ningún otro servicio, incluidos aquellos como el servicio de cloudtrace.googleapis.com, que también puede transferir datos de seguimiento.
Para obtener más información, consulta lo siguiente:
Cloud Trace y residencia de datos
Si usas Assured Workloads porque tienes requisitos de residencia de datos o de nivel de impacto 4 (IL4), no uses la API de Telemetry para enviar intervalos de seguimiento.