Ce document décrit l'API Telemetry (OTLP), qui implémente le protocole OTLP OpenTelemetry. Cette API est conçue pour être utilisée avec des applications instrumentées à l'aide de l'un des SDK OpenTelemetry.
Pourquoi utiliser l'API Telemetry ?
OpenTelemetry est un projet Open Source compatible avec Google Cloud. Des ingénieurs Google Cloudsont chargés d'assurer la prise en charge de l'ingestion et de la visualisation de vos données de trace.
Lorsque vous utilisez l'API Telemetry, vos données sont stockées dans un format généralement compatible avec les fichiers proto définis par le protocole OTLP OpenTelemetry. Toutefois, les champs peuvent être convertis d'un type de données spécifique à OpenTelemetry en type de données JSON avant d'être stockés. De plus, les limites de l'API Telemetry s'appliquent. Ces limites sont souvent plus généreuses que celles de l'API Cloud Trace. Enfin, votre instrumentation ne repose pas sur un exportateur spécifique à Google Cloud.
Pour en savoir plus sur le format de stockage, consultez Schéma des données de trace.
Quand utiliser l'API Telemetry ?
Lorsque vous instrumentez vos applications pour envoyer des données de trace à votre projetGoogle Cloud , nous vous recommandons d'effectuer l'une des opérations suivantes :
- Utilisez un exportateur qui écrit OTLP dans un collecteur, qui envoie ensuite vos données de trace à l'API Telemetry.
- Utilisez un exportateur OTLP intégré compatible avec une bibliothèque OpenTelemetry qui envoie la télémétrie à l'API Telemetry. Aucun collecteur ne correspond à cette configuration.
Pour savoir comment utiliser l'API Telemetry, consultez Migrer de l'exportateur Cloud Trace vers le point de terminaison OTLP.
Où consulter les données ingérées ?
Les données de trace ingérées via l'API Telemetry peuvent être consultées sur la page Trace Explorer. Pour savoir comment afficher vos données de trace, consultez Rechercher et explorer des traces.
Authentification
Les exportateurs doivent être autorisés à envoyer des données à votre projet Google Cloud . Par exemple, vous pouvez configurer l'exportateur avec vos Google Cloud identifiants par défaut de l'application (ADC) en ajoutant une bibliothèque d'authentification Google spécifique à la langue à votre application. Pour en savoir plus et obtenir un exemple de code, consultez Configurer l'authentification.
Compatibilité avec VPC Service Controls
Le service API Telemetry, dont le nom de service est telemetry.googleapis.com, est un service compatible avec VPC Service Controls. Toutes les restrictions VPC Service Controls que vous créez pour le service de l'API Telemetry s'appliquent uniquement à ce service. Ces restrictions ne s'appliquent à aucun autre service, y compris ceux comme le service cloudtrace.googleapis.com, qui peuvent également ingérer des données de trace.
Pour en savoir plus, consultez les ressources suivantes :