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

  • Article

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

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

Notes

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 premier projet. 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/jeux d’entités sont disponibles avec la préversion d’Analytics v4.0 . La version d’analyse 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 Progression status exemple de rapport.
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (Composite) Prend en charge la compréhension de la consommation de pipelines parallèles. Pour en savoir plus 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 Exemple de rapport sur la tendance du taux de réussite du 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 Exemple de rapport sur la durée de la tâche 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 comment ce jeu 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 . 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 String Nom attribué à une branche lors de sa création.
ID du dépôt RepositoryId String Numéro attribué à un dépôt lors de sa création.
ID Vsts du dépôt RepositoryVstsId String Numéro attribué à un dépôt TFVC lors de sa création.
RepositoryUrl RepositoryUrl String URL définie pour un dépôt 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 Booléen 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 Agents Azure Pipelines.
Échec de l’accès à tous les fournisseurs FailedToReachAllProviders Booléen 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 du instantané.
Nombre de minutes de pipelines parallèles TotalMinutes Int32 Nombre de minutes nécessaires pour exécuter le instantané.
Type de parallélisme ParallelismTag String Balise qui indique le type de parallélisme associé au travail instantané.
Premium Type IsPremium Booléen Indique si le pipeline parallèle est premium (True) ou non (False).
Exemple de date SamplingDate DateTime Date associée au 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 attribué au pipeline.
Nom du pipeline PipelineName String Nom attribué 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 de pipeline YAML.
Docker 3 Définition de pipeline Docker.

PipelineJobs

Un travail de pipeline est une série d’étapes qui s’exécutent de manière séquentielle en tant qu’unité. Un travail est la plus petite unité de travail que vous pouvez planifier pour 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 de pipeline FullJobName String Nom complet d’un travail de pipeline.
Pipeline Id PipelineId Int32 ID attribué au pipeline dans lequel le travail est défini.
Identificateur du travail de pipeline JobId String Identificateur de travail affecté à un travail de pipeline lors de sa création.
Nom du travail de pipeline JobName String Nom attribué au travail de pipeline.
Nom de l’étape du pipeline StageName String Nom de l’étape associé au travail de pipeline.
Attributs de stratégie de travail de pipeline StrategyAttributes String Attributs définis pour le travail de pipeline.
Identificateur d’étape StageId String 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 Exemple de rapport sur les é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 Séquence d’exécution de 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 DateTime 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 numéro RunNumberRevision Int32 Numéro affecté à une exécution de pipeline avec des exécutions séquentielles.
Nombre de réussites partielles 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 DateTime Date et heure auxquelles le pipeline a été mis en file d’attente pour s’exécuter.
Durée de la file d’attente en secondes QueueDurationSeconds Decimal Nombre de secondes pendant lesquelles le pipeline est resté dans la file d’attente.
Numéro d’exécution RunNumber String Numéro attribué à une exécution de pipeline lors de son exécution.
Résultat de l’exécution RunOutcome Énuméré Résultat attribué à un pipeline une fois son exécution terminée. 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 de l’exécution en secondes RunDurationSeconds Decimal Nombre de secondes qu’il a fallu pour que l’exécution du pipeline se termine.
Date de début StartedDate DateTime Date et heure du début de l’exécution du pipeline.
Nombre de réussites SucceededCount Int32 Nombre d’exécutions de pipeline qui ont réussi.
Durée totale en secondes TotalDurationSeconds Decimal Nombre total de secondes pendant lesquelles le pipeline se trouvait dans la file d’attente et l’exécution.

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 sur QueuedOn QueuedDateSK DateSK
Démarré le StartedOn QueuedDateSK DateSK
Pipeline Pipeline PipelineSK PipelineSK
Projet Project ProjectSK ProjectSK

PipelineRunReason , membres de type énumérés

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

Nom du membre Valeur Nom complet
None 0 Aucune
Manual 1 Manuel
IndividualCI 2 CI individuel
BatchedCI 4 CI par lots
Schedule 8 Planifier
UserCreated 32 Utilisateur créé
ValidateShelveset 64 Valider l’ensemble de étagères
CheckInShelveset 128 Point Shelveset
PullRequest 256 Demande de tirage (pull request)
PipelineRunCompletion 512 Fin de build

PipelineRunOutcome, membres de type énumérés

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 None
Succeed 2 Réussite
PartiallySucceeded 4 Succès partiel
Failed 6 Échec
Canceled 32 Opération 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 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 Référence des métadonnées 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 DateTime Date et heure auxquelles l’exécution du pipeline se termine.
Durée de l’activité en secondes ActivityDurationSeconds Decimal Nombre total de secondes pendant lesquelles le pipeline se trouvait dans la file d’attente et l’exécution.
Date de début de l’activité ActivityStartedDate DateTime Date-heure du démarrage 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 ayant é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 lors de son exécution.
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 du travail RelativeStartTimeFromJobSeconds Int32 Nombre de secondes écoulées depuis le début du travail.
Heure de début relative à partir des secondes d’étape RelativeStartTimeFromStageSeconds Int32 Nombre de secondes écoulées depuis le début de la phase.
Heure de début relative à partir des secondes d’exécution RelativeStartTimeFromRunSeconds Int32 Nombre de secondes qui se sont écoulées depuis l’exécution de l’exécution.
Nombre ignoré SkippedCount Int32 Nombre d’exécutions de pipeline qui ont été ignorées.
Nombre de réussites SucceededCount Int32 Nombre d’exécutions de pipeline qui ont réussi.
Nombre de problèmes réussis SucceededWithIssuesCount Int32 Nombre d’exécutions de pipeline qui ont partiellement réussi.
Nom complet de la tâche TaskDisplayName String Nom d’une tâche exécutée dans l’exécution du pipeline.
Chemin du journal des tâches TaskLogPath String Chemin du fichier journal généré par une tâche.
Résultat de la tâche TaskOutcome Custom Résultat de la tâche exécutée.

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

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

Nom complet Nom Contrainte référentielle Propriété référencée
Activité démarrée le 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 PipelineRunQueuedOn PipelineRunQueuedDateSK DateSK
Exécution du pipeline démarrée le PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Exécution du pipeline terminée le PipelineRunCompletedOn PipelineRunCompletedDateSK DateSK
Exécution du pipeline démarrée le 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 String 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 TaskAgentPoolSizeSnapshots 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 attribué au pool d’agents.
Exemple de date SamplingDate DateTime Date et heure auxquelles la taille du pool a été ancrée.

Pour obtenir un exemple de rapport généré à partir de l’entité TaskAgentPoolSizeSnapshot, consultez Graphique historique pour les 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 Booléen Indique si la build est mise en file d’attente (True) ou non en file d’attente (False).
Build en cours d’exécution IsRunning Booléen Indique si la build est en cours d’exécution (True) ou non (False).
Hébergé ou auto-hébergé IsHosted Booléen Indique si l’agent affecté à la tâche est hébergé (True) ou auto-hébergé (False).
Date de fin du travail FinishedDate DateTime Date-heure de fin de l’exécution de la demande de l’agent de tâche.
FinishedDateSK Int32 Date à laquelle la demande de l’agent de tâche a terminé son exécution, exprimée comme YYYYMMDD dans le fuseau horaire défini pour le organization.
Date mise en file d’attente QueuedDate DateTime Date-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 le organization.
Durée de la file d’attente en secondes QueueDurationSeconds Decimal Nombre de secondes pendant lesquelles la demande d’agent de tâche est restée dans la file d’attente avant qu’un agent soit affecté.
Pool Id PoolId Int32 Numéro attribué au pool d’agents affecté à la demande de l’agent de tâche.
Pipeline Type PipelineType String Type de pipeline contenant la demande de l’agent de tâche.
ID de demande RequestId Int64 Numéro attribué à la demande de l’agent de tâche.
Exemple d’heure SamplingHour Int32 Numéro attribué à l’heure à laquelle la demande a été reçue.
Temps de l'échantillon SamplingTime DateTime Date-heure de réception de la demande de l’agent de tâche.
Date de début StartedDate DateTime Date-heure d’exécution de la demande de l’agent de tâche.
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 le organization.

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 sur QueuedOn QueuedDateSK DateSK
Pipeline Pipeline PipelineSK PipelineSK
Projet Project ProjectSK ProjectSK
Démarré le StartedOn QueuedDateSK DateSK