Ce document explique comment exécuter le collecteur OpenTelemetry conçu par Google sur Cloud Run pour collecter les journaux, les métriques et les traces OTLP à partir d'applications instrumentées, puis exporter ces données vers Google Cloud.
Avant de commencer
L'exécution du collecteur OpenTelemetry intégré à Google nécessite les ressources suivantes :
Un projet Google Cloud avec l'API Cloud Monitoring, l'API Cloud Trace et l'API Cloud Logging activées.
Si vous n'avez pas de projet Google Cloud , procédez comme suit :
Dans la console Google Cloud , accédez à Nouveau projet :
Dans le champ Nom du projet, saisissez un nom pour votre projet, puis cliquez sur Créer.
Accéder à la page Facturation :
Sélectionnez le projet que vous venez de créer s'il n'est pas déjà sélectionné en haut de la page.
Vous êtes invité à choisir un profil de paiement existant ou à en créer un.
L'API Monitoring, l'API Trace et l'API Logging sont activées par défaut pour les nouveaux projets.
Si vous disposez déjà d'un projet Google Cloud , assurez-vous que l'API Monitoring, l'API Trace et l'API Logging sont activées :
Un service Cloud Run. Si vous n'avez pas de service Cloud Run, suivez les instructions de la section Planifier et préparer votre service.
Une installation de
gcloud
. Pour en savoir plus sur l'installation degcloud
, consultez Installer la CLIgcloud
.
Configurer les autorisations pour le collecteur
Par défaut, les tâches et les services Cloud Run utilisent le compte de service Compute Engine par défaut, PROJECT_NUMBER-compute@developer.gserviceaccount.com
.
Ce compte de service dispose généralement des rôles IAM (Identity and Access Management) nécessaires pour écrire les métriques et les journaux décrits dans ce document :
- Rédacteur de métriques Monitoring (
roles/monitoring.metricWriter
) - Rédacteur de journaux Logging (
roles/logging.logWriter
)
Demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :
- Administrateur Cloud Run (
roles/run.admin
) Secret Manager Secret Accessor
(roles/secretmanager.secretAccessor)
Vous pouvez également configurer un compte de service géré par l'utilisateur pour Cloud Run. Un compte de service géré par l'utilisateur doit également disposer de ces rôles. Pour en savoir plus sur les comptes de service pour Cloud Run, consultez Présentation de l'identité du service.
Déployer le collecteur
Pour installer le collecteur OpenTelemetry intégré à Google en tant que side-car pour votre Cloud Run, commencez par créer un secret pour stocker la configuration du collecteur.
gcloud secrets create SECRET_NAME --data-file=config.yaml --project=PROJECT_ID
Ensuite, ajoutez le collecteur OpenTelemetry intégré à Google en tant que side-car à votre service.yaml
:
apiVersion: serving.knative.dev/v1
kind: Service
metadata:
annotations:
run.googleapis.com/launch-stage: ALPHA
name: google-otel-cloud-run-sample
spec:
template:
metadata:
annotations:
# [REQUIRED] set the collector as a parent to the app
run.googleapis.com/container-dependencies: "{app:[collector]}"
run.googleapis.com/secrets: 'SECRET_NAME:projects/PROJECT_ID/secrets/SECRET_NAME'
spec:
containers:
- image: my-app
name: app
ports:
- containerPort: 8080
env:
- name: "OTEL_EXPORTER_OTLP_ENDPOINT"
value: "http://localhost:4317"
- image: "us-docker.pkg.dev/cloud-ops-agents-artifacts/google-cloud-opentelemetry-collector/otelcol-google:0.134.0"
args:
- --config=/etc/otelcol-google/config.yaml
name: collector
startupProbe:
httpGet:
path: /
port: 13133
timeoutSeconds: 30
periodSeconds: 30
livenessProbe:
httpGet:
path: /
port: 13133
timeoutSeconds: 30
periodSeconds: 30
volumeMounts:
- mountPath: /etc/otelcol-google/
name: config
volumes:
- name: config
secret:
items:
- key: latest
path: config.yaml
secretName: 'SECRET_NAME'
Configurer le collecteur
Nous fournissons une configuration du collecteur OpenTelemetry que vous pouvez utiliser avec le collecteur conçu par Google. Cette configuration est conçue pour fournir de grands volumes de métriques, de journaux et de traces OTLP. Cette configuration est également conçue pour éviter les problèmes d'ingestion courants. Vous pouvez ajouter des éléments à la configuration, mais nous vous recommandons vivement de ne pas en supprimer.
Cette section décrit la configuration fournie, les composants clés tels que les exportateurs, les processeurs, les récepteurs et les autres composants disponibles.
Configuration du collecteur fournie
Vous trouverez la configuration du collecteur dans le répertoiregoogle-built-opentelemetry-collector
du dépôt opentelemetry-operations-collector
:
Exportateurs
La configuration du collecteur inclut les exportateurs suivants :
L'exportateur
googlecloud
pour les journaux et les traces. Cet exportateur est configuré avec un nom de journal par défaut.Exportateur
googlemanagedprometheus
pour les métriques. Cet exportateur ne nécessite aucune configuration, mais des options de configuration sont disponibles. Pour en savoir plus sur les options de configuration de l'exportateurgooglemanagedprometheus
, consultez la section Premiers pas avec le collecteur OpenTelemetry dans la documentation Google Cloud Managed Service pour Prometheus.
Processeurs
La configuration du collecteur inclut les processeurs suivants :
batch
: configuré pour regrouper des requêtes de télémétrie avec le nombre maximal d'entrées Google Cloud par requête, ou avec l'intervalle minimal Google Cloud de cinq secondes (selon ce qui survient en premier).memory_limiter
: limite l'utilisation de la mémoire du collecteur pour éviter les plantages dus à la mémoire saturée en supprimant des points de données lorsque la limite est dépassée.resourcedetection
: détecte automatiquement les étiquettes de ressources Google Cloud , commeproject_id
.
Récepteurs
La configuration du collecteur n'inclut que le récepteur otlp
.
Pour savoir comment instrumenter vos applications afin d'envoyer des traces et des métriques OTLP au point de terminaison OTLP du collecteur, consultez Choisir une approche d'instrumentation.
Composants disponibles
Le collecteur OpenTelemetry conçu par Google contient les composants dont la plupart des utilisateurs auront besoin pour activer une expérience riche dans Google Cloud Observability. Pour obtenir la liste complète des composants disponibles, consultez Composants dans le dépôt opentelemetry-operations-collector
.
Pour demander des modifications ou des ajouts aux composants disponibles, ouvrez une demande de fonctionnalité dans le dépôt opentelemetry-operations-collector
.
Générer des données de télémétrie
Pour générer des données de télémétrie, vous devez créer une application Cloud Run avec un collecteur side-car. Le document Écrire des métriques OTLP à l'aide d'un side-car OpenTelemetry fournit un tutoriel sur l'utilisation du collecteur OpenTelemetry intégré à Google en tant que side-car. Vous pouvez utiliser ce tutoriel pour générer des données de télémétrie avec le collecteur intégré de Google.
Afficher la télémétrie
Le collecteur OpenTelemetry conçu par Google envoie les métriques, les journaux et les traces de vos applications instrumentées à Google Cloud Observability. Le collecteur envoie également des métriques d'auto-observabilité. Les sections suivantes expliquent comment afficher cette télémétrie.
Afficher vos métriques
Le collecteur OpenTelemetry intégré à Google collecte les métriques Prometheus que vous pouvez afficher à l'aide de l'explorateur de métriques. Les métriques collectées dépendent de l'instrumentation de l'application, bien que le collecteur conçu par Google écrive également certaines métriques propres.
Pour afficher les métriques collectées par le collecteur OpenTelemetry intégré à Google, procédez comme suit :-
Dans la console Google Cloud , accédez à la page leaderboard Explorateur de métriques :
Accéder à l'explorateur de métriques
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.
- Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
- Dans l'élément Métrique, développez le menu Sélectionner une métrique, saisissez
Prometheus Target
dans la barre de filtre, puis utilisez les sous-menus pour sélectionner un type de ressource et des métriques spécifiques :- Dans le menu Ressources actives, sélectionnez Cible Prometheus.
- Pour sélectionner une métrique, utilisez les menus Catégories de métriques actives et Métriques actives.
Les métriques collectées par le collecteur OpenTelemetry intégré à Google ont le préfixe
prometheus.googleapis.com
. - Cliquez sur Appliquer.
Pour ajouter des filtres qui suppriment des séries temporelles des résultats de la requête, utilisez l'élément Filtre.
- Configurez le mode d'affichage des données.
Lorsque les mesures d'une métrique sont cumulatives, l'explorateur de métriques normalise automatiquement les données mesurées par période d'alignement, ce qui permet d'afficher un taux dans le graphique. Pour en savoir plus, consultez la section Genres, types et conversions.
Lorsque des valeurs entières ou doubles sont mesurées, par exemple avec les métriques
counter
, l'explorateur de métriques additionne automatiquement toutes les séries temporelles. Pour modifier ce comportement, définissez le premier menu de l'entrée Agrégation sur Aucun.Pour plus d'informations sur la configuration d'un graphique, consultez la page Sélectionner des métriques lors de l'utilisation de l'explorateur de métriques.
Afficher vos traces
Pour afficher vos données de trace, procédez comme suit:
-
Dans la console Google Cloud , accédez à la page Explorateur Trace :
Vous pouvez également accéder à cette page à l'aide de la barre de recherche.
- Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
- Dans la section du tableau de la page, sélectionnez une ligne.
Dans le graphique de Gantt du panneau Détails des traces, sélectionnez un segment.
Un panneau contenant des informations sur la requête tracée s'affiche. Ces informations incluent la méthode, le code d'état, le nombre d'octets et le user-agent de l'appelant.
Pour afficher les journaux associés à cette trace, sélectionnez l'onglet Logs & Events (Journaux et événements).
Cet onglet affiche les journaux individuels. Pour afficher les détails de l'entrée de journal, développez-la. Vous pouvez également cliquer sur Afficher les journaux et afficher le journal à l'aide de l'explorateur de journaux.
Pour en savoir plus sur l'utilisation de l'explorateur Cloud Trace, consultez la page Rechercher et explorer des traces.
Afficher les journaux
L'explorateur de journaux vous permet d'inspecter vos journaux et d'afficher les traces associées, lorsqu'elles existent.
-
Dans la console Google Cloud , accédez à la page Explorateur de journaux.
Accéder à l'explorateur de journaux
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.
Recherchez une entrée de journal dans votre application instrumentée. Pour afficher les détails, développez l'entrée de journal.
Cliquez sur
Traces sur une entrée de journal contenant un message de trace, puis sélectionnez Afficher les détails des traces.
Un panneau Trace details (Informations sur la trace) s'ouvre et affiche la trace sélectionnée.
Pour en savoir plus sur l'utilisation de l'explorateur de journaux, consultez la page Afficher les journaux à l'aide de l'explorateur de journaux.
Observer et déboguer le collecteur
Le collecteur OpenTelemetry intégré à Google fournit automatiquement des métriques d'auto-observabilité pour vous aider à surveiller ses performances et à assurer la disponibilité continue du pipeline d'ingestion OTLP.
Pour surveiller le collecteur, installez l'exemple de tableau de bord correspondant. Ce tableau de bord fournit des insights brefs sur plusieurs métriques du collecteur, y compris le temps d'activité, l'utilisation de la mémoire et les appels d'API vers Google Cloud Observability.
Pour installer le tableau de bord, procédez comme suit :
-
Dans la console Google Cloud , accédez à la page
Tableaux de bord :
Accéder à la page Tableaux de bord
Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.
- Cliquez sur Modèles de tableau de bord.
- Recherchez le tableau de bord Collecteur OpenTelemetry.
- Facultatif : Pour prévisualiser le tableau de bord, sélectionnez-le.
Cliquez sur playlist_add Ajouter le tableau de bord à votre liste, puis remplissez la boîte de dialogue.
La boîte de dialogue vous permet de sélectionner le nom du tableau de bord et d'y ajouter des libellés.
Pour en savoir plus sur l'installation des tableaux de bord, consultez Installer un modèle de tableau de bord.