Azure Pipelines Analytics のメタデータ リファレンス

  • [アーティクル]

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

Analytics サービスは、Azure Pipelines を介して生成されたパイプラインとテスト アクティビティを収集します。 この記事では、パイプラインの分析レポートを生成するために使用できるプロパティについて説明します。 プロパティの組み合わせを使用して、クエリのフィルター処理、データの集計、またはレポートの作成を行います。

注意

Analytics データ モデルでサポートされるエンティティ、プロパティ、および列挙型の説明が提供されます。 これは初期の草案です。 詳細情報が必要な領域に関するフィードバックをお寄せください。 データ モデルのクエリを実行するには、「 Analytics 用の OData クエリを構築する」を参照してください。

エンティティ セットとエンティティ型

次の表は、Azure Pipelines をサポートするエンティティの種類とエンティティ セットをまとめたものです。 すべてのエンティティ型/エンティティ セットは、Analytics v4.0 プレビュー バージョンで使用できます。 Analytics バージョン v3.0-preview では、スナップショットはサポートされていません。

EntitySet EntityType 説明
ブランチ ブランチ テストまたはパイプラインで使用されるブランチに関する基本情報。 サンプル レポートについては、「 進行状況の状態のサンプル レポート」を参照してください。
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (複合)並列パイプラインの使用の理解をサポートします。 並列パイプライン テストの詳細については、「 Visual Studio テスト タスクを使用してテストを並列で実行する」を参照してください。
Pipelines パイプライン パイプラインのプロパティ。
PipelineJobs PipelineJob TestRun に関連付けられている特定のテストの個々の実行結果
PipelineRuns PipelineRun パイプラインの実行情報。 サンプル レポートについては、「 パイプラインの合格率傾向のサンプル レポート」を参照してください。
PipelineRunActivityResults PipelineRunActivityResult 特定のパイプライン実行内のすべてのステージ、ステップ、ジョブ、タスクのマージされたログ。 サンプル レポートについては、「 パイプライン タスク期間のサンプル レポート」を参照してください。
PipelineTasks PipelineTask パイプライン内で使用されるタスクのプロパティ。
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (複合)プール サイズ、パイプライン ジョブ、コンカレンシーの理解をサポートします。 エージェント プールの履歴グラフは、このエンティティ セットを使用する方法を示しています。
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (複合)タスク エージェント要求に関するレポートをサポートします。

ブランチ

次のプロパティは、 Branchs エンティティ セットに対して有効です。 Branch に関連付けられているサロゲート キーには、 と がProjectSK含まれますBranchSK。

表示名 名前 データの種類 説明
AnalyticsUpdatedDate DateTime 分析データが最後に更新された時刻を示す透かし。
ブランチ名 BranchName String 作成時にブランチに割り当てられる名前。
リポジトリ ID RepositoryId String リポジトリの作成時にリポジトリに割り当てられた番号。
リポジトリ Vsts ID RepositoryVstsId String TFVC リポジトリの作成時に割り当てられた番号。
RepositoryUrl RepositoryUrl String リポジトリの作成時に定義された URL。

ナビゲーション プロパティには、 とその参照制約 が含まれますProjectProjectSK。

ParallelPipelineJobsSnapshot

ParallelPipelineJobsSnapshot エンティティ セットでは、次のプロパティが有効です。 参照キーは次のとおりです。

  • IsHosted
  • ParallelismTag
  • SamplingDate
表示名 名前 データの種類 説明
ホストまたはセルフホステッド IsHosted ブール型 並列パイプラインが Microsoft ホステッド エージェント (True) で実行されているか、セルフホステッド (False) であるかを示します。 詳細については、「 Azure Pipelines エージェント」を参照してください。
すべてのプロバイダーに到達できませんでした FailedToReachAllProviders ブール型 ジョブの実行がすべてのプロバイダー (True) に達したかどうかを示します (False)。
並列パイプライン ジョブの数 TotalCount Int32 スナップショットの一部として実行されるジョブの数。
並列パイプラインの分数 TotalMinutes Int32 スナップショットの実行にかかった分数。
並列処理の種類 ParallelismTag String ジョブ スナップショットに関連付けられている並列処理の種類を示すタグ。
Premium の種類 IsPremium ブール型 並列パイプラインが Premium (True) かどうかを示します (False)。
サンプル日付 SamplingDate DateTime スナップショットに関連付けられている日付。

Pipelines

次のプロパティは、 Pipelines とその代理キー PipelineSKに対して有効です。

表示名 名前 データの種類 説明
パイプライン ID PipelineId Int32 パイプラインに割り当てられた ID。
Pipeline Name (パイプライン名) PipelineName String パイプラインに割り当てられた名前。
パイプラインのバージョン PipelineVersion Int32 パイプラインに関連付けられているバージョン。
パイプライン プロセスの種類 PipelineProcessType Enumerated パイプライン定義の種類。 PipelineProcessType の有効な値を次に示します。

ナビゲーション プロパティには、 とその参照制約 が含まれますProjectProjectSK。

PipelineProcessType 列挙型メンバー

パイプラインの定義に使用されるメソッドを PipelineProcessType 示す列挙型に対して、次のメンバーが定義されています。

メンバー名 値 定義
Designer 1 クラシック パイプライン定義。
Yaml 2 YAML パイプライン定義。
Docker 3 Docker パイプライン定義。

PipelineJobs

パイプライン ジョブは、ユニットとして順番に実行される一連の手順です。 ジョブは、実行をスケジュールできる最小の作業単位です。 パイプラインはジョブを中心に編成され、各パイプラインには少なくとも 1 つのジョブがあります。 詳細については、「 パイプラインでジョブを指定する」を参照してください。

次のプロパティは、 PipelineJobs とそのサロゲート キーに PipelineJobSK 対して有効です。

表示名 名前 データの種類 説明
パイプラインの完全なジョブ名 FullJobName String パイプライン ジョブの完全な名前。
パイプライン ID PipelineId Int32 ジョブが定義されているパイプラインに割り当てられた ID。
パイプライン ジョブ識別子 JobId String パイプライン ジョブの作成時に割り当てられたジョブ識別子。
パイプライン ジョブ名 JobName String パイプライン ジョブに割り当てられた名前。
パイプライン ステージ名 StageName String パイプライン ジョブに関連付けられているステージ名。
パイプライン ジョブ戦略の属性 StrategyAttributes String パイプライン ジョブに定義されている属性。
ステージ識別子 StageId String パイプライン ジョブに関連付けられているステージ識別子。

ナビゲーション プロパティには、 とその参照制約 が含まれますProjectProjectSK。

PipelineJob エンティティ型に対してクエリを実行するサンプル レポートについては、「Pipeline stage wise failures sample report」を参照してください。

PipelineRuns

パイプラインの実行は、パイプラインの 1 回の実行を表します。 実行中にパイプラインが処理され、エージェントは 1 つ以上のジョブを処理します。 パイプライン実行には、ジョブ、ステップ、タスクが含まれます。 詳細については、「 パイプラインの実行シーケンス」を参照してください。

次のプロパティは、 PipelineRun エンティティ型とその PipelineRunSK 代理キーに対して有効です。

表示名 名前 データの種類 説明
取り消された数 CanceledCount Int32 取り消されたパイプライン実行の数。
完了日 CompletedDate DateTime パイプラインの実行が完了した日時。
失敗した数 FailedCount Int32 成功したパイプライン実行の数。
数値のリビジョン RunNumberRevision Int32 パイプラインに割り当てられた数は、順次実行で実行されます。
部分的に成功した数 PartiallySucceededCount Int32 部分的に成功したパイプライン実行の数。
パイプラインの実行 ID PipelineRunId Int32 パイプライン実行に割り当てられた番号。
キューに登録された日付 QueuedDate DateTime パイプラインが実行キューに登録された日時。
キューの継続時間 (秒) QueueDurationSeconds Decimal パイプラインがキューに残った秒数。
実行番号 RunNumber String パイプラインに割り当てられた数は、実行時に実行されます。
実行結果 RunOutcome Enumerated 実行の完了時にパイプラインに割り当てられた結果。 PipelineRunOutcome の有効な値を次に示します。
実行理由 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 ProjectSK ProjectSK

PipelineRunReason 列挙型メンバー

「条件のPipelineRunReason指定」で説明されているように、各パイプライン ステージ、ジョブ、またはステップが実行される条件を示す列挙型に対して、次のメンバーが定義されています。

メンバー名 値 表示名
None 0 None
Manual 1 手動
IndividualCI 2 個々の CI
BatchedCI 4 バッチ化された CI
Schedule 8 スケジュール
UserCreated 32 ユーザーが作成した
ValidateShelveset 64 シェルブセットの検証
CheckInShelveset 128 チェックイン シェルブセット
PullRequest 256 Pull Request
PipelineRunCompletion 512 ビルドの完了

PipelineRunOutcome 列挙型メンバー

パイプライン実行の結果を PipelineRunOutcome 示す列挙型に対して、次のメンバーが定義されています。

メンバー名 値 表示名
None 0 なし
Succeed 2 合格
PartiallySucceeded 4 一部成功
Failed 6 失敗
Canceled 32 Canceled

PipelineRunActivityResults

次のプロパティは、 PipelineRunActivityResults エンティティ セットとその PipelineRunActivityResultSK サロゲート キーに対して有効です。

多くのプロパティは、日付ベースまたはユーザーベースです。 これらのプロパティは、「カレンダーの日付、プロジェクト、およびユーザーのメタデータリファレンス」で説明されている CalendarDate および User エンティティ セットに関連付けられます。

表示名 名前 データの種類 説明
破棄された数 AbandonedCount Int32 破棄済みとしてマークされたパイプライン実行の数。
アクティビティの完了日 ActivityCompletedDate DateTime パイプラインの実行が完了した日時。
アクティビティ期間 (秒) ActivityDurationSeconds Decimal パイプラインがキューに入って実行された合計秒数。
アクティビティの開始日 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 String パイプライン実行で実行されるタスクの名前。
タスク ログのパス TaskLogPath String タスクによって生成されるログ ファイルのパス。
タスクの結果 TaskOutcome Custom 実行されたタスクの結果。

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

次のプロパティは、 PipelineTasks エンティティ セットとその代理キー PipelineTaskSKに対して有効です。

表示名 名前 データの種類 説明
タスク定義 ID TaskDefinitionId GUID パイプライン タスクに割り当てられた GUID。
タスク定義のバージョン TaskDefinitionVersion String パイプライン タスクに割り当てられたバージョン。

ナビゲーション プロパティには、 とその参照制約 が含まれますProjectProjectSK。

TaskAgentPoolSizeSnapshots

次のプロパティは、 TaskAgentPoolSizeSnapshots エンティティ セットとその代理キー SamplingDateに対して有効です。

表示名 プロパティ名 データの種類 説明
オンライン数 OnlineCount Int32 タスクの実行時にエージェント プール内のオンラインエージェントの数。
オフライン数 OfflineCount Int32 タスクの実行時にエージェント プール内でオフラインになったエージェントの数。
プール ID PoolId Int32 エージェント プールに割り当てられた番号。
サンプル日付 SamplingDate DateTime プール サイズがスナップされた日時。

TaskAgentPoolSizeSnapshot エンティティから構築されたサンプル レポートについては、「エージェント プールの履歴グラフ (プレビュー)」を参照してください。

TaskAgentRequestSnapshots

エージェント プールは、タスクの実行時に割り当てられます。 TaskAgentRequestSnapshots エンティティ セットは、タスク エージェント要求に関連するデータをキャプチャします。

次のプロパティは、 TaskAgentRequestSnapshot エンティティ型とその代理キー SamplingTime と に対して SamplingDateSK有効です。

表示名 名前 データの種類 説明
キューに登録されたビルド IsQueued ブール型 ビルドがキューに登録されている (True) か、キューに入っていないか (False) を示します。
実行中のビルド IsRunning ブール型 ビルドが実行されているかどうかを示します (True) または実行されていない (False)。
ホステッドまたはセルフホステッド IsHosted ブール型 タスクに割り当てられたエージェントがホストされている (True) かセルフホステッド (False) かを示します。
ジョブの終了日 FinishedDate DateTime タスク エージェント要求の実行が完了した日時。
FinishedDateSK Int32 タスク エージェント要求の実行が完了した日付 。organizationに対して定義されているタイム ゾーンでYYYYMMDD表されます。
キューに登録された日付 QueuedDate DateTime タスク エージェント要求がキューに登録された日時。
QueuedDateSK Int32 タスク エージェント要求がキューに登録された日付。これは、organizationに対して定義されたタイム ゾーンで表YYYYMMDDされます。
キューの継続時間 (秒) QueueDurationSeconds Decimal エージェントが割り当てられる前にタスク エージェント要求がキューに残った秒数。
プール ID PoolId Int32 タスク エージェント要求に割り当てられたエージェント プールに割り当てられた番号。
パイプラインの種類 PipelineType String タスク エージェント要求を含むパイプラインの種類。
要求 ID RequestId Int64 タスク エージェント要求に割り当てられた番号。
サンプル時間 SamplingHour Int32 要求が受信されたときに時間に割り当てられた番号。
サンプリング時間 SamplingTime DateTime タスク エージェント要求を受信した日時。
開始日 StartedDate DateTime タスク エージェント要求が実行された日時。
StartedDateSK Int32 タスク エージェント要求が実行を開始した日付。organizationに対して定義されたタイム ゾーンで表YYYYMMDDされます。

ナビゲーション プロパティには、次の表に示すプロパティが含まれます。

表示名 名前 参照制約 -Referenced プロパティ
ブランチ Branch BranchSK BranchSK
完了日 CompletedOn CompletedDateSK DateSK
ジョブの終了時刻 FinishedOn FinishedDateSK DateSK
キューに入れられます QueuedOn QueuedDateSK DateSK
パイプライン Pipeline PipelineSK PipelineSK
プロジェクト Project ProjectSK ProjectSK
開始日 StartedOn QueuedDateSK DateSK