Présentation de l'API

Cette page offre un bref aperçu de l'API Observability et de l'API Telemetry (OTLP).

À propos de l'API Observability

L'API Observability vous permet d'effectuer les opérations suivantes :

  • Configurez les paramètres par défaut des buckets d'observabilité pour les projets, les dossiers et les organisations. Ces paramètres vous aident à respecter les exigences de conformité et réglementaires. Vous pouvez configurer les éléments suivants :

    • Emplacement de stockage par défaut pour les nouveaux buckets d'observabilité.
    • Une clé Cloud Key Management Service par défaut pour chaque emplacement. Cette clé permet de chiffrer les nouveaux buckets d'observabilité.

    Pour en savoir plus, consultez Définir des valeurs par défaut pour les buckets d'observabilité.

  • Configurez le champ d'application de l'observabilité pour votre projet. Ce champ d'application contrôle les ressources pour lesquelles les pages de l'explorateur recherchent des données de journaux, de métriques et de trace. Pour en savoir plus, consultez Configurer les étendues d'observabilité.

  • Répertoriez les informations sur les buckets d'observabilité dans votre projet Google Cloud . Vos données de trace sont stockées dans un bucket d'observabilité. Pour en savoir plus sur le modèle de données, consultez Présentation du stockage.

  • Créez un lien vers un ensemble de données pour que BigQuery puisse y accéder en lecture. Pour savoir comment créer un ensemble de données associé, consultez Gérer le stockage.

Points de terminaison d'un service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service d'API. L'API Observability accepte un point de terminaison global et des points de terminaison régionaux :

  • Point de terminaison global : observability.googleapis.com

    Vous pouvez utiliser le point de terminaison de service global pour effectuer toutes les opérations compatibles avec l'API Observability. De plus, pour ce point de terminaison, la commande list observability buckets vous permet de remplacer le champ "location" dans le paramètre "path" par le caractère générique (-).

  • Points de terminaison régionaux : observability.REGION.rep.googleapis.com, où REGION est une région disponible. Pour obtenir la liste des points de terminaison, consultez Point de terminaison de service régional.

    Vous ne pouvez utiliser un point de terminaison de service régional que lorsque l'emplacement fourni dans le paramètre de chemin d'accès correspond à la région du point de terminaison. Les commandes envoyées à ces points de terminaison de service échouent si elles incluent un caractère générique ou si la région diffère de celle du point de terminaison.

Documentation de référence de l'API

À propos de l'API Telemetry

L'API Telemetry (OTLP) est une implémentation du protocole OTLP OpenTelemetry. L'API Telemetry offre la compatibilité et l'assistance pour l'écosystème Open Source OpenTelemetry :

  • Journaux : l'API Telemetry vous permet d'ingérer des enregistrements de journaux au format OTLP dans votre projet. Pour en savoir plus, consultez Écrire des journaux OTLP dans l'API Telemetry.

  • Métriques : l'API Telemetry vous permet d'ingérer des métriques au format OTLP dans Cloud Monitoring à l'aide de l'exportateur otlphttp et d'un collecteur OpenTelemetry ou d'un SDK OpenTelemetry. Pour en savoir plus, consultez la présentation de l'ingestion de métriques OTLP.

  • Traces : l'API Telemetry vous permet d'envoyer des données de trace au format OTLP à votre projet. De plus, les limites de trace pour l'API Telemetry sont souvent plus généreuses que celles de l'API Cloud Trace.

Points de terminaison d'un service

Un point de terminaison de service est une URL de base qui spécifie l'adresse réseau d'un service d'API. L'API Telemetry accepte un point de terminaison global et des points de terminaison régionaux :

  • Point de terminaison global : telemetry.googleapis.com Pour ce point de terminaison, une fois que Google Cloud Observability a effectué toutes les étapes de validation, il envoie les données à un service de backend pour le stockage.

  • Points de terminaison régionaux : telemetry.REGION.rep.googleapis.com, où REGION est une région disponible. Pour ces points de terminaison, une fois que Google Cloud Observability a effectué toutes les étapes de validation, il envoie les données à un service de backend. Ce service stocke ou supprime les données :

    • Les données de journaux et de trace sont stockées. Le service de backend déplace automatiquement les données entre les régions si nécessaire.
    • Les données métriques ne sont stockées que lorsque le libellé de localisation associé aux données correspond à la région du point de terminaison ou à une zone de cette région.

    Pour obtenir la liste des points de terminaison régionaux compatibles, consultez la documentation de référence de l'API.

L'ingestion de données de trace peut déclencher la création d'un bucket d'observabilité. Toutefois, l'utilisation d'un point de terminaison régional n'a aucune incidence sur l'emplacement où le système crée le bucket d'observabilité. Le système détermine l'emplacement d'un bucket d'observabilité à l'aide des paramètres par défaut, des règles d'administration et de l'ensemble des emplacements de buckets compatibles.

Documentation de référence de l'API

Pour en savoir plus sur l'API Telemetry, consultez les documents suivants :