Informations de référence sur les métadonnées pour Azure Pipelines Analytique

  • Article

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019

Le service Analytique collecte l’activité de pipeline et de test générée via Azure Pipelines. Cet article décrit les propriétés que vous pouvez utiliser pour générer un rapport Analytique pour les pipelines. Vous utilisez une combinaison de propriétés pour filtrer une requête, agréger des données ou créer un rapport.

Remarque

Des descriptions des entités, des propriétés et des types énumérés pris en charge par le modèle de données Analytics sont fournies. Il s’agit d’un brouillon précoce. Veuillez fournir des commentaires sur les domaines que vous souhaitez obtenir plus d’informations. Pour interroger le modèle de données, consultez Construire des requêtes OData pour Analytics.

Jeux d’entités et types d’entités

Le tableau suivant récapitule les types d’entités et les jeux d’entités qui prennent en charge Azure Pipelines. Tous les types d’entités/ensembles d’entités sont disponibles avec Analytique version préliminaire v4.0. Analytique version v3.0-preview ne prend pas en charge les instantanés.

EntitySet EntityType Description
Branches Branche Informations de base sur les branches utilisées dans les tests ou les pipelines. Pour obtenir un exemple de rapport, consultez l’exemple de rapport État de progression.
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (Composite) Prend en charge la compréhension de la consommation de pipeline parallèle. Pour plus d’informations sur les tests de pipeline parallèles, consultez Exécuter des tests en parallèle à l’aide de la tâche de test Visual Studio.
Pipelines Pipeline Propriétés d’un pipeline.
PipelineJobs PipelineJob Résultats d’exécution individuels pour un test spécifique associé à un TestRun
PipelineRuns PipelineRun Informations d’exécution pour les pipelines. Pour obtenir un exemple de rapport, consultez l’exemple de rapport de tendance du taux de transmission de pipeline.
PipelineRunActivityResults PipelineRunActivityResult Journal fusionné de toutes les étapes, étapes, travaux et tâches au sein d’une exécution de pipeline spécifique. Pour obtenir un exemple de rapport, consultez l’exemple de rapport de durée des tâches de pipeline.
PipelineTasks PipelineTask Propriétés des tâches utilisées dans un pipeline.
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (Composite) Prend en charge la compréhension de la taille du pool, des travaux de pipeline et de la concurrence. Le graphique historique des pools d’agents illustre la façon dont cet ensemble d’entités peut être utilisé.
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (Composite) Prend en charge la création de rapports sur les demandes de l’agent de tâche.

Branches

Les propriétés suivantes sont valides pour l’ensemble d’entités Branches . Les clés de substitution associées à Branch include BranchSK et ProjectSK.

Nom complet Nom Type de données Description
AnalyticsUpdatedDate DateTime Filigrane qui indique l’heure de la dernière mise à jour des données Analytics.
Nom de la branche BranchName Chaîne Nom affecté à une branche lors de sa création.
ID du référentiel RepositoryId Chaîne Numéro affecté à un référentiel lors de sa création.
ID Vsts du référentiel RepositoryVstsId Chaîne Numéro affecté à un référentiel TFVC lors de sa création.
RepositoryUrl RepositoryUrl Chaîne URL définie pour un référentiel lors de sa création.

Les propriétés de navigation incluent Project et sa contrainte ProjectSKréférentielle .

ParallelPipelineJobsSnapshot

Les propriétés suivantes sont valides pour l’ensemble d’entités ParallelPipelineJobsSnapshot . Les clés de référence sont les suivantes :

  • IsHosted
  • ParallelismTag
  • SamplingDate
Nom complet Nom Type de données Description
Hébergé ou auto-hébergé IsHosted Boolean Indique si le pipeline parallèle est exécuté sur un agent hébergé par Microsoft (True) ou auto-hébergé (False). Pour plus d’informations, consultez les agents Azure Pipelines.
Impossible d’atteindre tous les fournisseurs FailedToReachAllProviders Boolean Indique si l’exécution du travail a atteint tous les fournisseurs (True) ou non (False).
Nombre de travaux de pipelines parallèles TotalCount Int32 Nombre de travaux exécutés dans le cadre de l’instantané.
Nombre de minutes de pipelines parallèles TotalMinutes Int32 Nombre de minutes nécessaires pour exécuter l’instantané.
Type de parallélisme ParallelismTag Chaîne Balise qui indique le type de parallélisme associé à l’instantané de travail.
Premium Type IsPremium Boolean Indique si le pipeline parallèle est Premium (True) ou non (False).
Exemple de date SamplingDate Date/Heure Date associée à l’instantané.

Pipelines

Les propriétés suivantes sont valides pour Pipelines et sa clé PipelineSKde substitution.

Nom complet Nom Type de données Description
Pipeline Id PipelineId Int32 ID affecté au pipeline.
Nom du pipeline PipelineName Chaîne Nom affecté au pipeline.
Pipeline Version PipelineVersion Int32 Version associée au pipeline.
Type de processus de pipeline PipelineProcessType Énuméré Type de définition de pipeline. Les valeurs valides sont répertoriées ci-dessous pour PipelineProcessType.

Les propriétés de navigation incluent Project et sa contrainte ProjectSKréférentielle .

Membres de type énumérés PipelineProcessType

Les membres suivants sont définis pour le PipelineProcessType type énuméré qui indique la méthode utilisée pour définir le pipeline.

Nom du membre Valeur Définition
Designer 1 Définition de pipeline classique.
Yaml 2 Définition du pipeline YAML.
Docker 3 Définition du pipeline Docker.

PipelineJobs

Un travail de pipeline est une série d’étapes qui s’exécutent séquentiellement en tant qu’unité. Un travail est la plus petite unité de travail que vous pouvez planifier pour s’exécuter. Les pipelines sont organisés autour des travaux, et chaque pipeline a au moins un travail. Pour plus d’informations, consultez Spécifier des travaux dans votre pipeline.

Les propriétés suivantes sont valides pour PipelineJobs et sa PipelineJobSK clé de substitution.

Nom complet Nom Type de données Description
Nom complet du travail du pipeline FullJobName Chaîne Nom complet d’un travail de pipeline.
Pipeline Id PipelineId Int32 ID affecté au pipeline dans lequel le travail est défini.
Identificateur de travail de pipeline JobId Chaîne Identificateur de travail affecté à un travail de pipeline lors de sa création.
Nom du travail du pipeline JobName Chaîne Nom attribué au travail de pipeline.
Nom de l’étape du pipeline StageName Chaîne Nom d’étape associé au travail de pipeline.
Attributs de stratégie de travail de pipeline StrategyAttributes Chaîne Attributs définis pour le travail de pipeline.
Identificateur d’étape StageId Chaîne Identificateur d’étape associé au travail de pipeline.

Les propriétés de navigation incluent Project et sa contrainte ProjectSKréférentielle .

Pour obtenir un exemple de rapport qui interroge le type d’entité PipelineJob, consultez l’exemple de rapport d’échecs de phase de pipeline.

PipelineRuns

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. Une exécution de pipeline comprend des travaux, des étapes et des tâches. Pour plus d’informations, consultez la séquence d’exécution du pipeline.

Les propriétés suivantes sont valides pour le type d’entité PipelineRun et sa PipelineRunSK clé de substitution.

Nom complet Nom Type de données Description
Nombre annulé CanceledCount Int32 Nombre d’exécutions de pipeline qui ont été annulées.
Date de fin CompletedDate Date/Heure Date et heure de fin de l’exécution du pipeline.
Nombre d’échecs FailedCount Int32 Nombre d’exécutions de pipeline qui ont réussi.
Révision de nombre RunNumberRevision Int32 Nombre affecté à une exécution de pipeline avec des exécutions séquentielles.
Nombre partiellement réussi PartiallySucceededCount Int32 Nombre d’exécutions de pipeline qui ont partiellement réussi.
ID d’exécution du pipeline PipelineRunId Int32 Numéro affecté à une exécution de pipeline.
Date mise en file d’attente QueuedDate Date/Heure Date et heure à laquelle le pipeline a été mis en file d’attente pour s’exécuter.
Durée de file d’attente en secondes QueueDurationSeconds Décimal Nombre de secondes pendant lesquelles le pipeline est resté dans la file d’attente.
Numéro d’exécution RunNumber Chaîne Numéro affecté à une exécution de pipeline lorsqu’il est exécuté.
Résultat de l’exécution RunOutcome Énuméré Résultat affecté à un pipeline à la fin de son exécution. Les valeurs valides sont répertoriées ci-dessous pour PipelineRunOutcome.
Raison de l’exécution RunReason Énuméré Condition qui a provoqué l’exécution du pipeline. Les valeurs valides sont répertoriées ci-dessous pour PipelineRunReason.
Durée d’exécution secondes RunDurationSeconds Décimal Nombre de secondes nécessaire pour que l’exécution du pipeline se termine.
Date de début StartedDate Date/Heure Date et heure de début de l’exécution du pipeline.
Nombre réussi SucceededCount Int32 Nombre d’exécutions de pipeline qui ont réussi.
Durée totale en secondes TotalDurationSeconds Décimal Nombre total de secondes pendant lesquelles le pipeline était dans la file d’attente et s’exécute.

Les propriétés de navigation suivantes sont prises en charge.

Nom d’affichage Nom -Contrainte référentielle Propriété référencée
Branche Branch BranchSK BranchSK
Terminé le CompletedOn CompletedDateSK DateSK
Mise en file d’attente activée QueuedOn QueuedDateSK DateSK
Démarré sur StartedOn QueuedDateSK DateSK
Pipeline Pipeline PipelineSK PipelineSK
Projet Project ProjectSK ProjectSK

Membres de type énumérés PipelineRunReason

Les membres suivants sont définis pour le PipelineRunReason type énuméré qui indique les conditions dans lesquelles chaque étape de pipeline, travail ou étape s’exécute comme décrit dans Spécifier les conditions.

Nom du membre Valeur Nom complet
None 0 Aucune
Manual 1 Manuel
IndividualCI 2 CI individuel
BatchedCI 4 Batched CI
Schedule 8 Planification
UserCreated 32 Utilisateur créé
ValidateShelveset 64 Valider l’ensemble de rayons
CheckInShelveset 128 Point Rayons
PullRequest 256 Demande de tirage (pull request)
PipelineRunCompletion 512 Saisie semi-automatique de build

Membres de type énumérés PipelineRunOutcome

Les membres suivants sont définis pour le PipelineRunOutcome type énuméré qui indique le résultat d’une exécution de pipeline.

Nom du membre Valeur Nom complet
None 0 Aucune
Succeed 2 Réussite
PartiallySucceeded 4 Succès partiel
Failed 6 Échec
Canceled 32 Annulée

PipelineRunActivityResults

Les propriétés suivantes sont valides pour l’ensemble d’entités PipelineRunActivityResults et sa PipelineRunActivityResultSK clé de substitution.

De nombreuses propriétés sont basées sur des dates ou basées sur l’utilisateur. Ces propriétés sont associées aux jeux d’entités CalendarDate et User décrits dans Date du calendrier, Projet et Informations de référence sur les métadonnées de l’utilisateur.

Nom complet Nom Type de données Description
Nombre abandonné AbandonedCount Int32 Nombre d’exécutions de pipeline marquées comme abandonnées.
Date de fin de l’activité ActivityCompletedDate Date/Heure Date et heure de fin de l’exécution du pipeline.
Durée de l’activité secondes ActivityDurationSeconds Décimal Nombre total de secondes pendant lesquelles le pipeline était dans la file d’attente et s’exécute.
Date de début de l’activité ActivityStartedDate Date/Heure Heure de début de l’exécution du pipeline.
Nombre annulé CanceledCount Int32 Nombre d’exécutions de pipeline qui ont été annulées.
Nombre d’échecs FailedCount Int32 Nombre d’exécutions de pipeline qui ont échoué.
Type d’activité de pipeline ActivityType Énuméré Type d’activité de pipeline. Les valeurs valides sont répertoriées ci-dessous pour PipelineActivityType.
ID d’exécution du pipeline PipelineRunId Int32 Numéro affecté à une exécution de pipeline lorsqu’il est exécuté.
Résultat de l’exécution du pipeline PipelineRunOutcome Énuméré Résultat affecté à un pipeline à la fin de son exécution. Les valeurs valides sont répertoriées sous PipelineRunOutcome.
Heure de début relative à partir des secondes de travail RelativeStartTimeFromJobSeconds Int32 Nombre de secondes écoulées à partir du début du travail.
Heure de début relative à partir de l’étape secondes RelativeStartTimeFromStageSeconds Int32 Nombre de secondes écoulées à partir du début de l’étape.
Heure de début relative à partir des secondes d’exécution RelativeStartTimeFromRunSeconds Int32 Nombre de secondes qui se sont écoulées à partir du moment où l’exécution a été exécutée.
Nombre ignoré SkippedCount Int32 Nombre d’exécutions de pipeline ignorées.
Nombre réussi SucceededCount Int32 Nombre d’exécutions de pipeline qui ont réussi.
Réussite avec le nombre de problèmes SucceededWithIssuesCount Int32 Nombre d’exécutions de pipeline qui ont partiellement réussi.
Nom complet de la tâche TaskDisplayName Chaîne Nom d’une tâche exécutée dans l’exécution du pipeline.
Chemin du journal des tâches TaskLogPath Chaîne Chemin d’accès du fichier journal généré par une tâche.
Résultat de la tâche TaskOutcome Personnalisée Résultat de la tâche exécutée.

Pour obtenir des exemples de rapports qui interrogent le type d’entité PipelineRunActivityResult, consultez l’exemple de rapport de tendance de la durée des tâches de pipeline.

Les propriétés de navigation incluent celles répertoriées dans le tableau suivant.

Nom d’affichage Nom Contrainte référentielle Propriété référencée
Activité démarrée sur ActivityStartedOn ActivityStartedDateSK DateSK
Branche Branch BranchSK BranchSK
Pipeline Pipeline PipelineSK PipelineSK
Tâche de pipeline PipelineTask PipelineTaskSK PipelineTaskSK
Travail de pipeline PipelineJob PipelineJobSK PipelineJobSK
Exécution du pipeline mise en file d’attente sur PipelineRunQueuedOn PipelineRunQueuedDateSK DateSK
Exécution du pipeline démarrée PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Exécution du pipeline terminée sur PipelineRunCompletedOn PipelineRunCompletedDateSK DateSK
Exécution du pipeline démarrée PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Projet Project ProjectSK ProjectSK

Membres de type énumérés PipelineActivityType

Les membres suivants sont définis pour le PipelineActivityType type énuméré.

Nom du membre Valeur Nom complet
Task 0 Tâche
Approval 1 Approbation
AgentWait 2 Attente de l’agent

PipelineTasks

Les propriétés suivantes sont valides pour l’ensemble d’entités PipelineTasks et sa clé PipelineTaskSKde substitution.

Nom complet Nom Type de données Description
ID de définition de tâche TaskDefinitionId GUID GUID affecté à une tâche de pipeline.
Version de définition de tâche TaskDefinitionVersion Chaîne Version affectée à une tâche de pipeline.

Les propriétés de navigation incluent Project et sa contrainte ProjectSKréférentielle .

TaskAgentPoolSizeSnapshots

Les propriétés suivantes sont valides pour l’ensemble d’entités TaskAgentPoolSnapshots et sa clé SamplingDatede substitution .

Nom complet Nom de la propriété Type de données Description
Nombre en ligne OnlineCount Int32 Nombre d’agents en ligne dans le pool d’agents lors de l’exécution de la tâche.
Nombre hors connexion OfflineCount Int32 Nombre d’agents hors connexion dans le pool d’agents lors de l’exécution de la tâche.
Pool Id PoolId Int32 Numéro affecté au pool d’agents.
Exemple de date SamplingDate Date/Heure Date et heure de l’alignement de la taille du pool.

Pour obtenir un exemple de rapport généré à partir de l’entité TaskAgentPoolSnapshot, consultez Graphique historique des pools d’agents (préversion).

TaskAgentRequestSnapshots

Les pools d’agents sont alloués lorsqu’une tâche est exécutée. Le jeu d’entités TaskAgentRequestSnapshots capture les données liées aux demandes de l’agent de tâche.

Les propriétés suivantes sont valides pour le type d’entité TaskAgentRequestSnapshot et ses clés SamplingTime de substitution et SamplingDateSK.

Nom complet Nom Type de données Description
Générer en file d’attente IsQueued Boolean Indique si la build est mise en file d’attente (True) ou non mise en file d’attente (False).
Générer en cours d’exécution IsRunning Boolean Indique si la build est en cours d’exécution (True) ou non (False).
Hébergé ou auto-hébergé IsHosted Boolean Indique si l’agent affecté à la tâche est hébergé (True) ou auto-hébergé (False).
Date de fin du travail FinishedDate Date/Heure Heure à laquelle la demande de l’agent de tâche s’est terminée en cours d’exécution.
FinishedDateSK Int32 Date d’exécution de la demande de l’agent de tâche, exprimée comme YYYYMMDD dans le fuseau horaire défini pour l’organisation.
Date mise en file d’attente QueuedDate Date/Heure Date et heure à laquelle la demande de l’agent de tâche a été mise en file d’attente.
QueuedDateSK Int32 Date à laquelle la demande de l’agent de tâche a été mise en file d’attente, exprimée comme YYYYMMDD dans le fuseau horaire défini pour l’organisation.
Durée de file d’attente en secondes QueueDurationSeconds Décimal Le nombre de secondes pendant lesquelles la demande de l’agent de tâche est restée dans la file d’attente avant qu’un agent n’ait été affecté.
Pool Id PoolId Int32 Numéro affecté au pool d’agents affecté à la demande de l’agent de tâche.
Pipeline Type PipelineType Chaîne Type de pipeline contenant la demande de l’agent de tâche.
ID de demande RequestId Int64 Numéro affecté à la demande de l’agent de tâche.
Exemple d’heure SamplingHour Int32 Numéro affecté à l’heure de réception de la requête.
Exemple d’heure SamplingTime Date/Heure Date et heure de réception de la demande de l’agent de tâche.
Date de début StartedDate Date/Heure Heure à laquelle la demande de l’agent de tâche a été exécutée.
StartedDateSK Int32 Date à laquelle la demande de l’agent de tâche a démarré l’exécution, exprimée comme YYYYMMDD dans le fuseau horaire défini pour l’organisation.

Les propriétés de navigation incluent celles répertoriées dans le tableau suivant.

Nom d’affichage Nom Contrainte référentielle -Referenced, propriété
Branche Branch BranchSK BranchSK
Terminé le CompletedOn CompletedDateSK DateSK
Heure de fin du travail FinishedOn FinishedDateSK DateSK
Mise en file d’attente activée QueuedOn QueuedDateSK DateSK
Pipeline Pipeline PipelineSK PipelineSK
Projet Project ProjectSK ProjectSK
Démarré sur StartedOn QueuedDateSK DateSK