Referenční informace k metadatům pro Azure Pipelines Analytics

  • Článek

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

Služba Analytics shromažďuje aktivitu kanálu a testování vygenerovanou prostřednictvím Azure Pipelines. Tento článek popisuje vlastnosti, které můžete použít k vygenerování analytické sestavy pro kanály. Kombinace vlastností slouží k filtrování dotazu, agregaci dat nebo sestavení sestavy.

Poznámka

K dispozici jsou popisy entit, vlastností a výčtových typů podporovaných datovým modelem Analytics. Toto je předběžný koncept. Pošlete nám prosím zpětnou vazbu k oblastem, ve kterých byste chtěli získat další informace. Informace o dotazování datového modelu najdete v tématu Vytváření dotazů OData pro analýzu.

Sady entit a typy entit

Následující tabulka shrnuje typy entit a sady entit, které podporují Azure Pipelines. Všechny typy entit nebo sady entit jsou k dispozici ve verzi Preview služby Analytics v4.0 . Analýza verze v3.0-preview nepodporuje snímky.

Entityset EntityType Description
Větve Větev Základní informace o větvích používaných v testech nebo kanálech Ukázkovou sestavu najdete v tématu Ukázková sestava stavu průběhu.
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (složený) Podporuje porozumění paralelní spotřebě kanálů. Další informace o paralelních testech kanálu najdete v tématu Spouštění testů paralelně pomocí úlohy Visual Studio Test.
Pipelines Kanál Vlastnosti kanálu.
Úlohy kanálu Úloha kanálu Jednotlivé výsledky spuštění konkrétního testu přidruženého k testovacímu spuštění
Spuštění kanálu Spuštění kanálu Informace o spuštění pro kanály Ukázkovou sestavu najdete v ukázkové sestavě trendu četnosti průchodů kanálů.
PipelineRunActivityResults PipelineRunActivityResult Sloučený protokol všech fází, kroků, úloh a úkolů v rámci konkrétního spuštění kanálu Ukázkovou sestavu najdete v tématu Ukázková sestava doby trvání úlohy kanálu.
PipelineTasks PipelineTask Vlastnosti pro úlohy, které se používají v rámci kanálu.
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (složený) Podporuje pochopení velikosti fondu, úloh kanálů a souběžnosti. Historický graf pro fondy agentů ukazuje, jak lze tuto sadu entit použít.
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (složený) Podporuje generování sestav u požadavků agenta úloh.

Větve

Následující vlastnosti jsou platné pro sadu entit Větve . Náhradní klíče přidružené k větvi zahrnují BranchSK a ProjectSK.

Zobrazovaný název Název Datový typ Popis
AnalyticsUpdatedDate DateTime Vodoznak, který označuje čas poslední aktualizace analytických dat.
Název větve BranchName Řetězec Název přiřazený větvi při jejím vytvoření.
ID úložiště RepositoryId Řetězec Číslo přiřazené k úložišti při jeho vytvoření.
ID Vsts úložiště RepositoryVstsId Řetězec Číslo přiřazené k úložišti TFVC při jeho vytvoření.
Adresa URL úložiště RepositoryUrl Řetězec Adresa URL definovaná pro úložiště při jeho vytvoření.

Mezi navigační vlastnosti patří Project a jeho referenční omezení ProjectSK.

ParallelPipelineJobsSnapshot

Následující vlastnosti jsou platné pro sadu entit ParallelPipelineJobsSnapshot . Mezi referenční klíče patří:

  • IsHosted
  • ParallelismTag
  • SamplingDate
Zobrazovaný název Název Datový typ Popis
Hostované nebo hostované v místním prostředí IsHosted Logická hodnota Označuje, jestli je paralelní kanál spuštěný na agentu hostovaném Microsoftem (True) nebo v místním prostředí (False). Další informace najdete v tématu Agenti Azure Pipelines.
Nepodařilo se spojit se všemi poskytovateli FailedToReachAllProviders Logická hodnota Označuje, jestli spuštění úlohy dosáhlo všech zprostředkovatelů (Pravda) nebo ne (False).
Počet úloh paralelních kanálů TotalCount Int32 Počet úloh spuštěných jako součást snímku.
Počet minut paralelních kanálů TotalMinutes Int32 Počet minut potřebných ke spuštění snímku.
Typ paralelismu ParallelismTag Řetězec Značka, která označuje typ paralelismu spojeného se snímkem úlohy.
Typ Premium IsPremium Logická hodnota Označuje, jestli je paralelní kanál premium (True) nebo ne (False).
Ukázkové datum SamplingDate DateTime Datum přidružené k snímku.

Pipelines

Následující vlastnosti jsou platné pro kanály a jejich náhradní klíč PipelineSK.

Zobrazovaný název Název Datový typ Popis
ID kanálu PipelineId Int32 ID přiřazené ke kanálu.
Název kanálu PipelineName Řetězec Název přiřazený kanálu.
Verze kanálu PipelineVersion Int32 Verze přidružená ke kanálu.
Typ procesu kanálu PipelineProcessType Enumerated Typ definice kanálu. Platné hodnoty jsou uvedené níže pro PipelineProcessType.

Mezi navigační vlastnosti patří Project a jeho referenční omezení ProjectSK.

PipelineProcessType – členy výčtu typu

Následující členy jsou definovány pro PipelineProcessType výčtový typ, který označuje metodu použitou k definování kanálu.

Název členu Hodnota Definice
Designer 1 Definice klasického kanálu
Yaml 2 Definice kanálu YAML.
Docker 3 Definice kanálu Dockeru

Úlohy kanálu

Úloha kanálu je řada kroků, které se spouštějí postupně jako jednotka. Úloha je nejmenší jednotka práce, kterou můžete naplánovat ke spuštění. Kanály jsou uspořádané podle úloh a každý kanál má alespoň jednu úlohu. Další informace najdete v tématu Určení úloh v kanálu.

Následující vlastnosti jsou platné pro úlohy PipelineJobs a jejich PipelineJobSK náhradní klíč.

Zobrazovaný název Název Datový typ Popis
Úplný název úlohy kanálu FullJobName Řetězec Úplný název úlohy kanálu
ID kanálu PipelineId Int32 ID přiřazené ke kanálu, ve kterém je úloha definovaná.
Identifikátor úlohy kanálu JobId Řetězec Identifikátor úlohy přiřazený k úloze kanálu při jejím vytvoření.
Název úlohy kanálu JobName Řetězec Název přiřazený úloze kanálu.
Název fáze kanálu StageName Řetězec Název fáze přidružené k úloze kanálu.
Atributy strategie úlohy kanálu StrategyAttributes Řetězec Atributy definované pro úlohu kanálu.
Identifikátor fáze StageId Řetězec Identifikátor fáze přidružený k úloze kanálu.

Mezi navigační vlastnosti patří Project a jeho referenční omezení ProjectSK.

Ukázkovou sestavu, která se dotazuje na typ entity PipelineJob , najdete v ukázkové sestavě selhání jednotlivých fází kanálu.

Spuštění kanálu

Spuštění kanálu představuje jedno spuštění kanálu. Během běhu se kanál zpracuje a agenti zpracují jednu nebo více úloh. Spuštění kanálu zahrnuje úlohy, kroky a úlohy. Další informace najdete v tématu Pořadí spuštění kanálu.

Následující vlastnosti jsou platné pro typ entity PipelineRun a její PipelineRunSK náhradní klíč.

Zobrazovaný název Název Datový typ Popis
Počet zrušených CanceledCount Int32 Počet zrušených spuštění kanálu.
Datum dokončení CompletedDate DateTime Datum a čas dokončení spuštění kanálu
Počet neúspěšných FailedCount Int32 Počet úspěšných spuštění kanálu.
Číslo revize RunNumberRevision Int32 Číslo přiřazené spuštění kanálu se sekvenčními spuštěními.
Počet částečně úspěšných PartiallySucceededCount Int32 Počet spuštění kanálu, která byla částečně úspěšná.
ID spuštění kanálu PipelineRunId Int32 Číslo přiřazené ke spuštění kanálu.
Datum ve frontě QueuedDate DateTime Datum a čas, kdy byl kanál zařazen do fronty ke spuštění.
Doba trvání fronty v sekundách QueueDurationSeconds Decimal Počet sekund, po který kanál zůstal ve frontě.
Číslo spuštění RunNumber Řetězec Číslo přiřazené ke spuštění kanálu při jeho spuštění.
Výsledek spuštění RunOutcome Enumerated Výsledek přiřazený ke kanálu po dokončení jeho provádění. Platné hodnoty pro PipelineRunOutcome jsou uvedené níže.
Důvod spuštění RunReason Enumerated Podmínka, která způsobila spuštění kanálu. Platné hodnoty pro PipelineRunReason jsou uvedené níže.
Doba trvání spuštění v sekundách RunDurationSeconds Decimal Počet sekund, které trvalo dokončení spuštění kanálu
Datum zahájení StartedDate DateTime Datum a čas zahájení spuštění kanálu
Počet úspěšných SucceededCount Int32 Počet úspěšných spuštění kanálu.
Total Duration Seconds TotalDurationSeconds Decimal Celkový počet sekund, po který byl kanál ve frontě a spuštěn.

Podporují se následující navigační vlastnosti.

Zobrazovaný název Název -Referenční omezení Odkazovaná vlastnost
Větev Branch BranchSK BranchSK
Dokončeno Dne CompletedOn CompletedDateSK DateSK
Zařazeno do fronty QueuedOn QueuedDateSK DateSK
Spuštěno StartedOn QueuedDateSK DateSK
Kanál Pipeline PipelineSK PipelineSK
Project Project ProjectSK ProjectSK

PipelineRunReason – členy výčtu typu

Následující členy jsou definovány pro PipelineRunReason výčtový typ, který označuje podmínky, za kterých se jednotlivé fáze kanálu, úloha nebo krok spouští, jak je popsáno v části Zadání podmínek.

Název členu Hodnota Zobrazované jméno
None 0 Žádné
Manual 1 Ruční
IndividualCI 2 Individuální CI
BatchedCI 4 Průběžná integrace v dávkách
Schedule 8 Plán
UserCreated 32 Vytvořeno uživatelem
ValidateShelveset 64 Ověřit sadu odložených od
CheckInShelveset 128 sada odložených Check In
PullRequest 256 Žádost o přijetí změn
PipelineRunCompletion 512 Dokončení sestavení

PipelineRunOutcome – členy výčtu typu

Následující členy jsou definovány pro PipelineRunOutcome výčtový typ, který označuje výsledek spuštění kanálu.

Název členu Hodnota Zobrazované jméno
None 0 Žádné
Succeed 2 Úspěch
PartiallySucceeded 4 Částečně úspěšné
Failed 6 Neúspěšný
Canceled 32 Zrušeno

PipelineRunActivityResults

Následující vlastnosti jsou platné pro sadu entit PipelineRunActivityResults a její PipelineRunActivityResultSK náhradní klíč.

Mnoho vlastností je založených na datech nebo na uživatelích. Tyto vlastnosti jsou přidružené k sadám entit CalendarDate a User , které jsou popsané v tématu Odkaz na metadata kalendáře, projekt a uživatel.

Zobrazovaný název Název Datový typ Popis
Počet opuštěných AbandonedCount Int32 Počet spuštění kanálu, která byla označena jako opuštěná.
Datum dokončení aktivity ActivityCompletedDate DateTime Datum a čas, kdy se spuštění kanálu dokončí.
Doba trvání aktivity v sekundách ActivityDurationSeconds Decimal Celkový počet sekund, po který byl kanál ve frontě a spuštěn.
Datum zahájení aktivity ActivityStartedDate DateTime Datum a čas spuštění kanálu.
Počet zrušených CanceledCount Int32 Počet zrušených spuštění kanálu.
Počet neúspěšných FailedCount Int32 Počet spuštění kanálu, která selhala.
Typ aktivity kanálu ActivityType Enumerated Typ aktivity kanálu. Platné hodnoty jsou uvedené níže pro PipelineActivityType.
ID spuštění kanálu PipelineRunId Int32 Číslo přiřazené ke spuštění kanálu při jeho spuštění.
Výsledek spuštění kanálu PipelineRunOutcome Enumerated Výsledek přiřazený kanálu po dokončení jeho provádění. Platné hodnoty jsou uvedené v části PipelineRunOutcome.
Relativní čas zahájení z úlohy v sekundách RelativeStartTimeFromJobSeconds Int32 Počet sekund, které uplynuly od začátku úlohy.
Relativní čas zahájení od fáze v sekundách RelativeStartTimeFromStageSeconds Int32 Počet sekund, které uplynuly od začátku fáze.
Relativní čas spuštění od sekund spuštění RelativeStartTimeFromRunSeconds Int32 Počet sekund, které uplynuly od spuštění.
Počet vynechaných položek SkippedCount Int32 Počet přeskočených spuštění kanálu
Počet úspěšných SucceededCount Int32 Počet úspěšných spuštění kanálu
Počet úspěšných problémů SucceededWithIssuesCount Int32 Počet spuštění kanálu, která byla částečně úspěšná.
Zobrazovaný název úkolu TaskDisplayName Řetězec Název úlohy spuštěné při spuštění kanálu
Cesta k protokolu úloh TaskLogPath Řetězec Cesta k souboru protokolu vygenerovanému úlohou.
Výsledek úkolu TaskOutcome Vlastní Výsledek úlohy, která byla provedena.

Ukázkové sestavy, které se dotazuje na typ entity PipelineRunActivityResult , najdete v ukázkové sestavě trendu doby trvání úlohy kanálu.

Vlastnosti navigace zahrnují vlastnosti uvedené v následující tabulce.

Zobrazovaný název Název Referenční omezení Odkazovaná vlastnost
Aktivita začala dne ActivityStartedOn ActivityStartedDateSK DateSK
Větev Branch BranchSK BranchSK
Kanál Pipeline PipelineSK PipelineSK
Úloha kanálu PipelineTask PipelineTaskSK PipelineTaskSK
Úloha kanálu PipelineJob PipelineJobSK PipelineJobSK
Spuštění kanálu ve frontě PipelineRunQueuedOn PipelineRunQueuedDateSK DateSK
Spuštění kanálu bylo spuštěno dne PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Spuštění kanálu se dokončilo dne PipelineRunCompletedOn PipelineRunCompletedDateSK DateSK
Spuštění kanálu bylo spuštěno dne PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Project Project ProjectSK ProjectSK

PipelineActivityType – členové výčtu typů

Pro výčtový typ jsou definovány PipelineActivityType následující členy.

Název členu Hodnota Zobrazované jméno
Task 0 Úkol
Approval 1 Schválení
AgentWait 2 Čekání agenta

PipelineTasks

Následující vlastnosti jsou platné pro sadu entit PipelineTasks a její náhradní klíč PipelineTaskSK.

Zobrazovaný název Název Datový typ Popis
ID definice úkolu TaskDefinitionId Identifikátor GUID Identifikátor GUID přiřazený k úkolu kanálu.
Verze definice úlohy TaskDefinitionVersion Řetězec Verze přiřazená k úkolu kanálu.

Mezi navigační vlastnosti patří Project a jeho referenční omezení ProjectSK.

TaskAgentPoolSizeSnapshots

Následující vlastnosti jsou platné pro sadu entit TaskAgentPoolSizeSnapshots a její náhradní klíč SamplingDate.

Zobrazovaný název Název vlastnosti Datový typ Popis
Online počet OnlineCount Int32 Počet agentů online ve fondu agentů, kdy byla úloha spuštěna.
Offline počet OfflineCount Int32 Počet agentů offline ve fondu agentů, kdy byla úloha spuštěna.
ID fondu PoolId Int32 Číslo přiřazené fondu agentů.
Ukázkové datum SamplingDate DateTime Datum a čas, kdy byla velikost fondu přichycená.

Ukázkovou sestavu sestavenou z entity TaskAgentPoolSizeSnapshot najdete v historickém grafu pro fondy agentů (Preview).

TaskAgentRequestSnapshots

Fondy agentů se přidělují při spuštění úlohy. Sada entit TaskAgentRequestSnapshots zaznamenává data související s požadavky agenta úloh.

Následující vlastnosti jsou platné pro typ entity TaskAgentRequestSnapshot a její náhradní klíče SamplingTime a SamplingDateSK.

Zobrazovaný název Název Datový typ Popis
Sestavení ve frontě IsQueued Logická hodnota Označuje, jestli je sestavení ve frontě (True) nebo není ve frontě (Nepravda).
Probíhající sestavování IsRunning Logická hodnota Označuje, jestli je sestavení spuštěné (Pravda) nebo neběží (False).
Hostované nebo místní IsHosted Logická hodnota Označuje, jestli je agent přiřazený k úloze hostovaný (True) nebo v místním prostředí (False).
Datum ukončení úlohy FinishedDate DateTime Datum a čas, kdy se žádost agenta úloh dokončila.
FinishedDateSK Int32 Datum dokončení spuštění požadavku agenta úloh vyjádřené YYYYMMDD v časovém pásmu definovaném pro organizaci.
Datum ve frontě QueuedDate DateTime Datum a čas, kdy byl požadavek agenta úloh zařazen do fronty.
QueuedDateSK Int32 Datum, kdy byl požadavek agenta úloh zařazen do fronty, vyjádřený jako YYYYMMDD v časovém pásmu definovaném pro organizaci.
Doba trvání fronty v sekundách QueueDurationSeconds Decimal Počet sekund, po které požadavek agenta úloh zůstal ve frontě před přiřazením agenta.
ID fondu PoolId Int32 Číslo přiřazené fondu agentů přiřazené k požadavku agenta úloh.
Typ kanálu PipelineType Řetězec Typ kanálu obsahující požadavek agenta úloh.
ID požadavku RequestId Int64 Číslo přiřazené k požadavku agenta úloh.
Ukázková hodina SamplingHour Int32 Číslo přiřazené hodině, kdy byla žádost přijata.
Čas ukázky SamplingTime DateTime Datum a čas přijetí požadavku agenta úlohy.
Datum zahájení StartedDate DateTime Datum a čas, kdy byl požadavek agenta úloh spuštěn.
StartedDateSK Int32 Datum spuštění požadavku agenta úloh vyjádřené YYYYMMDD v časovém pásmu definovaném pro organizaci.

Vlastnosti navigace zahrnují vlastnosti uvedené v následující tabulce.

Zobrazovaný název Název Referenční omezení -Odkazovaná vlastnost
Větev Branch BranchSK BranchSK
Dokončeno dne CompletedOn CompletedDateSK DateSK
Čas ukončení úlohy FinishedOn FinishedDateSK DateSK
Zapnuto ve frontě QueuedOn QueuedDateSK DateSK
Kanál Pipeline PipelineSK PipelineSK
Project Project ProjectSK ProjectSK
Spuštěno dne StartedOn QueuedDateSK DateSK