Справочник по метаданным для Аналитики Azure Pipelines

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

Аналитика собирает данные о конвейере и тестовой активности, созданные с помощью Azure Pipelines. В этой статье описываются свойства, которые можно использовать для создания отчета аналитики для конвейеров. Вы используете сочетание свойств для фильтрации запроса, агрегирования данных или создания отчета.

Примечание.

В этой статье содержатся описания сущностей, свойств и перечисленных типов, поддерживаемых моделью данных Аналитики. Сведения о запросе модели данных см. в разделе "Создание запросов OData для аналитики".

Наборы сущностей и типы сущностей

В следующей таблице перечислены типы сущностей и наборы сущностей, поддерживающие Azure Pipelines. Все типы сущностей и наборы сущностей доступны в предварительной версии Analytics версии 4.0. Аналитика версии v3.0-preview не поддерживает моментальные снимки.

EntitySet EntityType Описание
Филиалы Филиал Основные сведения о ветвях, используемых в тестах или конвейерах. Пример отчета см . в примере отчета о состоянии хода выполнения.
ParallelPipelineJobsSnapshot ParallelPipelineJobsSnapshot (Составной) Поддерживает понимание расхода параллельных конвейеров. Дополнительные сведения о параллельных тестах потоков см. в статье Запуск тестов в параллельном режиме с использованием задачи Visual Studio Test.
Конвейеры Конвейер Свойства конвейера.
Задания Pipeline 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 . К эталонным ключам относятся:

  • IsHosted
  • ParallelismTag
  • SamplingDate
Отображаемое имя Имя Тип данных Description
Размещение или локальное размещение IsHosted Логический Указывает, запущен ли параллельный конвейер на размещенном корпорацией Майкрософт агенте (True) или является ли локальным (False). Для получения дополнительной информации см. Агенты Azure Pipelines.
Не удалось связаться со всеми поставщиками FailedToReachAllProviders Логический Указывает, достигло ли выполнение задания всех поставщиков (Истина) или нет (Ложь).
Количество заданий параллельных конвейеров TotalCount Int32 Количество заданий, выполняемых в рамках моментального снимка.
Количество минут параллельных конвейеров TotalMinutes Int32 Количество минут, затраченных на запуск моментального снимка.
Тип параллелизма ParallelismTag Строка Тег, указывающий тип параллелизма, связанного с моментальным снимком задания.
Тип "Премиум" IsPremium Логический Указывает, является ли параллельный конвейер премиум (True) или нет (False).
Пример даты SamplingDate Дата/время Дата, связанная с моментальным снимком.

Pipelines

Следующие свойства допустимы для конвейеров и его суррогатного ключа PipelineSK.

Отображаемое имя Имя Тип данных Description
Идентификатор конвейера PipelineId Int32 Идентификатор, назначенный потоку данных.
Имя конвейера PipelineName Строка Имя, назначенное конвейеру.
Версия конвейера PipelineVersion Int32 Версия, связанная с конвейером.
Тип процесса конвейера PipelineProcessType Перечисленный Тип определения конвейера. Допустимые значения перечислены ниже для 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 Перечисленный Результат, назначенный конвейеру после завершения его выполнения. Допустимые значения перечислены ниже для PipelineRunOutcome.
Причина выполнения RunReason Перечисленный Условие, вызвавшее запуск конвейера. Допустимые значения перечислены ниже для 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 Проверка Shelveset
CheckInShelveset 128 Проверка в Shelveset
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 Перечисленный Тип действия конвейера. Допустимые значения перечислены ниже для PipelineActivityType.
Идентификатор запуска конвейера PipelineRunId Int32 Номер, назначенный конвейеру при выполнении.
Результат выполнения конвейера PipelineRunOutcome Перечисленный Результат, назначенный конвейеру после завершения его выполнения. Допустимые значения перечислены в разделе 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 Одобрение
AgentWait 2 Агент ожидает

Задачи конвейера

Следующие свойства допустимы для набора сущностей PipelineTasks и его суррогатного ключа PipelineTaskSK.

Отображаемое имя Имя Тип данных Description
Идентификатор определения задачи TaskDefinitionId GUID GUID, назначенный задаче конвейера.
Версия определения задачи TaskDefinitionVersion Строка Версия, назначенная задаче конвейера.

Свойства навигации включают Project и его ссылочное ограничение ProjectSK.

СнимкиРазмеровПулаАгентовЗадач

Следующие свойства допустимы для набора сущностей TaskAgentPoolSizeSnapshots и суррогатного ключа SamplingDate.

Отображаемое имя Имя свойства Тип данных Description
Количество пользователей в Интернете OnlineCount Int32 Количество агентов онлайн в пуле агентов при выполнении задачи.
Счетчик оффлайн OfflineCount Int32 Количество агентов, находившихся в офлайн-режиме в пуле агентов при запуске задачи.
Идентификатор пула PoolId Int32 Номер, назначенный пулу агентов.
Пример даты SamplingDate Дата/время Дата и время, когда был сделан снимок размера пула.

Пример отчета, созданного на основе сущности TaskAgentPoolSizeSnapshot, см. в разделе Исторический график для пулов агентов (предварительная версия).

TaskAgentRequestSnapshots

Пулы агентов выделяются при выполнении задачи. Набор сущностей TaskAgentRequestSnapshots записывает данные, связанные с запросами агента задач.

Следующие свойства допустимы для типа сущности TaskAgentRequestSnapshot и суррогатных ключей SamplingTime и SamplingDateSK.

Отображаемое имя Имя Тип данных Description
Сборка в очереди IsQueued Логический Указывает, находится ли сборка в очереди (True) или не находится в очереди (False).
Запуск сборки IsRunning Логический Указывает, запущена ли сборка (Истина) или не запущена (Ложь).
Размещение или локальное размещение IsHosted Логический Указывает, является ли агент, назначенный на задачу, размещённым (True) или самоуправляемым (False).
Дата окончания задания FinishedDate Дата/время Дата и время завершения выполнения запроса агента задачи.
FinishedDateSK Int32 Дата завершения выполнения запроса агента задачи, выраженного как YYYYMMDD в часовом поясе, определенном для организации.
Дата очереди QueuedDate Дата/время Дата и время, когда запрос агента задачи был поставлен в очередь.
QueuedDateSK Int32 Дата постановки запроса задачи агентом в очередь выражена как YYYYMMDD в часовом поясе, определенном для организации.
Длительность очереди в секундах QueueDurationSeconds Десятичное число Количество секунд, в течение которых запрос агента оставался в очереди до назначения исполнителя.
Идентификатор пула PoolId Int32 Номер, присвоенный пулу агентов, назначенному для выполнения запроса агента задачи.
Тип конвейера PipelineType Строка Тип конвейера, содержащий запрос агента задачи.
Идентификатор запроса RequestId Int64 Номер, назначенный запросу агента обработки задач.
Пример часа SamplingHour Int32 Номер, присвоенный часу получения запроса.
Пример времени SamplingTime Дата/время Дата и время поступления запроса от агента задачи.
Дата начала StartedDate Дата/время Дата и время выполнения запроса агента задачи.
StartedDateSK Int32 Дата запуска запроса агента задачи, выраженная как YYYYMMDD в часовом поясе, определенном для организации.

Свойства навигации включают те, которые перечислены в следующей таблице.

Отображаемое имя Имя. Ограничение ссылок -Ссылаемое свойство
Филиал Branch BranchSK BranchSK
Завершено CompletedOn CompletedDateSK DateSK
Время окончания задания FinishedOn FinishedDateSK DateSK
В очереди QueuedOn QueuedDateSK DateSK
Конвейер Pipeline PipelineSK PipelineSK
Проект Project ProjectSK ProjectSK
Начало работы StartedOn QueuedDateSK DateSK
  • Last updated on