Configuration de CircleCI pour CI Visibility

Ce produit n'est pas pris en charge par le site Datadog que vous avez sélectionné. ().

Section Overview

CircleCI est une plateforme d’intégration et de livraison continues qui permet aux équipes de créer, tester et déployer des logiciels à grande échelle.

Configurez CI Visibility pour CircleCI afin d’optimiser les performances de vos pipelines, d’améliorer la collaboration entre les équipes et de garantir des processus de build cohérents et conformes.

Compatibilité

Pipeline VisibilityPlateformeDéfinition
Tentatives partiellesPipelines partielsConsultez les exécutions de pipelines faisant lʼobjet de nouvelles tentatives.
Corrélation de logsCorrélation de logsMettre en corrélation les spans de pipeline et de tâches avec les logs et activer la collecte de logs de tâches.
Spans personnaliséesSpans personnaliséesConfigurez des spans personnalisées pour vos pipelines.
Tags prédéfinis personnalisésTags prédéfinis personnalisésDéfinir des tags personnalisés pour tous les spans de pipeline et de tâches générés.
Tags personnalisés et mesures au moment de l’exécutionTags et mesures personnalisés au moment de l’exécutionConfigurer des tags et des mesures personnalisés au moment de l’exécution.
Filtrer les tâches CI sur le chemin critiqueFiltrer les tâches CI sur le chemin critiqueFiltrer par tâches sur le chemin critique.
Temps d’exécutionDurée d’exécutionAfficher le temps pendant lequel les pipelines ont exécuté des tâches.

Termes

Ce tableau présente le mappage des concepts entre Datadog CI Visibility et CircleCI :

DatadogCircleCI
PipelineWorkflow
JobJob
Non disponible dans DatadogStep

Configurer l’intégration Datadog

L’intégration Datadog pour CircleCI utilise des webhooks pour envoyer des données à Datadog.

  1. Pour chaque projet, accédez à Project Settings > Webhooks dans CircleCI et ajoutez un nouveau webhook :

    • Webhook Name : Datadog CI Visibility ou tout autre nom d’identifiant que vous souhaitez fournir.
    • Receiver URL : https://webhook-intake./api/v2/webhook/?dd-api-key=<API_KEY> où <API_KEY> est votre clé d’API Datadog.
    • Certificate verifications : activez ce check.
    • Events : sélectionnez Workflow Completed et Job Completed.

  2. Cliquez sur Add Webhook pour enregistrer le nouveau webhook.

Configuration avancée

Configurer plusieurs projets en masse

Datadog propose un script pour vous aider à activer les hooks de service sur plusieurs ou tous vos projets CircleCI à l’aide de l’API CircleCI. Le script nécessite Python 3 et le package requests.

Pour exécuter ce script, vous avez besoin :

  • Votre clé d’API Datadog
  • D’un token d’API personnel CircleCI

Pour plus d’informations, vous pouvez exécuter la commande suivante :

./service_hooks.py --help

Pour configurer en masse les hooks pour vos projets :

  1. Connectez-vous à votre compte CircleCI et suivez tous les projets pour lesquels vous souhaitez activer les hooks. Si vous le souhaitez, utilisez le bouton Follow All sur la page Projects.

  2. Exécutez le script en utilisant les variables d’environnement DD_API_KEY et DD_SITE, ou en passant les paramètres de flags --dd-api-key et --dd-site :

    Exemple :

    ./service_hooks.py \
    --dd-api-key <DD_API_KEY> \
    --circle-token <CIRCLECI_TOKEN> \
    --dd-site  \
    --threads 4

Appliquer des tags personnalisés

Pour définir des tags personnalisés pour tous les spans de pipeline et de tâches générés par l’intégration, ajoutez au Receiver URL un paramètre de requête encodé en URL tags avec des paires key:value séparées par des virgules.

Si une paire key:value contient des virgules, entourez-la de guillemets. Par exemple, pour ajouter key1:value1,"key2: value with , comma",key3:value3, la chaîne suivante devrait être ajoutée au Receiver URL : ?tags=key1%3Avalue1%2C%22key2%3A+value+with+%2C+comma%22%2Ckey3%3Avalue3.

Intégrer avec Datadog Teams

Pour afficher et filtrer les équipes associées à vos pipelines, ajoutez team:<your-team> en tant que tag personnalisé. Le nom du tag personnalisé doit correspondre exactement au nom de votre équipe Datadog Teams.

Collecter les logs de tâches

L’intégration Datadog CircleCI collecte les logs de vos tâches CircleCI terminées et les transmet à Datadog. Pour installer et configurer cette intégration, consultez la documentation de l’intégration CircleCI.

Les logs sont facturés séparément de CI Visibility. La rétention, l’exclusion et les index de logs sont configurés dans Log Management. Les logs pour les tâches CircleCI peuvent être identifiés par les tags datadog.product:cipipeline et source:circleci.

Visualiser les données de pipeline dans Datadog

Les pages CI Pipeline List et Executions se remplissent de données une fois les workflows terminés.

La page CI Pipeline List affiche des données uniquement pour la branche par défaut de chaque référentiel. Pour plus d’informations, consultez la section Rechercher et gérer les pipelines CI.

Pour aller plus loin

Documentation, liens et articles supplémentaires utiles:

Explorer les résultats et les performances de l'exécution du pipelineDOCUMENTATION more more Gagner en visibilité sur les pipelines en traçant des commandes individuellesDOCUMENTATION more more Dépannage de CI VisibilityDOCUMENTATION more more Étendre Pipeline Visibility en ajoutant des tags et des mesures personnalisésDOCUMENTATION more more