Dokumentacja metadanych dla usługi Azure Pipelines Analytics

  • Artykuł

Azure DevOps Services | Azure DevOps Server 2022 r. — Azure DevOps Server 2019 r.

Usługa Analytics zbiera potok i działanie testowe generowane za pośrednictwem usługi Azure Pipelines. W tym artykule opisano właściwości, których można użyć do generowania raportu analizy dla potoków. Kombinacja właściwości służy do filtrowania zapytania, agregowania danych lub tworzenia raportu.

Uwaga

Podano opisy jednostek, właściwości i wyliczonych typów obsługiwanych przez model danych analizy. Jest to wczesna wersja robocza. Prześlij opinię na temat obszarów, w których chcesz uzyskać więcej informacji. Aby wysłać zapytanie do modelu danych, zobacz Konstruowanie zapytań OData na potrzeby analizy.

Zestawy jednostek i typy jednostek

Poniższa tabela zawiera podsumowanie typów jednostek i zestawów jednostek, które obsługują usługę Azure Pipelines. Wszystkie typy jednostek/zestawy jednostek są dostępne w wersji zapoznawczej Analytics w wersji 4.0 . Usługa Analytics w wersji 3.0-preview nie obsługuje migawek.

Entityset Typ obiektu Opis
Gałęzie Gałąź Podstawowe informacje o gałęziach używanych w testach lub potokach. Aby uzyskać przykładowy raport, zobacz Przykładowy raport o stanie postępu.
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (Złożony) Obsługuje zrozumienie użycia potoku równoległego. Aby dowiedzieć się więcej na temat równoległych testów potoków, zobacz Uruchamianie testów równolegle przy użyciu zadania testowego programu Visual Studio.
Pipelines Potok Właściwości potoku.
PotokiJobs PotokJob Pojedyncze wyniki wykonywania dla określonego testu skojarzonego z testemRun
PotokiRuns PipelineRun Informacje o wykonywaniu potoków. Aby uzyskać przykładowy raport, zobacz Przykładowy raport trendu szybkości przekazywania potoku.
PipelineRunActivityResults PipelineRunActivityResult Scalony dziennik wszystkich etapów, kroków, zadań i zadań w ramach określonego wykonania potoku. Aby uzyskać przykładowy raport, zobacz Przykładowy raport czasu trwania zadania potoku.
PipelineTasks PipelineTask Właściwości zadań używanych w potoku.
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (Złożony) Obsługuje zrozumienie rozmiaru puli, zadań potoku i współbieżności. Wykres historyczny dla pul agentów ilustruje sposób użycia tego zestawu jednostek.
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (Złożony) Obsługuje raportowanie żądań agenta zadań.

Gałęzie

Następujące właściwości są prawidłowe dla zestawu jednostek Gałęzie . Klucze zastępcze skojarzone z gałęzią obejmują BranchSK i ProjectSK.

Nazwa wyświetlana Nazwa Typ danych Opis
AnalyticsUpdatedDate DateTime Znak wodny wskazujący czas ostatniej aktualizacji danych analizy.
Nazwa gałęzi BranchName Ciąg Nazwa przypisana do gałęzi po jej utworzeniu.
Identyfikator repozytorium RepositoryId Ciąg Numer przypisany do repozytorium po jego utworzeniu.
Identyfikator vsts repozytorium RepositoryVstsId Ciąg Numer przypisany do repozytorium TFVC po jego utworzeniu.
RepositoryUrl RepositoryUrl Ciąg Adres URL zdefiniowany dla repozytorium podczas jego tworzenia.

Właściwości nawigacji obejmują Project i jego ograniczenie ProjectSKodwołań.

ParallelPipelineJobsSnapshot

Następujące właściwości są prawidłowe dla zestawu jednostek ParallelPipelineJobsSnapshot . Klucze referencyjne obejmują:

  • IsHosted
  • ParallelismTag
  • SamplingDate
Nazwa wyświetlana Nazwa Typ danych Opis
Hostowane lub self-hosted IsHosted Wartość logiczna Wskazuje, czy potok równoległy jest uruchamiany na agencie hostowanym przez firmę Microsoft (True) lub jest hostowany samodzielnie (Fałsz). Aby dowiedzieć się więcej, zobacz Agenci usługi Azure Pipelines.
Nie można nawiązać połączenia ze wszystkimi dostawcami FailedToReachAllProviders Wartość logiczna Wskazuje, czy przebieg zadania osiągnął wszystkie dostawcy (Prawda) lub nie (Fałsz).
Liczba zadań potoków równoległych TotalCount Int32 Liczba zadań uruchamianych w ramach migawki.
Liczba minut potoków równoległych TotalMinutes Int32 Liczba minut potrzebnych do uruchomienia migawki.
Typ równoległości ParallelismTag Ciąg Tag wskazujący typ równoległości skojarzony z migawką zadania.
Typ Premium IsPremium Wartość logiczna Wskazuje, czy potok równoległy ma wartość Premium (Prawda) lub nie (Fałsz).
Data próbki SamplingDate DateTime Data skojarzona z migawką.

Pipelines

Następujące właściwości są prawidłowe dla potoków i jego klucza PipelineSKzastępczego .

Nazwa wyświetlana Nazwa Typ danych Opis
Identyfikator potoku PipelineId Int32 Identyfikator przypisany do potoku.
Nazwa potoku PipelineName Ciąg Nazwa przypisana do potoku.
Wersja potoku PipelineVersion Int32 Wersja skojarzona z potokiem.
Typ procesu potoku PipelineProcessType Enumerated Typ definicji potoku. Prawidłowe wartości są wymienione poniżej dla parametru PipelineProcessType.

Właściwości nawigacji obejmują Project i jego ograniczenie ProjectSKodwołań.

PipelineProcessType, wyliczone elementy członkowskie typu

Następujące elementy członkowskie są definiowane dla wyliczonego PipelineProcessType typu, który wskazuje metodę używaną do definiowania potoku.

Nazwa elementu członkowskiego Wartość Definicja
Designer 1 Klasyczna definicja potoku.
Yaml 2 Definicja potoku YAML.
Docker 3 Definicja potoku platformy Docker.

PotokiJobs

Zadanie potoku to seria kroków uruchamianych sekwencyjnie jako jednostka. Zadanie to najmniejsza jednostka pracy, którą można zaplanować do uruchomienia. Potoki są zorganizowane wokół zadań, a każdy potok ma co najmniej jedno zadanie. Aby dowiedzieć się więcej, zobacz Określanie zadań w potoku.

Następujące właściwości są prawidłowe dla zadań PipelineJobs i jego PipelineJobSK klucza zastępczego.

Nazwa wyświetlana Nazwa Typ danych Opis
Pełna nazwa zadania potoku FullJobName Ciąg Pełna nazwa zadania potoku.
Identyfikator potoku PipelineId Int32 Identyfikator przypisany do potoku, w którym zdefiniowano zadanie.
Identyfikator zadania potoku JobId Ciąg Identyfikator zadania przypisany do zadania potoku po jego utworzeniu.
Nazwa zadania potoku JobName Ciąg Nazwa przypisana do zadania potoku.
Nazwa etapu potoku StageName Ciąg Nazwa etapu skojarzona z zadaniem potoku.
Atrybuty strategii zadania potoku StrategyAttributes Ciąg Atrybuty zdefiniowane dla zadania potoku.
Identyfikator etapu StageId Ciąg Identyfikator etapu skojarzony z zadaniem potoku.

Właściwości nawigacji obejmują Project i jego ograniczenie ProjectSKodwołań.

Aby uzyskać przykładowy raport, który wysyła zapytanie do typu jednostki PipelineJob , zobacz Przykładowy raport dotyczący błędów etapu potoku.

PotokiRuns

Uruchomienie potoku reprezentuje pojedyncze wykonanie potoku. Podczas uruchamiania potok jest przetwarzany, a agenci przetwarzają co najmniej jedno zadania. Uruchomienie potoku obejmuje zadania, kroki i zadania. Aby dowiedzieć się więcej, zobacz Sekwencja uruchamiania potoku.

Następujące właściwości są prawidłowe dla typu jednostki PipelineRun i jego PipelineRunSK klucza zastępczego.

Nazwa wyświetlana Nazwa Typ danych Opis
Liczba anulowanych CanceledCount Int32 Liczba anulowanych przebiegów potoku.
Data ukończenia CompletedDate DateTime Data i godzina zakończenia wykonywania potoku.
Liczba niepowiódłanych FailedCount Int32 Liczba przebiegów potoku, które zakończyły się pomyślnie.
Poprawka liczbowa RunNumberRevision Int32 Numer przypisany do uruchomienia potoku z sekwencyjnymi wykonaniami.
Częściowo powiodła się liczba PartiallySucceededCount Int32 Liczba przebiegów potoku, które częściowo zakończyły się pomyślnie.
Identyfikator uruchomienia potoku PipelineRunId Int32 Numer przypisany do uruchomienia potoku.
Data w kolejce QueuedDate DateTime Data i godzina uruchomienia potoku.
Czas trwania kolejki w sekundach QueueDurationSeconds Liczba dziesiętna Liczba sekund, przez które potok pozostał w kolejce.
Numer uruchomienia RunNumber Ciąg Numer przypisany do uruchomienia potoku po jego wykonaniu.
Wynik przebiegu RunOutcome Enumerated Wynik przypisany do potoku po zakończeniu wykonywania. Prawidłowe wartości są wymienione poniżej dla parametru PipelineRunOutcome.
Przyczyna uruchomienia RunReason Enumerated Warunek, który spowodował uruchomienie potoku. Prawidłowe wartości są wymienione poniżej dla parametru PipelineRunReason.
Czas trwania przebiegu w sekundach RunDurationSeconds Liczba dziesiętna Liczba sekund potrzebnych do ukończenia przebiegu potoku.
Data rozpoczęcia StartedDate DateTime Data i godzina rozpoczęcia przebiegu potoku.
Liczba zakończonych powodzeniem SucceededCount Int32 Liczba przebiegów potoku, które zakończyły się pomyślnie.
Łączny czas trwania sekund TotalDurationSeconds Liczba dziesiętna Całkowita liczba sekund, w których potok znajdował się w kolejce i został uruchomiony.

Obsługiwane są następujące właściwości nawigacji.

Nazwa wyświetlana Nazwa -Ograniczenie odwołań Przywoływna właściwość
Gałąź Branch BranchSK BranchSK
Ukończono CompletedOn CompletedDateSK DateSK
W kolejce QueuedOn QueuedDateSK DateSK
Rozpoczęto StartedOn QueuedDateSK DateSK
Potok Pipeline PipelineSK PipelineSK
Project Project ProjectSK ProjectSK

PipelineRunReason, wyliczone elementy członkowskie typu

Następujące elementy członkowskie są definiowane dla wyliczonego PipelineRunReason typu, który wskazuje warunki, w których każdy etap potoku, zadanie lub krok jest uruchamiany zgodnie z opisem w temacie Określanie warunków.

Nazwa elementu członkowskiego Wartość Nazwa wyświetlana
None 0 Brak
Manual 1 Ręcznie
IndividualCI 2 Indywidualna ciągła integracja
BatchedCI 4 Wsadowa ciągła integracja
Schedule 8 Zaplanuj
UserCreated 32 Utworzony użytkownik
ValidateShelveset 64 Weryfikowanie zestawu półek
CheckInShelveset 128 zestaw półek Synchronizacja
PullRequest 256 Żądanie ściągnięcia
PipelineRunCompletion 512 Uzupełnianie kompilacji

PipelineRunOutcome wyliczone elementy członkowskie typu

Następujące elementy członkowskie są definiowane dla wyliczonego PipelineRunOutcome typu, który wskazuje wynik uruchomienia potoku.

Nazwa elementu członkowskiego Wartość Nazwa wyświetlana
None 0 Brak
Succeed 2 Powodzenie
PartiallySucceeded 4 Częściowo powiodło się
Failed 6 Niepowodzenie
Canceled 32 Anulowane

PipelineRunActivityResults

Następujące właściwości są prawidłowe dla zestawu jednostek PipelineRunActivityResults i jego PipelineRunActivityResultSK klucza zastępczego.

Wiele właściwości jest opartych na dacie lub na podstawie użytkownika. Te właściwości są skojarzone z zestawami jednostek CalendarDate i User opisanymi w temacie Data kalendarza, Projekt i Dokumentacja metadanych użytkownika.

Nazwa wyświetlana Nazwa Typ danych Opis
Porzucona liczba AbandonedCount Int32 Liczba przebiegów potoków oznaczonych jako porzucone.
Data ukończenia działania ActivityCompletedDate DateTime Data i godzina zakończenia wykonywania potoku.
Czas trwania działania w sekundach ActivityDurationSeconds Liczba dziesiętna Całkowita liczba sekund, w których potok znajdował się w kolejce i został uruchomiony.
Data rozpoczęcia działania ActivityStartedDate DateTime Data rozpoczęcia uruchomienia potoku.
Liczba anulowanych CanceledCount Int32 Liczba anulowanych przebiegów potoku.
Liczba niepowiódłanych FailedCount Int32 Liczba przebiegów potoku, które zakończyły się niepowodzeniem.
Typ działania potoku ActivityType Enumerated Typ działania potoku. Prawidłowe wartości są wymienione poniżej dla parametru PipelineActivityType.
Identyfikator uruchomienia potoku PipelineRunId Int32 Liczba przypisana do uruchomienia potoku po jego wykonaniu.
Wynik uruchomienia potoku PipelineRunOutcome Enumerated Wynik przypisany do potoku po zakończeniu jego wykonywania. Prawidłowe wartości są wyświetlane w obszarze PipelineRunOutcome.
Względny czas rozpoczęcia od sekund zadania RelativeStartTimeFromJobSeconds Int32 Liczba sekund, które upłynęły od początku zadania.
Względny czas rozpoczęcia od sekund etapu RelativeStartTimeFromStageSeconds Int32 Liczba sekund, które upłynęły od początku etapu.
Względny czas rozpoczęcia od sekund uruchomienia RelativeStartTimeFromRunSeconds Int32 Liczba sekund, które upłynęły od momentu wykonania przebiegu.
Pominięto liczbę SkippedCount Int32 Liczba pominiętych przebiegów potoków.
Liczba zakończonych powodzeniem SucceededCount Int32 Liczba przebiegów potoku, które zakończyły się pomyślnie.
Liczba problemów zakończonych powodzeniem SucceededWithIssuesCount Int32 Liczba przebiegów potoków, które częściowo zakończyły się powodzeniem.
Nazwa wyświetlana zadania TaskDisplayName Ciąg Nazwa zadania wykonanego w przebiegu potoku.
Ścieżka dziennika zadań TaskLogPath Ciąg Ścieżka pliku dziennika wygenerowanego przez zadanie.
Wynik zadania TaskOutcome Niestandardowy Wynik wykonanego zadania.

Przykładowe raporty, które wysyłają zapytania dotyczące typu jednostki PipelineRunActivityResult , zobacz Przykładowy raport trendu czasu trwania zadania potoku.

Właściwości nawigacji obejmują te wymienione w poniższej tabeli.

Nazwa wyświetlana Nazwa Ograniczenie odwołań Przywoływna właściwość
Działanie rozpoczęte w dniu ActivityStartedOn ActivityStartedDateSK DateSK
Gałąź Branch BranchSK BranchSK
Potok Pipeline PipelineSK PipelineSK
Zadanie potoku PipelineTask PipelineTaskSK PipelineTaskSK
Zadanie potoku PipelineJob PipelineJobSK PipelineJobSK
Uruchomione potoki w kolejce PipelineRunQueuedOn PipelineRunQueuedDateSK DateSK
Rozpoczęto uruchamianie potoku PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Ukończono przebieg potoku PipelineRunCompletedOn PipelineRunCompletedDateSK DateSK
Rozpoczęto uruchamianie potoku PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Project Project ProjectSK ProjectSK

Wyliczone składowe typu PipelineActivityType

Następujące elementy członkowskie są definiowane dla typu wyliczonego PipelineActivityType .

Nazwa elementu członkowskiego Wartość Nazwa wyświetlana
Task 0 Zadanie
Approval 1 Zatwierdzenie
AgentWait 2 Oczekiwanie agenta

Zadania potoku

Następujące właściwości są prawidłowe dla zestawu jednostek PipelineTasks i jego klucza PipelineTaskSKzastępczego .

Nazwa wyświetlana Nazwa Typ danych Opis
Identyfikator definicji zadania TaskDefinitionId GUID Identyfikator GUID przypisany do zadania potoku.
Wersja definicji zadania TaskDefinitionVersion Ciąg Wersja przypisana do zadania potoku.

Właściwości nawigacji obejmują Project i jej ograniczenie ProjectSKodwołań.

TaskAgentPoolSizeSnapshots

Następujące właściwości są prawidłowe dla zestawu jednostek TaskAgentPoolSizeSnapshots i jego klucza SamplingDatezastępczego .

Nazwa wyświetlana Nazwa właściwości Typ danych Opis
Liczba online OnlineCount Int32 Liczba agentów w trybie online w puli agentów podczas uruchamiania zadania.
Liczba offline OfflineCount Int32 Liczba agentów w trybie offline w puli agentów podczas uruchamiania zadania.
Identyfikator puli PoolId Int32 Liczba przypisana do puli agentów.
Data próbki SamplingDate DateTime Data i godzina przyciągnięcia rozmiaru puli.

Aby uzyskać przykładowy raport utworzony w jednostce TaskAgentPoolSizeSnapshot , zobacz Historyczny graf dla pul agentów (wersja zapoznawcza).

TaskAgentRequestSnapshots

Pule agentów są przydzielane po wykonaniu zadania. Zestaw jednostek TaskAgentRequestSnapshots przechwytuje dane związane z żądaniami agenta zadań.

Następujące właściwości są prawidłowe dla typu jednostki TaskAgentRequestSnapshot i jego kluczy SamplingTime zastępczych i SamplingDateSK.

Nazwa wyświetlana Nazwa Typ danych Opis
Kompilacja w kolejce IsQueued Wartość logiczna Wskazuje, czy kompilacja jest w kolejce (prawda) lub nie jest w kolejce (Fałsz).
Uruchomiona kompilacja IsRunning Wartość logiczna Wskazuje, czy kompilacja jest uruchomiona (prawda) lub nie jest uruchomiona (Fałsz).
Hostowane lub self-hosted IsHosted Wartość logiczna Wskazuje, czy agent przypisany do zadania jest hostowany (prawda) lub self-hosted (Fałsz).
Data zakończenia zadania FinishedDate DateTime Data i godzina zakończenia działania żądania agenta zadania.
FinishedDateSK Int32 Data zakończenia działania żądania agenta zadania wyrażona w YYYYMMDD strefie czasowej zdefiniowanej dla organizacji.
Data w kolejce QueuedDate DateTime Data-godzina, kiedy żądanie agenta zadania zostało w kolejce.
QueuedDateSK Int32 Data kolejkowania żądania agenta zadania wyrażona w YYYYMMDD strefie czasowej zdefiniowanej dla organizacji.
Czas trwania kolejki w sekundach QueueDurationSeconds Liczba dziesiętna Liczba sekund, przez które żądanie agenta zadań pozostawało w kolejce przed przypisaniem agenta.
Identyfikator puli PoolId Int32 Numer przypisany do puli agentów przypisany do żądania agenta zadania.
Typ potoku PipelineType Ciąg Typ potoku zawierający żądanie agenta zadania.
Identyfikator żądania RequestId Int64 Numer przypisany do żądania agenta zadania.
Przykładowa godzina SamplingHour Int32 Liczba przypisana do godziny odebrania żądania.
Czas próbki SamplingTime DateTime Data i godzina odebrania żądania agenta zadania.
Data rozpoczęcia StartedDate DateTime Data i godzina wykonania żądania agenta zadania.
StartedDateSK Int32 Data rozpoczęcia wykonywania żądania agenta zadania wyrażona w YYYYMMDD strefie czasowej zdefiniowanej dla organizacji.

Właściwości nawigacji zawierają te wymienione w poniższej tabeli.

Nazwa wyświetlana Nazwa Ograniczenie odwołań -Referenced, właściwość
Gałąź Branch BranchSK BranchSK
Ukończono CompletedOn CompletedDateSK DateSK
Godzina zakończenia zadania FinishedOn FinishedDateSK DateSK
W kolejce QueuedOn QueuedDateSK DateSK
Potok Pipeline PipelineSK PipelineSK
Project Project ProjectSK ProjectSK
Rozpoczęto StartedOn QueuedDateSK DateSK