Présentation

Associez votre solution Google Cloud Platform pour visualiser tous vos hosts Google Compute Engine (GCE) dans Datadog. Vos hosts apparaissent dans l’aperçu de l’infrastructure de Datadog. Vous pouvez les trier grâce aux tags de host GCE et aux libellés GCE qui leur sont automatiquement attribués par Datadog.

Configuration

Configurez lʼintégration Datadog/Google Cloud pour recueillir des métriques et des logs à partir de vos services Google Cloud.

Prérequis

• Si votre organisation restreint les identités en fonction de leur domaine, vous devez ajouter l’identité client Datadog à la liste blanche de votre stratégie. L’identité client de Datadog est C0147pk0i.

• Pour utiliser les fonctionnalités d’emprunt d’identité de compte de service et de découverte automatique des projets, et ainsi surveiller vos projets, il est nécessaire d’attribuer certains rôles et d’activer certaines API. Avant de commencer, vérifiez que les API suivantes sont activées pour les projets à surveiller :

  • API Cloud Resource Manager
  • API Google Cloud Billing
  • API Cloud Monitoring
  • API Compute Engine
  • API Cloud Asset
  • API IAM

Collecte de métriques

Installation

datadog:monitored,env:production,!env:staging,instance-type:c1.*

Grâce à l’emprunt d’identité de compte de service et à la découverte automatique des projets, vous pouvez intégrer Datadog à Google Cloud.

Cette approche vous permet de surveiller tous les projets accessibles depuis un compte de service, en attribuant des rôles IAM aux projets pertinents. Il est possible d’attribuer ces rôles à des projets spécifiques, mais aussi de les attribuer à l’échelle d’une organisation ou d’un dossier, afin de surveiller des groupes de projets. De cette façon, Datadog découvre et surveille automatiquement tous les projets d’un contexte donné, y compris les nouveaux projets qui intègrent ultérieurement le groupe.

1. Créer votre compte de service Google Cloud

1. Ouvrez votre console Google Cloud.
2. Accédez à IAM & Admin > Service Accounts.
3. Cliquez sur Create service account en haut de la page.
4. Attribuez un nom unique au compte de service, puis cliquez sur Create and continue.
5. Ajoutez les rôles suivants au compte de service :
   • Monitoring Viewer
   • Compute Viewer
   • Cloud Asset Viewer
   • Navigateur
6. Cliquez sur Continue, puis sur Done pour terminer la création du compte de service.

2. Ajouter le service principal Datadog à votre compte de service

1. Dans Datadog, accédez à Integrations > Google Cloud Platform.

2. Cliquez sur Add GCP Account. SI vous n’avez pas encore configuré de projet, vous êtes automatiquement redirigé vers cette page.

3. Si vous n’avez pas généré de service principal Datadog pour votre organisation, cliquez sur le bouton Generate Principal.

4. Copiez votre service principal Datadog et conservez-le pour la prochaine section.

   Gardez cette fenêtre ouverte, car vous en aurez besoin lors de la [prochaine section](#3-terminer-la-configuration-de-l-integration-dans-datadog).

5. Dans la [console Google Cloud][38303 sous le menu Service Accounts, recherchez le compte de service que vous avez créé lors de la première section.

6. Accédez à l’onglet Permissions, puis cliquez sur Grant Access.

7. Collez votre service principal Datadog dans la zone New Principals.

8. Attribuez le rôle Service Account Token Creator, puis cliquez sur Save.

Remarque : si vous avez déjà configuré l’accès à l’aide d’un service principal Datadog partagé, vous pouvez révoquer l’autorisation pour ce service principal après avoir suivi ces étapes.

3. Terminer la configuration de l’intégration dans Datadog

1. Dans votre console Google Cloud, accédez à l’onglet Service Account > Details, afin de consulter l’adresse e-mail associée à ce compte de service Google. Son format est <sa-name>@<project-id>.iam.gserviceaccount.com.
2. Copiez cette adresse e-mail.
3. Revenez sur le carré de configuration de l’intégration dans Datadog (là où vous avez copié votre service principal Datadog lors de la section précédente).
4. Dans la zone de texte sous Add Service Account Email, collez l’adresse e-mail que vous avez précédemment copiée.
5. Cliquez sur Verify and Save Account.

Les métriques devraient s’afficher dans Datadog après environ 15 minutes.

4. Attribuer des rôles à d’autres projets (facultatif)

Grâce à la découverte automatique de projets, il est beaucoup plus simple d’ajouter de nouveaux projets à surveiller. SI vous attribuez à d’autres projets, dossiers ou organisations un accès à votre compte de service, Datadog découvre ces projets (ainsi que tous les projets imbriqués dans les dossiers ou organisations) et les ajoute automatiquement à votre carré d’intégration.

1. Vérifiez que vous avez configuré les bonnes autorisations, afin que les rôles attribués disposent de l’accès prévu :
   • Project IAM Admin (ou autorisation de plus haut niveau)
   • Folder Admin
   • Organization Admin
2. Dans la console Google Cloud, accédez à la page IAM.
3. Sélectionnez un projet, un dossier ou une organisation.
4. Pour attribuer un rôle à un service principal qui ne possède pas encore de rôle pour la ressource, cliquez sur Grant Access, puis saisissez l’adresse e-mail du compte de service créé précédemment.
5. Attribuez les rôles suivants :
   • Compute Viewer
   • Monitoring Viewer
   • Cloud Asset Viewer Remarque : le rôle Browser est uniquement requis pour le projet par défaut du compte de service.
6. Cliquez sur Save.

Configuration

Si vous le souhaitez, vous pouvez limiter les instances GCE récupérées par Datadog. Pour ce faire, saisissez des tags dans la zone de texte Limit Metric Collection située dans le menu déroulant d’un projet donné. Seuls les hosts qui correspondent à l’un des tags définis sont alors importés dans Datadog. Vous pouvez utiliser des wildcards (? pour un caractère unique, * pour plusieurs caractères) pour inclure un grand nombre de hosts, ou encore ! pour exclure certains hosts. L’exemple ci-dessous englobe toutes les instances de taille c1*, mais exclut les hosts de type staging :

datadog:monitored,env:production,!env:staging,instance-type:c1.*

Consultez la documentation Google pour obtenir plus de renseignements sur la création et la gestion de libellés.

Collecte de logs

Transmettez des logs à Datadog depuis vos services Google Cloud en utilisant Google Cloud Dataflow et le modèle Datadog. Cette méthode permet à la fois de compresser et de mettre en lots des événements avant de les transmettre à Datadog. Suivez les instructions indiquées dans cette section pour :

1. Créer une rubrique Pub/Sub et un abonnement pull pour recevoir des logs provenant d’un récepteur de logs configuré.
2. Créer un compte de service de worker Datadog personnalisé pour accorder le moindre privilège aux workers de votre pipeline Dataflow.
3(#3-exporter-des-logs-depuis-une-rubrique- -google-cloud-pubsub). Créer un récepteur de logs pour publier des logs dans la rubrique Pub/Sub.
4. Créer une tâche Dataflow à lʼaide du modèle Datadog pour transmettre à Datadog des logs à partir de l’abonnement Pub/Sub.

Vous contrôlez entièrement les logs qui sont envoyés à Datadog via filtres de journalisation que vous créez dans le récepteur de logs, y compris les logs GCE et GKE. Consultez la page Langage de requête Logging de Google pour en savoir plus sur l’écriture de filtres.

Remarque : vous devez activer l’API Dataflow pour utiliser Google Cloud Dataflow. Consultez la section Activation des API de la documentation de Google Cloud pour en savoir plus.

Vous pouvez également utiliser lʼAgent Datadog pour recueillir des logs à partir d’applications exécutées dans GCE ou GKE, .

1. Créer une rubrique et un abonnement Cloud Pub/Sub

1. Accédez à la console Pub/Sub Cloud et créez une rubrique. Sélectionnez l’option Add a default subscription pour simplifier la configuration.

   Remarque : vous pouvez aussi configurer un abonnement Cloud Pub/Sub manuellement avec le type de livraison Pull. Si vous créez manuellement votre abonnement Pub/Sub, ne cochez pas la case Enable dead lettering. Pour en savoir plus, référez-vous à la section Fonctionnalités Pub/Sub non prises en charge.

2. Donnez un nom clair à ce sujet, comme export-logs-to-datadog, et cliquez sur Create.

3. Créez un autre sujet et un autre abonnement par défaut pour gérer tous les messages de logs rejetés par lʼAPI Datadog. Le nom de ce sujet est utilisé dans le modèle Dataflow Datadog, où il fait partie de la configuration du chemin pour le paramètre de modèle outputDeadletterTopic. Une fois que vous avez inspecté et corrigé tous les problèmes des messages dʼéchec, renvoyez-les au sujet export-logs-to-datadog dʼorigine en exécutant une tâche Modèle Pub/Sub vers Pub/Sub.

4. Datadog recommande de créer un secret dans Secret Manager avec la valeur de votre clé dʼAPI Datadog valide, afin de lʼutiliser plus tard dans le modèle Dataflow Datadog.

Avertissement : les Pub/Sub Cloud sont inclus dans les quotas et limitations de Google Cloud. Si votre nombre de logs dépasse ces limites, Datadog vous conseille de les répartir sur plusieurs sujets. Consultez la rubrique Surveiller la redirection de logs Pub/Sub pour découvrir comment configurer des notifications de monitor si vous vous approchez de ces limites.

2. Créer un compte de service de worker Dataflow personnalisé

Par défaut, les workers de pipelines Dataflow utilisent le compte de service Compute Engine par défaut de votre projet, qui accorde des autorisations pour toutes les ressources du projet. Si vous transmettez des logs dʼun environnement Production, il est conseillé de privilégier la création dʼun compte de service de worker personnalisé nʼincluant que les rôles et les autorisations nécessaires, et dʼattribuer ce compte de service à vos workers de pipeline Dataflow.

1. Accédez à la page Comptes de service de la console Google Cloud et sélectionnez votre projet.
2. Cliquez sur CREATE SERVICE ACCOUNT et attribuez un nom descriptif au compte de service. Cliquez sur CREATE AND CONTINUE.
3. Ajoutez les rôles dans le tableau des autorisations correspondant et cliquez sur DONE.

Autorisations requises

Remarque : si vous ne créez par de compte de service pour les workers de pipeline Dataflow, assurez-vous que le compte de service Compute Engine par défaut possède les autorisations requises ci-dessus.

3. Exporter des logs depuis le sujet Pub/Sub Google Cloud

1. Accédez à la page Logs Explorer dans la console Google Cloud.

2. Depuis lʼonglet Log Router, sélectionnez Create Sink.

3. Nommez le récepteur.

4. Choisissez Cloud Pub/Sub comme destination et sélectionnez le sujet Cloud Pub/Sub créé à cette fin. Remarque : le sujet Cloud Pub/Sub peut se situer dans un autre projet.

5. Choisissez les logs que vous souhaitez inclure dans le récepteur avec un filtre dʼinclusion ou dʼexclusion facultatif. Vous pouvez filtrer les logs avec une requête de recherche, ou utiliser lʼexemple de fonction. Par exemple, si vous souhaitez inclure seulement 10 % des logs avec ERROR comme niveau de severity, créez un filtre dʼinclusion avec severity="ERROR" AND sample(insertId, 0.01).

6. Cliquez sur Create Sink.

Remarque : il est possible de créer plusieurs exportations depuis Google Cloud Logging vers le même sujet Cloud Pub/Sub en utilisant plusieurs récepteurs.

4. Créer et exécuter la tâche Dataflow

1. Accédez à la page Créer une tâche à partir d’un modèle dans la console Google Cloud.

2. Donnez un nom à la tâche et sélectionnez un endpoint régional Dataflow.

3. Sélectionnez Pub/Sub to Datadog dans la liste déroulante Dataflow template, et la section Required parameters apparaît.
   a. Sélectionnez l’abonnement en entrée dans la liste déroulante Pub/Sub input subscription.
   b. Saisissez les informations suivantes dans le champ Datadog logs API URL :

   https://
   

   Remarque : assurez-vous que le sélecteur de site Datadog à droite de la page est défini sur votre site Datadog avant de copier l’URL ci-dessus.

   c. Sélectionnez le sujet créé pour recevoir les échecs de messages dans la liste déroulante Output deadletter Pub/Sub topic.
   d. Indiquez un chemin d’accès pour les fichiers temporaires dans votre compartiement de stockage dans le champ Temporary location.

4. Sous Optional Parameters, cochez Include full Pub/Sub message in the payload.

5. Si vous avez créé un secret dans Secret Manager avec la valeur de votre clé API Datadog comme indiqué dans étape 1), entrez le nom de la ressource du secret dans le champ Google Cloud Secret Manager ID.

Consultez la section Paramètres de modèle dans le modèle Dataflow pour en savoir plus sur lʼutilisation des autres options disponibles :

• apiKeySource=KMS avec apiKeyKMSEncryptionKey défini sur votre clé dʼID de Cloud KMS et apiKey défini sur la clé dʼAPI chiffrée
• Non conseillé : apiKeySource=PLAINTEXT avec apiKey défini sur la clé dʼAPI en texte brut

6. Si vous avez créé un compte service de worker personnalisé, sélectionnez-le dans le menu déroulant Service account email.

7. Cliquez sur RUN JOB.

Remarque : si vous possédez un VPC partagé, consultez la page Spécifier un réseau et un sous-réseau de la documentation Dataflow pour obtenir des instructions sur la spécification des paramètres Network et Subnetwork.

Validation

Les nouveaux événements de logs envoyés au sujet Cloud Pub/Sub apparaissent dans le Log Explorer de Datadog.

Remarque : vous pouvez utiliser le Calculateur de prix Google Cloud pour calculer les coûts potentiels.

Surveiller la redirection des logs Cloud Pub/Sub

Lʼintégration Google Cloud Pub/Sub fournit des métriques utiles pour surveiller l’état de la redirection des logs :

• gcp.pubsub.subscription.num_undelivered_messages pour le nombre de messages en attente de livraison
• gcp.pubsub.subscription.oldest_unacked_message_age pour l’âge du plus ancien message non acquitté dans un abonnement

Utilisez les métriques ci-dessus avec un monitor de métriques pour recevoir des alertes pour les messages dans vos abonnements en entrée et de messages non aboutis.

Surveiller le pipeline Dataflow

Utilisez lʼintégration Google Cloud Dataflow de Datadog pour surveiller tous les aspects de vos pipelines Dataflow. Vous pouvez voir toutes vos métriques Dataflow principales sur le dashboard prêt à l’emploi, doté de données contextuelles telles que des informations sur les instances GCE qui exécutent vos workloads Dataflow, et votre débit Pub/Sub.

Vous pouvez également utiliser un monitor recommandé préconfiguré pour configurer des notifications pour les augmentations du temps de backlog dans votre pipeline. Pour en savoir plus, lisez la section Monitor your Dataflow pipelines with Datadog (en anglais) dans le blog de Datadog.

Données collectées

Métriques

Consultez les différentes pages des intégrations Google Cloud pour en savoir plus sur les métriques associées.

Métriques cumulatives

Les métrique cumulatives sont importées dans Datadog avec une métrique .delta chaque nom de métrique. Une métrique cumulative est une métrique dont la valeur augmente constamment au fil du temps. Par exemple, une métrique pour sent bytes peut être cumulative. Chaque valeur enregistre le nombre total d’octets envoyés par un service à ce moment-là. La valeur delta représente la différence avec la mesure précédente.

Exemple :

gcp.gke.container.restart_count est une métrique CUMULATIVE. Lors de l’importation de cette métrique en tant que métrique cumulative, Datadog ajoute la métrique gcp.gke.container.restart_count.delta, qui inclut les valeurs delta (par opposition à la valeur agrégée émise dans le cadre de la métrique CUMULATIVE). Référez-vous à a section types de métriques Google Cloud pour en savoir plus.

Événements

Tous les événements de service générés par Google Cloud Platform sont transférés vers votre Events Explorer Datadog.

Checks de service

L’intégration Google Cloud Platform n’inclut aucun check de service.

Tags

Les tags sont automatiquement attribués en fonction d’un ensemble d’options de configuration Google Cloud Platform et Google Compute Engine. Toutes les métriques bénéficient du tag project_id. Des tags supplémentaires sont recueillis à partir de la plateforme Google Cloud, le cas échéant. Les tags recueillis dépendent du type de métrique.

En outre, Datadog recueille les éléments suivants en tant que tags :

• Les hosts avec les libellés <key>:<value>
• Les libellés personnalisés de Google Pub/Sub, GCE, Cloud SQL et Cloud Storage

Dépannage

Mes métadonnées sont incorrectes pour les métriques gcp.logging définies par l’utilisateur

Pour les métriques gcp.logging non standard, comme les métriques qui ne correspondent pas aux métriques de journalisation Datadog par défaut, les métadonnées appliquées peuvent différer de celles de Google Cloud Logging.

Dans ce cas, les métadonnées doivent être définies manuellement sur la page de résumé de la métrique : recherchez et sélectionnez la métrique en question, puis cliquez sur l’icône en forme de crayon à côté des métadonnées.

Besoin d’aide ? Contactez l’assistance Datadog.

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles:

Améliorez la conformité et la sécurité de votre environnement Google Cloud avec DatadogBLOG Surveiller Google Cloud Vertex AI avec DatadogBLOG Surveiller des pipelines Dataflow avec DatadogBLOG Créer et gérer votre intégration Google Cloud avec TerraformTERRAFORM Surveiller BigQuery avec DatadogBLOG