Referencia de metadatos para Azure Pipelines Analytics

  • Artículo

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

El servicio Analytics recopila la actividad de canalización y prueba generada a través de Azure Pipelines. En este artículo se describen las propiedades que puede usar para generar un informe de Analytics para canalizaciones. Use una combinación de propiedades para filtrar una consulta, agregar datos o crear un informe.

Nota:

Se proporcionan descripciones de las entidades, las propiedades y los tipos enumerados admitidos por el modelo de datos de Analytics. Este es un borrador temprano. Proporcione comentarios sobre las áreas que le gustaría tener más información. Para consultar el modelo de datos, consulte Construcción de consultas de OData para Analytics.

Conjuntos de entidades y tipos de entidad

En la tabla siguiente se resumen los tipos de entidad y los conjuntos de entidades que admiten Azure Pipelines. Todos los tipos de entidad o conjuntos de entidades están disponibles con la versión preliminar de Analytics v4.0 . La versión de Analytics v3.0-preview no admite instantáneas.

EntitySet EntityType Descripción
Ramas Rama Información básica sobre las ramas usadas en pruebas o canalizaciones. Para obtener un informe de ejemplo, consulte Informe de ejemplo de estado de progreso.
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (Compuesto) Admite la comprensión del consumo de canalización en paralelo. Para obtener más información sobre las pruebas de canalización paralelas, consulte Ejecución de pruebas en paralelo mediante la tarea Prueba de Visual Studio.
Pipelines Canalización Propiedades de una canalización.
PipelineJobs PipelineJob Resultados de ejecución individuales de una prueba específica asociada a un testRun
PipelineRuns PipelineRun Información de ejecución para canalizaciones. Para obtener un informe de ejemplo, consulte El informe de ejemplo de tendencias de frecuencia de paso de canalización.
PipelineRunActivityResults PipelineRunActivityResult Registro combinado de todas las fases, pasos, trabajos y tareas dentro de una ejecución de canalización específica. Para obtener un informe de ejemplo, consulte Informe de ejemplo de duración de tareas de canalización.
PipelineTasks PipelineTask Propiedades de las tareas que se usan dentro de una canalización.
TaskAgentPoolSizeSnapshots TaskAgentPoolSizeSnapshot (Compuesto) Admite la comprensión del tamaño del grupo, los trabajos de canalización y la simultaneidad. En el gráfico histórico de los grupos de agentes se muestra cómo se puede usar este conjunto de entidades.
TaskAgentRequestSnapshots TaskAgentRequestSnapshot (Compuesto) Admite la creación de informes en las solicitudes del agente de tareas.

Ramas

Las propiedades siguientes son válidas para el conjunto de entidades Branches . Las claves suplentes asociadas a Branch incluyen BranchSK y ProjectSK.

Nombre para mostrar Nombre Tipo de datos Descripción
AnalyticsUpdatedDate DateTime Marca de agua que indica la última vez que se actualizaron los datos de Analytics.
Nombre de rama BranchName String Nombre asignado a una rama cuando se crea.
Id. de repositorio RepositoryId String Número asignado a un repositorio cuando se crea.
Identificador de vsts del repositorio RepositoryVstsId String Número asignado a un repositorio TFVC cuando se crea.
RepositoryUrl RepositoryUrl String Dirección URL definida para un repositorio cuando se crea.

Las propiedades de navegación incluyen Project y su restricción ProjectSKreferencial .

ParallelPipelineJobsSnapshot

Las propiedades siguientes son válidas para el conjunto de entidades ParallelPipelineJobsSnapshot . Las claves de referencia incluyen:

  • IsHosted
  • ParallelismTag
  • SamplingDate
Nombre para mostrar Nombre Tipo de datos Descripción
Hospedado o autohospedado IsHosted Boolean Indica si la canalización paralela se ejecuta en un agente hospedado por Microsoft (True) o es autohospedado (False). Para más información, consulte Agentes de Azure Pipelines.
No se pudo acceder a todos los proveedores FailedToReachAllProviders Boolean Indica si la ejecución del trabajo alcanzó todos los proveedores (True) o no (False).
Número de trabajos de canalizaciones paralelas TotalCount Int32 El número de trabajos que se ejecutan como parte de la instantánea.
Número de minutos de canalizaciones paralelas TotalMinutes Int32 Número de minutos que se tardan en ejecutar la instantánea.
Tipo de paralelismo ParallelismTag String Etiqueta que indica el tipo de paralelismo asociado a la instantánea de trabajo.
Tipo Premium IsPremium Boolean Indica si la canalización paralela es premium (True) o no (False).
Fecha de ejemplo SamplingDate DateTime Fecha asociada a la instantánea.

Pipelines

Las siguientes propiedades son válidas para Pipelines y su clave PipelineSKsuplente .

Nombre para mostrar Nombre Tipo de datos Descripción
Identificador de canalización PipelineId Int32 Identificador asignado a la canalización.
Nombre de canalización PipelineName String Nombre asignado a la canalización.
Versión de canalización PipelineVersion Int32 Versión asociada a la canalización.
Tipo de proceso de canalización PipelineProcessType Enumerated Tipo de definición de canalización. Los valores válidos se enumeran a continuación para PipelineProcessType.

Las propiedades de navegación incluyen Project y su restricción ProjectSKreferencial .

Miembros de tipo enumerados PipelineProcessType

Los miembros siguientes se definen para el PipelineProcessType tipo enumerado que indica el método utilizado para definir la canalización.

Nombre del miembro Valor Definición
Designer 1 Definición de canalización clásica.
Yaml 2 Definición de canalización de YAML.
Docker 3 Definición de canalización de Docker.

PipelineJobs

Un trabajo de canalización es una serie de pasos que se ejecutan secuencialmente como una unidad. Un trabajo es la unidad de trabajo más pequeña que puede programar para ejecutarse. Las canalizaciones se organizan en torno a trabajos y cada canalización tiene al menos un trabajo. Para más información, consulte Especificación de trabajos en la canalización.

Las siguientes propiedades son válidas para PipelineJobs y su clave suplente PipelineJobSK .

Nombre para mostrar Nombre Tipo de datos Descripción
Nombre completo del trabajo de canalización FullJobName String Nombre completo de un trabajo de canalización.
Identificador de canalización PipelineId Int32 Identificador asignado a la canalización en la que se define el trabajo.
Identificador de trabajo de canalización JobId String Identificador de trabajo asignado a un trabajo de canalización cuando se crea.
Nombre del trabajo de canalización JobName String Nombre asignado al trabajo de canalización.
Nombre de la fase de canalización StageName String Nombre de la fase asociado al trabajo de canalización.
Atributos de estrategia de trabajo de canalización StrategyAttributes String Atributos definidos para el trabajo de canalización.
Identificador de fase StageId String Identificador de fase asociado al trabajo de canalización.

Las propiedades de navegación incluyen Project y su restricción ProjectSKreferencial .

Para obtener un informe de ejemplo que consulta el tipo de entidad PipelineJob , consulte Informe de ejemplo de errores de fase de canalización.

PipelineRuns

Una ejecución de canalización representa una única ejecución de una canalización. Durante una ejecución, la canalización se procesa y los agentes procesan uno o varios trabajos. Una ejecución de canalización incluye trabajos, pasos y tareas. Para más información, consulte Secuencia de ejecución de canalización.

Las siguientes propiedades son válidas para el tipo de entidad PipelineRun y su PipelineRunSK clave suplente.

Nombre para mostrar Nombre Tipo de datos Descripción
Recuento cancelado CanceledCount Int32 Recuento de ejecuciones de canalización canceladas.
Fecha de finalización CompletedDate DateTime Fecha y hora en que la canalización completa la ejecución.
Recuento de errores FailedCount Int32 Recuento de ejecuciones de canalización que se realizaron correctamente.
Revisión de números RunNumberRevision Int32 Número asignado a una ejecución de canalización con ejecuciones secuenciales.
Recuento parcialmente correcto PartiallySucceededCount Int32 Recuento de ejecuciones de canalización que se realizaron parcialmente correctamente.
Identificador de ejecución de canalización PipelineRunId Int32 Número asignado a una ejecución de canalización.
Fecha en cola QueuedDate DateTime Fecha y hora en que se puso en cola la canalización para ejecutarse.
Duración de la cola segundos QueueDurationSeconds Decimal Número de segundos que la canalización permaneció en la cola.
Número de ejecución RunNumber String Número asignado a una ejecución de canalización cuando se ejecuta.
Resultado de la ejecución RunOutcome Enumerated Resultado asignado a una canalización tras la finalización de su ejecución. Los valores válidos se enumeran a continuación para PipelineRunOutcome.
Motivo de ejecución RunReason Enumerated Condición que provocó la ejecución de la canalización. Los valores válidos se enumeran a continuación para PipelineRunReason.
Duración de ejecución segundos RunDurationSeconds Decimal Número de segundos que tardó la ejecución de la canalización en completarse.
Fecha de inicio StartedDate DateTime Fecha y hora en que se inició la ejecución de la canalización.
Recuento correcto SucceededCount Int32 Recuento de ejecuciones de canalización que se realizaron correctamente.
Duración total de segundos TotalDurationSeconds Decimal El número total de segundos que la canalización estaba en la cola y se ejecutó.

Se admiten las siguientes propiedades de navegación.

Nombre para mostrar Nombre -Restricción referencial Propiedad a la que se hace referencia
Rama Branch BranchSK BranchSK
Completado activado CompletedOn CompletedDateSK DateSK
Activado en cola QueuedOn QueuedDateSK DateSK
Iniciado en StartedOn QueuedDateSK DateSK
Canalización Pipeline PipelineSK PipelineSK
Project Project ProjectSK ProjectSK

Miembros de tipo enumerados PipelineRunReason

Los miembros siguientes se definen para el PipelineRunReason tipo enumerado que indica las condiciones en las que se ejecuta cada fase de canalización, trabajo o paso, como se describe en Especificar condiciones.

Nombre del miembro Valor Nombre para mostrar
None 0 None
Manual 1 Manual
IndividualCI 2 Individual CI
BatchedCI 4 CI por lotes
Schedule 8 Programación
UserCreated 32 Usuario creado
ValidateShelveset 64 Validar conjunto de estantes
CheckInShelveset 128 conjunto de estantes de Check In
PullRequest 256 Solicitud de incorporación de cambios
PipelineRunCompletion 512 Finalización de la compilación

Miembros de tipo enumerados PipelineRunOutcome

Los miembros siguientes se definen para el PipelineRunOutcome tipo enumerado que indica el resultado de una ejecución de canalización.

Nombre del miembro Valor Nombre para mostrar
None 0 None
Succeed 2 Correcto
PartiallySucceeded 4 Completado parcialmente
Failed 6 Con error
Canceled 32 Canceled

PipelineRunActivityResults

Las propiedades siguientes son válidas para el conjunto de entidades PipelineRunActivityResults y su PipelineRunActivityResultSK clave suplente.

Muchas propiedades están basadas en fechas o basadas en el usuario. Estas propiedades están asociadas a los conjuntos de entidades CalendarDate y Userdescritos en Referencia de metadatos de fecha de calendario, Proyecto y Usuario.

Nombre para mostrar Nombre Tipo de datos Descripción
Recuento abandonado AbandonedCount Int32 Recuento de ejecuciones de canalización marcadas como abandonadas.
Fecha de finalización de la actividad ActivityCompletedDate DateTime Fecha y hora en que la ejecución de la canalización completa la ejecución.
Duración de la actividad segundos ActivityDurationSeconds Decimal El número total de segundos que la canalización estaba en la cola y se ejecutó.
Fecha de inicio de la actividad ActivityStartedDate DateTime Fecha y hora en que se inició la ejecución de la canalización.
Recuento cancelado CanceledCount Int32 Recuento de ejecuciones de canalización canceladas.
Recuento de errores FailedCount Int32 Recuento de ejecuciones de canalización con errores.
Tipo de actividad de canalización ActivityType Enumerated Tipo de actividad de canalización. Los valores válidos se enumeran a continuación para PipelineActivityType.
Identificador de ejecución de canalización PipelineRunId Int32 Número asignado a una ejecución de canalización cuando se ejecuta.
Resultado de la ejecución de canalización PipelineRunOutcome Enumerated Resultado asignado a una canalización tras la finalización de su ejecución. Los valores válidos aparecen en PipelineRunOutcome.
Hora de inicio relativa desde segundos de trabajo RelativeStartTimeFromJobSeconds Int32 Número de segundos transcurridos desde el inicio del trabajo.
Hora de inicio relativa desde segundos de fase RelativeStartTimeFromStageSeconds Int32 Número de segundos transcurridos desde el inicio de la fase.
Hora de inicio relativa desde segundos de ejecución RelativeStartTimeFromRunSeconds Int32 Número de segundos transcurridos desde el momento en que se ejecutó la ejecución.
Recuento omitido SkippedCount Int32 Recuento de ejecuciones de canalización que se omitieron.
Recuento correcto SucceededCount Int32 Recuento de ejecuciones de canalización que se realizaron correctamente.
Correcto con el recuento de problemas SucceededWithIssuesCount Int32 Recuento de ejecuciones de canalización que se realizaron parcialmente correctamente.
Nombre para mostrar de la tarea TaskDisplayName String Nombre de una tarea ejecutada en la ejecución de la canalización.
Ruta de acceso del registro de tareas TaskLogPath String Ruta de acceso del archivo de registro generado por una tarea.
Resultado de la tarea TaskOutcome Personalizado Resultado de la tarea que se ejecutó.

Para obtener informes de ejemplo que consultan el tipo de entidad PipelineRunActivityResult , consulte Informe de ejemplo de tendencias de duración de tareas de canalización.

Las propiedades de navegación incluyen las enumeradas en la tabla siguiente.

Nombre para mostrar Nombre Restricción referencial Propiedad a la que se hace referencia
Actividad iniciada ActivityStartedOn ActivityStartedDateSK DateSK
Rama Branch BranchSK BranchSK
Canalización Pipeline PipelineSK PipelineSK
Tarea de canalización PipelineTask PipelineTaskSK PipelineTaskSK
Trabajo de canalización PipelineJob PipelineJobSK PipelineJobSK
Ejecución de canalización en cola activada PipelineRunQueuedOn PipelineRunQueuedDateSK DateSK
Ejecución de canalización iniciada PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Ejecución de canalización completada en PipelineRunCompletedOn PipelineRunCompletedDateSK DateSK
Ejecución de canalización iniciada PipelineRunStartedOn PipelineRunStartedDateSK DateSK
Project Project ProjectSK ProjectSK

Miembros de tipo enumerados pipelineActivityType

Los miembros siguientes se definen para el PipelineActivityType tipo enumerado.

Nombre del miembro Valor Nombre para mostrar
Task 0 Tarea
Approval 1 Aprobación
AgentWait 2 Espera del agente

PipelineTasks

Las siguientes propiedades son válidas para el conjunto de entidades PipelineTasks y su clave PipelineTaskSKsuplente .

Nombre para mostrar Nombre Tipo de datos Descripción
Id. de definición de tarea TaskDefinitionId GUID GUID asignado a una tarea de canalización.
Versión de definición de tarea TaskDefinitionVersion String Versión asignada a una tarea de canalización.

Las propiedades de navegación incluyen Project y su restricción ProjectSKreferencial .

TaskAgentPoolSizeSnapshots

Las siguientes propiedades son válidas para el conjunto de entidades TaskAgentPoolSizeSnapshots y su clave SamplingDatesuplente .

Nombre para mostrar Nombre de propiedad Tipo de datos Descripción
Recuento en línea OnlineCount Int32 Número de agentes en línea en el grupo de agentes cuando se ejecutó la tarea.
Recuento sin conexión OfflineCount Int32 Número de agentes sin conexión en el grupo de agentes cuando se ejecutó la tarea.
Id. del grupo PoolId Int32 Número asignado al grupo de agentes.
Fecha de ejemplo SamplingDate DateTime Fecha y hora en que se asignó el tamaño del grupo.

Para obtener un informe de ejemplo basado en la entidad TaskAgentPoolSizeSnapshot, consulte Gráfico histórico para grupos de agentes (versión preliminar).

TaskAgentRequestSnapshots

Los grupos de agentes se asignan cuando se ejecuta una tarea. El conjunto de entidades TaskAgentRequestSnapshots captura los datos relacionados con las solicitudes del agente de tareas.

Las propiedades siguientes son válidas para el tipo de entidad TaskAgentRequestSnapshot y sus claves suplentes SamplingTime y SamplingDateSK.

Nombre para mostrar Nombre Tipo de datos Descripción
Compilación en cola IsQueued Boolean Indica si la compilación está en cola (True) o no está en cola (False).
Compilación en ejecución IsRunning Boolean Indica si la compilación se está ejecutando (True) o no se está ejecutando (False).
Hospedado o autohospedado IsHosted Boolean Indica si el agente asignado a la tarea está hospedado (True) o autohospedado (False).
Fecha de finalización del trabajo FinishedDate DateTime Fecha y hora en que la solicitud del agente de tareas terminó de ejecutarse.
FinishedDateSK Int32 Fecha en que la solicitud del agente de tareas finalizó en ejecución, expresada como YYYYMMDD en la zona horaria definida para la organización.
Fecha en cola QueuedDate DateTime Fecha y hora en que se puso en cola la solicitud del agente de tareas.
QueuedDateSK Int32 Fecha en que se puso en cola la solicitud del agente de tareas, expresada como YYYYMMDD en la zona horaria definida para la organización.
Duración de la cola segundos QueueDurationSeconds Decimal Número de segundos que la solicitud del agente de tareas permaneció en la cola antes de que se asignara un agente.
Id. de grupo PoolId Int32 Número asignado al grupo de agentes asignado a la solicitud del agente de tareas.
Tipo de canalización PipelineType String Tipo de canalización que contiene la solicitud del agente de tareas.
Id. de solicitud RequestId Int64 Número asignado a la solicitud del agente de tareas.
Hora de ejemplo SamplingHour Int32 Número asignado a la hora en que se recibió la solicitud.
Tiempo de muestreo SamplingTime DateTime Fecha y hora en que se recibió la solicitud del agente de tareas.
Fecha de inicio StartedDate DateTime Fecha y hora en que se ejecutó la solicitud del agente de tareas.
StartedDateSK Int32 Fecha en que la solicitud del agente de tareas inició la ejecución, expresada como YYYYMMDD en la zona horaria definida para la organización.

Las propiedades de navegación incluyen las que aparecen en la tabla siguiente.

Nombre para mostrar Nombre Restricción referencial -Referenced (propiedad)
Rama Branch BranchSK BranchSK
Completado activado CompletedOn CompletedDateSK DateSK
Hora de finalización del trabajo FinishedOn FinishedDateSK DateSK
Activado en cola QueuedOn QueuedDateSK DateSK
Canalización Pipeline PipelineSK PipelineSK
Project Project ProjectSK ProjectSK
Iniciado en StartedOn QueuedDateSK DateSK