Azure Pipelines Analytics 的元数据参考

  • 项目

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

分析服务收集通过 Azure Pipelines 生成的管道和测试活动。 本文介绍可用于为管道生成 Analytics 报表的属性。 可以使用属性的组合来筛选查询、聚合数据或生成报表。

注意

提供了分析数据模型支持的实体、属性和枚举类型的说明。 这是一个早期草稿。 请提供有关想要了解详细信息的领域的反馈。 若要查询数据模型，请参阅 为 Analytics 构造 OData 查询。

实体集和实体类型

下表汇总了支持 Azure Pipelines 的实体类型和实体集。 所有实体类型/实体集都可用于 Analytics v4.0 预览 版。 分析版本 v3.0-preview 不支持快照。

EntitySet EntityType 说明
分支 分支 有关测试或管道中使用的分支的基本信息。 有关示例报表，请参阅 进度状态示例报告。
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (复合) 支持了解并行管道使用情况。 若要详细了解并行管道测试，请参阅 使用 Visual Studio 测试任务并行运行测试。
管道 管道 管道的属性。
PipelineJobs PipelineJob 与 TestRun 关联的特定测试的单个执行结果
PipelineRuns PipelineRun 管道的执行信息。 有关示例报表，请参阅 管道通过率趋势示例报告。
PipelineRunActivityResults PipelineRunActivityResult 特定管道执行中所有阶段、步骤、作业和任务的合并日志。 有关示例报表，请参阅 管道任务持续时间示例报告。
PipelineTasks PipelineTask 管道中使用的任务的属性。
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (复合) 支持了解池大小、管道作业和并发性。 代理池的历史图说明了如何使用此实体集。
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (复合) 支持报告任务代理请求。

分支

以下属性对 分支 实体集有效。 与 Branch 关联的代理键包括 BranchSK 和 ProjectSK。

显示名称 名称 数据类型 描述
AnalyticsUpdatedDate DateTime 指示上次更新分析数据的水印。
分支名称 BranchName 字符串 创建分支时分配给分支的名称。
存储库 ID RepositoryId 字符串 创建存储库时分配给存储库的数字。
存储库 Vsts ID RepositoryVstsId 字符串 创建 TFVC 存储库时分配给它的编号。
RepositoryUrl RepositoryUrl 字符串 创建存储库时为存储库定义的 URL。

导航属性包括 Project 及其引用约束 ProjectSK。

ParallelPipelineJobsSnapshot

以下属性对 ParallelPipelineJobsSnapshot 实体集有效。 引用密钥包括：

  • IsHosted
  • ParallelismTag
  • SamplingDate
显示名称 名称 数据类型 描述
托管或自承载 IsHosted Boolean 指示并行管道是在 Microsoft 托管代理上运行 (True) 还是自承载 (False) 。 若要了解详细信息，请参阅 Azure Pipelines 代理。
未能到达所有提供程序 FailedToReachAllProviders Boolean 指示作业运行是否到达所有提供程序 (True) ，还是 (False) 。
并行管道作业数 TotalCount Int32 作为快照一部分运行的作业数。
并行管道分钟数 TotalMinutes Int32 运行快照所花费的分钟数。
并行度类型 ParallelismTag 字符串 一个标记，指示与作业快照关联的并行度类型。
高级类型 IsPremium Boolean 指示并行管道是高级 (True) ，还是 (False) 。
示例日期 SamplingDate DateTime 与快照关联的日期。

管道

以下属性对 Pipelines 及其代理项 PipelineSK有效。

显示名称 名称 数据类型 描述
管道 ID PipelineId Int32 分配给管道的 ID。
管道名称 PipelineName 字符串 分配给管道的名称。
管道版本 PipelineVersion Int32 与管道关联的版本。
管道进程类型 PipelineProcessType Enumerated 管道定义的类型。 下面列出了 PipelineProcessType 的有效值。

导航属性包括 Project 及其引用约束 ProjectSK。

PipelineProcessType 枚举类型成员

以下成员是为 PipelineProcessType 枚举类型定义的，该类型指示用于定义管道的方法。

成员名称 值 定义
Designer 1 经典管道定义。
Yaml 2 YAML 管道定义。
Docker 3 Docker 管道定义。

PipelineJobs

管道作业是作为一个单元按顺序运行的一系列步骤。 作业是可以计划运行的最小工作单位。 管道围绕作业进行组织，每个管道至少有一个作业。 若要了解详细信息，请参阅 在管道中指定作业。

以下属性对 PipelineJobs 及其 PipelineJobSK 代理键有效。

显示名称 名称 数据类型 描述
管道完整作业名称 FullJobName 字符串 管道作业的全名。
管道 ID PipelineId Int32 分配给在其中定义作业的管道的 ID。
管道作业标识符 JobId 字符串 创建管道作业时分配给管道作业的作业标识符。
管道作业名称 JobName 字符串 分配给管道作业的名称。
管道阶段名称 StageName 字符串 与管道作业关联的阶段名称。
管道作业策略属性 StrategyAttributes 字符串 为管道作业定义的属性。
阶段标识符 StageId 字符串 与管道作业关联的阶段标识符。

导航属性包括 Project 及其引用约束 ProjectSK。

有关查询 PipelineJob 实体类型的示例报表，请参阅 管道阶段故障示例报告。

PipelineRuns

管道运行表示管道的单个执行。 在运行期间，将处理管道，代理处理一个或多个作业。 管道运行包括作业、步骤和任务。 若要了解详细信息，请参阅 管道运行序列。

以下属性对 PipelineRun 实体类型及其 PipelineRunSK 代理键有效。

显示名称 名称 数据类型 描述
已取消计数 CanceledCount Int32 已取消的管道运行计数。
完成日期 CompletedDate DateTime 管道完成执行的日期和时间。
失败计数 FailedCount Int32 成功的管道运行计数。
编号修订 RunNumberRevision Int32 分配给具有顺序执行的管道运行的数量。
部分成功计数 PartiallySucceededCount Int32 部分成功的管道运行计数。
管道运行 ID PipelineRunId Int32 分配给管道运行的编号。
排队日期 QueuedDate DateTime 管道排队运行的日期和时间。
队列持续时间秒 QueueDurationSeconds 小数 管道保留在队列中的秒数。
运行编号 RunNumber 字符串 执行管道时分配给管道运行的编号。
运行结果 RunOutcome Enumerated 完成管道执行时分配给管道的结果。 下面列出了 PipelineRunOutcome 的有效值。
运行原因 RunReason Enumerated 导致管道运行的条件。 下面列出了 PipelineRunReason 的有效值。
运行持续时间秒 RunDurationSeconds 小数 管道运行完成所花费的秒数。
开始日期 StartedDate DateTime 管道运行的开始日期和时间。
成功计数 SucceededCount Int32 成功的管道运行计数。
总持续时间秒数 TotalDurationSeconds 小数 管道在队列中运行的总秒数。

支持以下导航属性。

显示名称 名称 -Referential constraint 引用的属性
分支 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 Check In书架集
PullRequest 256 拉取请求
PipelineRunCompletion 512 生成完成

PipelineRunOutcome 枚举类型成员

以下成员是为 PipelineRunOutcome 指示管道运行结果的枚举类型定义的。

成员名称 值 显示名称
None 0 无
Succeed 2 成功
PartiallySucceeded 4 部分成功
Failed 6 已失败
Canceled 32 已取消

PipelineRunActivityResults

以下属性对 PipelineRunActivityResults 实体集及其 PipelineRunActivityResultSK 代理键有效。

许多属性基于日期或基于用户。 这些属性与 Calendar 日期、项目和用户元数据引用中所述的 CalendarDate和 User 实体集相关联。

显示名称 名称 数据类型 描述
已放弃计数 AbandonedCount Int32 标记为已放弃的管道运行的计数。
活动完成日期 ActivityCompletedDate DateTime 管道运行完成执行的日期和时间。
活动持续时间秒 ActivityDurationSeconds 小数 管道在队列中运行的总秒数。
活动开始日期 ActivityStartedDate DateTime 管道运行开始的日期-时间。
已取消计数 CanceledCount Int32 已取消的管道运行的计数。
失败计数 FailedCount Int32 失败的管道运行计数。
管道活动类型 ActivityType Enumerated 管道活动的类型。 下面列出了 PipelineActivityType 的有效值。
管道运行 ID PipelineRunId Int32 执行管道时分配给管道运行的编号。
管道运行结果 PipelineRunOutcome Enumerated 完成管道执行时分配给管道的结果。 有效值列在 PipelineRunOutcome 下。
从作业秒开始的相对开始时间 RelativeStartTimeFromJobSeconds Int32 从作业开始经过的秒数。
阶段秒的相对开始时间 RelativeStartTimeFromStageSeconds Int32 从阶段开始经过的秒数。
运行秒数的相对开始时间 RelativeStartTimeFromRunSeconds Int32 执行运行时所经过的秒数。
跳过计数 SkippedCount Int32 跳过的管道运行的计数。
成功计数 SucceededCount Int32 成功的管道运行计数。
已成功，问题计数 SucceededWithIssuesCount Int32 部分成功的管道运行的计数。
任务显示名称 TaskDisplayName 字符串 在管道运行中执行的任务的名称。
任务日志路径 TaskLogPath 字符串 任务生成的日志文件的路径。
任务结果 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 Project ProjectSK ProjectSK

PipelineActivityType 枚举类型成员

为枚举类型定义 PipelineActivityType 以下成员。

成员名称 值 显示名称
Task 0 任务
Approval 1 审批
AgentWait 2 代理等待

PipelineTasks

以下属性对 PipelineTasks 实体集及其代理键 PipelineTaskSK有效。

显示名称 名称 数据类型 描述
任务定义 ID TaskDefinitionId GUID 分配给管道任务的 GUID。
任务定义版本 TaskDefinitionVersion 字符串 分配给管道任务的版本。

导航属性包括 Project 及其引用约束 ProjectSK。

TaskAgentPoolSizeSnapshots

以下属性对 TaskAgentPoolSizeSnapshots 实体集及其代理键 SamplingDate有效。

显示名称 属性名称 数据类型 描述
联机计数 OnlineCount Int32 运行任务时代理池中联机代理的数目。
脱机计数 OfflineCount Int32 运行任务时代理池中脱机的代理数。
池 ID PoolId Int32 分配给代理池的编号。
示例日期 SamplingDate DateTime 贴靠池大小的日期和时间。

有关基于 TaskAgentPoolSizeSnapshot 实体生成的示例报表，请参阅 代理池的历史图 (预览版) 。

TaskAgentRequestSnapshots

执行任务时会分配代理池。 TaskAgentRequestSnapshots 实体集捕获与任务代理请求相关的数据。

以下属性对 TaskAgentRequestSnapshot 实体类型及其代理键 SamplingTime 和 SamplingDateSK有效。

显示名称 名称 数据类型 描述
生成排队 IsQueued Boolean 指示生成是排队 (True) ，还是未排队 (False) 。
正在运行的生成 IsRunning Boolean 指示生成是 (True) 运行还是未运行 (False) 。
托管或自承载 IsHosted Boolean 指示分配给任务的代理是托管 (True) 还是自承载 (False) 。
作业结束日期 FinishedDate DateTime 任务代理请求完成运行的日期时间。
FinishedDateSK Int32 任务代理请求的运行完成日期，表示 YYYYMMDD 为组织定义的时区。
排队日期 QueuedDate DateTime 任务代理请求排队的日期时间。
QueuedDateSK Int32 任务代理请求排队的日期，以为组织定义的时区表示 YYYYMMDD 。
队列持续时间秒 QueueDurationSeconds 小数 任务代理请求在分配代理之前保留在队列中的秒数。
池 ID PoolId Int32 分配给分配给任务代理请求的代理池的数字。
管道类型 PipelineType 字符串 包含任务代理请求的管道类型。
请求 ID 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