Compartilhar via

Referência de metadados do Azure Pipelines Analytics

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

O serviço de Análise coleta atividades de pipeline e de teste geradas por meio do Azure Pipelines. Este artigo descreve as propriedades que você pode usar para gerar um relatório do Analytics 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 entidades/conjuntos de entidades estão disponíveis com a versão prévia do Analytics v4.0. A versão v3.0-preview do Analytics não dá suporte a instantâneos.

ConjuntoDeEntidades (EntitySet) Tipo de Entidade Descrição
Ramificações Branch 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 (Composição) Dá suporte à compreensão do consumo de pipeline paralelo. Para obter mais informações sobre testes de pipeline em paralelo, consulte Executar testes em paralelo usando a tarefa Teste do Visual Studio.
Pipelines Pipeline Propriedades de um pipeline.
Trabalhos em Pipeline 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 do pipeline.
PipelineRunActivityResults PipelineRunActivityResult Registro consolidado 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 gráfico histórico para pools de agentes ilustra como esse conjunto pode ser usado.
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (Composição) Dá suporte a relatórios sobre solicitações do agente de tarefa.

Ramificações

As propriedades a seguir 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 dado Descrição
AnalyticsUpdatedDate DateTime Marca d'água que indica a última vez em que os dados do Analytics foram atualizados.
Nome da Filial BranchName Cadeia de caracteres O nome atribuído a um ramo quando ele é criado.
ID do repositório RepositoryId Cadeia de caracteres O número atribuído a um repositório quando ele é criado.
ID do repositório vsts RepositoryVstsId Cadeia de caracteres O número atribuído a um repositório TFVC quando ele é criado.
RepositoryUrl RepositoryUrl Cadeia de caracteres 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 dado Descrição
Hospedado ou auto-gerenciado IsHosted Booliano Indica se o fluxo de trabalho paralelo é executado em um agente hospedado pela Microsoft (Verdadeiro) ou é auto-hospedado (Falso). Para obter mais informações, confira Agentes do Azure Pipelines.
Falha em alcançar todos os provedores FailedToReachAllProviders Booliano Indica se a execução da tarefa 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 necessários para executar o instantâneo.
Tipo de paralelismo ParallelismTag Cadeia de caracteres Uma marcação que indica o tipo de paralelismo associado ao instantâneo de trabalho.
Tipo Premium IsPremium Booliano Indica se o pipeline paralelo é premium (True) ou não (False).
Data da amostra SamplingDate DateTime A data associada ao instantâneo.

Linhas de Produção

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

Nome de exibição Nome Tipo de dado Descrição
Pipeline Id PipelineId Int32 O ID atribuído ao pipeline.
Nome do pipeline PipelineName Cadeia de caracteres O nome atribuído ao pipeline.
Versão do pipeline PipelineVersion Int32 A versão associada ao pipeline.
Tipo de processo de tubulação 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 referencial ProjectSK.

Membros de 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 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 executadas sequencialmente como uma unidade. Uma tarefa é a menor unidade de trabalho que você pode agendar para ser executada. Os pipelines são organizados em torno de tarefas e cada pipeline tem pelo menos uma tarefa. Para obter mais informações, 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 Tipo de dado Descrição
Nome completo do trabalho do pipeline FullJobName Cadeia de caracteres O nome completo de um trabalho de pipeline.
Pipeline Id PipelineId Int32 O ID atribuído ao pipeline no qual o trabalho é definido.
Identificador de trabalho de pipeline JobId Cadeia de caracteres O identificador atribuído a um trabalho de pipeline quando ele é criado.
Nome do trabalho do pipeline JobName Cadeia de caracteres O nome atribuído ao trabalho de pipeline.
Nome do estágio do pipeline StageName Cadeia de caracteres O nome da etapa associado ao trabalho de pipeline.
Atributos da estratégia de trabalho de pipeline StrategyAttributes Cadeia de caracteres Os atributos definidos para o trabalho de pipeline.
Identificador de estágio StageId Cadeia de caracteres O identificador da etapa associado ao trabalho de pipeline.

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

Para obter um relatório de exemplo que consulta o tipo de entidade PipelineJob, consulte o Relatório de exemplo de falhas por estágio no 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 mais informações, consulte Sequência de execução do 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 Tipo de dado 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 quantidade de execuções de pipeline que foram bem-sucedidas.
Número de revisão RunNumberRevision Int32 O número atribuído a uma execução de pipeline que possui execuções sequenciais.
Contagem de sucessos parciais PartiallySucceededCount Int32 A quantidade de execuções de pipeline que foram parcialmente bem-sucedidas.
ID de execução do pipeline PipelineRunId Int32 O número atribuído a uma execução de pipeline.
Data em espera QueuedDate DateTime A data e a hora em que o pipeline foi agendado para execução.
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 Cadeia de caracteres O número atribuído a uma execução de pipeline quando ela é executada.
Resultado da execução RunOutcome Enumerated O resultado atribuído a um pipeline após a conclusão da execução. Os valores válidos estão listados abaixo para PipelineRunOutcome.
Motivo da execução RunReason Enumerated A condição que levou à execução do pipeline. Os valores válidos estão listados abaixo para PipelineRunReason.
Duração da execução Segundos RunDurationSeconds Decimal O número de segundos necessários para a execução de 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 de êxito SucceededCount Int32 A quantidade de execuções de pipeline que foram bem-sucedidas.
Duração total de segundos TotalDurationSeconds Decimal O número total de segundos em que o pipeline esteve na fila e em execução.

As propriedades de navegação a seguir são suportadas.

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

Membros de 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 de exibição
None 0 Nenhum
Manual 1 Manual
IndividualCI 2 CI individual
BatchedCI 4 CI em lote
Schedule 8 Agenda
UserCreated 32 Criado pelo usuário
ValidateShelveset 64 Validar prateleira
CheckInShelveset 128 Check-in de Shelveset
PullRequest 256 Pull Request
PipelineRunCompletion 512 Conclusão da construção

Membros de tipo enumerado PipelineRunOutcome

Os membros a seguir são definidos para o tipo enumerado PipelineRunOutcome 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 Cancelado

PipelineRunActivityResults

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

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 Tipo de dado Descrição
Contagem de Abandonados AbandonedCount Int32 A contagem de execuções do pipeline que foram marcadas como abandonadas.
Data de conclusão da atividade ActivityCompletedDate DateTime A data e a hora em que a execução de pipeline conclui a execução.
Duração da atividade Segundos ActivityDurationSeconds Decimal O número total de segundos em que o pipeline esteve na fila e em execução.
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 com falha FailedCount Int32 A quantidade de execuções de pipeline que falharam.
Tipo de atividade de pipeline ActivityType Enumerated O tipo da atividade de pipeline. Os valores válidos estão listados abaixo para PipelineActivityType.
ID de execução do pipeline PipelineRunId Int32 O número atribuído a uma execução de pipeline quando ela é executada.
Resultado da execução de pipeline PipelineRunOutcome Enumerated O resultado atribuído a um pipeline após a conclusão da execução. Os valores válidos são listados em PipelineRunOutcome.
Hora de início relativa em segundos do trabalho RelativeStartTimeFromJobSeconds Int32 O número de segundos decorridos desde o início do trabalho.
Hora de início relativa em segundos de estágio RelativeStartTimeFromStageSeconds Int32 O número de segundos decorridos desde o início da etapa.
Hora de início relativa em segundos da execução RelativeStartTimeFromRunSeconds Int32 O número de segundos decorridos desde o momento em que a execução foi realizada.
Contagem pulada SkippedCount Int32 A contagem de execuções de pipeline que foram ignoradas.
Contagem de êxito SucceededCount Int32 A quantidade de execuções de pipeline que foram bem-sucedidas.
Sucesso com a contagem de problemas SucceededWithIssuesCount Int32 A quantidade de execuções de pipeline que foram parcialmente bem-sucedidas.
Nome de exibição da tarefa TaskDisplayName Cadeia de caracteres Nome de uma tarefa executada na execução de pipeline.
Caminho do log de tarefas TaskLogPath Cadeia de caracteres 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 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
Branch Branch BranchSK BranchSK
Pipeline Pipeline PipelineSK PipelineSK
Tarefa de pipeline PipelineTask PipelineTaskSK PipelineTaskSK
Trabalho no pipeline PipelineJob PipelineJobSK PipelineJobSK
Execução de pipeline enfileirada em 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 enumerado 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 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 Cadeia de caracteres A versão atribuída a uma tarefa de pipeline.

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

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

Para um relatório de exemplo baseado na entidade TaskAgentPoolSizeSnapshot, consulte Gráfico histórico para pools de agentes (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 tarefas.

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

Nome de exibição Nome Tipo de dado Descrição
Compilação enfileirada IsQueued Booliano Indica se o build está enfileirado (True) ou não enfileirado (False).
Compilação em execução IsRunning Booliano Indica se a compilação está em execução (True) ou não está em execução (False).
Hospedado ou auto-hospedado IsHosted Booliano Indica se o agente atribuído à tarefa é 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 de colocação na fila QueuedDate DateTime A data e a 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 colocada na fila, expressa como YYYYMMDD no fuso horário especificado pela 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 de um agente ser atribuído.
Pool Id PoolId Int32 O número atribuído ao pool de agentes designado para a solicitação de agente de tarefa.
Tipo de tubulação PipelineType Cadeia de caracteres 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 da amostra SamplingHour Int32 O número atribuído à hora em que a solicitação foi recebida.
Tempo da amostra 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
Data de conclusão CompletedOn CompletedDateSK DateSK
Hora de Término do Trabalho FinishedOn FinishedDateSK DateSK
Na fila QueuedOn QueuedDateSK DateSK
Pipeline Pipeline PipelineSK PipelineSK
Projeto Project ProjectSK ProjectSK
Iniciado em StartedOn QueuedDateSK DateSK