Configurer le tracing sur les workflows GitHub Actions
Le site Datadog sélectionné () n'est pas pris en charge.
Compatibilité
Versions de GitHub prises en charge :
- GitHub.com (SaaS)
- Serveur GitHub Enterprise 3.5.0 ou une version ultérieure
Pipelines partiels : consultez les exécutions de pipeline en aval qui ont fait l’objet d’une nouvelle tentative partielle
Mise en corrélation des logs : mettez les spans de pipeline en corrélation avec les logs et activez la collecte des logs de tâches
Mise en corrélation des métriques d’infrastructure : mettez les métriques d’infrastructure en corrélation avec les tâches de pipeline pour les exécuteurs GitHub auto-hébergés
Métriques et tags personnalisés lors de l’exécution : configurez des métriques et tags personnalisés lors de l’exécution pour des spans de pipeline
Délai de mise en file d’attente: découvrez le temps que les tâches de workflow passent dans la file d’attente avant d’être traitées
L’intégration GitHub Actions utilise une application GitHub privée pour recueillir les informations sur les workflows. Si vous possédez déjà une application, vous pouvez passer à la section suivante.
- Accédez au carré d’intégration GitHub.
- Cliquez sur Link GitHub Account.
- Suivez les instructions de configuration de l’intégration pour un compte personnel ou pour celui d’une organisation.
- Dans Edit Permissions, accordez l’accès
Actions: Read. - Cliquez sur Create App in GitHub pour terminer le processus de création de l’application dans GitHub.
- Attribuez un nom à l’application, par exemple
Datadog CI Visibility. - Cliquez sur Install GitHub App, puis suivez les instructions sur GitHub.
Une fois l’application GitHub créée et installée, activez CI Visibility sur les comptes et/ou les référentiels qui vous intéressent.
- Accédez à la page Getting Started, puis cliquez sur GitHub.
- Cliquez sur Enable Account pour le compte à activer.
- Cliquez sur Enable CI Visibility pour activer CI Visibility sur l’ensemble du compte.
- Vous avez également la possibilité d’activer des référentiels individuels. Pour ce faire, faites défiler la liste des référentiels et cliquez sur le bouton Enable CI Visibility.
Les pipelines s’afficheront immédiatement après l’activation de CI Visibility pour un compte ou un référentiel.
Activer la collecte de logs
L’intégration GitHub Actions avec CI Visibility permet également d’envoyer automatiquement les logs des tâches de workflow aux solutions de gestion des logs. Pour activer les logs, procédez comme suit :
- Accédez à la page des paramètres CI Visibility.
- Cliquez sur un compte activé ou sur un compte pour lequel des référentiels sont activés.
- Cliquez sur Enable Job Logs Collection pour activer la collecte de logs sur l’ensemble du compte.
- Vous avez également la possibilité d’activer des référentiels individuels. Pour ce faire, faites défiler la liste des référentiels et cliquez sur le bouton Enable Job Logs Collection.
Dès que vous avez activé la collecte des logs, les logs de tâches de workflow sont envoyés à Datadog. Notez que les logs et CI Visibility sont facturés séparément. La rétention des logs, l’exclusion de logs et les index de logs sont configurés dans les paramètres des logs.
Les fichiers de logs de plus de 1 Go sont tronqués.
Mettre les métriques d’infrastructure en corrélation avec les tâches
Si vous utilisez des exécuteurs GitHub auto-hébergés, vous pouvez mettre les tâches en corrélation avec l’host qui les exécute. Pour ce faire, assurez-vous que le nom de l’exécuteur GitHub correspond au hostname de la machine sur laquelle il est exécuté. CI Visibility pourra ainsi faire le lien avec les métriques d’infrastructure pertinentes. Pour consulter les métriques, cliquez sur une span de tâche dans la vue Trace. Dans la fenêtre qui s’affiche, vous verrez un nouvel onglet intitulé Infrastructure qui contient les métriques du host.
Visualiser des données de pipeline dans Datadog
Les pages Pipelines et Pipeline Executions affichent des données après l’exécution des pipelines.
Remarque : la page Pipelines affiche des données uniquement pour la branche par défaut de chaque référentiel.
Désactiver le tracing sur GitHub Actions
Pour désactiver l’intégration GitHub Actions avec CI Visibility, assurez-vous que l’application GitHub n’est plus abonnée aux événements de tâche de workflow et d’exécution de workflow. Pour supprimer ces événements, procédez comme suit :
- Accédez à la page GitHub Apps.
- Cliquez sur Edit > Permission & events pour l’application GitHub Datadog concernée (si vous en avez plusieurs, vous devrez répéter ce processus pour chaque application).
- Faites défiler la page jusqu’à atteindre la section Subscribe to events, puis assurez-vous que les options Workflow job et Workflow run ne sont pas sélectionnées.
Pour aller plus loin
Documentation, liens et articles supplémentaires utiles:
