Справочник по метаданным для Аналитики Azure Pipelines
Azure DevOps Services | Azure DevOps Server 2022 — Azure DevOps Server 2019
Служба Аналитики собирает конвейер и тестовые действия, созданные с помощью Azure Pipelines. В этой статье описываются свойства, которые можно использовать для создания отчета аналитики для конвейеров. Вы используете сочетание свойств для фильтрации запроса, агрегирования данных или создания отчета.
Примечание.
Приведены описания сущностей, свойств и перечисленных типов, поддерживаемых моделью данных Аналитики. Это ранний проект. Укажите отзывы о областях, которые вы хотите получить дополнительные сведения. Сведения о запросе модели данных см. в разделе "Создание запросов OData для аналитики".
Наборы сущностей и типы сущностей
В следующей таблице перечислены типы сущностей и наборы сущностей, поддерживающие Azure Pipelines. Все типы сущностей и наборы сущностей доступны в предварительной версии Analytics версии 4.0. Аналитика версии 3.0-preview не поддерживает моментальные снимки.
| EntitySet | EntityType | Description |
|---|---|---|
| Ветви | Ветвь | Основные сведения о ветвях, используемых в тестах или конвейерах. Пример отчета см . в примере отчета о состоянии хода выполнения. |
| ParallelPipelineJobsSnapshot | ParallelPipelineJobsSnapshot | (Составной) Поддерживает понимание использования параллельных конвейеров. Дополнительные сведения о параллельных тестах конвейера см. в статье "Параллельное выполнение тестов" с помощью задачи "Тест Visual Studio". |
| Конвейеры | Конвейер | Свойства конвейера. |
| Задания конвейера | PipelineJob | Отдельные результаты выполнения для определенного теста, связанного с TestRun |
| PipelineRuns | PipelineRun | Сведения о выполнении конвейеров. Пример отчета см . в примере отчета о скорости передачи конвейера. |
| PipelineRunActivityResults | PipelineRunActivityResult | Объединенный журнал всех этапов, шагов, заданий и задач в рамках определенного выполнения конвейера. Пример отчета см . в примере отчета о длительности задачи конвейера. |
| PipelineTasks | PipelineTask | Свойства для задач, используемых в конвейере. |
| TaskAgentPoolSizeSnapshots | TaskAgentPoolSizeSnapshot | (Составной) Поддерживает понимание размера пула, заданий конвейера и параллелизма. График журнала для пулов агентов иллюстрирует, как можно использовать этот набор сущностей . |
| TaskAgentRequestSnapshots | TaskAgentRequestSnapshot | (Составной) Поддерживает отчеты о запросах агента задач. |
Ветви
Следующие свойства допустимы для набора сущностей "Ветви ". Суррогатные ключи, связанные с ветвью , включают BranchSK и ProjectSK.
| Отображаемое имя | Имя | Тип данных | Description |
|---|---|---|---|
AnalyticsUpdatedDate |
Дата/время | Подложка, указывающая время последнего обновления данных Аналитики. | |
| Имя ветви | BranchName |
Строка | Имя, назначенное ветви при его создании. |
| Идентификатор репозитория | RepositoryId |
Строка | Номер, назначенный репозиторию при его создании. |
| Идентификатор vsts репозитория | RepositoryVstsId |
Строка | Номер, назначенный репозиторию TFVC при его создании. |
| РепозиторийUrl | RepositoryUrl |
Строка | URL-адрес, определенный для репозитория при его создании. |
Свойства навигации включают Project и его ссылочное ограничение ProjectSK.
ParallelPipelineJobsSnapshot
Следующие свойства допустимы для набора сущностей ParallelPipelineJobsSnapshot . К эталонным ключам относятся:
IsHostedParallelismTagSamplingDate
| Отображаемое имя | Имя | Тип данных | Description |
|---|---|---|---|
| Размещение или локальное размещение | IsHosted |
Логический | Указывает, запущен ли параллельный конвейер на размещенном корпорацией Майкрософт агенте (True) или является ли локальным (False). Дополнительные сведения см. в описании Агенты Azure Pipelines. |
| Не удалось связаться со всеми поставщиками | FailedToReachAllProviders |
Логический | Указывает, достиг ли выполнение задания всех поставщиков (True) или нет (False). |
| Количество заданий параллельных конвейеров | TotalCount |
Int32 | Количество заданий, выполняемых в рамках моментального снимка. |
| Количество минут параллельных конвейеров | TotalMinutes |
Int32 | Количество минут, затраченных на запуск моментального снимка. |
| Тип параллелизма | ParallelismTag |
Строка | Тег, указывающий тип параллелизма, связанного с моментальным снимком задания. |
| Тип "Премиум" | IsPremium |
Логический | Указывает, является ли параллельный конвейер премиум (True) или нет (False). |
| Пример даты | SamplingDate |
Дата/время | Дата, связанная с моментальным снимком. |
Pipelines
Следующие свойства допустимы для конвейеров и его суррогатного ключа PipelineSK.
| Отображаемое имя | Имя | Тип данных | Description |
|---|---|---|---|
| Идентификатор конвейера | PipelineId |
Int32 | Идентификатор, назначенный конвейеру. |
| Имя конвейера | PipelineName |
Строка | Имя, назначенное конвейеру. |
| Версия конвейера | PipelineVersion |
Int32 | Версия, связанная с конвейером. |
| Тип процесса конвейера | PipelineProcessType |
Enumerated | Тип определения конвейера. Допустимые значения перечислены ниже для PipelineProcessType. |
Свойства навигации включают Project и его ссылочное ограничение ProjectSK.
Элементы перечисленного типа PipelineProcessType
Следующие элементы определяются для перечисленного типа, указывающего метод, используемый для PipelineProcessType определения конвейера.
| Имя участника | Значение | Определение |
|---|---|---|
Designer |
1 | Классическое определение конвейера. |
Yaml |
2 | Определение конвейера YAML. |
Docker |
3 | Определение конвейера Docker. |
Задания конвейера
Задание конвейера — это ряд шагов, которые выполняются последовательно в виде единицы. Задание — это наименьшая единица работы, которую можно запланировать. Конвейеры организованы вокруг заданий, и каждый конвейер имеет по крайней мере одно задание. Дополнительные сведения см. в разделе Указание заданий в конвейере.
Следующие свойства допустимы для PipelineJobs и его PipelineJobSK суррогатного ключа.
| Отображаемое имя | Имя | Тип данных | Description |
|---|---|---|---|
| Полное имя задания конвейера | FullJobName |
Строка | Полное имя задания конвейера. |
| Идентификатор конвейера | PipelineId |
Int32 | Идентификатор, назначенный конвейеру, в котором определено задание. |
| Идентификатор задания конвейера | JobId |
Строка | Идентификатор задания, назначенный заданию конвейера при его создании. |
| Имя задания конвейера | JobName |
Строка | Имя, назначенное заданию конвейера. |
| Имя этапа конвейера | StageName |
Строка | Имя этапа, связанное с заданием конвейера. |
| Атрибуты стратегии задания конвейера | StrategyAttributes |
Строка | Атрибуты, определенные для задания конвейера. |
| Идентификатор этапа | StageId |
Строка | Идентификатор этапа, связанный с заданием конвейера. |
Свойства навигации включают Project и его ссылочное ограничение ProjectSK.
Пример отчета, который запрашивает тип сущности PipelineJob , см . в примере отчета о сбоях этапа конвейера.
PipelineRuns
Запуск конвейера представляет собой одно выполнение конвейера. Во время выполнения конвейер обрабатывается, а агенты обрабатывают одно или несколько заданий. Запуск конвейера включает задания, шаги и задачи. Дополнительные сведения см. в разделе "Последовательность выполнения конвейера".
Следующие свойства допустимы для типа сущности PipelineRun и его PipelineRunSK суррогатного ключа.
| Отображаемое имя | Имя | Тип данных | Description |
|---|---|---|---|
| Отмененное число | CanceledCount |
Int32 | Количество отмененных запусков конвейера. |
| Дата завершения | CompletedDate |
Дата/время | Дата и время завершения выполнения конвейера. |
| Число неудачных данных | FailedCount |
Int32 | Количество успешных запусков конвейера. |
| Номер редакции | RunNumberRevision |
Int32 | Номер, назначенный конвейеру с последовательными выполнениями. |
| Частично успешное число | PartiallySucceededCount |
Int32 | Количество успешно выполненных конвейеров. |
| Идентификатор запуска конвейера | PipelineRunId |
Int32 | Номер, назначенный выполнению конвейера. |
| Дата очереди | QueuedDate |
Дата/время | Дата и время выполнения конвейера. |
| Длительность очереди в секундах | QueueDurationSeconds |
Десятичное число | Количество секунд, в течение которых конвейер остался в очереди. |
| Номер выполнения | RunNumber |
Строка | Номер, назначенный конвейеру при выполнении. |
| Результат выполнения | RunOutcome |
Enumerated | Результат, назначенный конвейеру после завершения его выполнения. Допустимые значения перечислены ниже для PipelineRunOutcome. |
| Причина выполнения | RunReason |
Enumerated | Условие, вызвавшее запуск конвейера. Допустимые значения перечислены ниже для PipelineRunReason. |
| Время выполнения секунд | RunDurationSeconds |
Десятичное число | Время выполнения конвейера занимает несколько секунд. |
| Дата начала | StartedDate |
Дата/время | Дата и время начала выполнения конвейера. |
| Успешное число | SucceededCount |
Int32 | Количество успешных запусков конвейера. |
| Общая длительность секунд | TotalDurationSeconds |
Десятичное число | Общее количество секунд, в течение которых конвейер находился в очереди и выполнялся. |
Свойства навигации
Поддерживаются следующие свойства навигации.
| Отображаемое имя | Имя. | -Ссылочная ограничение | Свойство, на которое ссылается ссылка |
|---|---|---|---|
| Ветвь | Branch |
BranchSK |
BranchSK |
| Завершено | CompletedOn |
CompletedDateSK |
DateSK |
| В очереди | QueuedOn |
QueuedDateSK |
DateSK |
| Начало работы | StartedOn |
QueuedDateSK |
DateSK |
| Конвейер | Pipeline |
PipelineSK |
PipelineSK |
| Проект | Project |
ProjectSK |
ProjectSK |
Элементы перечисленного типа PipelineRunReason
Следующие члены определяются для PipelineRunReason перечисленного типа, указывающего условия, в которых выполняется каждый этап конвейера, задание или шаг, как описано в разделе "Указать условия".
| Имя участника | Значение | Отображаемое имя |
|---|---|---|
None |
0 | None |
Manual |
1 | Вручную |
IndividualCI |
2 | Отдельная CI |
BatchedCI |
4 | Пакетная CI |
Schedule |
8 | Расписание |
UserCreated |
32 | Пользователь создан |
ValidateShelveset |
64 | Проверка набора полок |
CheckInShelveset |
128 | Проверка набора полок |
PullRequest |
256 | Запрос на вытягивание |
PipelineRunCompletion |
512 | Завершение сборки |
Элементы перечисленного типа PipelineRunOutcome
Следующие элементы определяются для PipelineRunOutcome перечисленного типа, указывающего результат выполнения конвейера.
| Имя участника | Значение | Отображаемое имя |
|---|---|---|
None |
0 | None |
Succeed |
2 | Успешно |
PartiallySucceeded |
4 | Частично выполнено |
Failed |
6 | Неудачно |
Canceled |
32 | Отменено |
PipelineRunActivityResults
Следующие свойства допустимы для набора сущностей PipelineRunActivityResults и суррогатного PipelineRunActivityResultSK ключа.
Многие свойства основаны на дате или на основе пользователей. Эти свойства связаны с наборами сущностей CalendarDate и User , описанными в разделе "Дата календаря", "Проект" и "Метаданные пользователя".
| Отображаемое имя | Имя | Тип данных | Description |
|---|---|---|---|
| Отброшенное число | AbandonedCount |
Int32 | Количество запусков конвейера, помеченных как заброшенные. |
| Дата завершения действия | ActivityCompletedDate |
Дата/время | Дата и время завершения выполнения конвейера. |
| Длительность действия в секундах | ActivityDurationSeconds |
Десятичное число | Общее количество секунд, в течение которых конвейер находился в очереди и выполнялся. |
| Дата начала действия | ActivityStartedDate |
Дата/время | Дата запуска конвейера. |
| Отмененное число | CanceledCount |
Int32 | Количество отмененных запусков конвейера. |
| Число неудачных данных | FailedCount |
Int32 | Количество неудачных запусков конвейера. |
| Тип действия конвейера | ActivityType |
Enumerated | Тип действия конвейера. Допустимые значения перечислены ниже для PipelineActivityType. |
| Идентификатор запуска конвейера | PipelineRunId |
Int32 | Номер, назначенный конвейеру при выполнении. |
| Результат выполнения конвейера | PipelineRunOutcome |
Enumerated | Результат, назначенный конвейеру после завершения его выполнения. Допустимые значения перечислены в разделе PipelineRunOutcome. |
| Относительное время начала с секунд задания | RelativeStartTimeFromJobSeconds |
Int32 | Количество секунд, прошедших с начала задания. |
| Относительное время начала с этапа секунд | RelativeStartTimeFromStageSeconds |
Int32 | Количество секунд, прошедших с начала этапа. |
| Относительное время начала от секунд выполнения | RelativeStartTimeFromRunSeconds |
Int32 | Количество секунд, прошедших после выполнения выполнения. |
| Пропущенное число | SkippedCount |
Int32 | Количество пропущенных запусков конвейера. |
| Успешное число | SucceededCount |
Int32 | Количество успешных запусков конвейера. |
| Выполнено успешно с числом проблем | SucceededWithIssuesCount |
Int32 | Количество успешно выполненных конвейеров. |
| Отображаемое имя задачи | TaskDisplayName |
Строка | Имя задачи, выполняемой в выполнении конвейера. |
| Путь к журналу задач | TaskLogPath |
Строка | Путь к файлу журнала, созданному задачей. |
| Результат задачи | TaskOutcome |
Пользовательское | Результат выполняемой задачи. |
Примеры отчетов, запрашивающих тип сущности PipelineRunActivityResult , см . в примере отчета о тренде длительности конвейера.
Свойства навигации
Свойства навигации включают те, которые перечислены в следующей таблице.
| Отображаемое имя | Имя | Ограничение ссылок | Свойство, на которое ссылается ссылка |
|---|---|---|---|
| Действие, запущенное в | ActivityStartedOn |
ActivityStartedDateSK |
DateSK |
| Ветвь | Branch |
BranchSK |
BranchSK |
| Конвейер | Pipeline |
PipelineSK |
PipelineSK |
| Задача конвейера | PipelineTask |
PipelineTaskSK |
PipelineTaskSK |
| Задание конвейера | PipelineJob |
PipelineJobSK |
PipelineJobSK |
| Запуск конвейера в очереди | PipelineRunQueuedOn |
PipelineRunQueuedDateSK |
DateSK |
| Запуск конвейера запущен в | PipelineRunStartedOn |
PipelineRunStartedDateSK |
DateSK |
| Выполнение конвейера завершено в | PipelineRunCompletedOn |
PipelineRunCompletedDateSK |
DateSK |
| Запуск конвейера запущен в | PipelineRunStartedOn |
PipelineRunStartedDateSK |
DateSK |
| Проект | Project |
ProjectSK |
ProjectSK |
Элементы перечисленного типа PipelineActivityType
Для перечисленного типа определены PipelineActivityType следующие члены.
| Имя участника | Значение | Отображаемое имя |
|---|---|---|
Task |
0 | Задача |
Approval |
1 | Approval |
AgentWait |
2 | Ожидание агента |
PipelineTasks
Следующие свойства допустимы для набора сущностей PipelineTasks и его суррогатного ключа PipelineTaskSK.
| Отображаемое имя | Имя | Тип данных | Description |
|---|---|---|---|
| Идентификатор определения задачи | TaskDefinitionId |
GUID | GUID, назначенный задаче конвейера. |
| Версия определения задачи | TaskDefinitionVersion |
Строка | Версия, назначенная задаче конвейера. |
Свойства навигации включают Project и его ссылочное ограничение ProjectSK.
TaskAgentPoolSizeSnapshots
Следующие свойства допустимы для набора сущностей TaskAgentPoolSizeSnapshots и суррогатного ключа SamplingDate.
| Отображаемое имя | Имя свойства | Тип данных | Description |
|---|---|---|---|
| Количество пользователей в Интернете | OnlineCount |
Int32 | Количество агентов в сети в пуле агентов при выполнении задачи. |
| Автономное число | OfflineCount |
Int32 | Количество агентов в автономном режиме в пуле агентов при выполнении задачи. |
| Идентификатор пула | PoolId |
Int32 | Номер, назначенный пулу агентов. |
| Пример даты | SamplingDate |
Дата/время | Дата и время привязки размера пула. |
Пример отчета, созданного из сущности TaskAgentPoolSizeSnapshot, см. в разделе "Журнал" для пулов агентов (предварительная версия).
TaskAgentRequestSnapshots
Пулы агентов выделяются при выполнении задачи. Набор сущностей TaskAgentRequestSnapshots записывает данные, связанные с запросами агента задач.
Следующие свойства допустимы для типа сущности TaskAgentRequestSnapshot и суррогатных ключей SamplingTime и SamplingDateSK.
| Отображаемое имя | Имя | Тип данных | Description |
|---|---|---|---|
| Сборка в очереди | IsQueued |
Логический | Указывает, находится ли сборка в очереди (True) или не включена в очередь (False). |
| Выполнение сборки | IsRunning |
Логический | Указывает, запущена ли сборка (True) или не запущена (False). |
| Размещение или локальное размещение | IsHosted |
Логический | Указывает, размещается ли агент, назначенный задаче (True) или локально (False). |
| Дата окончания задания | FinishedDate |
Дата/время | Дата и время завершения выполнения запроса агента задачи. |
FinishedDateSK |
Int32 | Дата завершения выполнения запроса агента задачи, выраженного как YYYYMMDD в часовом поясе, определенном для организации. |
|
| Дата очереди | QueuedDate |
Дата/время | Дата и время, когда запрос агента задачи был поставлен в очередь. |
QueuedDateSK |
Int32 | Дата, когда запрос агента задачи был помещен в очередь, как YYYYMMDD в часовом поясе, определенном для организации. |
|
| Длительность очереди в секундах | QueueDurationSeconds |
Десятичное число | Количество секунд, в течение которых запрос агента задачи оставался в очереди до назначения агента. |
| Идентификатор пула | PoolId |
Int32 | Номер, назначенный пулу агентов, назначенный запросу агента задачи. |
| Тип конвейера | PipelineType |
Строка | Тип конвейера, содержащий запрос агента задачи. |
| Идентификатор запроса | RequestId |
Int64 | Номер, назначенный запросу агента задачи. |
| Пример часа | SamplingHour |
Int32 | Номер, назначенный часу при получении запроса. |
| Пример времени | SamplingTime |
Дата/время | Дата получения запроса агента задачи. |
| Дата начала | StartedDate |
Дата/время | Дата выполнения запроса агента задачи. |
StartedDateSK |
Int32 | Дата запуска запроса агента задачи, выраженная как YYYYMMDD в часовом поясе, определенном для организации. |
Свойства навигации включают те, которые перечислены в следующей таблице.
| Отображаемое имя | Имя. | Ограничение ссылок | -Referenced property |
|---|---|---|---|
| Ветвь | Branch |
BranchSK |
BranchSK |
| Завершено | CompletedOn |
CompletedDateSK |
DateSK |
| Время окончания задания | FinishedOn |
FinishedDateSK |
DateSK |
| В очереди | QueuedOn |
QueuedDateSK |
DateSK |
| Конвейер | Pipeline |
PipelineSK |
PipelineSK |
| Проект | Project |
ProjectSK |
ProjectSK |
| Начало работы | StartedOn |
QueuedDateSK |
DateSK |