Relatório de amostra de resumo de resultados de pipeline

  • Artigo

Serviços de DevOps do Azure | 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 Êxito, Reprovação, Cancelamento e Êxito Parcial. Para criar relatórios que mostrem 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 ecrã do relatório de Resumo de Resultados dos Pipelines do Power BI.

Importante

A integração do Power BI e o acesso ao feed OData do Serviço de Análise estão geralmente disponíveis para os Serviços de DevOps do Azure e o Azure DevOps Server 2020 e versões posteriores. As consultas de exemplo fornecidas neste artigo são válidas apenas no Azure DevOps Server 2020 e versões posteriores e dependem da versão v3.0-preview ou posterior. Nós encorajamos você a usar essas consultas e nos fornecer feedback.

Pré-requisitos

  • Acesso: Ser membro de um projeto com pelo menos acesso Básico .
  • Permissões: por predefinição, os membros do projeto têm permissão para consultar o Analytics e criar vistas.
  • Para obter mais informações sobre outros pré-requisitos relacionados com a ativação de serviços e funcionalidades e atividades gerais de monitorização de dados, consulte Permissões e pré-requisitos para aceder ao Analytics.

Nota

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

Consultas de amostra

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

Nota

Para determinar as propriedades disponíveis para fins de filtro ou relatório, consulte Referência de metadados para Pipelines do Azure. 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 um corresponde a um EntityTypearquivo . Para obter mais informações sobre o tipo de dados de cada valor, revise os metadados fornecidos para o .EntityType

Duração do pipeline para um pipeline nomeado

As consultas a seguir retornam que o pipeline é executado para um pipeline específico a partir de uma data de início especificada.

Copie e cole a seguinte consulta do Power BI diretamente na janela Obter Consulta em Branco de Dados>. Para obter mais informações, consulte 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 seguintes cadeias de caracteres por seus valores. Não inclua parênteses com a {} sua substituição. Por exemplo, se o nome da sua organização for "Fabrikam", substitua {organization} por Fabrikam, não {Fabrikam}.

  • {organization} - Nome da sua organização
  • {project} - O nome do seu projeto de equipa
  • {pipelinename} - O nome do seu pipeline. Exemplo: Fabrikam hourly build pipeline
  • {startdate} - A data para iniciar o seu relatório. Formato: AAAA-MM-DDZ. Exemplo: 2021-09-01Z representa 1º de setembro de 2021. Não coloque entre aspas ou parênteses e use dois dígitos para ambos, 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 inicial 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 encerramento filter()

/aggregate(

Cláusula 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 um ID de pipeline específico

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 o ID do pipeline na URL da página de execução do pipeline.

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

As consultas a seguir retornam que o pipeline é executado para uma ID de pipeline específica e a partir de uma data de início especificada.

Copie e cole a seguinte consulta do Power BI diretamente na janela Obter Consulta em Branco de Dados>. Para obter mais informações, consulte 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 ramificação

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

Copie e cole a seguinte consulta do Power BI diretamente na janela Obter Consulta em Branco de Dados>. Para obter mais informações, consulte 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 compilação

Você pode querer exibir o resumo de resultados de um pipeline apenas para Motivos de Compilação específicos (Manual / BatchedCI, Pull Request e assim por diante). Para criar o relatório, execute as seguintes etapas:

Copie e cole a seguinte consulta do Power BI diretamente na janela Obter Consulta em Branco de Dados>. Para obter mais informações, consulte 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 dos resultados de todas as reservas de projetos

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

  • Expanda Pipeline para Pipeline.PipelineName
  • Alterar o tipo de dados da coluna
  • Criar o relatório do gráfico Donut
  • Selecione Segmentação de Dados no painel Visualizações e adicione o Pipeline.PipelineName ao Campo da segmentação de dados
  • Selecione o pipeline na segmentação de dados para o qual você precisa ver o resumo do resultado.

Consulte também Resumo dos resultados do relatório de amostra de todos os pipelines para obter etapas detalhadas.

Copie e cole a seguinte consulta do Power BI diretamente na janela Obter Consulta em Branco de Dados>. Para obter mais informações, consulte 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 ecrã das opções do menu de consulta do Power BI, consulta de mudança de nome.

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 as alterações

Depois de concluir todas as suas transformações de dados, escolha Fechar & Aplicar no menu Início para salvar a consulta e retornar à guia Relatório no Power BI.

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

Criar o relatório do gráfico Donut

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

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

  2. Adicione os seguintes campos a Valores, na ordem indicada. Clique com o botão direito do rato em cada campo e certifique-se de que a opção Soma está selecionada.

    • CanceledCount
    • PartiallySucceededCount.
    • SucceededCount
    • FailedCount

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

    Captura de ecrã 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 ecrã do relatório de Resumo de Resultados de Pipelines de exemplo do Power BI.