Referência de metadados para a Análise de Pipelines do Azure

  • Artigo

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

O serviço Analytics recolhe o pipeline e a atividade de teste gerada através dos Pipelines do Azure. Este artigo descreve as propriedades que pode utilizar para gerar um relatório de Análise para pipelines. Utiliza 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 de Análise. Este é um rascunho inicial. Envie feedback sobre as áreas que gostaria de ter mais informações. Para consultar o modelo de dados, veja Construir consultas OData para Análise.

Conjuntos de entidades e tipos de entidade

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

EntitySet EntityType Description
Ramos Ramo Informações básicas sobre ramos utilizados em testes ou pipelines. Para obter um relatório de exemplo, veja Relatório de exemplo de estado de progresso.
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (Composto) Suporta a compreensão do consumo paralelo de pipelines. Para saber mais sobre os testes de pipeline paralelos, veja Executar testes em paralelo com a tarefa de Teste do Visual Studio.
Pipelines Pipeline Propriedades de um pipeline.
PipelineJobs PipelineJob Resultados de execução individuais de um Teste específico associado a uma TestRun
PipelineRuns PipelineRun Informações de execução para pipelines. Para obter um relatório de exemplo, veja Relatório de exemplo de tendência de taxa de transmissão do pipeline.
PipelineRunActivityResults PipelineRunActivityResult Registo intercalado de todas as fases, passos, tarefas e tarefas numa execução de pipeline específica. Para obter um relatório de exemplo, veja Relatório de exemplo de duração da tarefa de pipeline.
PipelineTasks PipelineTask Propriedades para tarefas que são utilizadas num pipeline.
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (Composto) Suporta a compreensão do tamanho do conjunto, das tarefas de pipeline e da simultaneidade. O gráfico Histórico para conjuntos de agentes ilustra como este conjunto de entidades pode ser utilizado.
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (Composto) Suporta relatórios sobre pedidos do agente de tarefas.

Ramos

As seguintes propriedades são válidas para o conjunto de entidades Ramos . As chaves de substituição 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 Analytics foram atualizados.
Nome do Ramo BranchName String O nome atribuído a um ramo quando é criado.
ID do repositório RepositoryId String O número atribuído a um repositório quando é criado.
ID do Vsts do Repositório RepositoryVstsId String O número atribuído a um repositório TFVC quando é criado.
RepositoryUrl RepositoryUrl String O URL definido para um repositório quando é criado.

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

ParallelPipelineJobsSnapshot

As seguintes propriedades 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
Alojado ou Autoalojado IsHosted Booleano Indica se o pipeline paralelo é executado num agente alojado pela Microsoft (Verdadeiro) ou está autoalojado (Falso). Para saber mais, veja Agentes do Azure Pipelines.
Falha ao Contactar Todos os Fornecedores FailedToReachAllProviders Booleano Indica se a execução da tarefa atingiu todos os fornecedores (Verdadeiro) ou não (Falso).
Número de Tarefas de Pipelines Paralelos TotalCount Int32 O número de tarefas executadas 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 String Uma etiqueta que indica o tipo de paralelismo associado ao instantâneo da tarefa.
Tipo Premium IsPremium Booleano Indica se o pipeline paralelo é premium (Verdadeiro) ou não (Falso).
Data de Exemplo SamplingDate DateTime A data associada ao instantâneo.

Pipelines

As seguintes propriedades são válidas para Pipelines e a respetiva chave PipelineSKde substituição.

Nome a apresentar 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 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 a respetiva restrição ProjectSKreferencial.

Membros do tipo enumerado PipelineProcessType

Os seguintes membros são definidos para o PipelineProcessType tipo enumerado que indica o método utilizado para definir o pipeline.

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

PipelineJobs

Uma tarefa de pipeline é uma série de passos que são executados sequencialmente como uma unidade. Uma tarefa é a unidade de trabalho mais pequena que pode agendar para execução. Os pipelines são organizados em torno de tarefas e cada pipeline tem, pelo menos, uma tarefa. Para saber mais, consulte Especificar tarefas no seu pipeline.

As seguintes propriedades são válidas para PipelineJobs e respetiva PipelineJobSK chave de substituição.

Nome a apresentar Nome Tipo de dados Descrição
Nome da Tarefa Completa do Pipeline FullJobName String O nome completo de uma tarefa 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 de tarefa atribuído a uma tarefa de pipeline quando é criado.
Nome da Tarefa de Pipeline JobName String O nome atribuído à tarefa de pipeline.
Nome da Fase do Pipeline StageName String O nome da fase associado à tarefa de pipeline.
Atributos de Estratégia de Tarefa de Pipeline StrategyAttributes String Os atributos definidos para a tarefa de pipeline.
Identificador de Fase StageId String O identificador de fase associado à tarefa de pipeline.

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

Para obter um relatório de exemplo que consulta o tipo de entidade PipelineJob , veja Relatório de exemplo falhas de fase 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 uma ou mais tarefas. Uma execução de pipeline inclui tarefas, passos e tarefas. Para saber mais, veja Sequência de execução de pipelines.

As seguintes propriedades são válidas para o tipo de entidade PipelineRun e a respetiva PipelineRunSK chave de substituição.

Nome a apresentar Nome Tipo de dados Descrição
Contagem Cancelada CanceledCount Int32 A contagem de execuções de pipelines que foram canceladas.
Data de Conclusão CompletedDate DateTime A data e hora em que o pipeline conclui a execução.
Contagem Falhada FailedCount Int32 A contagem de execuções de pipelines com êxito.
Revisão de Números 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 pipelines 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 Fila QueuedDate DateTime A data e hora em que o pipeline foi executado em fila.
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 é executado.
Executar Resultado RunOutcome Enumerated O resultado atribuído a um pipeline após a conclusão da respetiva execução. Os valores válidos estão listados abaixo para PipelineRunOutcome.
Razão da Execução RunReason Enumerated A condição que causou a execução do pipeline. 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 a execução do pipeline demorou a ser concluída.
Data de Início StartedDate DateTime A data e hora em que a execução do pipeline começou.
Contagem com Êxito SucceededCount Int32 A contagem de execuções de pipeline que foram bem-sucedidas.
Total Duration Seconds TotalDurationSeconds Decimal O número total de segundos em que o pipeline estava na fila e foi executado.

São suportadas as seguintes propriedades de navegação.

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

Membros do tipo enumerado PipelineRunReason

Os seguintes membros são definidos para o PipelineRunReason tipo enumerado que indica as condições em que cada fase, trabalho ou passo do pipeline é executado conforme descrito em Especificar condições.

Nome do membro Valor Nome a apresentar
None 0 Nenhuma
Manual 1 Manual
IndividualCI 2 Individual CI
BatchedCI 4 CI em lote
Schedule 8 Agenda
UserCreated 32 Utilizador Criado
ValidateShelveset 64 Validar Conjunto de Prateleiras
CheckInShelveset 128 Check In Shelveset
PullRequest 256 Pedido Pull
PipelineRunCompletion 512 Conclusão da Compilação

Membros do tipo enumerado PipelineRunOutcome

Os seguintes membros 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 Com Êxito Parcial
Failed 6 Com falhas
Canceled 32 Cancelado

PipelineRunActivityResults

As seguintes propriedades são válidas para o conjunto de entidades PipelineRunActivityResults e a respetiva PipelineRunActivityResultSK chave de substituição.

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

Nome a apresentar Nome Tipo de dados 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 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-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 de Falhas FailedCount Int32 A contagem de execuções de pipeline que falharam.
Tipo de Atividade do Pipeline ActivityType Enumerated O tipo de 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 é executado.
Resultado da Execução do Pipeline PipelineRunOutcome Enumerated O resultado atribuído a um pipeline após a conclusão da execução. Os valores válidos estão listados em PipelineRunOutcome.
Hora de início relativa a partir de segundos de trabalho RelativeStartTimeFromJobSeconds Int32 O número de segundos decorrido desde o início da tarefa.
Hora de Início Relativa a Partir dos Segundos de Fase RelativeStartTimeFromStageSeconds Int32 O número de segundos que decorrido desde o início da fase.
Hora de Início Relativa a Partir de Segundos de Execução RelativeStartTimeFromRunSeconds Int32 O número de segundos decorrido 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 pipelines com êxito.
Contagem de Problemas Com Êxito SucceededWithIssuesCount Int32 A contagem de execuções de pipelines que foram parcialmente bem-sucedidas.
Nome a Apresentar da Tarefa TaskDisplayName String Nome de uma tarefa executada na execução do pipeline.
Caminho do Registo de Tarefas TaskLogPath String O caminho do ficheiro de registo 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 de duração da tarefa de pipeline.

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

Nome a Apresentar Nome Restrição referencial Propriedade referenciada
Atividade Iniciada Em ActivityStartedOn ActivityStartedDateSK DateSK
Ramo Branch BranchSK BranchSK
Pipeline Pipeline PipelineSK PipelineSK
Tarefa de Pipeline PipelineTask PipelineTaskSK PipelineTaskSK
Tarefa de Pipeline PipelineJob PipelineJobSK PipelineJobSK
Execução do Pipeline Em Fila Ativada PipelineRunQueuedOn PipelineRunQueuedDateSK DateSK
Execução do Pipeline Iniciada Em PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Execução do Pipeline Concluída Em PipelineRunCompletedOn PipelineRunCompletedDateSK DateSK
Execução do Pipeline Iniciada Em PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Project Project ProjectSK ProjectSK

Membros do tipo enumerado PipelineActivityType

Os seguintes membros são definidos para o PipelineActivityType tipo enumerado.

Nome do membro Valor Nome a apresentar
Task 0 Tarefa
Approval 1 Aprovação
AgentWait 2 Espera do Agente

PipelineTasks

As seguintes propriedades são válidas para o conjunto de entidades PipelineTasks e a respetiva chave PipelineTaskSKde substituição.

Nome a apresentar Nome Tipo de dados Descrição
ID da 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 a respetiva restrição ProjectSKreferencial.

TaskAgentPoolSizeSnapshots

As seguintes propriedades são válidas para o conjunto de entidades TaskAgentPoolSizeSnapshots e a respetiva chave de substituição SamplingDate.

Nome a apresentar 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 conjunto de agentes quando a tarefa foi executada.
ID do Conjunto PoolId Int32 O número atribuído ao conjunto de agentes.
Data de Exemplo SamplingDate DateTime A data e hora em que o tamanho do conjunto foi encaixado.

Para obter um relatório de exemplo criado a partir da entidade TaskAgentPoolSizeSnapshot , veja Histórico de gráficos para conjuntos de agentes (Pré-visualização).

TaskAgentRequestSnapshots

Os conjuntos de agentes são alocados quando uma tarefa é executada. O conjunto de entidades TaskAgentRequestSnapshots captura dados relacionados com os pedidos do agente de tarefas.

As seguintes propriedades são válidas para o tipo de entidade TaskAgentRequestSnapshot e as respetivas chaves SamplingTime de substituição e SamplingDateSK.

Nome a apresentar Nome Tipo de dados Descrição
Compilar em Fila IsQueued Booleano Indica se a compilação está em fila de espera (Verdadeiro) ou não em fila (Falso).
Compilação em Execução IsRunning Booleano Indica se a compilação está em execução (Verdadeiro) ou não em execução (Falso).
Alojado ou Autoalojado IsHosted Booleano Indica se o agente atribuído à tarefa está alojado (Verdadeiro) ou autoalojado (Falso).
Data de Fim da Tarefa FinishedDate DateTime A data-hora em que o pedido do agente de tarefas terminou a execução.
FinishedDateSK Int32 A data em que o pedido do agente de tarefas terminou a execução, expressa como YYYYMMDD no fuso horário definido para a organização.
Data de Colocação em Fila QueuedDate DateTime A data-hora em que o pedido do agente de tarefas foi em fila de colocação.
QueuedDateSK Int32 A data em que o pedido do agente de tarefas foi em fila de espera, 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 o pedido do agente de tarefas permaneceu na fila antes da atribuição de um agente.
ID do Conjunto PoolId Int32 O número atribuído ao conjunto de agentes atribuído ao pedido do agente de tarefas.
Tipo de Pipeline PipelineType String O tipo de pipeline que contém o pedido do agente de tarefas.
ID do Pedido RequestId Int64 O número atribuído ao pedido do agente de tarefas.
Hora de Exemplo SamplingHour Int32 O número atribuído à hora em que o pedido foi recebido.
Hora de Exemplo SamplingTime DateTime A data-hora em que o pedido do agente de tarefas foi recebido.
Data de Início StartedDate DateTime A data-hora em que o pedido do agente de tarefas foi executado.
StartedDateSK Int32 A data em que o pedido do agente de tarefas 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 seguinte.

Nome a apresentar Nome Restrição referencial -Propriedade referenciada
Ramo Branch BranchSK BranchSK
Concluído Em CompletedOn CompletedDateSK DateSK
Hora de Fim da Tarefa FinishedOn FinishedDateSK DateSK
Colocado em fila QueuedOn QueuedDateSK DateSK
Pipeline Pipeline PipelineSK PipelineSK
Project Project ProjectSK ProjectSK
Iniciado Em StartedOn QueuedDateSK DateSK