パイプラインの結果の概要サンプルレポート

[アーティクル]
11/21/2024

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020

パイプラインの実行は、パイプラインの 1 回の実行を表します。実行中にパイプラインが処理され、エージェントは 1 つ以上のジョブを処理します。結果には、 Succeeded、 Failed、 Canceled、 Partially Succeeded が含まれます。パイプライン実行の結果を示すレポートを作成するには、 'PipelineRuns entity set にクエリを実行します。

この記事では、さまざまなパイプライン結果の実行数を取得するレポートを作成する方法に関するいくつかのクエリと手順について説明します。

次の図は、結果の概要レポートの例を示しています。

Power BI パイプラインの結果の概要レポートのスクリーンショット。

重要

Power BI 統合 Analytics Service の OData フィードへのアクセスは、Azure DevOps Services および Azure DevOps Server 2020 以降のバージョンで一般提供されています。この記事で提供されるサンプルクエリは、Azure DevOps Server 2020 以降のバージョンに対してのみ有効であり、 v3.0-preview 以降のバージョンによって異なります。これらのクエリを使用し、フィードバックをお寄せください。

前提条件

Access:少なくとも Basic アクセス権を持つプロジェクトのメンバーである必要があります。
Permissions: 既定では、プロジェクトメンバーには Analytics にクエリを実行してビューを作成する権限があります。
サービスと機能の有効化と一般的なデータ追跡アクティビティに関するその他の前提条件の詳細については、「 Analytics にアクセスするためのアクセス許可と前提条件を参照してください。

Note

この記事では、 OData クエリを使用したサンプルレポートの概要 Power BI の基本的な理解があることを前提としています。

サンプルクエリ

PipelineRuns エンティティセットの次のクエリを使用して、似たパイプライン結果の概要レポートを作成できます。

Note

フィルターまたはレポートの目的で使用可能なプロパティを確認するには、Azure Pipelines の Metadata リファレンスを参照してください。クエリをフィルター処理したり、で使用可能なまたは値のProperty下EntityTypeNavigationPropertyBinding Pathの値のいずれかを使用してプロパティをEntitySet返したりできます。各は EntitySet に EntityType対応します。各値のデータ型の詳細については、対応する EntityTypeに指定されたメタデータを確認してください。

名前付きパイプラインのパイプライン期間

次のクエリは、指定した開始日から特定のパイプラインのパイプライン実行を返します。

Power BI クエリ
OData クエリ

次の Power BI クエリをコピーして、 Get Data>Blank クエリ ウィンドウに直接貼り付けます。詳細については、「 OData クエリを使用したサンプルレポートの概要を参照してください。

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"Pipeline/PipelineName eq '{pipelineName}' "
                &"and CompletedDate ge {startdate} "
                &") "
        &"/aggregate( "
        &"$count as TotalCount, "
            &"SucceededCount with sum as SucceededCount , "
                &"FailedCount with sum as FailedCount, "
                &"PartiallySucceededCount with sum as PartiallySucceededCount , "
            &"CanceledCount with sum as CanceledCount "
                &") "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

次の OData クエリコードを使用して、Power BI でクエリを使用する前にクエリを変更またはテストできます。詳細については、「 Power BI クエリと OData クエリを使用した接続」を参照してください。

https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?
$apply=filter(
	Pipeline/PipelineName eq '{pipelineName}'
	and CompletedDate ge {startdate}
	)
/aggregate(
	$count as TotalCount,
	SucceededCount with sum as SucceededCount ,
	FailedCount with sum as FailedCount,
	PartiallySucceededCount with sum as PartiallySucceededCount ,
	CanceledCount with sum as CanceledCount
	)

置換文字列とクエリの内訳

次の文字列を実際の値に置き換えます。置換に角かっこを {} 含めないでください。たとえば、組織名が "Fabrikam" の場合は、ではなく {Fabrikam}をにFabrikam置き換えます{organization}。

{organization} - 組織名
{project} - チームプロジェクト名
{pipelinename} - パイプライン名。例: Fabrikam hourly build pipeline
{startdate} - レポートを開始する日付。形式: YYYY-MM-DDZ。例: 2021-09-01Z は 2021 年 9 月 1 日を表します。引用符または角かっこで囲んで、月と日付の両方に 2 桁の数字を使用しないでください。

クエリの内訳

次の表では、クエリの各部分について説明します。

クエリパーツ

説明

$apply=filter(

句 filter() 開始します。

Pipeline/PipelineName eq '{pipelinename}'

指定したパイプラインのパイプライン実行を返します。

and CompletedDate ge {startdate}

返されるパイプラインは、指定した日付以降に実行されます。

)

close filter() 句

/aggregate(

フィルター条件 aggregate 一致するすべてのパイプライン実行の句を開始します。

$count as TotalCount,

実行の合計数を TotalCountとしてカウントします。

SucceededCount with sum as SucceededCount ,

成功した実行の数を SucceededCountとしてカウントします。

FailedCount with sum as FailedCount,

失敗した実行の数を FailedCountとしてカウントします。

PartiallySucceededCount with sum as PartiallySucceededCount ,

部分的に成功した実行の数を PartiallySucceededCountとしてカウントします。

CanceledCount with sum as CanceledCount

取り消された実行の数を CanceledCountとしてカウントします。

)

句 aggregate() 閉じます。

特定のパイプライン ID のパイプライン実行結果の概要

パイプラインの名前を変更できます。パイプライン名が変更されたときに Power BI レポートが中断されないようにするには、その名前ではなくパイプライン ID を使用します。パイプライン ID は、パイプラインの実行ページの URL から取得できます。

https://dev.azure.com/{organization}/{project}/_build?definitionId={pipelineid}

次のクエリは、指定した開始日から、特定のパイプライン ID に対するパイプラインの実行を返します。

Power BI クエリ
OData クエリ

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"PipelineId eq {pipelineId} "
                &"and CompletedDate ge {startdate} "
                &") "
        &"/aggregate( "
        &"$count as TotalCount, "
            &"SucceededCount with sum as SucceededCount , "
                &"FailedCount with sum as FailedCount, "
                &"PartiallySucceededCount with sum as PartiallySucceededCount , "
            &"CanceledCount with sum as CanceledCount "
                &") "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?
$apply=filter(
    PipelineId eq {pipelineId}
    and CompletedDate ge {startdate}
    )
/aggregate(
    $count as TotalCount,
    SucceededCount with sum as SucceededCount ,
    FailedCount with sum as FailedCount,
    PartiallySucceededCount with sum as PartiallySucceededCount ,
    CanceledCount with sum as CanceledCount
)

分岐でフィルター処理されたパイプライン実行の結果の概要

特定のブランチのパイプラインの結果の概要を表示するには、次のクエリを使用します。レポートを作成するには、次の手順を実行します。

BranchをBranch.BranchName
列のデータ型を変更する
ドーナツグラフレポートを作成する
Visualizations ペインから Slicer を選択し、スライサーの Field にBranch.BranchNameを追加します。
結果の概要を表示する必要があるスライサーからブランチを選択します。

Power BI クエリ
OData クエリ

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"Pipeline/PipelineName eq '{pipelinename}' "
                &"and CompletedDate ge {startdate} "
                &") "
        &"/groupby( "
        &"(Branch/BranchName), "
            &"aggregate( "
                &"$count as TotalCount, "
                &"SucceededCount with sum as SucceededCount , "
            &"FailedCount with sum as FailedCount, "
                &"PartiallySucceededCount with sum as PartiallySucceededCount , "
            &"CanceledCount with sum as CanceledCount "
        &")) "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?
$apply=filter(
    Pipeline/PipelineName eq '{pipelinename}'
    and CompletedDate ge {startdate}
    )
/groupby(
(Branch/BranchName),
aggregate(
    $count as TotalCount,
    SucceededCount with sum as SucceededCount ,
    FailedCount with sum as FailedCount,
    PartiallySucceededCount with sum as PartiallySucceededCount ,
    CanceledCount with sum as CanceledCount
    ))

ビルド理由でフィルター処理されたパイプライン実行結果の概要

特定の Build の理由 (手動/BatchedCI、Pull Request など) についてのみ、パイプラインの結果の概要を表示できます。レポートを作成するには、次の手順を実行します。

列のデータ型を変更する
ドーナツグラフレポートを作成する
Visualizations ペインから Slicer を選択し、スライサーの Field にPipeline.PipelineNameを追加します。
結果の概要を表示する必要があるスライサーからパイプラインを選択します。

Power BI クエリ
OData クエリ

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"Pipeline/PipelineName eq '{pipelinename}' "
                &"and CompletedDate ge {startdate} "
                &") "
        &"/groupby( "
        &"(RunReason), "
            &"aggregate( "
                &"$count as TotalCount, "
                &"SucceededCount with sum as SucceededCount , "
            &"FailedCount with sum as FailedCount, "
                &"PartiallySucceededCount with sum as PartiallySucceededCount , "
            &"CanceledCount with sum as CanceledCount "
        &")) "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?
$apply=filter(
    Pipeline/PipelineName eq '{pipelinename}'
    and CompletedDate ge {startdate}
    )
/groupby(
(RunReason),
aggregate(
    $count as TotalCount,
    SucceededCount with sum as SucceededCount ,
    FailedCount with sum as FailedCount,
    PartiallySucceededCount with sum as PartiallySucceededCount ,
    CanceledCount with sum as CanceledCount
))

すべてのプロジェクトパイプラインの結果の概要

すべてのプロジェクトパイプラインのパイプライン結果の概要を 1 つのレポートで表示できます。レポートを作成するには、次の手順を実行します。

PipelineをPipeline.PipelineName
列のデータ型を変更する
ドーナツグラフレポートを作成する
Visualizations ペインから Slicer を選択し、スライサーの Field にPipeline.PipelineNameを追加します。
結果の概要を表示する必要があるスライサーからパイプラインを選択します。

詳細な手順については、すべてのパイプラインの Outcome の概要サンプルレポートも参照してください。

Power BI クエリ
OData クエリ

let
   Source = OData.Feed ("https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?"
        &"$apply=filter( "
                &"CompletedDate ge {startdate} "
                &") "
                &"/groupby( "
        &"(Pipeline/PipelineName), "
        &"aggregate( "
            &"$count as TotalCount, "
                &"SucceededCount with sum as SucceededCount , "
                &"FailedCount with sum as FailedCount, "
            &"PartiallySucceededCount with sum as PartiallySucceededCount , "
                &"CanceledCount with sum as CanceledCount "
            &")) "
    ,null, [Implementation="2.0",OmitValues = ODataOmitValues.Nulls,ODataVersion = 4]) 
in
    Source

https://analytics.dev.azure.com/{organization}/{project}/_odata/v3.0-preview/PipelineRuns?
$apply=filter(
    CompletedDate ge {startdate}
    )
/groupby(
(Pipeline/PipelineName),
aggregate(
    $count as TotalCount,
    SucceededCount with sum as SucceededCount ,
    FailedCount with sum as FailedCount,
    PartiallySucceededCount with sum as PartiallySucceededCount ,
    CanceledCount with sum as CanceledCount
    ))

(省略可能)クエリの名前を変更する

既定のクエリラベル Query1 の名前を、より意味のある名前に変更できます。 [ クエリ設定] ペインから新しい名前を入力するだけです。

Power BI クエリメニューオプションのスクリーンショット。クエリの名前を変更します。

列のデータ型を変更する

Power Query エディターからTotalCount列を選択し、Transform メニューから Data Type を選択し、Whole Number を選択します。データ型の変更の詳細については、「 Transform Analytics データを使用して Power BI レポートを生成する」、列データ型の変換を参照してください。

(省略可能)列フィールドの名前を変更する

列フィールドの名前を変更できます。たとえば、列 Pipeline.PipelineName の名前を Pipeline Name に変更したり、 TotalCount を Total Count に変更したりできます。方法については、「 Rename 列フィールドを参照してください。

クエリを閉じて変更を適用する

すべてのデータ変換が完了したら、Home メニューから Close & Apply を選択してクエリを保存し、Power BI の Report タブに戻ります。

ドーナツグラフレポートを作成する

Power BI の Visualizations で、 Donut レポートを選択します。
Values に、指定した順序で次のフィールドを追加します。各フィールドを右クリックし、 Sum が選択されていることを確認します。
- CanceledCount
- PartiallySucceededCount.
- SucceededCount
- FailedCount
レポートのタイトルを変更するには、表示ペインから ビジュアルの書式設定ペイントブラシアイコンを選択し、General を選択し、Title を展開して、既存のテキストを置き換えます。

次の図は、結果のレポートを示しています。

次の方法で共有

パイプラインの結果の概要サンプルレポート

前提条件

サンプルクエリ

名前付きパイプラインのパイプライン期間

置換文字列とクエリの内訳

クエリの内訳

特定のパイプライン ID のパイプライン実行結果の概要

分岐でフィルター処理されたパイプライン実行の結果の概要

ビルド理由でフィルター処理されたパイプライン実行結果の概要

すべてのプロジェクトパイプラインの結果の概要

(省略可能)クエリの名前を変更する

列のデータ型を変更する

(省略可能)列フィールドの名前を変更する

クエリを閉じて変更を適用する

ドーナツグラフレポートを作成する

フィードバック

その他のリソース

次の方法で共有

パイプラインの結果の概要サンプル レポート

前提条件

サンプル クエリ

名前付きパイプラインのパイプライン期間

置換文字列とクエリの内訳

クエリの内訳

特定のパイプライン ID のパイプライン実行結果の概要

分岐でフィルター処理されたパイプライン実行の結果の概要

ビルド理由でフィルター処理されたパイプライン実行結果の概要

すべてのプロジェクト パイプラインの結果の概要

(省略可能)クエリの名前を変更する

列のデータ型を変更する

(省略可能)列フィールドの名前を変更する

クエリを閉じて変更を適用する

ドーナツ グラフ レポートを作成する

関連記事

フィードバック

その他のリソース

パイプラインの結果の概要サンプルレポート

サンプルクエリ

すべてのプロジェクトパイプラインの結果の概要

ドーナツグラフレポートを作成する