Partilhar via

Referência de metadados para o Azure Pipelines Analytics

Serviços de DevOps do Azure | Azure DevOps Server | Azure DevOps Server 2022

O serviço Analytics recolhe o pipeline e a atividade de teste geradas por meio do Azure Pipelines. Este artigo descreve as propriedades que você pode usar para gerar um relatório do Google Analytics para pipelines. Você usa uma combinação de propriedades para filtrar uma consulta, agregar dados ou criar um relatório.

Nota

Este artigo fornece descrições de entidades, propriedades e tipos enumerados suportados pelo modelo de dados do Google Analytics. Para consultar o modelo de dados, consulte Construir consultas OData para Analytics.

Conjuntos de entidades e tipos de entidades

A tabela a seguir resume os tipos de entidade e os conjuntos de entidades que dão suporte aos Pipelines do Azure. Todos os tipos de entidade/conjuntos de entidades estão disponíveis na versão de visualização do Analytics v4.0. A versão do Google Analytics v3.0-preview não suporta instantâneos.

Conjunto de Entidades Tipo de entidade Descrição
Sucursais Ramo Informações básicas sobre ramificações usadas em testes ou pipelines. Para obter um relatório de exemplo, consulte Relatório de exemplo de status de progresso.
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (Composto) Ajuda a compreender o consumo de processos paralelos em pipeline. Para obter mais informações sobre testes de pipeline paralelo, consulte Executar testes em paralelo usando a tarefa de teste do Visual Studio.
Pipelines Gasoduto Propriedades de um pipeline.
PipelineJobs PipelineJob Resultados de execução individuais para um teste específico associado a um TestRun
PipelineRuns PipelineRun Informações de execução para processos em pipeline. Para obter um relatório de exemplo, consulte o Relatório exemplo de tendência da taxa de aprovação da pipeline.
PipelineRunActivityResults PipelineRunActivityResult Log fusionado de todos os estágios, etapas, trabalhos e tarefas dentro de uma execução de um pipeline específico. Para obter um relatório de exemplo, consulte Relatório de exemplo de duração da tarefa de pipeline.
PipelineTasks PipelineTask Propriedades para tarefas que são usadas dentro de um pipeline.
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (Composto) Suporta a compreensão do tamanho do pool, trabalhos de pipeline e simultaneidade. O gráfico histórico de pools de agentes ilustra como este conjunto de entidades pode ser usado.
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (Composto) Suporta a geração de relatórios sobre solicitações de agentes de tarefas.

Ramos

As seguintes propriedades são válidas para o conjunto de entidades Branches. As chaves substitutas associadas ao Branch incluem BranchSK e ProjectSK.

Nome de exibição Nome Tipo de dados Descrição
AnalyticsUpdatedDate Data e Hora Marca d'água que indica a última vez que os dados do Google Analytics foram atualizados.
Nome da filial BranchName String O nome atribuído a uma ramificação quando ela é criada.
ID do repositório RepositoryId String O número atribuído a um repositório quando ele é criado.
ID do Repositório Vsts RepositoryVstsId String O número atribuído a um repositório TFVC quando ele é criado.
RepositoryUrl RepositoryUrl String A URL definida para um repositório quando ele é criado.

As propriedades de navegação incluem Project e sua restrição ProjectSKreferencial.

ParallelPipelineJobsSnapshot

As propriedades a seguir são válidas para o conjunto de entidades ParallelPipelineJobsSnapshot . As chaves de referência incluem:

  • IsHosted
  • ParallelismTag
  • SamplingDate
Nome de exibição Nome Tipo de dados Descrição
Hospedado ou autónomo IsHosted booleano Indica se o pipeline paralelo é executado em um agente hospedado pela Microsoft (True) ou se é auto-hospedado (False). Para obter mais informações, veja Agentes do Azure Pipelines.
Falha ao contatar todos os provedores FailedToReachAllProviders booleano Indica se a execução do trabalho atingiu todos os provedores (True) ou não (False).
Número de trabalhos de linhas de produção paralelas TotalCount Int32 O número de trabalhos executados como parte do snapshot.
Número de minutos de pipelines paralelos TotalMinutes Int32 O número de minutos necessários para executar o instantâneo.
Tipo de paralelismo ParallelismTag String Uma tag que indica o tipo de paralelismo associado ao instantâneo de trabalho.
Tipo Premium IsPremium booleano Indica se o pipeline paralelo é premium (True) ou não (False).
Data da amostra SamplingDate Data e Hora A data associada ao instantâneo.

Pipelines

As propriedades a seguir são válidas para Pipelines e sua chave PipelineSKsubstituta.

Nome de exibição Nome Tipo de dados Descrição
Pipeline Id PipelineId Int32 O ID atribuído ao pipeline.
Nome do pipeline PipelineName String O nome atribuído ao pipeline.
Versão do pipeline PipelineVersion Int32 A versão associada ao pipeline.
Tipo de processo de pipeline PipelineProcessType Enumerado O tipo de definição de pipeline. Os valores válidos estão listados abaixo para PipelineProcessType.

As propriedades de navegação incluem Project e sua restrição ProjectSKreferencial.

Membros do tipo enumerado PipelineProcessType

Os membros a seguir são definidos para o tipo enumerado PipelineProcessType que indica o método usado para definir o pipeline.

Nome do membro Valor Definição
Designer 1 Definição clássica de pipeline.
Yaml 2 Definição de pipeline YAML.
Docker 3 Definição de pipeline do Docker.

Empregos de Pipeline

Uma tarefa de pipeline é uma série de etapas executadas sequencialmente como uma unidade. Um trabalho é a menor unidade de trabalho que você pode programar para executar. Os pipelines são organizados em torno de tarefas, e cada pipeline tem pelo menos uma tarefa. Para obter mais informações, consulte Especificar trabalhos no pipeline.

As propriedades a seguir são válidas para PipelineJobs e sua chave substituta PipelineJobSK .

Nome de exibição Nome Tipo de dados Descrição
Nome completo da tarefa do pipeline FullJobName String O nome completo de um trabalho de pipeline.
Pipeline Id PipelineId Int32 O ID atribuído ao pipeline no qual a tarefa é definida.
Identificador de tarefa de pipeline JobId String O identificador da tarefa atribuído a uma tarefa de pipeline na sua criação.
Nome da tarefa de pipeline JobName String O nome atribuído ao trabalho de pipeline.
Nome do estágio do pipeline StageName String O nome da etapa associado à tarefa de pipeline.
Atributos da estratégia de tarefas de pipeline StrategyAttributes String Os atributos definidos para o trabalho de pipeline.
Identificador de estágio StageId String O identificador de estágio associado ao trabalho de pipeline.

As propriedades de navegação incluem Project e sua restrição ProjectSKreferencial.

Para obter um relatório de exemplo que consulta o tipo de entidade PipelineJob, veja Relatório de exemplo de falhas por estágio do pipeline.

PipelineRuns

Um processo de pipeline refere-se a uma única execução de um fluxo de trabalho. Durante uma execução, o pipeline é processado e os agentes processam uma ou mais tarefas. Uma execução de um pipeline inclui trabalhos, passos e tarefas. Para obter mais informações, consulte Sequência de execução de pipeline.

As propriedades a seguir são válidas para o tipo de entidade PipelineRun.

Nome de exibição Nome Tipo de dados Descrição
Número Cancelado CanceledCount Int32 A contagem de execuções de pipeline que foram canceladas.
Data de Conclusão CompletedDate Data e Hora A data e a hora em que o pipeline conclui a execução.
Contagem Falhada FailedCount Int32 A contagem das execuções de pipeline que tiveram sucesso.
Revisão de Números RunNumberRevision Int32 O número atribuído a um pipeline é executado com execuções sequenciais.
Número de Sucessos Parciais PartiallySucceededCount Int32 A contagem de execuções de pipeline que foram parcialmente bem-sucedidas.
ID de execução do pipeline PipelineRunId Int32 O número atribuído para uma execução de pipeline.
Data da fila QueuedDate Data e Hora A data e a hora em que o pipeline foi colocado na fila para execução.
Segundos de duração da fila QueueDurationSeconds Decimal O número de segundos que o pipeline permaneceu na fila.
Número de execução RunNumber String O número atribuído a um pipeline é executado quando ele é executado.
Resultado da execução RunOutcome Enumerado O resultado atribuído a um pipeline após a conclusão de sua execução. Os valores válidos estão listados abaixo para PipelineRunOutcome.
Motivo da execução RunReason Enumerado A condição que fez com que o pipeline fosse operado. Os valores válidos estão listados abaixo para PipelineRunReason.
Segundos de duração da execução RunDurationSeconds Decimal O número de segundos que levou para concluir a execução do pipeline.
Data de início StartedDate Data e Hora A data e a hora em que a execução do pipeline começou.
Contagem de Sucessos SucceededCount Int32 A contagem das execuções de pipeline que tiveram sucesso.
Duração total segundos TotalDurationSeconds Decimal O número total de segundos em que o pipeline estava na fila e em execução.

As seguintes propriedades de navegação são suportadas.

Nome a apresentar Nome -Restrição referencial Propriedade referenciada
Ramo Branch BranchSK BranchSK
Concluído em CompletedOn CompletedDateSK DateSK
Na fila desde QueuedOn QueuedDateSK DateSK
Iniciado em StartedOn QueuedDateSK DateSK
Gasoduto Pipeline PipelineSK PipelineSK
Projeto Project ProjectSK ProjectSK

Membros do tipo enumerado PipelineRunReason

Os membros a seguir são definidos para o tipo enumerado PipelineRunReason que indica as condições sob as quais cada estágio, trabalho ou etapa do pipeline é executado conforme descrito em Especificar condições.

Nome do membro Valor Nome a apresentar
None 0 Nenhuma
Manual 1 Manual
IndividualCI 2 IC Individual
BatchedCI 4 IC em lote
Schedule 8 Horário
UserCreated 32 Usuário criado
ValidateShelveset 64 Validar Shelveset
CheckInShelveset 128 Prateleiras de Check-In
PullRequest 256 Pedido de Pull
PipelineRunCompletion 512 Conclusão da construção

Membros do tipo enumerado PipelineRunOutcome

Os membros a seguir são definidos para o PipelineRunOutcome tipo enumerado que indica o resultado de uma execução de pipeline.

Nome do membro Valor Nome a apresentar
None 0 Nenhuma
Succeed 2 Com êxito
PartiallySucceeded 4 Parcialmente bem-sucedido
Failed 6 Com falhas
Canceled 32 Cancelada

Resultados da Atividade de Execução de Pipeline

As propriedades a seguir são válidas para o conjunto de entidades PipelineRunActivityResults.

Muitas propriedades são dependentes de data ou do utilizador. Essas propriedades estão associadas aos conjuntos de entidades CalendarDate e User, descritos em Referência de metadados de data de calendário, projeto e usuário.

Nome de exibição Nome Tipo de dados Descrição
Contagem de Abandonos AbandonedCount Int32 A contagem de condutas que foram marcadas como abandonadas.
Data de Conclusão da Atividade ActivityCompletedDate Data e Hora A data e a hora em que a execução do pipeline fica concluída.
Duração da atividade Segundos ActivityDurationSeconds Decimal O número total de segundos em que o pipeline estava na fila e em execução.
Data de início da atividade ActivityStartedDate Data e Hora A data e hora em que a execução do pipeline começou.
Número Cancelado CanceledCount Int32 A contagem de execuções de pipeline que foram canceladas.
Contagem Falhada FailedCount Int32 A contagem das execuções de pipeline que falharam.
Tipo de atividade do pipeline ActivityType Enumerado O tipo de atividade do gasoduto. Os valores válidos estão listados abaixo para PipelineActivityType.
ID de execução do pipeline PipelineRunId Int32 O número atribuído a um pipeline é executado quando ele é executado.
Resultado da execução do pipeline PipelineRunOutcome Enumerado O resultado atribuído a um pipeline após a conclusão de sua execução. Os valores válidos estão listados em PipelineRunOutcome.
Tempo de início relativo a partir de segundos de trabalho RelativeStartTimeFromJobSeconds Int32 O número de segundos decorridos desde o início do trabalho.
Hora de início relativa a partir de segundos de fase RelativeStartTimeFromStageSeconds Int32 O número de segundos decorridos desde o início da etapa.
Tempo de início relativo a partir de segundos de execução RelativeStartTimeFromRunSeconds Int32 O número de segundos decorridos a partir do momento em que a execução foi realizada.
Contagem ignorada SkippedCount Int32 A contagem das execuções de pipeline que ficaram por realizar.
Contagem de Sucessos SucceededCount Int32 A contagem das execuções de pipeline que tiveram sucesso.
bem-sucedido com a contagem de problemas SucceededWithIssuesCount Int32 A contagem de execuções de pipeline que foram parcialmente bem-sucedidas.
Nome de exibição da tarefa TaskDisplayName String Nome de uma tarefa executada durante a execução do pipeline.
Caminho do Log de Tarefas TaskLogPath String O caminho do arquivo de log gerado por uma tarefa.
Resultado da Tarefa TaskOutcome Personalizado O resultado da tarefa que foi executada.

Para relatórios de exemplo que consultam o tipo de entidade PipelineRunActivityResult, veja relatório de exemplo de tendência da duração da tarefa de pipeline.

As propriedades de navegação incluem as listadas na tabela a seguir.

Nome de Exibição Nome Restrição referencial Propriedade referenciada
Atividade iniciada em ActivityStartedOn ActivityStartedDateSK DateSK
Ramo Branch BranchSK BranchSK
Gasoduto Pipeline PipelineSK PipelineSK
Tarefa de pipeline PipelineTask PipelineTaskSK PipelineTaskSK
Trabalho de pipeline PipelineJob PipelineJobSK PipelineJobSK
Pipeline executado na fila PipelineRunQueuedOn PipelineRunQueuedDateSK DateSK
Execução de pipeline iniciada em PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Execução do pipeline concluída em PipelineRunCompletedOn PipelineRunCompletedDateSK DateSK
Execução de pipeline iniciada em PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Projeto Project ProjectSK ProjectSK

Membros do tipo enumerado PipelineActivityType

Os membros a seguir são definidos para o PipelineActivityType tipo enumerado.

Nome do membro Valor Nome a apresentar
Task 0 Tarefa
Approval 1 Aprovação
AgentWait 2 Tempo de espera do agente

Tarefas de Pipeline

As propriedades a seguir são válidas para o conjunto de entidades PipelineTasks.

Nome de exibição Nome Tipo de dados Descrição
ID de Definição de Tarefa TaskDefinitionId GUID O GUID atribuído a uma tarefa de pipeline.
Versão de definição de tarefa TaskDefinitionVersion String A versão atribuída a uma tarefa de pipeline.

As propriedades de navegação incluem Project e sua restrição ProjectSKreferencial.

Instantâneos do Tamanho do Pool do Agente de Tarefas

As propriedades a seguir são válidas para o conjunto de entidades TaskAgentPoolSizeSnapshots.

Nome de exibição Nome da propriedade Tipo de dados Descrição
Contagem Online OnlineCount Int32 O número de agentes online no conjunto de agentes quando a tarefa foi executada.
Contagem offline OfflineCount Int32 O número de agentes offline no pool de agentes quando a tarefa foi executada.
Identificação da Piscina PoolId Int32 O número atribuído ao pool de agentes.
Data da amostra SamplingDate Data e Hora A data e a hora em que o tamanho do pool foi ajustado.

Para obter um relatório de exemplo baseado na entidade TaskAgentPoolSizeSnapshot, consulte Gráfico histórico para pools de agentes (Pré-visualização).

Instantâneos de Pedidos de Agente de Tarefas

Os pools de agentes são alocados quando uma tarefa é executada. O conjunto de entidades TaskAgentRequestSnapshots captura dados relacionados às solicitações do agente de tarefas.

As seguintes propriedades são válidas para o tipo de entidade TaskAgentRequestSnapshot e suas chaves substitutas SamplingTime e SamplingDateSK.

Nome de exibição Nome Tipo de dados Descrição
Compilação em fila IsQueued booleano Indica se a compilação está na fila (True) ou não está na fila (False).
Build em Execução IsRunning booleano Indica se a compilação está em execução (True) ou não está em execução (False).
Hospedado ou autónomo IsHosted booleano Indica se o agente atribuído à tarefa está hospedado (True) ou auto-hospedado (False).
Data de Fim do Trabalho FinishedDate Data e Hora A data-hora em que a solicitação do agente de tarefa terminou de ser executada.
FinishedDateSK Int32 A data em que a solicitação do agente de tarefa terminou de ser executada, expressa como YYYYMMDD no fuso horário definido para a organização.
Data da fila QueuedDate Data e Hora A data-hora em que a solicitação do agente de tarefas foi colocada na fila.
QueuedDateSK Int32 A data em que a solicitação do agente de tarefa foi enfileirada, expressa como YYYYMMDD no fuso horário definido para a organização.
Segundos de duração da fila QueueDurationSeconds Decimal O número de segundos que a solicitação do agente de tarefa permaneceu na fila antes que um agente fosse atribuído.
Identificação da Piscina PoolId Int32 O número atribuído ao pool de agentes na solicitação do agente de tarefa.
Tipo de pipeline PipelineType String O tipo de pipeline que contém a solicitação do agente de tarefa.
ID do pedido RequestId Int64 O número atribuído à solicitação do agente de tarefa.
Hora da amostra SamplingHour Int32 O número atribuído à hora em que a solicitação foi recebida.
Tempo da amostra SamplingTime Data e Hora A data-hora em que a solicitação do agente de tarefa foi recebida.
Data de início StartedDate Data e Hora A data-hora em que a solicitação do agente de tarefa foi executada.
StartedDateSK Int32 A data em que a solicitação do agente de tarefa iniciou a execução, expressa como YYYYMMDD no fuso horário definido para a organização.

As propriedades de navegação incluem as listadas na tabela a seguir.

Nome a apresentar Nome Restrição referencial -Propriedade referenciada
Ramo Branch BranchSK BranchSK
Concluído em CompletedOn CompletedDateSK DateSK
Hora de Fim do Trabalho FinishedOn FinishedDateSK DateSK
Na fila desde QueuedOn QueuedDateSK DateSK
Gasoduto Pipeline PipelineSK PipelineSK
Projeto Project ProjectSK ProjectSK
Iniciado em StartedOn QueuedDateSK DateSK
  • Last updated on