Azure Pipelines 分析的中繼資料參考

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

分析服務會收集透過 Azure Pipelines 產生的管線和測試活動。 本文說明可用來產生管線分析報表的屬性。 您可以使用屬性的組合來篩選查詢、匯總資料或建置報表。

注意

提供分析資料模型所支援的實體、屬性和列舉型別的描述。 這是早期草稿。 請提供您想要取得詳細資訊之區域的意見反應。 若要查詢資料模型,請參閱 建構分析的 OData 查詢

實體集和實體類型

下表摘要說明支援 Azure Pipelines 的實體類型和實體集。 所有實體類型/實體集都可搭配 Analytics v4.0 預覽 版本使用。 分析 v3.0-preview 版不支援快照集。

EntitySet EntityType 描述
分支 分支 測試或管線中使用的分支基本資訊。 如需範例報表,請參閱 進度狀態範例報告
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (複合) 支援瞭解平行管線耗用量。 若要深入瞭解平行管線測試,請參閱 使用 Visual Studio 測試工作平行執行測試
Pipelines 管線 管線的屬性。
PipelineJobs PipelineJob 與 TestRun 相關聯的特定測試個別執行結果
PipelineRuns PipelineRun 管線的執行資訊。 如需範例報表,請參閱 管線通過率趨勢範例報告
PipelineRunActivityResults PipelineRunActivityResult 特定管線執行內所有階段、步驟、作業和工作的合併記錄。 如需範例報表,請參閱 管線工作持續時間範例報表
PipelineTasks PipelineTask 管線內使用之工作的屬性。
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (複合式) 支援瞭解集區大小、管線作業和並行。 代理程式組件區的歷程圖表說明如何使用此實體集。
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (複合式) 支援報告工作代理程式要求。

分支

下列屬性適用于 Branch 實體集。 與 Branch include BranchSKProjectSK 相關聯的 Surrogate 索引鍵。

顯示名稱 名稱 Data type 說明
AnalyticsUpdatedDate Datetime 浮水印,指出上次更新分析資料的時間。
分支名稱 BranchName String 建立分支時指派給分支的名稱。
存放庫識別碼 RepositoryId String 建立存放庫時指派給存放庫的數位。
存放庫 Vsts 識別碼 RepositoryVstsId String 建立 TFVC 存放庫時指派給 TFVC 存放庫的數位。
RepositoryUrl RepositoryUrl String 建立存放庫時所定義的 URL。

導覽屬性包含 Project 及其引用條件約束 ProjectSK

ParallelPipelineJobsSnapshot

下列屬性適用于 ParallelPipelineJobsSnapshot 實體集。 參考索引鍵包括:

  • IsHosted
  • ParallelismTag
  • SamplingDate
顯示名稱 名稱 Data type 說明
裝載或自我裝載 IsHosted Boolean 指出平行管線是否在 Microsoft 裝載的代理程式上執行, (True) 或自我裝載 (False) 。 若要深入瞭解,請參閱 Azure Pipelines 代理程式
無法連線到所有提供者 FailedToReachAllProviders Boolean 指出作業執行是否已達到 True) 或未 (False) 的所有 (提供者。
平行管線作業數目 TotalCount Int32 作業數目會以快照集的一部分執行。
平行管線分鐘數 TotalMinutes Int32 執行快照集所花費的分鐘數。
平行處理原則類型 ParallelismTag String 標記,表示與作業快照集相關聯的平行處理原則類型。
進階類型 IsPremium Boolean 指出平行管線是否為進階 (True) 或未 (False) 。
範例日期 SamplingDate Datetime 與快照集相關聯的日期。

Pipelines

下列屬性適用于 Pipelines 及其 Surrogate 索引鍵 PipelineSK

顯示名稱 名稱 Data type 說明
管線識別碼 PipelineId Int32 指派給管線的識別碼。
管線名稱 PipelineName String 指派給管線的名稱。
管線版本 PipelineVersion Int32 與管線相關聯的版本。
管線進程類型 PipelineProcessType Enumerated 管線定義的類型。 PipelineProcessType的有效值如下所列。

導覽屬性包含 Project 及其引用條件約束 ProjectSK

PipelineProcessType 列舉型別成員

下列成員是針對 PipelineProcessType 列舉型別所定義,指出用來定義管線的方法。

成員名稱 定義
Designer 1 傳統管線定義。
Yaml 2 YAML 管線定義。
Docker 3 Docker 管線定義。

PipelineJobs

管線作業是一系列以單位循序執行的步驟。 作業是您可以排程執行的最小工作單位。 管線會依作業組織,而且每個管線至少有一個作業。 若要深入瞭解,請參閱 在管線中指定作業

下列屬性適用于 PipelineJobs 及其 PipelineJobSK Surrogate 索引鍵。

顯示名稱 名稱 Data type 說明
管線完整作業名稱 FullJobName String 管線作業的完整名稱。
管線識別碼 PipelineId Int32 指派給定義作業之管線的識別碼。
管線作業識別碼 JobId String 建立管線作業時指派給管線作業的作業識別碼。
管線作業名稱 JobName String 指派給管線作業的名稱。
管線階段名稱 StageName String 與管線作業相關聯的階段名稱。
管線作業策略屬性 StrategyAttributes String 為管線作業定義的屬性。
階段識別碼 StageId String 與管線作業相關聯的階段識別碼。

導覽屬性包含 Project 及其引用條件約束 ProjectSK

如需查詢 PipelineJob 實體類型的範例報表,請參閱 管線階段失敗範例報表

PipelineRuns

管線執行代表管線的單一執行。 在執行期間,會處理管線,代理程式會處理一或多個作業。 管線執行包括作業、步驟和工作。 若要深入瞭解,請參閱 管線執行順序

下列屬性適用于 PipelineRun 實體類型和其 PipelineRunSK Surrogate 索引鍵。

顯示名稱 名稱 Data type 說明
已取消計數 CanceledCount Int32 已取消的管線執行計數。
完成日期 CompletedDate Datetime 管線完成執行的日期和時間。
失敗計數 FailedCount Int32 成功執行的管線計數。
編號修訂 RunNumberRevision Int32 指派給具有循序執行的管線執行數目。
部分成功計數 PartiallySucceededCount Int32 部分成功的管線執行計數。
管線執行識別碼 PipelineRunId Int32 指派給管線執行的數位。
佇列日期 QueuedDate Datetime 管線排入佇列以執行時的日期和時間。
佇列持續時間秒數 QueueDurationSeconds Decimal 管線保留在佇列中的秒數。
執行編號 RunNumber String 執行管線時指派給管線執行的數位。
執行結果 RunOutcome Enumerated 完成執行時指派給管線的結果。 管線RunOutcome的有效值如下。
執行原因 RunReason Enumerated 導致管線執行的條件。 PipelineRunReason的有效值如下。
執行持續時間秒數 RunDurationSeconds Decimal 管線執行完成所花費的秒數。
開始日期 StartedDate Datetime 管線執行的開始日期和時間。
成功計數 SucceededCount Int32 成功執行的管線計數。
持續時間總計秒數 TotalDurationSeconds Decimal 管線在佇列中並執行的總秒數。

支援下列導覽屬性。

顯示名稱 名稱 -引用條件約束 參考的屬性
分支 Branch BranchSK BranchSK
已完成日期 CompletedOn CompletedDateSK DateSK
已排入佇列開啟 QueuedOn QueuedDateSK DateSK
開始時間 StartedOn QueuedDateSK DateSK
管線 Pipeline PipelineSK PipelineSK
Project Project ProjectSK ProjectSK

PipelineRunReason 列舉型別成員

下列成員是針對 PipelineRunReason 列舉型別所定義,指出每個管線階段、作業或步驟執行的條件,如 指定條件中所述。

成員名稱 顯示名稱
None 0
Manual 1 手動
IndividualCI 2 個別 CI
BatchedCI 4 批次 CI
Schedule 8 排程
UserCreated 32 使用者已建立
ValidateShelveset 64 驗證擱置集
CheckInShelveset 128 簽到擱置集
PullRequest 256 提取要求
PipelineRunCompletion 512 建置完成

PipelineRunOutcome 列舉型別成員

下列成員是針對 PipelineRunOutcome 列舉型別所定義,指出管線執行的結果。

成員名稱 顯示名稱
None 0
Succeed 2 成功
PartiallySucceeded 4 已部分成功
Failed 6 Failed
Canceled 32 已取消

PipelineRunActivityResults

下列屬性適用于 PipelineRunActivityResults 實體集及其 PipelineRunActivityResultSK Surrogate 索引鍵。

許多屬性都是以日期為基礎或以使用者為基礎。 這些屬性會與 CalendarDateUser 實體集相關聯 ,如行事曆日期、專案和使用者中繼資料參考中所述。

顯示名稱 名稱 Data type 說明
放棄計數 AbandonedCount Int32 標示為已放棄的管線執行計數。
活動完成日期 ActivityCompletedDate Datetime 管線執行完成執行的日期和時間。
活動持續時間秒 ActivityDurationSeconds Decimal 管線在佇列中並執行的總秒數。
活動開始日期 ActivityStartedDate Datetime 管線執行啟動時的日期時間。
已取消計數 CanceledCount Int32 已取消的管線執行計數。
失敗計數 FailedCount Int32 失敗的管線執行計數。
管線活動類型 ActivityType Enumerated 管線活動的類型。 管線ActivityType的有效值如下所列。
管線執行識別碼 PipelineRunId Int32 執行管線時指派給管線執行的數位。
管線執行結果 PipelineRunOutcome Enumerated 完成執行時指派給管線的結果。 有效值列在 PipelineRunOutcome之下。
從作業秒開始的相對開始時間 RelativeStartTimeFromJobSeconds Int32 從作業開始經過的秒數。
從階段秒的相對開始時間 RelativeStartTimeFromStageSeconds Int32 從階段開頭經過的秒數。
從執行秒的相對開始時間 RelativeStartTimeFromRunSeconds Int32 執行執行時所經過的秒數。
略過計數 SkippedCount Int32 已略過之管線執行的計數。
成功計數 SucceededCount Int32 成功執行的管線計數。
問題計數成功 SucceededWithIssuesCount Int32 部分成功的管線執行計數。
工作顯示名稱 TaskDisplayName String 在管線執行中執行的工作名稱。
工作記錄檔路徑 TaskLogPath String 工作所產生的記錄檔路徑。
工作結果 TaskOutcome Custom 執行之工作的結果。

如需查詢 PipelineRunActivityResult 實體類型的範例報表,請參閱 管線工作持續時間趨勢範例報告

導覽屬性包括下表所列的屬性。

顯示名稱 名稱 引用條件約束 Referenced 屬性
活動啟動時間 ActivityStartedOn ActivityStartedDateSK DateSK
分支 Branch BranchSK BranchSK
管線 Pipeline PipelineSK PipelineSK
管線工作 PipelineTask PipelineTaskSK PipelineTaskSK
管線作業 PipelineJob PipelineJobSK PipelineJobSK
已排入佇列的管線執行 PipelineRunQueuedOn PipelineRunQueuedDateSK DateSK
管線執行已啟動 PipelineRunStartedOn PipelineRunStartedDateSK DateSK
管線執行已完成 PipelineRunCompletedOn PipelineRunCompletedDateSK DateSK
管線執行已啟動 PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Project Project ProjectSK ProjectSK

PipelineActivityType 列舉類型成員

列舉型別定義 PipelineActivityType 下列成員。

成員名稱 顯示名稱
Task 0 Task
Approval 1 核准
AgentWait 2 代理程式等候

PipelineTasks

下列屬性適用于 PipelineTasks 實體集及其 Surrogate 索引鍵 PipelineTaskSK

顯示名稱 名稱 Data type 說明
工作定義識別碼 TaskDefinitionId GUID 指派給管線工作的 GUID。
工作定義版本 TaskDefinitionVersion String 指派給管線工作的版本。

導覽屬性包括 Project 及其引用條件約束 ProjectSK

TaskAgentPoolSizeSnapshots

下列屬性適用于 TaskAgentPoolSizeSnapshots 實體集及其 Surrogate 索引鍵 SamplingDate

顯示名稱 屬性名稱 Data type 說明
線上計數 OnlineCount Int32 執行工作時,代理程式組件區中的線上代理程式數目。
離線計數 OfflineCount Int32 執行工作時,代理程式組件區中離線的代理程式數目。
集區識別碼 PoolId Int32 指派給代理程式組件區的數位。
範例日期 SamplingDate Datetime 已貼齊集區大小的日期和時間。

如需從 TaskAgentPoolSizeSnapshot 實體建置的範例報表,請參閱 代理程式組件區的歷程圖表 (Preview)

TaskAgentRequestSnapshots

執行工作時會配置代理程式組件區。 TaskAgentRequestSnapshots實體集會擷取與工作代理程式要求相關的資料。

下列屬性適用于 TaskAgentRequestSnapshot 實體類型及其 Surrogate 索引鍵 SamplingTimeSamplingDateSK

顯示名稱 名稱 Data type 說明
組建已排入佇列 IsQueued Boolean 指出組建是否已排入佇列, (True) 或未排入佇列 (False) 。
組建執行中 IsRunning Boolean 指出組建是否執行 (True) 或未執行 (False) 。
裝載或自我裝載 IsHosted Boolean 指出指派給工作的代理程式是否裝載 (True) 或自我裝載 (False) 。
作業結束日期 FinishedDate Datetime 工作代理程式要求完成執行的日期時間。
FinishedDateSK Int32 工作代理程式要求完成執行的日期,以 YYYYMMDD 組織定義的時區表示。
已排入佇列的日期 QueuedDate Datetime 工作代理程式要求已排入佇列的日期時間。
QueuedDateSK Int32 工作代理程式要求的佇列日期,以 YYYYMMDD 組織定義的時區表示。
佇列持續時間秒數 QueueDurationSeconds Decimal 指派代理程式之前,工作代理程式要求的秒數會保留在佇列中。
集區識別碼 PoolId Int32 指派給指派給工作代理程式要求之代理程式組件區的數位。
管線類型 PipelineType String 包含工作代理程式要求的管線類型。
要求識別碼 RequestId Int64 指派給工作代理程式要求的號碼。
範例小時 SamplingHour Int32 收到要求時指派給小時的數位。
取樣時間 SamplingTime Datetime 收到工作代理程式要求的日期時間。
開始日期 StartedDate Datetime 執行工作代理程式要求的日期時間。
StartedDateSK Int32 工作代理程式要求開始執行的日期,以 YYYYMMDD 組織定義的時區表示。

導覽屬性包括下表所列的屬性。

顯示名稱 名稱 引用條件約束 -Referenced 屬性
分支 Branch BranchSK BranchSK
已完成于 CompletedOn CompletedDateSK DateSK
作業結束時間 FinishedOn FinishedDateSK DateSK
已排入佇列開啟 QueuedOn QueuedDateSK DateSK
管線 Pipeline PipelineSK PipelineSK
Project Project ProjectSK ProjectSK
已啟動 StartedOn QueuedDateSK DateSK