Modelo de dados para Analytics

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

O modelo de dados do Analytics para Azure DevOps consiste em conjuntos de entidades, cujos membros (entidades) contêm propriedades que podem ser filtradas, agregadas e resumidas. Além disso, eles contêm propriedades de navegação que relacionam entidades entre si, fornecendo acesso a outras propriedades para seleção, filtragem e agrupamento.

Observação

O serviço do Analytics é habilitado automaticamente e tem suporte na produção para todos os Azure DevOps Services. A integração do Power BI e o acesso ao feed OData do serviço do Analytics estão em disponibilidade geral. Encorajamos você a usá-lo e nos dar feedback. Os dados disponíveis dependem da versão. A versão mais recente com suporte é v2.0, e a versão prévia mais recente é v4.0-preview. Para obter mais informações, confira Sobre o controle de versão da API OData.

Namespaces de esquema

O modelo de dados do Analytics é baseado em dois namespaces de esquema:

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

Conjuntos de entidades e tipos de entidade

Os tipos de entidade são chamados de tipos estruturados com uma chave. Eles definem as propriedades nomeadas e os relacionamentos de cada entidade. A chave de an EntityType é formada a partir de um subconjunto das propriedades primitivas, por exemplo, WorkItemId, PipelineId, ReleasePipelineId, e mais do tipo de entidade.

Os conjuntos de entidades são coleções nomeadas de entidades. Por exemplo, WorkItems é um conjunto de entidades que contém WorkItem entidades. A chave de uma entidade identifica exclusivamente a entidade dentro de um conjunto de entidades. Se vários conjuntos de entidades usarem o mesmo tipo de entidade, a mesma combinação de valores de chave poderá aparecer em mais de um conjunto de entidades e identificar entidades diferentes, uma por conjunto de entidades em que essa combinação de chaves aparece. Cada uma dessas entidades tem um entity-id diferente. Os conjuntos de entidades fornecem pontos de entrada no modelo de dados.

Os conjuntos de entidades são descritos em metadados OData e variam de acordo com o projeto. Você pode explorar a lista completa de conjuntos de entidades, tipos de entidade e propriedades solicitando os metadados OData para seu projeto. Para saber como, consulte Construir consultas OData para o Analytics.

Entidades compostas

As entidades compostas dão suporte a cenários específicos. Eles são compostos de entidades mais simples, geralmente exigem mais recursos de computação para serem gerados e podem retornar conjuntos de resultados maiores. Para obter o melhor desempenho e evitar limitações desnecessárias, certifique-se de consultar a entidade correta para seu cenário.

Por exemplo, WorkItemSnapshot combina WorkItemRevisions e Dates de modo que cada data tenha uma revisão para cada item de trabalho. Essa representação dá suporte a consultas OData que se concentram em dados de tendência para um conjunto filtrado de itens de trabalho. No entanto, você não deve usar essa entidade composta para consultar o estado atual dos itens de trabalho. Em vez disso, você deve usar o WorkItems conjunto de entidades para gerar uma consulta de execução mais rápida.

Da mesma forma, algumas entidades podem conter todos os valores históricos, enquanto outras podem conter apenas valores atuais. WorkItemRevisions Contém todo o histórico de itens de trabalho, que você não deve usar em cenários em que os valores atuais são de interesse.

Relações

Para gerar resultados de consulta mais complexos, você pode combinar entidades usando relações. Você pode empregar relações para expandir, filtrar ou resumir dados.

Algumas propriedades de navegação resultam em uma única entidade, enquanto outras resultam em uma coleção de entidades. O diagrama a seguir mostra entidades selecionadas e suas propriedades de navegação. Para maior clareza, algumas entidades e relacionamentos compostos foram omitidos.

Chaves de relacionamento

As relações entre entidades também são representadas como chaves estrangeiras para que ferramentas externas possam unir entidades. Essas propriedades têm o sufixo "SK" e são tipos de dados inteiros ou GUID. As propriedades de data têm propriedades de chave de data inteira correspondentes com o seguinte formato: AAAAMMDD.

Tipos de entidade de acompanhamento de trabalho e conjuntos de entidades

Os seguintes tipos de entidade e conjuntos de entidades são suportados com as versões de API indicadas. Para obter uma referência completa, consulte Referência de metadados de acompanhamento de trabalho para Azure Boards Analytics.

EntityType/EntitySet	Descrição	v1.0	v2.0	v3.0–versão prévia	v4.0-preview
Área/ Áreas	O item de trabalho Caminhos da Área, com propriedades para agrupamento e filtragem por hierarquia de área.	✔️	✔️	✔️	✔️
Iteração/ Iterações	O item de trabalho Caminhos de Iteração, com propriedades para agrupamento e filtragem por hierarquia de iteração.	✔️	✔️	✔️	✔️
BoardLocation/ BoardLocations	Os locais das células do quadro, conforme identificados pela coluna do quadro, raia e divisão, incluem configurações históricas do quadro. Para obter uma descrição de cada campo do quadro, consulte Fluxo de trabalho e campos do quadro.	✔️	✔️	✔️	✔️
CalendarDate/ Datas	As datas usadas para filtrar e agrupar outras entidades usando relações.	✔️	✔️	✔️	✔️
Projeto/ Projetos	Todos os projetos definidos para uma organização (nuvem) ou coleção de projetos (local).	✔️	✔️	✔️	✔️
Processo/ Processos	Informações de lista de pendências usadas para expandir ou filtrar itens de trabalho e tipos de item de trabalho. Para obter um exemplo que usa Processos para filtrar um relatório, consulte Relatório de exemplo de acompanhamento de requisitos.		✔️	✔️	✔️
Marca/ Marcas	Todas as marcas de item de trabalho para cada projeto. Para obter um exemplo que usa Marcas para filtrar um relatório, consulte Relatório de exemplo de burndown de versão.	✔️	✔️	✔️	✔️
Equipe/ Teams	Todas as equipes definidas para o projeto. Para obter um exemplo que usa o Teams para filtrar um relatório, consulte Adicionar uma segmentação de equipe a um relatório do Power BI.	✔️	✔️	✔️	✔️
Usuário/ Usuários	Informações do usuário usadas para expandir ou filtrar várias propriedades de item de trabalho, por exemplo , Atribuído a, Criado por.	✔️	✔️	✔️	✔️
WorkItemBoardSnapshot/ WorkItemBoardSnapshot	(Composto) O estado de cada item de trabalho em cada data do calendário, incluindo a localização do quadro, usado para gerar relatórios de tendências. Para obter um relatório de exemplo, consulte Relatório de exemplo do CFD (Diagrama de Fluxo Cumulativo).	✔️	✔️	✔️	✔️
WorkItemLink/ WorkItemLinks	Os links entre itens de trabalho, por exemplo, Filho, Pai e Relacionado. Inclui apenas a revisão mais recente de links, sem histórico. Os hiperlinks não estão incluídos.	✔️	✔️	✔️	✔️
WorkItemRevision/ WorkItemRevisions	Todas as revisões de item de trabalho histórico, incluindo a revisão atual. Não inclui itens de trabalho excluídos.	✔️	✔️	✔️	✔️
WorkItemSnapshot/ WorkItemSnapshot	(Composição) O estado de cada item de trabalho em cada data de calendário, usado para dar suporte a relatórios de tendências. Para obter um relatório de exemplo, consulte Relatório de exemplo de tendências de bugs.	✔️	✔️	✔️	✔️
Workitem/ Workitems	O estado atual dos itens de trabalho. Usado para dar suporte a relatórios status. Para obter um relatório de exemplo, consulte Rollup child work item values to parent sample report.	✔️	✔️	✔️	✔️
WorkItemTypeField/ WorkItemTypeFields	As propriedades do item de trabalho para cada tipo de item de trabalho e processo. Usado para dar suporte à criação de relatórios.	✔️	✔️	✔️	✔️

Tipos de entidade de pipelines e conjuntos de entidades

Os seguintes tipos de entidade e conjuntos de entidades são compatíveis com a versão v3.0-preview ou v4.0-preview do Analytics. Para obter uma referência completa, consulte Referência de metadados do pipeline.

EntityType/EntitySet	Descrição	v3.0–versão prévia	v4.0-preview
Branch/ Branches	Informações básicas sobre ramificações usadas em testes ou pipelines. Para obter um relatório de exemplo, consulte Relatório de exemplo de status de progresso.	✔️	✔️
ParallelPipelineJobsSnapshot/ ParallelPipelineJobsSnapshot	(Composição) Dá suporte à compreensão do consumo de pipeline paralelo. Para obter mais informações sobre testes de pipeline paralelo, consulte Executar testes em paralelo usando a tarefa Teste do Visual Studio.		✔️
Pipeline/ Pipelines	Propriedades de um pipeline.	✔️	✔️
Trabalho de pipeline/ Trabalhos em Pipeline	Resultados de execução individuais para um teste específico associado a um TestRun	✔️	✔️
Execução de pipeline/ PipelineRuns	Informações de execução para pipelines. Para obter um relatório de exemplo, consulte Relatório de exemplo de tendência de taxa de aprovação do pipeline.	✔️	✔️
PipelineRunActivityResult/ PipelineRunActivityResults	Log mesclado de todos os estágios, etapas, trabalhos e tarefas em uma execução de pipeline específica. Para obter um relatório de exemplo, consulte Relatório de exemplo de duração da tarefa de pipeline.	✔️	✔️
PipelineTask/ Tarefas de pipeline	Propriedades para tarefas que são usadas em um pipeline.	✔️	✔️
TaskAgentPoolSizeSnapshot/ TaskAgentPoolSizeSnapshots	(Composição) Dá suporte à compreensão do tamanho do pool, dos trabalhos de pipeline e da simultaneidade. O gráfico Histórico para pools de agentes ilustra como esse conjunto de entidades pode ser usado.		✔️
TaskAgentRequestSnapshot/ TaskAgentRequestSnapshots	(Composto)		✔️

Tipos de entidade de teste e conjuntos de entidades

Os seguintes tipos de entidade e conjuntos de entidades são compatíveis com a versão v3.0-preview ou v4.0-preview do Analytics. Para obter uma referência completa, consulte Referência de metadados de teste.

EntityType/EntitySet	Descrição	v3.0–versão prévia	v4.0-preview
TestConfiguration/ Configurações de teste	Informações de configuração do plano de teste. Para obter detalhes sobre como configurar testes, consulte Testar configurações diferentes	✔️	✔️
Resultado do teste/ Resultados do teste	Resultados de execução individuais para um teste específico associado a um TestRun.	✔️	✔️
TestResultsDaily/ TestResultsDaily	Um instantâneo diário agregado de execuções TestResult, agrupadas por Test (não TestRun). Para obter um relatório de exemplo, consulte Relatório de exemplo de tendência de resumo de teste.	✔️	✔️
Execução de teste/ Testes	Informações de execução para testes executados em um pipeline com TestResult agregado.	✔️	✔️
Test/ Testes	Propriedades de um caso de teste, como nome do teste e proprietário do teste. Para obter detalhes sobre como definir casos de teste, consulte Criar casos de teste manuais.	✔️	✔️
Ponto de teste/ Pontos de teste	Informações de execução para pontos de teste. Um ponto de teste é uma combinação exclusiva de caso de teste, conjunto de testes, configuração e testador. Para obter um relatório de exemplo, consulte Relatório de exemplo de status de progresso.	✔️	✔️
TestPointHistorySnapshot/ TestPointHistorySnapshots	(Composição) Resultados de execução individuais para um teste específico associado a um TestRun. Para obter um relatório de exemplo, consulte Relatório de exemplo de tendência de execução de teste manual	✔️	✔️
Suíte de testes/ Suítes de teste	Informações sobre suítes de teste. Para obter detalhes sobre a definição de suítes de teste, consulte Criar planos de teste e suítes de teste.	✔️	✔️

Artigos relacionados

• Diretrizes de consulta do OData Analytics
• Análise WIT
• Agregação de dados
• Explorando metadados OData do Analytics
• Acompanhamento de trabalho, processo e limites de projeto
• Design do conjunto de dados de exibições de análise