Referencia de metadatos para Azure Pipelines Analytics
Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2019
El servicio Analytics recopila la canalización y la actividad de prueba generadas 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. Se usa una combinación de propiedades para filtrar una consulta, agregar datos o crear un informe.
Nota:
Se proporcionan descripciones de las entidades, propiedades y 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, vea Ejecutar pruebas en paralelo mediante la tarea Prueba de Visual Studio. |
| Canalizaciones | Canalización | Propiedades de una canalización. |
| PipelineJobs | PipelineJob | Resultados de ejecución individuales para una prueba específica asociada a testRun |
| PipelineRuns | PipelineRun | Información de ejecución para canalizaciones. Para obtener un informe de ejemplo, consulte El informe de ejemplo de tendencia 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 la tarea 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. El gráfico histórico de los grupos de agentes 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 siguientes propiedades son válidas para el conjunto de entidades Bifurcaciones . 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 |
Cadena | Nombre asignado a una rama cuando se crea. |
| Id. del repositorio | RepositoryId |
Cadena | Número asignado a un repositorio cuando se crea. |
| Identificador de vsts del repositorio | RepositoryVstsId |
Cadena | Número asignado a un repositorio tfVC cuando se crea. |
| RepositoryUrl | RepositoryUrl |
Cadena | Dirección URL definida para un repositorio cuando se crea. |
Las propiedades de navegación incluyen Project y su restricción ProjectSKreferencial .
ParallelPipelineJobsSnapshot
Las siguientes propiedades son válidas para el conjunto de entidades ParallelPipelineJobsSnapshot . Las claves de referencia incluyen:
IsHostedParallelismTagSamplingDate
| Nombre para mostrar | Nombre | Tipo de datos | Descripción |
|---|---|---|---|
| Hospedado o autohospedado | IsHosted |
Booleano | Indica si la canalización en paralelo se ejecuta en un agente hospedado por Microsoft (True) o está autohospedado (False). Para más información, consulte Agentes de Azure Pipelines. |
| No se pudo acceder a todos los proveedores | FailedToReachAllProviders |
Booleano | 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 |
Cadena | Etiqueta que indica el tipo de paralelismo asociado a la instantánea de trabajo. |
| Tipo Premium | IsPremium |
Booleano | 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 |
|---|---|---|---|
| Id. de canalización | PipelineId |
Int32 | Identificador asignado a la canalización. |
| Nombre de canalización | PipelineName |
Cadena | 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 los trabajos y cada canalización tiene al menos un trabajo. Para obtener más información, consulte Especificación de trabajos en la canalización.
Las siguientes propiedades son válidas para PipelineJobs y su PipelineJobSK clave suplente.
| Nombre para mostrar | Nombre | Tipo de datos | Descripción |
|---|---|---|---|
| Nombre completo del trabajo de canalización | FullJobName |
Cadena | Nombre completo de un trabajo de canalización. |
| Id. 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 |
Cadena | Identificador de trabajo asignado a un trabajo de canalización cuando se crea. |
| Nombre del trabajo de canalización | JobName |
Cadena | Nombre asignado al trabajo de canalización. |
| Nombre de la fase de canalización | StageName |
Cadena | Nombre de la fase asociado al trabajo de canalización. |
| Atributos de estrategia de trabajo de canalización | StrategyAttributes |
Cadena | Atributos definidos para el trabajo de canalización. |
| Identificador de fase | StageId |
Cadena | 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 sola 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 clave suplente PipelineRunSK .
| 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 finaliza 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 |
Cadena | 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 | Número total de segundos que la canalización estaba en la cola y se ejecutó. |
Propiedades de navegación
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 en | CompletedOn |
CompletedDateSK |
DateSK |
| Activado en cola | QueuedOn |
QueuedDateSK |
DateSK |
| Iniciado en | StartedOn |
QueuedDateSK |
DateSK |
| Canalización | Pipeline |
PipelineSK |
PipelineSK |
| Proyecto | Project |
ProjectSK |
ProjectSK |
Miembros de tipo enumerados PipelineRunReason
Los siguientes miembros se definen para el PipelineRunReason tipo enumerado que indica las condiciones en las que se ejecuta cada fase de canalización, trabajo o paso, tal como se describe en Especificar condiciones.
| Nombre del miembro | Valor | Nombre para mostrar |
|---|---|---|
None |
0 | Ninguno |
Manual |
1 | Manual |
IndividualCI |
2 | Integración continua individual |
BatchedCI |
4 | CI por lotes |
Schedule |
8 | Programación |
UserCreated |
32 | Usuario creado |
ValidateShelveset |
64 | Validar conjunto de estantes |
CheckInShelveset |
128 | Registro en estantes |
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 siguientes propiedades 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 del 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 finaliza la ejecución. |
| Duración de la actividad segundos | ActivityDurationSeconds |
Decimal | 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. |
| Tiempo de inicio relativo desde segundos de trabajo | RelativeStartTimeFromJobSeconds |
Int32 | Número de segundos transcurridos desde el inicio del trabajo. |
| Tiempo de inicio relativo a partir de segundos de fase | RelativeStartTimeFromStageSeconds |
Int32 | Número de segundos transcurridos desde el inicio de la fase. |
| Tiempo de inicio relativo 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 omitidas. |
| 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 |
Cadena | Nombre de una tarea ejecutada en la ejecución de la canalización. |
| Ruta de acceso del registro de tareas | TaskLogPath |
Cadena | 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.
Propiedades de navegació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 en | 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 |
| Proyecto | 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 |
Cadena | 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. de 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 siguientes propiedades 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 |
Booleano | Indica si la compilación está en cola (True) o no está en cola (False). |
| Compilación en ejecución | IsRunning |
Booleano | Indica si la compilación se está ejecutando (True) o no se está ejecutando (False). |
| Hospedado o autohospedado | IsHosted |
Booleano | 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 finalizó en ejecución. |
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 |
Cadena | 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. |
| Hora de ejemplo | 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 se inició la ejecución de la solicitud del agente de tareas, expresada como YYYYMMDD en la zona horaria definida para la organización. |
Las propiedades de navegación incluyen las enumeradas en la tabla siguiente.
| Nombre para mostrar | Nombre | Restricción referencial | -Referenced (propiedad) |
|---|---|---|---|
| Rama | Branch |
BranchSK |
BranchSK |
| Completado en | CompletedOn |
CompletedDateSK |
DateSK |
| Hora de finalización del trabajo | FinishedOn |
FinishedDateSK |
DateSK |
| Activado en cola | QueuedOn |
QueuedDateSK |
DateSK |
| Canalización | Pipeline |
PipelineSK |
PipelineSK |
| Proyecto | Project |
ProjectSK |
ProjectSK |
| Iniciado en | StartedOn |
QueuedDateSK |
DateSK |