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