Relatório de exemplo de resumo do resultado do pipeline

  • Artigo

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

Uma execução de pipeline representa uma única execução de um pipeline. Durante uma execução, o pipeline é processado e os agentes processam um ou mais trabalhos. Os resultados incluem Bem-sucedido, Reprovado, Cancelado e Parcialmente Bem-sucedido. Para criar relatórios que mostram os resultados das execuções de pipeline, consulte o ''PipelineRuns entity set.

Este artigo fornece várias consultas e instruções sobre como criar um relatório para obter o número de execuções para diferentes resultados de pipeline.

A imagem a seguir mostra um exemplo de um relatório de resumo de resultados.

Captura de tela do relatório Resumo do resultado do Power BI Pipelines.

Importante

A integração do Power BI e o acesso ao feed OData do Serviço de Análise estão em disponibilidade geral para Azure DevOps Services e Azure DevOps Server 2020 e versões posteriores. As consultas de exemplo fornecidas neste artigo são válidas somente em Azure DevOps Server 2020 e versões posteriores e dependem da versão prévia v3.0 ou posterior. Incentivamos você a usar essas consultas e nos fornecer comentários.

Pré-requisitos

  • Nível de acesso: você deve ser membro de um projeto com acesso básico ou superior.
  • Permissão: por padrão, os membros do projeto têm permissão para consultar o Analytics e criar vistas da propriedade.
  • Para obter mais informações sobre outros pré-requisitos relacionados à ativação de serviços e recursos e atividades gerais de rastreamento de dados, consulte Permissões e pré-requisitos para acessar o Analytics.

Observação

Este artigo pressupõe que você tenha lido Visão geral de relatórios de exemplo usando consultas OData e tenha uma compreensão básica do Power BI.

Consultas de exemplo

Você pode usar as consultas a seguir do conjunto de entidades para criar relatórios de resumo de resultados de PipelineRuns pipeline diferentes, mas semelhantes.

Observação

Para determinar as propriedades disponíveis para fins de filtro ou relatório, consulte Referência de metadados para Azure Pipelines. Você pode filtrar suas consultas ou retornar propriedades usando qualquer um dos Property valores em um EntityType ou NavigationPropertyBinding Path valores disponíveis com um EntitySet. Cada EntitySet corresponde a um EntityType. Para obter mais informações sobre o tipo de dados de cada valor, examine os metadados fornecidos para o EntityType.

Duração do pipeline para um pipeline nomeado

As consultas a seguir retornam as execuções de pipeline para um pipeline específico a partir de uma data de início especificada.

Você pode colar a consulta do Power BI listada abaixo diretamente na janela Obter Consulta em Branco de> Dados . Para obter mais informações, examine Visão geral de relatórios de exemplo usando consultas 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

Cadeias de caracteres de substituição e detalhamento de consulta

Substitua as cadeias de caracteres a seguir pelos valores. Não inclua colchetes {} com sua substituição. Por exemplo, se o nome da sua organização for "Fabrikam", substitua por {organization}Fabrikam, não {Fabrikam}.

  • {organization} - Nome da sua organização
  • {project} - Nome do seu projeto de equipe
  • {pipelinename} - Nome do pipeline. Exemplo: Fabrikam hourly build pipeline
  • {startdate} - A data para iniciar seu relatório. Formato: AAAA-MM-DDZ. Exemplo: 2021-09-01Z representa 1º de setembro de 2021. Não coloque entre aspas ou colchetes e use dois dígitos para mês e data.

Detalhamento da consulta

A tabela a seguir descreve cada parte da consulta.

Parte da consulta

Descrição

$apply=filter(

Cláusula de início filter() .

Pipeline/PipelineName eq '{pipelinename}'

O pipeline de retorno é executado para o pipeline especificado.

and CompletedDate ge {startdate}

O pipeline de retorno é executado na data especificada ou após ela.

)

Cláusula de fechamento filter()

/aggregate(

Start aggregate para todas as execuções de pipeline que correspondem aos critérios de filtro.

$count as TotalCount,

Conte o número total de execuções como TotalCount.

SucceededCount with sum as SucceededCount ,

Conte o número de execuções bem-sucedidas como SucceededCount.

FailedCount with sum as FailedCount,

Conte o número de execuções com falha como FailedCount.

PartiallySucceededCount with sum as PartiallySucceededCount ,

Conte o número de execuções parcialmente bem-sucedidas como PartiallySucceededCount.

CanceledCount with sum as CanceledCount

Conte o número de execuções canceladas como CanceledCount.

)

Cláusula de fechamento aggregate() .

Resumo do resultado da execução do pipeline para uma ID de pipeline específica

Os pipelines podem ser renomeados. Para garantir que os relatórios do Power BI não sejam interrompidos quando um nome de pipeline for alterado, use a ID do pipeline em vez de seu nome. Você pode obter a ID do pipeline na URL da página de execuções de pipeline.

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

As consultas a seguir retornam as execuções de pipeline para uma ID de pipeline específica e de uma data de início especificada.

Você pode colar a consulta do Power BI listada abaixo diretamente na janela Obter Consulta em Branco de> Dados . Para obter mais informações, examine Visão geral de relatórios de exemplo usando consultas 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

Resumo do resultado da execução do pipeline filtrado por branch

Para exibir o resumo do resultado de um pipeline para uma ramificação específica, use as consultas a seguir. Para criar o relatório, execute as seguintes etapas:

Você pode colar a consulta do Power BI listada abaixo diretamente na janela Obter Consulta em Branco de> Dados . Para obter mais informações, examine Visão geral de relatórios de exemplo usando consultas 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

Resumo do resultado da execução do pipeline filtrado por motivo de build

Talvez você queira exibir o resumo do resultado de um pipeline apenas por motivos de build específicos (Manual/BatchedCI, Pull Request e assim por diante). Para criar o relatório, execute as seguintes etapas:

Você pode colar a consulta do Power BI listada abaixo diretamente na janela Obter Consulta em Branco de> Dados . Para obter mais informações, examine Visão geral de relatórios de exemplo usando consultas 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

Resumo do resultado para todos os pipelines de projeto

Talvez você queira exibir o resumo do resultado do pipeline para todos os pipelines de projeto em um único relatório. Para criar o relatório, execute as seguintes etapas:

Consulte também Resumo do resultado para todos os pipelines

Você pode colar a consulta do Power BI listada abaixo diretamente na janela Obter Consulta em Branco de> Dados . Para obter mais informações, examine Visão geral de relatórios de exemplo usando consultas 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

(Opcional) Renomear consulta

Você pode renomear o rótulo de consulta padrão, Query1, para algo mais significativo. Basta inserir um novo nome no painel Configurações de Consulta .

Captura de tela das opções de menu de consulta do Power BI, renomear consulta.

Alterar o tipo de dados da coluna

No Editor do Power Query, selecione a TotalCount coluna e, em seguida, selecione Tipo de Dados no menu Transformar e escolha Número Inteiro. Para obter mais informações sobre como alterar o tipo de dados, consulte Transformar dados do Analytics para gerar relatórios do Power BI, Transformar um tipo de dados de coluna.

(Opcional) Renomear campos de coluna

Você pode renomear campos de coluna. Por exemplo, você pode renomear a coluna Pipeline.PipelineName para Pipeline Name, ou TotalCount para Total Count. Para saber como, consulte Renomear campos de coluna.

Feche a consulta e aplique suas alterações

Depois de concluir todas as transformações de dados, escolha Fechar e Aplicar no menu Página Inicial para salvar a consulta e retornar à guia Relatório no Power BI.

Captura de tela da opção Fechar e Aplicar Editor do Power Query.

Criar o relatório de gráfico de rosca

  1. No Power BI, em Visualizações, escolha o relatório Donut .

    Captura de tela das seleções de campos de visualização para todas as execuções de pipeline relatório.

  2. Adicione os seguintes campos a Valores, na ordem indicada. Clique com o botão direito do mouse em cada campo e verifique se a Soma está selecionada.

    • CanceledCount
    • PartiallySucceededCount.
    • SucceededCount
    • FailedCount

  3. Para alterar o título do relatório, selecione o ícone Formatar seu pincel visual no painel Visualizações , selecione Geral, expanda Título e substitua o texto existente.

    Captura de tela do painel Visualizações, Opções de formato de relatório, alterar título.

    A imagem a seguir mostra o relatório resultante.

    Captura de tela do relatório de Resumo de Resultados de Pipelines de exemplo do Power BI.