分享方式：

Azure Pipelines Analytics 的元數據參考

  • 文章

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

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

注意

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

實體集和實體類型

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

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

分支

下列屬性適用於 Branch 實體集。 與 Branch 相關聯的 Surrogate 索引鍵包含 BranchSK 和 ProjectSK。

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

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

ParallelPipelineJobsSnapshot

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

  • IsHosted
  • ParallelismTag
  • SamplingDate
顯示名稱 名稱 資料類型 說明
裝載或自我裝載 IsHosted 布林值 指出平行管線是在Microsoft裝載的代理程式上執行 （True） 或自我裝載的 （False）。 如需詳細資訊，請參閱 Azure Pipelines 代理程式。
無法連線到所有提供者 FailedToReachAllProviders 布林值 指出作業執行是否達到所有提供者 （True） 或不是 （False）。
平行管線作業的數目 TotalCount Int32 作業數目會以快照集的一部分執行。
平行管線分鐘數 TotalMinutes Int32 執行快照集所花費的分鐘數。
平行處理原則類型 ParallelismTag String 標記，表示與作業快照集相關聯的平行處理原則類型。
進階類型 IsPremium 布林值 指出平行管線是否為進階 （True） 或非 [False]。
範例日期 SamplingDate Datetime 與快照集相關聯的日期。

管線

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

顯示名稱 名稱 資料類型 說明
管線標識碼 PipelineId Int32 指派給管線的標識碼。
管線名稱 PipelineName String 指派給管線的名稱。
管線版本 PipelineVersion Int32 與管線相關聯的版本。
管線進程類型 PipelineProcessType 枚舉 管線定義的類型。 PipelineProcessType 的有效值如下。

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

PipelineProcessType 列舉類型成員

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

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

PipelineJobs

管線作業是一系列以單位順序執行的步驟。 作業是您可以排程執行的最小工作單位。 管線會圍繞作業進行組織，而且每個管線至少有一個作業。 如需詳細資訊，請參閱在管線中指定作業。

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

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

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

如需查詢 PipelineJob 實體類型的範例報表，請參閱 管線階段明智失敗範例報告。

PipelineRuns

管線執行代表管線的單一執行。 在執行期間，會處理管線，而代理程式會處理一或多個作業。 管線執行包括作業、步驟和工作。 如需詳細資訊，請參閱 管線執行順序。

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

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

支援下列導覽屬性。

Display name 名稱 -引用條件約束 參考屬性
分支 Branch BranchSK BranchSK
已完成於 CompletedOn CompletedDateSK DateSK
佇列開啟 QueuedOn QueuedDateSK DateSK
已啟動 StartedOn QueuedDateSK DateSK
管線 Pipeline PipelineSK PipelineSK
計畫 Project ProjectSK ProjectSK

PipelineRunReason 列舉類型成員

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

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

PipelineRunOutcome 列舉類型成員

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

成員名稱 值 Display name
None 0 無
Succeed 2 成功
PartiallySucceeded 4 部分成功
Failed 6 失敗
Canceled 32 已取消

PipelineRunActivityResults

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

許多屬性都是以日期為基礎或以用戶為基礎。 這些屬性會與 CalendarDate 和 User 實體集相關聯，如行事曆日期、專案和使用者元數據參考中所述。

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

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

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

顯示名稱 名稱 引用條件約束 參考屬性
活動已啟動 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 ProjectSK ProjectSK

PipelineActivityType 列舉類型成員

下列成員是針對 PipelineActivityType 列舉型別所定義。

成員名稱 值 Display name
Task 0 Task
Approval 1 Approval
AgentWait 2 代理程式等候

PipelineTasks

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

顯示名稱 名稱 資料類型 說明
工作定義標識碼 TaskDefinitionId GUID 指派給管線工作的 GUID。
工作定義版本 TaskDefinitionVersion String 指派給管線工作的版本。

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

TaskAgentPoolSizeSnapshots

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

顯示名稱 屬性名稱 資料類型 說明
在線計數 OnlineCount Int32 執行工作時，代理程式集區中在線的代理程式數目。
離線計數 OfflineCount Int32 執行工作時，代理程式集區中離線的代理程式數目。
集區標識碼 PoolId Int32 指派給代理程式集區的數位。
範例日期 SamplingDate Datetime 已擷取集區大小的日期和時間。

如需從 TaskAgentPoolSizeSnapshot 實體建置的範例報表，請參閱代理程式集區的歷程記錄圖表（預覽）。

TaskAgentRequestSnapshots

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

下列屬性適用於 TaskAgentRequestSnapshot 實體類型及其 Surrogate 索引鍵 SamplingTime 和 SamplingDateSK。

顯示名稱 名稱 資料類型 說明
建置已排入佇列 IsQueued 布林值 指出組建是否已排入佇列 （True） 或未排入佇列 （False）。
建置執行中 IsRunning 布林值 指出組建是否正在執行 （True） 或未執行 （False）。
裝載或自我裝載 IsHosted 布林值 指出指派給工作的代理程式是否已裝載 （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 為組織定義的時區表示。

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

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