共用方式為

Azure Pipelines Analytics 的元數據參考

  • 發行項

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

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

注意

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

實體集和實體類型

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

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

分支

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

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

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

ParallelPipelineJobsSnapshot

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

  • IsHosted
  • ParallelismTag
  • SamplingDate
顯示名稱 名稱 資料類型 說明
伺服器托管或自行托管 IsHosted 布林值 指示平行管線是運行在 Microsoft 托管代理程式上（為真）或自行托管（為假）。 如需詳細資訊，請參閱 Azure Pipelines 代理程式。
無法連線到所有提供者 FailedToReachAllProviders 布林值 指示作業執行是否涉及所有提供者（True）或不是（False）。
平行管線作業的數目 TotalCount Int32 作業數目會以快照集的一部分執行。
平行管線分鐘數 TotalMinutes Int32 執行快照所花費的分鐘數。
平行性類型 ParallelismTag 字串 與作業快照相關的平行處理類型的標記。
進階類型 IsPremium 布林值 表示平行管線是否為高級 ("True") 或非 ("False")。
範例日期 SamplingDate 日期時間 與快照相關聯的日期。

管線

下列屬性對 Pipelines 及其代理鍵 PipelineSK 是有效的。

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

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

PipelineProcessType 列舉類型成員

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

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

PipelineJobs

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

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

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

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

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

PipelineRuns

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

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

顯示名稱 名稱 資料類型 說明
取消計數 CanceledCount Int32 已取消的管線執行次數。
完成日期 CompletedDate Datetime 管線完成執行的日期和時間。
失敗計數 FailedCount Int32 成功執行的管線計數。
數字修訂 RunNumberRevision Int32 指派給具有循序執行的管線執行數目。
部分成功計數 PartiallySucceededCount Int32 管道執行中部分成功的計數。
管道運行識別碼 PipelineRunId Int32 指派給管線執行的數位。
已排入佇列的日期 QueuedDate 日期時間 管線等待執行的日期和時間。
佇列持續時間秒 QueueDurationSeconds 十進制 管線保留在佇列中的秒數。
執行編號 RunNumber 字串 執行管線時指派給該執行工作的編號。
執行結果 RunOutcome 列舉 執行操作完成時指派給管線的結果。 提供下列有效值供 PipelineRunOutcome 參考。
執行原因 RunReason 列舉 導致管線運行的條件。 PipelineRunReason 的有效值如下。
執行持續時間秒 RunDurationSeconds 十進制 完成管線流程所需的秒數。
開始日期 StartedDate 日期時間 管線執行開始的日期和時間。
成功計數 SucceededCount Int32 成功執行的管線執行次數計數。
持續時間總計秒數 TotalDurationSeconds 十進制 管線在佇列中並執行的總秒數。

支援下列導覽屬性。

顯示名稱 名稱 -引用條件約束 參考屬性
分支 Branch BranchSK BranchSK
已完成於 CompletedOn CompletedDateSK DateSK
佇列開啟 QueuedOn QueuedDateSK DateSK
已啟動 StartedOn QueuedDateSK DateSK
管線 Pipeline PipelineSK PipelineSK
計畫 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 失敗
Canceled 32 已取消

管道運行活動結果

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

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

顯示名稱 名稱 資料類型 說明
放棄計數 AbandonedCount Int32 標示為已放棄的管線執行計數。
活動完成日期 ActivityCompletedDate 日期時間 管線執行完成執行的日期和時間。
活動持續時間秒數 ActivityDurationSeconds 十進制 流水線在佇列中等待以及執行的總秒數。
活動開始日期 ActivityStartedDate 日期時間 管道運行啟動時的日期時間。
已取消的計數 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 列舉型別所定義。

成員名稱 價值 顯示名稱
Task 0 任務
Approval 1 核准
AgentWait 2 代理人等候

管線任務

下列屬性適用於 PipelineTasks 實體集及其代理鍵 PipelineTaskSK。

顯示名稱 名稱 資料類型 說明
工作定義標識碼 TaskDefinitionId 全域唯一識別碼 (GUID) 指派給管線任務的 GUID。
工作定義版本 TaskDefinitionVersion 字串 指派給管線工作的版本。

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

任務代理程式池大小快照

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

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

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

任務代理請求快照

當任務執行時，代理程式集區將被分配。 TaskAgentRequestSnapshots 實體集會擷取與工作代理程式要求相關的數據。

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

顯示名稱 名稱 資料類型 說明
建置已排入佇列 IsQueued 布林值 指出組建是否在佇列中（True）或不在佇列中（False）。
建置執行中 IsRunning 布林值 指出組建是否正在執行 （True） 或未執行 （False）。
託管或自託管 IsHosted 布林值 指示工作指派的代理程式是托管（True）還是自管（False）。
作業結束日期 FinishedDate 日期時間 工作代理程式要求完成執行的日期時間。
FinishedDateSK Int32 任務代理的請求完成運行的日期，以組織定義的時區中的 YYYYMMDD 表示。
排隊日期 QueuedDate 日期時間 工作代理程式要求已排入佇列的日期時間。
QueuedDateSK Int32 工作代理要求被佇列的日期，以組織定義的時區表示為 YYYYMMDD。
佇列持續時間秒 QueueDurationSeconds 十進制 指派代理程式之前，工作代理程式要求的秒數會保留在佇列中。
集區標識碼 PoolId Int32 指派給指派給工作代理程式要求之代理程式集區的號碼。
管線類型 PipelineType 字串 包含工作代理程式要求的管線類型。
請求編號 RequestId Int64 指派給工作代理程式要求的數位。
示範時段 SamplingHour Int32 收到要求時指派給小時的數位。
範例時間 SamplingTime 日期時間 收到工作代理程式要求的日期時間。
開始日期 StartedDate 日期時間 執行工作代理程式要求的日期時間。
StartedDateSK Int32 工作代理程式要求開始執行的日期，如 YYYYMMDD 為組織定義的時區表示。

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

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