Referência de metadados para o Azure Pipelines Analytics

  • Artigo

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

O serviço Analytics coleta pipeline e atividade de teste gerada 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

São fornecidas descrições das entidades, propriedades e tipos enumerados suportados pelo modelo de dados do Google Analytics. Este é um rascunho inicial. Por favor, forneça comentários sobre as áreas que você gostaria de ter mais informações. 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 com a 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 Description
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) Suporta a compreensão do consumo de pipeline paralelo. 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 pipelines. Para obter um relatório de exemplo, consulte Relatório de exemplo de tendência de taxa de aprovação de pipeline.
PipelineRunActivityResults PipelineRunActivityResult Log mesclado de todos os estágios, etapas, trabalhos e tarefas dentro de uma execução de pipeline específica. 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 para pools de agentes ilustra como esse 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 propriedades a seguir são válidas para o conjunto de entidades Branchs . As chaves substitutas associadas ao Branch incluem BranchSK e ProjectSK.

Nome a apresentar Nome Tipo de dados Descrição
AnalyticsUpdatedDate DateTime 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 Vsts do repositório 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 a apresentar Nome Tipo de dados Descrição
Hospedado ou auto-hospedado IsHosted Boolean Indica se o pipeline paralelo é executado em um agente hospedado pela Microsoft (True) ou se é auto-hospedado (False). Para obter mais informações, consulte Agentes do Azure Pipelines.
Falha ao contatar todos os provedores FailedToReachAllProviders Boolean Indica se a execução do trabalho atingiu todos os provedores (True) ou não (False).
Número de trabalhos de pipelines paralelos 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 Boolean Indica se o pipeline paralelo é premium (True) ou não (False).
Data da amostra SamplingDate DateTime A data associada ao instantâneo.

Pipelines

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

Nome a apresentar Nome Tipo de dados Descrição
Pipeline Id PipelineId Int32 A ID atribuída 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 Enumerated 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 Value 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.

PipelineJobs

Um trabalho 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 trabalhos, e cada pipeline tem pelo menos um trabalho. Para obter mais informações, veja Especificar trabalhos no pipeline.

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

Nome a apresentar Nome Tipo de dados Descrição
Nome completo do trabalho do pipeline FullJobName String O nome completo de um trabalho de pipeline.
Pipeline Id PipelineId Int32 A ID atribuída ao pipeline no qual o trabalho é definido.
Identificador de trabalho de pipeline JobId String O identificador de trabalho atribuído a um trabalho de pipeline quando ele é criado.
Nome do trabalho de pipeline JobName String O nome atribuído ao trabalho de pipeline.
Nome do estágio do pipeline StageName String O nome do palco associado ao trabalho de pipeline.
Atributos da estratégia de trabalho 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 , consulte Relatório de exemplo de falhas de estágio de pipeline.

PipelineRuns

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. Uma execução de pipeline inclui trabalhos, etapas 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 e sua PipelineRunSK chave substituta.

Nome a apresentar Nome Tipo de dados Descrição
Contagem cancelada CanceledCount Int32 A contagem de execuções de pipeline que foram canceladas.
Data de Conclusão CompletedDate DateTime A data e a hora em que o pipeline conclui a execução.
Contagem com falha FailedCount Int32 A contagem de execuções de pipeline que teve sucesso.
Revisão do número RunNumberRevision Int32 O número atribuído a um pipeline é executado com execuções sequenciais.
Contagem parcialmente bem-sucedida PartiallySucceededCount Int32 A contagem de execuções de pipeline que foi parcialmente bem-sucedida.
ID de execução do pipeline PipelineRunId Int32 O número atribuído a uma execução de pipeline.
Data da fila QueuedDate DateTime A data e a hora em que o pipeline foi colocado na fila para ser executado.
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 Enumerated 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 Enumerated A condição que fez com que o pipeline fosse executado. 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 a execução do pipeline ser concluída.
Data de início StartedDate DateTime A data e a hora em que a execução do pipeline começou.
Contagem bem-sucedida SucceededCount Int32 A contagem de execuções de pipeline que teve sucesso.
Duração total segundos TotalDurationSeconds Decimal O número total de segundos em que o pipeline estava na fila e era executado.

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
Enfileirado em 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 Display name
None 0 Nenhuma
Manual 1 Manual
IndividualCI 2 IC individual
BatchedCI 4 IC em lote
Schedule 8 Agenda
UserCreated 32 Usuário criado
ValidateShelveset 64 Validar Shelveset
CheckInShelveset 128 Check In Shelveset
PullRequest 256 Pull Request
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 Display name
None 0 Nenhuma
Succeed 2 Com êxito
PartiallySucceeded 4 Parcialmente bem-sucedido
Failed 6 Com falhas
Canceled 32 Cancelada

PipelineRunActivityResults

As propriedades a seguir são válidas para o conjunto de entidades PipelineRunActivityResults e sua PipelineRunActivityResultSK chave substituta.

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

Nome a apresentar Nome Tipo de dados Descrição
Conde Abandonado AbandonedCount Int32 A contagem de condutas que foram marcadas como abandonadas.
Data de Conclusão da Atividade ActivityCompletedDate DateTime A data e a hora em que a execução do pipeline conclui a execução.
Duração da atividade Segundos ActivityDurationSeconds Decimal O número total de segundos em que o pipeline estava na fila e era executado.
Data de início da atividade ActivityStartedDate DateTime A data-hora em que a execução do pipeline começou.
Contagem cancelada CanceledCount Int32 A contagem de execuções de pipeline que foram canceladas.
Contagem com falha FailedCount Int32 A contagem de execuções de pipeline que falharam.
Tipo de atividade do pipeline ActivityType Enumerated 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 Enumerated 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.
Tempo de início relativo a partir de segundos de estágio 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 executada.
Contagem ignorada SkippedCount Int32 A contagem de execuções de pipeline que foram ignoradas.
Contagem bem-sucedida SucceededCount Int32 A contagem de execuções de pipeline que teve sucesso.
bem-sucedido com a contagem de problemas SucceededWithIssuesCount Int32 A contagem de execuções de pipeline que foi parcialmente bem-sucedida.
Nome de exibição da tarefa TaskDisplayName String Nome de uma tarefa executada na 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, consulte Relatório de tendência de tendência de duração da tarefa de pipeline.

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

Nome a Apresentar 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 Display name
Task 0 Task
Approval 1 Approval
AgentWait 2 Espera do agente

PipelineTasks

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

Nome a apresentar 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.

TaskAgentPoolSizeSnapshots

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

Nome a apresentar Nome da propriedade Tipo de dados Descrição
Contagem Online OnlineCount Int32 O número de agentes online no pool 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.
Pool Id PoolId Int32 O número atribuído ao pool de agentes.
Data da amostra SamplingDate DateTime A data e a hora em que o tamanho do pool foi ajustado.

Para obter um relatório de exemplo criado a partir da entidade TaskAgentPoolSizeSnapshot, consulte Gráfico histórico para pools de agentes (Visualização).

TaskAgentRequestSnapshots

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 propriedades a seguir são válidas para o tipo de entidade TaskAgentRequestSnapshot e suas chaves SamplingTime substitutas e SamplingDateSK.

Nome a apresentar Nome Tipo de dados Descrição
Compilação em fila IsQueued Boolean Indica se a compilação está enfileirada (True) ou não na fila (False).
Construir em execução IsRunning Boolean Indica se a compilação está em execução (True) ou não está em execução (False).
Hospedado ou auto-hospedado IsHosted Boolean Indica se o agente atribuído à tarefa está hospedado (True) ou auto-hospedado (False).
Data de Fim do Trabalho FinishedDate DateTime 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 DateTime A data-hora em que a solicitação do agente de tarefa foi enfileirada.
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.
Pool Id PoolId Int32 O número atribuído ao pool de agentes atribuído à 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 DateTime A data-hora em que a solicitação do agente de tarefa foi recebida.
Data de início StartedDate DateTime 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
Enfileirado em QueuedOn QueuedDateSK DateSK
Gasoduto Pipeline PipelineSK PipelineSK
Projeto Project ProjectSK ProjectSK
Iniciado em StartedOn QueuedDateSK DateSK