Présentation de l'API

Cette page fournit une brève présentation 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 :

  • Configurer les paramètres par défaut des buckets d'observabilité pour les projets, les dossiers et les organisations. Ces paramètres vous aident à répondre à vos exigences en termes de conformité et de réglementation. Vous pouvez configurer les éléments suivants :

    • Un emplacement de stockage par défaut pour les nouveaux buckets d'observabilité.
    • Pour chaque emplacement, une clé Cloud Key Management Service par défaut. Cette clé est utilisée pour chiffrer les nouveaux buckets d'observabilité.

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

  • Configurer le champ d'application de l'observabilité pour votre projet. Ce champ d'application contrôle les ressources dans lesquelles les pages de l'explorateur recherchent des données de journal, de métrique et de trace. Pour en savoir plus, consultez la section Configurer les champs d'application de l'observabilité.

  • Répertorier les informations sur les buckets d'observabilité dans votre Google Cloud projet. 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 la section Présentation du stockage.

  • Créer un lien sur un ensemble de données, ce qui permet à BigQuery d'y accéder en lecture. Pour savoir comment créer un ensemble de données associé, consultez la section 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 d'emplacement dans le paramètre de chemin par le caractère générique (-).

  • Points de terminaison régionaux : observability.REGION.rep.googleapis.com, où REGION est une région compatible. Pour obtenir la liste des points de terminaison, consultez la section 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 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 l'emplacement diffère de la région 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 OpenTelemetry OTLP. L'API Telemetry offre une compatibilité et une assistance pour l'écosystème OpenTelemetry Open Source :

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

  • 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 section Présentation de l'ingestion 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 compatible. 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 journal 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 de métrique ne sont stockées que lorsque le libellé d'emplacement 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 les pages de 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, règles d'administration et de l'ensemble des emplacements de bucket compatibles.

Documentation de référence de l'API

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