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 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 proyecto deGoogle Cloud , te recomendamos que uses un exportador que escriba datos con formato de OTLP en un Collector, que luego envía 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 de OTLP/HTTP.
Si deseas ver ejemplos que exportan datos de seguimiento o de métricas a la API de Telemetry, consulta los siguientes documentos:
- Descripción general de las muestras de instrumentación basadas en recopiladores
- Descripción general de la transferencia de métricas de OTLP
Cuando no puedes usar un recopilador, puedes usar una biblioteca de OpenTelemetry que contenga un exportador de OTLP en el proceso para enviar datos de 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 proyecto de Google Cloud . Por ejemplo, cuando usas recopiladores, por lo general, 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 ilustra cómo configurar el exportador con tus Google Cloud credenciales predeterminadas de la aplicación (ADC) y agregar una biblioteca de Google Auth específica del idioma a tu aplicación.
Para enviar datos de telemetría a tu proyecto de Google Cloud con la API de Telemetry, también debes hacer lo siguiente:
- Configura un proyecto de cuota. Para obtener más información, consulta Configura el proyecto de cuota.
- Otorga al usuario o a la cuenta de servicio que usa la aplicación el rol de Consumidor de Service Usage (
roles/serviceusage.serviceUsageConsumer) en ese proyecto de cuota. Otorga al usuario o a la cuenta de servicio que usa la aplicación los siguientes roles en tu proyecto:
- Escritor de registros (
roles/logging.logWriter) - Escritor de métricas de Monitoring (
roles/monitoring.metricWriter) - Escritor de registros de telemetría de Cloud (
roles/telemetry.tracesWriter)
- Escritor de registros (
Compatibilidad con los Controles del servicio de VPC
El servicio de la API de Telemetry, cuyo nombre 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. Estas 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:
Extremos del servicio
Un extremo de servicio es una URL base que especifica la dirección de red de un servicio de API. La API de Telemetry admite un extremo global y extremos regionales:
Extremo global:
telemetry.googleapis.com. En el caso de este extremo, después de que Google Cloud Observability completa correctamente todos los pasos de validación, envía los datos a un servicio de backend para su almacenamiento.Extremos regionales:
telemetry.REGION.rep.googleapis.com, donde REGION es una región admitida. En el caso de estos extremos, después de que Google Cloud Observability completa correctamente todos los pasos de validación, envía los datos a un servicio de backend. Este servicio almacena o descarta los datos de la siguiente manera:- Se almacenan los datos de registro y de seguimiento. El servicio de backend mueve automáticamente los datos entre regiones cuando es necesario.
- Los datos de métricas solo se almacenan cuando la etiqueta de ubicación adjunta a los datos coincide con la región del extremo o con una zona dentro de esa región.
Para obtener una lista de los extremos regionales admitidos, consulta las páginas de referencia de la API.
La transferencia de datos de seguimiento puede activar la creación de un bucket de observabilidad. Sin embargo, el uso de un extremo regional no afecta el lugar donde el sistema crea el bucket de observabilidad. El sistema determina la ubicación de un bucket de observabilidad con la configuración predeterminada, las políticas de la organización y el conjunto de ubicaciones de buckets admitidas.