Exemple de rapport récapitulatif des résultats du pipeline

  • Article

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020

Une exécution de pipeline représente une seule exécution d’un pipeline. Pendant une exécution, le pipeline est traité et les agents traitent un ou plusieurs travaux. Les résultats incluent La réussite, l’échec, l’annulation et la réussite partielle. Pour créer des rapports qui affichent les résultats des exécutions de pipeline, vous interrogez « PipelineRuns entity set ».

Cet article fournit plusieurs requêtes et instructions sur la création d’un rapport pour obtenir le nombre d’exécutions pour différents résultats de pipeline.

L’image suivante montre un exemple de rapport récapitulatif des résultats.

Capture d’écran du rapport résumé des résultats power BI Pipelines.

Important

L’intégration de Power BI et l’accès au flux OData du service Analytics sont généralement disponibles pour Azure DevOps Services et Azure DevOps Server 2020 et versions ultérieures. Les exemples de requêtes fournis dans cet article sont valides uniquement sur Azure DevOps Server 2020 et versions ultérieures, et dépendent de la version v3.0-preview ou ultérieure. Nous vous encourageons à utiliser ces requêtes et à nous fournir des commentaires.

Prérequis

  • Accès : être membre d’un projet avec au moins un accès de base .
  • Autorisations : par défaut, les membres du projet ont l’autorisation d’interroger Analytics et de créer des vues.
  • Pour plus d’informations sur les autres prérequis concernant l’activation du service et des fonctionnalités et les activités de suivi des données générales, consultez Autorisations et conditions préalables pour accéder à Analytics.

Remarque

Cet article part du principe que vous lisez la vue d’ensemble des exemples de rapports à l’aide de requêtes OData et que vous avez une compréhension de base de Power BI.

Exemples de requêtes

Vous pouvez utiliser les requêtes suivantes de l’ensemble PipelineRuns d’entités pour créer des rapports de synthèse de résultats de pipeline différents, mais similaires.

Remarque

Pour déterminer les propriétés disponibles à des fins de filtre ou de rapport, consultez la référence des métadonnées pour Azure Pipelines. Vous pouvez filtrer vos requêtes ou renvoyer des propriétés à l’aide de l’une Property des valeurs sous ou EntityType des NavigationPropertyBinding Path valeurs disponibles avec un EntitySet. Chaque EntitySet correspond à un EntityType. Pour plus d’informations sur le type de données de chaque valeur, passez en revue les métadonnées fournies pour le type de données correspondant EntityType.

Durée du pipeline pour un pipeline nommé

Les requêtes suivantes retournent les exécutions du pipeline pour un pipeline spécifique à partir d’une date de début spécifiée.

Copiez et collez la requête Power BI suivante directement dans la fenêtre Obtenir une requête vide de données>. Pour plus d’informations, consultez Vue d’ensemble des exemples de rapports à l’aide de requêtes OData.

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"Pipeline/PipelineName eq '{pipelineName}' "
                &"and CompletedDate ge {startdate} "
                &") "
        &"/aggregate( "
        &"$count as TotalCount, "
            &"SucceededCount with sum as SucceededCount , "
                &"FailedCount with sum as FailedCount, "
                &"PartiallySucceededCount with sum as PartiallySucceededCount , "
            &"CanceledCount with sum as CanceledCount "
                &") "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

Chaînes de substitution et répartition des requêtes

Remplacez les chaînes suivantes par vos valeurs. N’incluez pas de crochets {} avec votre substitution. Par exemple, si le nom de votre organisation est « Fabrikam », remplacez par {organization}Fabrikam, et non {Fabrikam}par .

  • {organization} - Nom de votre organisation
  • {project} - Nom de votre projet d’équipe
  • {pipelinename} - Nom de votre pipeline. Exemple : Fabrikam hourly build pipeline
  • {startdate} - Date de démarrage de votre rapport. Format : AAAA-MM-DDZ. Exemple : 2021-09-01Z représente le 1er septembre 2021. Ne placez pas entre guillemets ou crochets et utilisez deux chiffres pour les deux, mois et date.

Répartition des requêtes

Le tableau suivant décrit chaque partie de la requête.

Composant de requête

Description

$apply=filter(

Clause Start filter() .

Pipeline/PipelineName eq '{pipelinename}'

Retourne des exécutions de pipeline pour le pipeline spécifié.

and CompletedDate ge {startdate}

Le pipeline de retour s’exécute à la date spécifiée ou après celle-ci.

)

Close filter() , clause

/aggregate(

Clause Start aggregate pour tous les exécutions du pipeline correspondant aux critères de filtre.

$count as TotalCount,

Comptez le nombre total d’exécutions sous la forme TotalCount.

SucceededCount with sum as SucceededCount ,

Compter le nombre d’exécutions réussies en tant que SucceededCount.

FailedCount with sum as FailedCount,

Comptez le nombre d’exécutions ayant échoué en tant que FailedCount.

PartiallySucceededCount with sum as PartiallySucceededCount ,

Comptez le nombre d’exécutions partiellement réussies en tant que PartiallySucceededCount.

CanceledCount with sum as CanceledCount

Comptez le nombre d’exécutions annulées en tant que CanceledCount.

)

Clause Close aggregate() .

Résumé des résultats de l’exécution du pipeline pour un ID de pipeline spécifique

Les pipelines peuvent être renommés. Pour vous assurer que les rapports Power BI ne s’arrêtent pas lorsqu’un nom de pipeline est modifié, utilisez l’ID de pipeline plutôt que son nom. Vous pouvez obtenir l’ID de pipeline à partir de l’URL de la page d’exécutions du pipeline.

https://dev.azure.com/{organization}/{project}/_build?definitionId={pipelineid}

Les requêtes suivantes retournent les exécutions du pipeline pour un ID de pipeline spécifique et à partir d’une date de début spécifiée.

Copiez et collez la requête Power BI suivante directement dans la fenêtre Obtenir une requête vide de données>. Pour plus d’informations, consultez Vue d’ensemble des exemples de rapports à l’aide de requêtes OData.

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"PipelineId eq {pipelineId} "
                &"and CompletedDate ge {startdate} "
                &") "
        &"/aggregate( "
        &"$count as TotalCount, "
            &"SucceededCount with sum as SucceededCount , "
                &"FailedCount with sum as FailedCount, "
                &"PartiallySucceededCount with sum as PartiallySucceededCount , "
            &"CanceledCount with sum as CanceledCount "
                &") "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

Résumé des résultats de l’exécution du pipeline filtré par branche

Pour afficher le résumé des résultats d’un pipeline pour une branche particulière, utilisez les requêtes suivantes. Pour créer le rapport, procédez comme suit :

Copiez et collez la requête Power BI suivante directement dans la fenêtre Obtenir une requête vide de données>. Pour plus d’informations, consultez Vue d’ensemble des exemples de rapports à l’aide de requêtes OData.

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"Pipeline/PipelineName eq '{pipelinename}' "
                &"and CompletedDate ge {startdate} "
                &") "
        &"/groupby( "
        &"(Branch/BranchName), "
            &"aggregate( "
                &"$count as TotalCount, "
                &"SucceededCount with sum as SucceededCount , "
            &"FailedCount with sum as FailedCount, "
                &"PartiallySucceededCount with sum as PartiallySucceededCount , "
            &"CanceledCount with sum as CanceledCount "
        &")) "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

Résumé des résultats de l’exécution du pipeline filtré par raison de build

Vous pouvez afficher le résumé des résultats d’un pipeline uniquement pour des raisons de build spécifiques (Manuel / BatchedCI, Demande d’extraction, etc.). Pour créer le rapport, procédez comme suit :

Copiez et collez la requête Power BI suivante directement dans la fenêtre Obtenir une requête vide de données>. Pour plus d’informations, consultez Vue d’ensemble des exemples de rapports à l’aide de requêtes OData.

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"Pipeline/PipelineName eq '{pipelinename}' "
                &"and CompletedDate ge {startdate} "
                &") "
        &"/groupby( "
        &"(RunReason), "
            &"aggregate( "
                &"$count as TotalCount, "
                &"SucceededCount with sum as SucceededCount , "
            &"FailedCount with sum as FailedCount, "
                &"PartiallySucceededCount with sum as PartiallySucceededCount , "
            &"CanceledCount with sum as CanceledCount "
        &")) "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

Résumé des résultats pour tous les pipelines de projet

Vous pouvez afficher le résumé des résultats du pipeline pour tous les pipelines de projet dans un seul rapport. Pour créer le rapport, procédez comme suit :

Consultez également le résumé des résultats pour tous les exemples de rapport de pipelines pour obtenir des étapes détaillées .

Copiez et collez la requête Power BI suivante directement dans la fenêtre Obtenir une requête vide de données>. Pour plus d’informations, consultez Vue d’ensemble des exemples de rapports à l’aide de requêtes OData.

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"CompletedDate ge {startdate} "
                &") "
                &"/groupby( "
        &"(Pipeline/PipelineName), "
        &"aggregate( "
            &"$count as TotalCount, "
                &"SucceededCount with sum as SucceededCount , "
                &"FailedCount with sum as FailedCount, "
            &"PartiallySucceededCount with sum as PartiallySucceededCount , "
                &"CanceledCount with sum as CanceledCount "
            &")) "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

(Facultatif) Renommer la requête

Vous pouvez renommer l’étiquette de requête par défaut , Query1, en quelque chose de plus significatif. Entrez simplement un nouveau nom dans le volet Paramètres de requête .

Capture d’écran des options de menu de requête Power BI, renommer la requête.

Modifier le type de données de colonne

Dans le Éditeur Power Query, sélectionnez la TotalCount colonne, puis sélectionnez Type de données dans le menu Transformer, puis choisissez Nombre entier. Pour plus d’informations sur la modification du type de données, consultez Transform Analytics pour générer des rapports Power BI, Transformer un type de données de colonne.

(Facultatif) Renommer des champs de colonne

Vous pouvez renommer des champs de colonne. Par exemple, vous pouvez renommer la colonne Pipeline.PipelineName en Pipeline Name, ou TotalCount en Total Count. Pour savoir comment procéder, consultez Renommer les champs de colonne.

Fermez la requête et appliquez vos modifications

Une fois que vous avez terminé toutes vos transformations de données, choisissez Fermer & Appliquer dans le menu Accueil pour enregistrer la requête et revenir à l’onglet Rapport dans Power BI.

Capture d’écran de Éditeur Power Query’option Fermer et appliquer.

Créer le rapport de graphique en anneau

  1. Dans Power BI, sous Visualisations, choisissez le rapport Donut .

    Capture d’écran des sélections de champs de visualisation pour tous les rapports d’exécutions de pipeline.

  2. Ajoutez les champs suivants aux valeurs, dans l’ordre indiqué. Cliquez avec le bouton droit sur chaque champ et vérifiez que Somme est sélectionnée.

    • CanceledCount
    • PartiallySucceededCount.
    • SucceededCount
    • FailedCount

  3. Pour modifier le titre du rapport, sélectionnez l’icône Mettre en forme votre pinceau visuel dans le volet Visualisations, sélectionnez Général, Développez Titre et remplacez le texte existant.

    Capture d’écran du volet Visualisations, options de format de rapport, modification du titre.

    L’image suivante montre le rapport résultant.

    Capture d’écran du rapport Résumé des résultats des pipelines Power BI.