Descripción general de la API de Telemetry (OTLP)

En este documento, se describe la API de Telemetry (OTLP), que implementa el protocolo OpenTelemetry Line. Esta API está diseñada para usarse con aplicaciones instrumentadas con uno de los SDK de OpenTelemetry o que usan cualquier recopilador de OpenTelemetry.

OpenTelemetry es un proyecto de código abierto compatible con Google Google Cloud, con Google Cloud ingenieros asignados para garantizar la compatibilidad con la transferencia y visualización de tu telemetría.

Para obtener más información sobre esta API, consulta los siguientes documentos de referencia:

Prácticas recomendadas

Cuando instrumentes tus aplicaciones para enviar datos de seguimiento a tu Google Cloud proyecto, te recomendamos que uses un exportador que escriba datos con formato OTLP en un recopilador, que luego enviará tus datos de seguimiento a la API de Telemetry. En tu recopilador, especifica solo la URL raíz:

exporters:
  otlphttp:
    encoding: proto
    endpoint: https://telemetry.googleapis.com

OpenTelemetry detecta el tipo de datos y agrega automáticamente /v1/traces, /v1/metrics o /v1/logs según corresponda. Para obtener más información, consulta Solicitud OTLP/HTTP.

Para ver ejemplos que exportan datos de seguimiento o métricas a la API de Telemetry, consulta los siguientes documentos:

Cuando no puedes usar un recopilador, puedes usar una biblioteca de OpenTelemetry que contenga un exportador de OTLP en el proceso para enviar telemetría a la API de Telemetry. Para obtener información sobre cómo exportar datos de seguimiento directamente, consulta Exportador de Cloud Trace al extremo de OTLP.

Autenticación

Debes configurar tus exportadores con las credenciales necesarias para enviar datos a tu Google Cloud proyecto. Por ejemplo, cuando usas recopiladores, por lo general, también usas la extensión googleclientauth para autenticarte con las credenciales de Google.

Para ver un ejemplo de autenticación cuando se usa la exportación directa de datos de seguimiento, consulta Configura la autenticación. En este ejemplo, se muestra cómo configurar el exportador con tus Google Cloud Credenciales predeterminadas de la aplicación (ADC) y agregar una biblioteca de autenticación de Google específica del lenguaje a tu aplicació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 los que son como el servicio cloudtrace.googleapis.com, que también puede transferir datos de seguimiento.

Para obtener más información, consulta lo siguiente: