Analytics のデータ モデル
Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
Azure DevOps の Analytics データ モデルはエンティティ セットで構成され、そのメンバー (エンティティ) には、フィルター処理、集計、集計できるプロパティが含まれています。 さらに、エンティティを相互に関連付ける ナビゲーション プロパティ を含み、選択、フィルター処理、グループ化のための他のプロパティへのアクセスを提供します。
Note
Analytics サービスは、すべての Azure DevOps Services で自動的に有効になり、運用環境でサポートされます。 Power BI の統合 Analytics サービスの OData フィード へのアクセスが一般公開されています。 お使いいただき、フィードバックをお寄せください。
使用可能なデータはバージョンによって異なります。 サポートされている最新バージョンが v2.0され、最新のプレビュー バージョンが v4.0-preview。 詳細については、 OData API のバージョン管理に関するページを参照してください。
Note
Analytics サービスは、Azure DevOps Server 2020 以降のすべての新しいプロジェクト コレクションに対して、運用環境で自動的にインストールされ、サポートされます。 Power BI の統合 Analytics サービスの OData フィード へのアクセスが一般公開されています。 お使いいただき、フィードバックをお寄せください。 Azure DevOps Server 2019 からアップグレードした場合は、アップグレード中に Analytics サービスをインストールできます。
使用可能なデータはバージョンによって異なります。 サポートされている最新バージョンが v2.0され、最新のプレビュー バージョンが v4.0-preview。 詳細については、 OData API のバージョン管理に関するページを参照してください。
Note
Analytics サービスは、Azure DevOps Server 2019 のプレビュー段階です。 プロジェクト コレクション 有効またはインストール できます。 Power BI 統合 Analytics Service の OData フィード へのアクセスはプレビュー段階です。 お使いいただき、フィードバックをお寄せください。
使用可能なデータはバージョンによって異なります。 サポートされている最新バージョンが v2.0され、最新のプレビュー バージョンが v4.0-preview。 詳細については、 OData API のバージョン管理に関するページを参照してください。
スキーマ名前空間
Analytics データ モデルは、次の 2 つのスキーマ名前空間に基づいています。
Microsoft.VisualStudio.Services.Analytics.ModelMicrosoft.VisualStudio.Services.Analytics.
エンティティ セットとエンティティ型
エンティティ型は、キーを持つ名前付き構造化型です。 各エンティティの名前付きプロパティとリレーションシップを定義します。 EntityTypeのキーは、プリミティブ プロパティのサブセット (WorkItemId、PipelineId、ReleasePipelineId など) から形成されます。
エンティティ セットは、エンティティの名前付きコレクションです。 たとえば、 WorkItems は、 WorkItem エンティティを含むエンティティ セットです。 エンティティのキーは、エンティティ セット内のエンティティを一意に識別します。 複数のエンティティ セットで同じエンティティ型が使用されている場合、キー値の同じ組み合わせを複数のエンティティ セットに表示し、異なるエンティティ (このキーの組み合わせが表示されるエンティティ セットごとに 1 つ) を識別できます。 これらのエンティティはそれぞれ異なるエンティティ ID を持っています。エンティティ セットは、データ モデルへのエントリ ポイントを提供します。
エンティティ セットは OData メタデータで記述され、プロジェクトによって異なります。 プロジェクトの OData メタデータを要求することで、エンティティ セット、エンティティ型、プロパティの完全な一覧を調べることができます。 方法については、「 Analytics の OData クエリを作成するを参照してください。
複合エンティティ
複合エンティティは、特定のシナリオをサポートします。 これらは、より単純なエンティティから構成され、多くの場合、生成するコンピューティング リソースが多く必要になり、より大きな結果セットが返される場合があります。 最適なパフォーマンスを実現し、不要な調整を回避するには、シナリオに合わせて正しいエンティティに対してクエリを実行してください。
たとえば、WorkItemSnapshotWorkItemRevisionsとDatesを組み合わせて、各日付に作業項目ごとに 1 つのリビジョンが設定されるようにします。 この表現は、フィルター処理された一連の作業項目の傾向データに焦点を当てる OData クエリをサポートします。 ただし、この複合エンティティを使用して作業項目の現在の状態を照会しないでください。 代わりに、 WorkItems エンティティ セットを使用して、より迅速に実行できるクエリを生成する必要があります。
同様に、一部のエンティティにはすべての履歴値が含まれる場合もあれば、現在の値のみを含むエンティティもあります。 WorkItemRevisions にはすべての作業項目履歴が含まれています。現在の値が関心のあるシナリオでは使用しないでください。
リレーションシップ
より複雑なクエリ結果を生成するには、リレーションシップを使用してエンティティを結合します。 リレーションシップを使用して、データの拡張、フィルター処理、集計を行うことができます。
一部のナビゲーション プロパティでは 1 つのエンティティが生成され、その他のプロパティはエンティティのコレクションになります。 次の図は、選択エンティティとそのナビゲーション プロパティを示しています。 わかりやすくするために、一部の複合エンティティとリレーションシップは省略されています。
リレーションシップ キー
外部ツールがエンティティを結合できるように、エンティティリレーションシップも外部キーとして表されます。 これらのプロパティにはサフィックス "SK" があり、整数または GUID のデータ型です。 日付プロパティには、 YYYYMMDDという形式の、対応する整数の日付キー プロパティがあります。
作業追跡エンティティの種類とエンティティ セット
指定された API バージョンでは、次のエンティティ型とエンティティ セットがサポートされています。 完全なリファレンスについては、「 Work tracking metadata reference for Azure Boards Analytics(Azure Boards Analytics の作業追跡メタデータ リファレンスを参照してください。
EntityType/EntitySet |
説明 | v1.0 | v2.0 | v3.0 プレビュー | v4.0-preview |
|---|---|---|---|---|---|
| 領域/ 領域 |
作業項目 エリア パス。エリア階層別にグループ化およびフィルター処理するためのプロパティが含まれます。 | ✔️ | ✔️ | ✔️ | ✔️ |
| 反復/ イテレーション |
作業項目 イテレーション パス。イテレーション階層によるグループ化とフィルター処理のプロパティが含まれます。 | ✔️ | ✔️ | ✔️ | ✔️ |
| BoardLocation/ BoardLocations |
ボード列、スイムレーン、および分割によって識別されるボード セルの場所には、履歴ボードの設定が含まれます。 各ボード フィールドの説明については、「 ワークフローフィールドとボード フィールドを参照してください。 | ✔️ | ✔️ | ✔️ | ✔️ |
| CalendarDate/ 日付 |
リレーションシップを使用して他のエンティティをフィルター処理およびグループ化するために使用される日付。 | ✔️ | ✔️ | ✔️ | ✔️ |
| プロジェクト/ プロジェクト |
organization (クラウド) またはプロジェクト コレクション (オンプレミス) に対して定義されているすべてのプロジェクト。 | ✔️ | ✔️ | ✔️ | ✔️ |
| 処理/ プロセス |
作業項目と作業項目の種類を展開またはフィルター処理するために使用されるバックログ情報。 プロセスを使用してレポートをフィルター処理する例については、「要件追跡サンプル レポート」を参照してください。 | ✔️ | ✔️ | ✔️ | |
| Tag/ タグ |
各プロジェクトのすべての作業項目タグ。 タグを使用してレポートをフィルター処理する例については、「リリース バーンダウン サンプル レポート」を参照してください。 | ✔️ | ✔️ | ✔️ | ✔️ |
| チーム/ Teams |
プロジェクトに対して定義されているすべてのチーム。 Teams を使用してレポートをフィルター処理する例については、「Power BI レポートにチーム スライサーを追加する」を参照してください。 | ✔️ | ✔️ | ✔️ | ✔️ |
| User/ ユーザー |
さまざまな作業項目のプロパティ ( 割り当て先、 作成者など) を展開またはフィルター処理するために使用されるユーザー情報。 | ✔️ | ✔️ | ✔️ | ✔️ |
| WorkItemBoardSnapshot/ WorkItemBoardSnapshot |
(複合)傾向レポートの生成に使用される、ボードの場所を含む各カレンダー日付の各作業項目の状態。 サンプル レポートについては、「 累積フローダイアグラム (CFD) サンプル レポート」を参照してください。 | ✔️ | ✔️ | ✔️ | ✔️ |
| WorkItemLink/ WorkItemLinks |
作業項目間のリンク ( 子、 親、 関連など)。 リンクの最新のリビジョンのみを含み、履歴は含まない。 ハイパーリンクは含まれません。 | ✔️ | ✔️ | ✔️ | ✔️ |
| WorkItemRevision/ WorkItemRevisions |
現在のリビジョンを含むすべての履歴作業項目のリビジョン。 削除された作業項目は含まれません。 | ✔️ | ✔️ | ✔️ | ✔️ |
| WorkItemSnapshot/ WorkItemSnapshot |
(複合)傾向レポートをサポートするために使用される、各カレンダー日付の各作業項目の状態。 サンプル レポートについては、「 バグ傾向のサンプル レポート」を参照してください。 | ✔️ | ✔️ | ✔️ | ✔️ |
| Workitem/ Workitem |
作業項目の現在の状態。 状態レポートをサポートするために使用されます。 サンプル レポートについては、「 子作業項目の値を親サンプル レポートにロールアップする」を参照してください。 | ✔️ | ✔️ | ✔️ | ✔️ |
| WorkItemTypeField/ WorkItemTypeFields |
作業項目の種類とプロセスごとの作業項目のプロパティ。 レポートの作成をサポートするために使用されます。 | ✔️ | ✔️ | ✔️ | ✔️ |
パイプライン エンティティの種類とエンティティ セット
v3.0-preview または v4.0-preview Analytics バージョンでは、次のエンティティ型とエンティティ セットがサポートされています。 完全なリファレンスについては、 Pipeline メタデータ リファレンス を参照してください。
| EntityType/EntitySet | 説明 | v3.0 プレビュー | v4.0-preview |
|---|---|---|---|
| Branch/ ブランチ |
テストまたはパイプラインで使用されるブランチに関する基本情報。 サンプル レポートについては、 Progress 状態のサンプル レポートを参照してください。 | ✔️ | ✔️ |
| ParallelPipelineJobsSnapshot/ ParallelPipelineJobsSnapshot |
(複合)並列パイプラインの使用の理解をサポートします。 並列パイプライン テストの詳細については、「 Visual Studio テスト タスクを使用して並列でテストを実行するを参照してください。 | ✔️ | |
| パイプライン/ パイプライン |
パイプラインのプロパティ。 | ✔️ | ✔️ |
| PipelineJob/ PipelineJobs |
TestRun に関連付けられている特定のテストの個々の実行結果 | ✔️ | ✔️ |
| PipelineRun/ PipelineRuns |
パイプラインの実行情報。 サンプル レポートについては、「 Pipeline pass rate trend sample reportを参照してください。 | ✔️ | ✔️ |
| PipelineRunActivityResult/ PipelineRunActivityResults |
特定のパイプライン実行内のすべてのステージ、ステップ、ジョブ、およびタスクのマージされたログ。 サンプル レポートについては、 Pipeline タスク期間のサンプル レポートを参照してください。 | ✔️ | ✔️ |
| PipelineTask/ PipelineTasks |
パイプライン内で使用されるタスクのプロパティ。 | ✔️ | ✔️ |
| TaskAgentPoolSizeSnapshot/ TaskAgentPoolSizeSnapshots |
(複合)プール サイズ、パイプライン ジョブ、コンカレンシーの理解をサポートします。 エージェント プールの Historical グラフ は、このエンティティ セットを使用する方法を示しています。 | ✔️ | |
| TaskAgentRequestSnapshot/ TaskAgentRequestSnapshots |
(複合) | ✔️ |
エンティティの種類とエンティティ セットをテストする
v3.0-preview または v4.0-preview Analytics バージョンでは、次のエンティティ型とエンティティ セットがサポートされています。 完全なリファレンスについては、 Test メタデータ リファレンスを参照してください。
EntityType/EntitySet |
説明 | v3.0 プレビュー | v4.0-preview |
|---|---|---|---|
| TestConfiguration/ TestConfigurations |
テスト 計画の構成情報。 テストの構成の詳細については、「 異なる構成のテスト」を参照してください。 | ✔️ | ✔️ |
| TestResult/ TestResults |
TestRun に関連付けられた特定の Test に対する個々の実行結果。 | ✔️ | ✔️ |
| TestResultsDaily/ TestResultsDaily |
TestResult 実行の毎日のスナップショット集計。Test でグループ化されます (TestRun ではありません)。 サンプル レポートについては、 概要傾向のサンプル レポートを参照してください。 | ✔️ | ✔️ |
| TestRun/ TestRuns |
テストの実行情報は、集計 TestResult を使用してパイプラインで実行されます。 | ✔️ | ✔️ |
| テスト/ テスト |
テスト名やテスト所有者など、テスト ケースのプロパティ。 テスト ケースの定義の詳細については、 手動テスト ケースの作成を参照してください。 | ✔️ | ✔️ |
| TestPoint/ TestPoints |
テスト ポイントの実行情報。 テスト ポイントは、テスト ケース、テスト スイート、構成、テスターの一意の組み合わせです。 サンプル レポートについては、 Progress 状態のサンプル レポートを参照してください。 | ✔️ | ✔️ |
| TestPointHistorySnapshot/ TestPointHistorySnapshots |
(複合)TestRun に関連付けられている特定のテストの個々の実行結果。 サンプル レポートについては、「 Manual テスト実行の傾向のサンプル レポート」を参照してください。 | ✔️ | ✔️ |
| TestSuite/ TestSuites |
テスト スイートの情報。 テスト スイートの定義の詳細については、「 テスト 計画とテスト スイートの作成」を参照してください。 | ✔️ | ✔️ |