Модель данных для аналитики

Azure DevOps Services | Azure DevOps Server 2022 г. - Azure DevOps Server 2019 г.

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

Примечание

Служба аналитики автоматически включается и поддерживается в рабочей среде для всех Azure DevOps Services. Интеграция Power BI и доступ к веб-каналу OData службы аналитики являются общедоступными. Мы рекомендуем вам использовать его и оставить отзыв. Доступные данные зависят от версии. Последняя поддерживаемая версия — v2.0, а последняя предварительная версия — v4.0-preview. Дополнительные сведения см. в разделе Управление версиями API OData.

Примечание

Служба аналитики автоматически устанавливается и поддерживается в рабочей среде для всех новых коллекций проектов для Azure DevOps Server 2020 и более поздних версий. Интеграция Power BI и доступ к веб-каналу OData службы аналитики являются общедоступными. Мы рекомендуем вам использовать его и оставить отзыв. Если вы обновили с Azure DevOps Server 2019 года, вы можете установить службу Аналитики во время обновления.

Доступные данные зависят от версии. Последняя поддерживаемая версия — v2.0, а последняя предварительная версия — v4.0-preview. Дополнительные сведения см. в разделе Управление версиями API OData.

Примечание

Служба аналитики доступна в предварительной версии для Azure DevOps Server 2019 г. Его можно включить или установить для коллекции проектов. Интеграция Power BI и доступ к веб-каналу OData службы аналитики доступны в предварительной версии. Мы рекомендуем вам использовать его и оставить отзыв.

Доступные данные зависят от версии. Последняя поддерживаемая версия — v2.0, а последняя предварительная версия — v4.0-preview. Дополнительные сведения см. в разделе Управление версиями API OData.

Пространства имен схемы

Модель данных Аналитики основана на двух пространствах имен схемы:

  • Microsoft.VisualStudio.Services.Analytics.Model
  • Microsoft.VisualStudio.Services.Analytics.

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

Типы сущностей называются структурированными типами с ключом. Они определяют именованные свойства и связи каждой сущности. Ключ EntityType формируется из подмножества примитивных свойств, например WorkItemId, PipelineId, ReleasePipelineId и других типов сущностей.

Наборы сущностей — это именованные коллекции сущностей. Например, — это набор сущностей, WorkItems содержащий сущности WorkItem . Ключ сущности однозначно идентифицирует сущность в наборе сущностей. Если несколько наборов сущностей используют один и тот же тип сущностей, то одно и то же сочетание значений ключей может отображаться в нескольких наборах сущностей и идентифицирует разные сущности, по одной для каждого набора сущностей, где отображается эта комбинация ключей. Каждая из этих сущностей имеет свой идентификатор сущности. Наборы сущностей предоставляют точки входа в модель данных.

Наборы сущностей описаны в разделе Метаданные OData и зависят от проекта. Вы можете изучить полный список наборов сущностей, типов сущностей и свойств, запросив метаданные OData для проекта. Дополнительные сведения см. в статье Создание запросов OData для аналитики.

Составные сущности

Составные сущности поддерживают определенные сценарии. Они состоят из более простых сущностей, часто требуют больше вычислительных ресурсов для создания и могут возвращать большие результирующие наборы. Чтобы достичь наилучшей производительности и избежать ненужного регулирования, убедитесь, что вы запрашиваете правильную сущность для вашего сценария.

Например, объединяет WorkItemRevisions и Dates таким образом, WorkItemSnapshot что каждая дата имеет по одной редакции для каждого рабочего элемента. Это представление поддерживает запросы OData, ориентированные на данные тренда для отфильтрованного набора рабочих элементов. Однако не следует использовать эту составную сущность для запроса текущего состояния рабочих элементов. Вместо этого следует использовать набор сущностей WorkItems , чтобы создать более быстрый запрос.

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

Отношения

Для создания более сложных результатов запроса можно объединять сущности с помощью связей. Вы можете использовать связи для развертывания, фильтрации или суммы данных.

Некоторые свойства навигации приводят к созданию одной сущности, а другие — к коллекции сущностей. На следующей схеме показаны выборки сущностей и их свойства навигации. Для ясности некоторые составные сущности и связи были опущены.

Схема отношений для модели данных Аналитики.

Ключи связи

Связи сущностей также представлены в виде внешних ключей, чтобы внешние средства могли объединять сущности. Эти свойства имеют суффикс "SK" и являются целыми числами или типами данных GUID. Свойства date имеют соответствующие целочисленные ключевые свойства даты в следующем формате: ГГГГММДД.

Типы сущностей и наборы сущностей отслеживания работы

Указанные версии API поддерживают следующие типы сущностей и наборы сущностей. Полный справочник см. в статье Справочник по метаданным отслеживания работы для Azure Boards Analytics.

EntityType/EntitySet Описание Версия 1.0 Версия 2.0 Версия 3.0 (предварительная версия) версия 4.0-preview
Области/
Области
Путь к области рабочего элемента со свойствами для группировки и фильтрации по иерархии областей. ✔️ ✔️ ✔️ ✔️
Итерации/
Количество итераций
Пути итерации рабочего элемента со свойствами для группировки и фильтрации по иерархии итерации. ✔️ ✔️ ✔️ ✔️
BoardLocation/
BoardLocations
Расположение ячеек канбан-доски, определяемое столбцом доски, дорожкой и разделением, включает исторические параметры доски. Описание каждого поля канбан-доски см. в разделе Поля рабочих процессов и канбан-доски. ✔️ ✔️ ✔️ ✔️
CalendarDate/
Даты
Даты, используемые для фильтрации и группировки других сущностей с помощью связей. ✔️ ✔️ ✔️ ✔️
Project/
Проекты
Все проекты, определенные для организации (облака) или коллекции проектов (локально). ✔️ ✔️ ✔️ ✔️
Процесс/
Процессы
Сведения о невыполненной работе, используемые для развертывания или фильтрации рабочих элементов и типов рабочих элементов. Пример использования процессов для фильтрации отчета см. в разделе Пример отчета для отслеживания требований. ✔️ ✔️ ✔️
Тег/
Теги
Все теги рабочих элементов для каждого проекта. Пример использования тегов для фильтрации отчета см. в разделе Пример отчета о выпуске сгорания. ✔️ ✔️ ✔️ ✔️
Команда/
Teams
Все команды, определенные для проекта. Пример использования Teams для фильтрации отчета см. в статье Добавление среза команды в отчет Power BI. ✔️ ✔️ ✔️ ✔️
Пользователя/
Пользователи
Сведения о пользователе, используемые для развертывания или фильтрации различных свойств рабочих элементов, например Назначено, Создано. ✔️ ✔️ ✔️ ✔️
WorkItemBoardSnapshot/
WorkItemBoardSnapshot
(Составной) Состояние каждого рабочего элемента на каждую дату календаря, включая расположение канбан-доски, используемое для создания отчетов о тенденциях. Пример отчета см. в разделе Пример отчета о совокупной схеме потоков (CFS). ✔️ ✔️ ✔️ ✔️
WorkItemLink/
WorkItemLinks
Связи между рабочими элементами, например дочерними, родительскими и связанными. Включает только последнюю редакцию ссылок, без журнала. Гиперссылки не включаются. ✔️ ✔️ ✔️ ✔️
WorkItemRevision/
WorkItemRevisions
Все исторические редакции рабочих элементов, включая текущую редакцию. Не включает удаленные рабочие элементы. ✔️ ✔️ ✔️ ✔️
WorkItemSnapshot/
WorkItemSnapshot
(Составной) Состояние каждого рабочего элемента на каждую дату календаря, используемое для поддержки отчетов о тенденциях. Пример отчета см. в разделе Пример отчета о тенденциях ошибок. ✔️ ✔️ ✔️ ✔️
Workitem/
WorkItems
Текущее состояние рабочих элементов. Используется для поддержки отчетов о состоянии. Пример отчета см. в разделе Свертка значений дочерних рабочих элементов в родительский пример отчета. ✔️ ✔️ ✔️ ✔️
WorkItemTypeField/
WorkItemTypeFields
Свойства рабочего элемента для каждого типа рабочего элемента и процесса. Используется для поддержки создания отчетов. ✔️ ✔️ ✔️ ✔️

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

Следующие типы сущностей и наборы сущностей поддерживаются в версии 3.0-preview или v4.0-preview Analytics. Полный справочник см. в статье Справочник по метаданным конвейера .

EntityType/EntitySet Описание Версия 3.0 (предварительная версия) версия 4.0-preview
Филиал/
Ветви
Основные сведения о ветвях, используемых в тестах или конвейерах. Пример отчета см. в разделе Пример отчета о состоянии хода выполнения. ✔️ ✔️
ParallelPipelineJobsSnapshot/
ParallelPipelineJobsSnapshot
(Составной) Поддерживает понимание использования параллельных конвейеров. Дополнительные сведения о параллельных тестах конвейера см. в статье Параллельное выполнение тестов с помощью задачи тестирования Visual Studio. ✔️
Трубопровода/
Конвейеры
Свойства для конвейера. ✔️ ✔️
PipelineJob/
Конвейерные задания
Отдельные результаты выполнения для определенного теста, связанного с TestRun ✔️ ✔️
PipelineRun/
PipelineRuns
Сведения о выполнении для конвейеров. Пример отчета см. в разделе Отчет о тренде скорости прохода конвейера. ✔️ ✔️
PipelineRunActivityResult/
PipelineRunActivityResults
Объединенный журнал всех этапов, шагов, заданий и задач в рамках выполнения определенного конвейера. Пример отчета см. в разделе Отчет о длительности задачи конвейера. ✔️ ✔️
PipelineTask/
PipelineTasks
Свойства для задач, используемых в конвейере. ✔️ ✔️
TaskAgentPoolSizeSnapshot/
TaskAgentPoolSizeSnapshots
(Составной) Поддерживает понимание размера пула, заданий конвейера и параллелизма. На графе с историей для пулов агентов показано, как можно использовать этот набор сущностей. ✔️
TaskAgentRequestSnapshot/
TaskAgentRequestSnapshots
(Составной) ✔️

Тестирование типов сущностей и наборов сущностей

В версии 3.0-preview или v4.0-preview поддерживаются следующие типы сущностей и наборы сущностей. Полный справочник см. в разделе Справочник по метаданным теста.

EntityType/EntitySet Описание Версия 3.0 (предварительная версия) Версия 4.0-preview
TestConfiguration/
TestConfigurations
Сведения о конфигурации плана тестирования. Дополнительные сведения о настройке тестов см. в статье Тестирование различных конфигураций. ✔️ ✔️
TestResult/
TestResults
Отдельные результаты выполнения для определенного теста , связанного с TestRun. ✔️ ✔️
TestResultsDaily/
TestResultsDaily
Ежедневное snapshot агрегирование выполнений TestResult, сгруппированных по test (а не TestRun). Пример отчета см. в разделе Пример отчета о сводных тенденциях тестирования. ✔️ ✔️
TestRun/
TestRuns
Сведения о выполнении тестов, выполняемых в конвейере с агрегатом TestResult. ✔️ ✔️
Тестирование/
Тесты
Свойства тестового случая, например имя теста и владелец теста. Дополнительные сведения об определении тестовых случаев см. в разделе Создание тестовых случаев вручную. ✔️ ✔️
TestPoint/
TestPoints
Сведения о выполнении для тестовых точек. Точка тестирования — это уникальное сочетание тестового случая, набора тестов, конфигурации и тестировщика. Пример отчета см. в разделе Пример отчета о состоянии хода выполнения. ✔️ ✔️
TestPointHistorySnapshot/
TestPointHistorySnapshots
(Составной) Отдельные результаты выполнения для определенного теста , связанного с TestRun. Пример отчета см. в разделе Пример отчета о тенденциях выполнения тестов вручную. ✔️ ✔️
TestSuite/
TestSuites
Сведения о наборах тестов. Дополнительные сведения об определении наборов тестов см. в статье Создание планов тестирования и наборов тестов. ✔️ ✔️