Share via

Referência de metadados para o Azure Pipelines Analytics

  • Artigo

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

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

Observação

Descrições das entidades, propriedades e tipos enumerados compatíveis com o modelo de dados do Analytics são fornecidas. Este é um rascunho antecipado. 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 Análise.

Conjuntos de entidades e tipos de entidade

A tabela a seguir resume os tipos de entidade e os conjuntos de entidades que dão suporte ao Azure Pipelines. Todos os tipos de entidade/conjuntos de entidades estão disponíveis com a versão prévia do Analytics v4.0 . A versão de análise v3.0-preview não dá suporte a instantâneos.

Entityset EntityType Descrição
Branches Branch Informações básicas sobre branches usados em testes ou pipelines. Para obter um relatório de exemplo, consulte Relatório de exemplo de progresso status.
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (Composição) Dá suporte à compreensão do consumo de pipeline paralelo. Para saber mais sobre testes de pipeline paralelos, consulte Executar testes em paralelo usando a tarefa teste do Visual Studio.
Pipelines Pipeline 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 em 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 em um pipeline.
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (Composição) Dá suporte à compreensão do tamanho do pool, dos trabalhos de pipeline e da simultaneidade. O grafo Histórico para pools de agentes ilustra como esse conjunto de entidades pode ser usado.
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (Composição) Dá suporte a relatórios sobre solicitações do agente de tarefa.

Branches

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

Nome de exibição Nome Data type Descrição
AnalyticsUpdatedDate Datetime Marca d'água que indica a última vez em que os dados do Analytics foram atualizados.
Nome do branch BranchName String O nome atribuído a um branch quando ele é criado.
ID do repositório RepositoryId String O número atribuído a um repositório quando ele é criado.
ID de 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 ela é criada.

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 Data type Descrição
Hospedado ou auto-hospedado IsHosted Boolean Indica se o pipeline paralelo é executado em um agente hospedado pela Microsoft (True) ou é auto-hospedado (False). Para saber mais, confira Agentes do Azure Pipelines.
Falha ao alcançar 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 instantâneo.
Número de minutos de pipelines paralelos TotalMinutes Int32 O número de minutos para executar o instantâneo.
Tipo de paralelismo ParallelismTag String Uma marca que indica o tipo de paralelismo associado ao trabalho instantâneo.
Tipo Premium IsPremium Boolean Indica se o pipeline paralelo é premium (True) ou não (False).
Data de exemplo SamplingDate Datetime A data associada ao instantâneo.

Pipelines

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

Nome de exibição Nome Data type 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 PipelineProcessType tipo enumerado que indica o método usado para definir o pipeline.

Nome do membro Valor Definição
Designer 1 Definição de pipeline clássico.
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 que são executadas sequencialmente como uma unidade. Um trabalho é a menor unidade de trabalho que você pode agendar para executar. Os pipelines são organizados em torno de trabalhos e cada pipeline tem pelo menos um trabalho. Para saber mais, confira Especificar trabalhos em seu pipeline.

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

Nome de exibição Nome Data type 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 do pipeline JobName String O nome atribuído ao trabalho de pipeline.
Nome do estágio do pipeline StageName String O nome do estágio associado ao trabalho de pipeline.
Atributos de 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 no estágio do 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 saber mais, confira 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 alternativa.

Nome de exibição Nome Data type 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 de falha FailedCount Int32 A contagem de execuções de pipeline bem-sucedidas.
Revisão de Número RunNumberRevision Int32 O número atribuído a uma execução de pipeline com execuções sequenciais.
Contagem parcialmente bem-sucedida PartiallySucceededCount Int32 A contagem de execuções de pipeline parcialmente bem-sucedidas.
ID de Execução de 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 enfileirado para ser executado.
Segundos de Duração da Fila QueueDurationSeconds Decimal O número de segundos em que o pipeline permaneceu na fila.
Número de Execução RunNumber String O número atribuído a uma execução de pipeline 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 seja 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 necessários 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 bem-sucedidas.
Total de Segundos de Duração TotalDurationSeconds Decimal O número total de segundos em que o pipeline estava na fila e foi executado.

Há suporte para as propriedades de navegação a seguir.

Nome de exibição Nome -Restrição referencial Propriedade referenciada
Branch Branch BranchSK BranchSK
Concluído em CompletedOn CompletedDateSK DateSK
Na fila ativada QueuedOn QueuedDateSK DateSK
Iniciado em StartedOn QueuedDateSK DateSK
Pipeline Pipeline PipelineSK PipelineSK
Projeto Project ProjectSK ProjectSK

Membros de tipo enumerados PipelineRunReason

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

Nome do membro Valor Nome de exibição
None 0 Nenhum
Manual 1 Manual
IndividualCI 2 Individual CI
BatchedCI 4 CI 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 do build

Membros de tipo enumerados 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 de exibição
None 0 Nenhum
Succeed 2 Êxito
PartiallySucceeded 4 Parcialmente bem-sucedida
Failed 6 Com falha
Canceled 32 Canceled

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 de exibição Nome Data type Descrição
Contagem abandonada AbandonedCount Int32 A contagem de execuções de pipeline 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.
Segundos de Duração da Atividade ActivityDurationSeconds Decimal O número total de segundos em que o pipeline estava na fila e foi executado.
Data de Início da Atividade ActivityStartedDate Datetime A data e hora em que a execução do pipeline foi iniciada.
Contagem Cancelada CanceledCount Int32 A contagem de execuções de pipeline que foram canceladas.
Contagem de falha FailedCount Int32 A contagem de execuções de pipeline que falharam.
Tipo de atividade de pipeline ActivityType Enumerated O tipo de atividade de pipeline. Os valores válidos estão listados abaixo para PipelineActivityType.
ID de Execução de Pipeline PipelineRunId Int32 O número atribuído a uma execução de pipeline 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 são listados em PipelineRunOutcome.
Hora de início relativa dos segundos de trabalho RelativeStartTimeFromJobSeconds Int32 O número de segundos decorridos desde o início do trabalho.
Hora de início relativa dos segundos de estágio RelativeStartTimeFromStageSeconds Int32 O número de segundos decorridos desde o início do estágio.
Tempo de início relativo de segundos de execução RelativeStartTimeFromRunSeconds Int32 O número de segundos decorridos de quando 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 bem-sucedidas.
Contagem de problemas bem-sucedida SucceededWithIssuesCount Int32 A contagem de execuções de pipeline parcialmente bem-sucedidas.
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 obter relatórios de exemplo que consultam o tipo de entidade PipelineRunActivityResult , consulte Relatório de exemplo de tendência de duração da tarefa pipeline.

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

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

Membros de tipo enumerados PipelineActivityType

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

Nome do membro Valor Nome de exibição
Task 0 Tarefa
Approval 1 Aprovação
AgentWait 2 Espera do agente

PipelineTasks

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

Nome de exibição Nome Data type Descrição
ID de definição de tarefa TaskDefinitionId GUID O GUID atribuído a uma tarefa de pipeline.
Versão da 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 SamplingDatealternativa .

Nome de exibição Nome da propriedade Data type 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 de exemplo SamplingDate Datetime A data e a hora em que o tamanho do pool foi ajustado.

Para obter um relatório de exemplo criado com base na entidade TaskAgentPoolSizeSnapshot , consulte Gráfico histórico para pools de agentes (versão prévia).

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 tarefa.

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

Nome de exibição Nome Data type Descrição
Compilar enfileirado IsQueued Boolean Indica se o build está na fila (True) ou não na fila (False).
Compilação em execução IsRunning Boolean Indica se o build está em execução (True) ou não (False).
Hospedado ou auto-hospedado IsHosted Boolean Indica se o agente atribuído à tarefa está hospedado (True) ou auto-hospedado (False).
Data de término do trabalho FinishedDate Datetime A data e 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 enfileirada QueuedDate Datetime A data e 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 em que a solicitação do agente de tarefa permaneceu na fila antes de um agente ser atribuído.
Pool Id PoolId Int32 O número atribuído ao pool de agentes atribuído à solicitação do agente de tarefas.
Tipo de pipeline PipelineType String O tipo de pipeline que contém a solicitação do agente de tarefa.
ID da solicitação RequestId Int64 O número atribuído à solicitação do agente de tarefa.
Hora de Exemplo SamplingHour Int32 O número atribuído à hora em que a solicitação foi recebida.
Tempo de Amostragem SamplingTime Datetime A data e hora em que a solicitação do agente de tarefa foi recebida.
Data de Início StartedDate Datetime A data e 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 de exibição Nome Restrição referencial -Propriedade referenciada
Branch Branch BranchSK BranchSK
Concluído ativado CompletedOn CompletedDateSK DateSK
Hora de Término do Trabalho FinishedOn FinishedDateSK DateSK
Enfileirado ativado QueuedOn QueuedDateSK DateSK
Pipeline Pipeline PipelineSK PipelineSK
Projeto Project ProjectSK ProjectSK
Iniciado em StartedOn QueuedDateSK DateSK