Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
Serviços de DevOps do Azure | Azure DevOps Server | Azure DevOps Server 2022
O modelo de dados do Google Analytics para DevOps do Azure consiste em conjuntos de entidades, cujos membros (entidades) contêm propriedades que você pode filtrar, agregar e resumir. 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.
Nota
O serviço Analytics é automaticamente habilitado e suportado na produção para todos os serviços nos Serviços de DevOps do Azure. A integração do Power BI e o acesso ao feed OData do serviço Analytics estão geralmente disponíveis. Você é incentivado a usar o feed OData do Google Analytics e fornecer feedback.
Os dados disponíveis dependem da versão. A última versão suportada da API OData é v2.0, e a versão de visualização mais recente é v4.0-preview. Para obter mais informações, consulte o artigo Controlo de Versões da API OData.
Nota
O serviço Analytics é instalado automaticamente e suportado na produção para todas as novas coleções de projetos para o Azure DevOps Server 2020 e versões posteriores. A integração do Power BI e o acesso ao feed OData do serviço Analytics estão geralmente disponíveis. Você é incentivado a usar o feed OData do Google Analytics e fornecer feedback. Se você atualizar do Azure DevOps Server 2019, poderá instalar o serviço Analytics durante a atualização.
Os dados disponíveis dependem da versão. A última versão suportada da API OData é v2.0, e a versão de visualização mais recente é v4.0-preview. Para obter mais informações, consulte o artigo Controlo de Versões da API OData.
Noções básicas sobre o modelo de dados do Google Analytics
O serviço Analytics fornece uma abordagem estruturada para aceder a dados do Azure DevOps através de endpoints OData. Este modelo de dados permite-lhe:
- Consultar dados de acompanhamento de trabalho: acessar itens de trabalho, áreas, iterações e metadados relacionados
- Analise informações de pipeline: consultar dados de pipeline de compilação e distribuição
- Relatório sobre os resultados do teste: Acesse a execução do teste e os dados de planejamento
- Criar relatórios personalizados: crie relatórios do Power BI e outras soluções de análise
Namespaces de esquema
O modelo de dados do Google Analytics opera em dois namespaces de esquema:
Microsoft.VisualStudio.Services.Analytics.ModelMicrosoft.VisualStudio.Services.Analytics
Esses namespaces organizam as entidades e definem sua estrutura, garantindo padrões consistentes de acesso a dados em diferentes recursos do Azure DevOps.
Conjuntos de entidades e tipos de entidades
Os tipos de entidade são nomeados tipos estruturados com uma chave. Eles definem as propriedades nomeadas e as relações de cada entidade. A chave de um EntityType forma-se a partir de um subconjunto das propriedades primitivas — por exemplo, WorkItemId, PipelineId, ReleasePipelineId — e outras propriedades do tipo de entidade.
Os conjuntos de entidades são denominados coleções 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 onde essa combinação de chaves aparece. Cada uma dessas entidades tem um ID de entidade 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 suportam cenários específicos. O sistema compõe-os a partir de entidades mais simples, muitas vezes requer mais recursos de computação para gerar, e pode retornar conjuntos de resultados maiores. Para obter o melhor desempenho e evitar limitações desnecessárias, certifique-se de consultar a entidade correta para o seu cenário.
Por exemplo, WorkItemSnapshot combina WorkItemRevisions e Dates de tal forma que cada data tem uma revisão para cada item de trabalho. Essa representação oferece 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 onde 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 relacionamentos 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 relações compostas foram omitidas.
Noções básicas sobre relacionamentos de entidades
O modelo de dados do Google Analytics usa vários tipos de relacionamentos:
- Um para muitos: uma única entidade pai está relacionada a várias entidades filhas (por exemplo, uma Área para muitos Itens de Trabalho)
- Muitos-para-um: Várias entidades estão relacionadas com uma única entidade principal (por exemplo, muitos WorkItems para uma Área)
- Um-para-um: Uma única entidade relaciona-se exatamente com uma outra entidade
- Muitos-para-muitos: várias entidades estão relacionadas a várias outras entidades (por exemplo, WorkItems para Tags)
Chaves de relacionamento
As relações de entidade 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 entidades de rastreamento 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 o Azure Boards Analytics.
EntityType/EntitySet |
Descrição | v1,0 | v2,0 | v3.0 - pré-visualização | Pré-visualização da v4.0 |
|---|---|---|---|---|---|
|
Área/ Áreas |
O item de trabalho Caminhos de área, com propriedades para agrupamento e filtragem por hierarquias 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. | ✔️ | ✔️ | ✔️ | ✔️ |
|
Localização da Placa/ BoardLocations |
A localização das células do tabuleiro, conforme identificado por coluna do tabuleiro, faixa e divisão, inclui configurações históricas do tabuleiro. Para obter uma descrição de cada campo do painel, consulte Fluxo de trabalho e campos do quadro. | ✔️ | ✔️ | ✔️ | ✔️ |
|
Data do Calendário/ 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ção da lista de pendências usada para expandir ou filtrar itens de trabalho e tipos de itens de trabalho. Para obter um exemplo que usa Processos para filtrar um relatório, consulte Relatório de exemplo de controle de requisitos. | ✔️ | ✔️ | ✔️ | |
|
Etiqueta/ Etiquetas |
Todas as etiquetas de item de trabalho para cada projeto. Para obter um exemplo que usa Tags para filtrar um relatório, consulte o Relatório de exemplo da versão burndown. | ✔️ | ✔️ | ✔️ | ✔️ |
|
Equipa/ Equipas |
Todas as equipas definidas para o projeto. Para obter um exemplo que usa o Teams para filtrar um relatório, consulte Adicionar uma segmentação de dados de equipe a um relatório do Power BI. | ✔️ | ✔️ | ✔️ | ✔️ |
|
Utilizador/ Utilizadores |
Informações de usuário que você usa para expandir ou filtrar várias propriedades de item de trabalho, por exemplo, Atribuído a, Criado por. | ✔️ | ✔️ | ✔️ | ✔️ |
|
WorkItemBoardSnapshot/ CapturaDeQuadroDeItensDeTrabalho |
(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 de diagrama de fluxo cumulativo (CFD). | ✔️ | ✔️ | ✔️ | ✔️ |
|
WorkItemLink/ WorkItemLinks |
Os links entre itens de trabalho, por exemplo, Filho, Pai e Relacionado. Inclui apenas a última revisão de links, sem histórico. Os hiperlinks não estão incluídos. | ✔️ | ✔️ | ✔️ | ✔️ |
|
WorkItemRevision/ Revisões de Itens de Trabalho |
Todas as revisões de itens de trabalho históricos, incluindo a revisão atual. Não inclui itens de trabalho excluídos. | ✔️ | ✔️ | ✔️ | ✔️ |
|
WorkItemSnapshot/ WorkItemSnapshot |
(Composto) O estado de cada item de trabalho em cada data do 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. | ✔️ | ✔️ | ✔️ | ✔️ |
|
Item de trabalho/ Itens de Trabalho |
O estado atual dos itens de trabalho. Usado para dar suporte a relatórios de status. Para um relatório de exemplo, consulte Acumular valores dos itens de trabalho filho no relatório de exemplo do pai. | ✔️ | ✔️ | ✔️ | ✔️ |
|
WorkItemTypeField/ (CampoTipoDeItemDeTrabalho) WorkItemTypeFields |
As propriedades do item de trabalho para cada tipo de item de trabalho e processo. Usado para dar suporte à construção de relatórios. | ✔️ | ✔️ | ✔️ | ✔️ |
Principais entidades de monitorização de trabalho para elaboração de relatórios
Ao criar relatórios, considere estes conjuntos de entidades primárias:
-
Relatórios de estado atual: Use
WorkItemspara o status atual do item de trabalho -
Relatórios históricos de tendências: Use
WorkItemSnapshotpara análise de tendências ao longo do tempo -
Controle detalhado de alterações: uso
WorkItemRevisionspara histórico abrangente -
Relatórios específicos do conselho: uso
WorkItemBoardSnapshotpara análise de quadros Kanban
Tipos de entidades de pipelines e conjuntos de entidades
Os seguintes tipos de entidades e conjuntos de entidades são suportados 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 pipeline.
| TipoDeEntidade/ConjuntoDeEntidades | Descrição | v3.0 - pré-visualização | Pré-visualização da v4.0 |
|---|---|---|---|
|
Ramo/ Sucursais |
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 |
(Composto) Suporta o entendimento do consumo de pipelines em paralelo. Para obter mais informações sobre testes de pipeline paralelo, consulte Executar testes em paralelo usando a tarefa de teste do Visual Studio. | ✔️ | |
|
Gasoduto/ Condutas |
Propriedades de um pipeline. | ✔️ | ✔️ |
|
PipelineJob/ PipelineJobs |
Resultados de execução individuais para um trabalho específico dentro de uma execução de pipeline. | ✔️ | ✔️ |
|
PipelineRun/ 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 de pipeline. | ✔️ | ✔️ |
|
PipelineRunActivityResult/ PipelineRunActivityResults |
Log mesclado de todos os estágios, etapas, trabalhos e tarefas dentro de uma execução de pipeline específica. Para um relatório de exemplo, consulte Relatório de amostra de duração da tarefa de pipeline. | ✔️ | ✔️ |
|
PipelineTask/ PipelineTasks |
Propriedades para tarefas que você usa dentro de um pipeline. | ✔️ | ✔️ |
|
TaskAgentPoolSizeSnapshot/ TaskAgentPoolSizeSnapshots |
(Composto) Suporta a compreensão do tamanho do pool, tarefas de pipeline e simultaneidade. O gráfico histórico para pools de agentes ilustra como este conjunto de entidades pode ser usado. | ✔️ | |
|
TaskAgentRequestSnapshot/ TaskAgentRequestSnapshots |
(Composto) Fornece informações sobre padrões de solicitação de agente e utilização de recursos ao longo do tempo. | ✔️ |
Padrões de uso da entidade de pipeline
Diferentes entidades de pipeline atendem a cenários de relatórios específicos:
-
Relatórios de visão geral do pipeline: utilize
PipelinesePipelineRunspara métricas de alto nível -
Análise de desempenho: Use
PipelineRunActivityResultspara análise detalhada de tempo -
Utilização de recursos: uso
TaskAgentPoolSizeSnapshotpara planejamento de capacidade -
Análise de falhas: Use
PipelineJobspara rastreamento de sucesso/falha no nível de trabalho
Testar tipos de entidade e conjuntos de entidades
Os seguintes tipos de entidades e conjuntos de entidades são suportados 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 - pré-visualização | Pré-visualização da v4.0 |
|---|---|---|---|
|
TestConfiguration/ TestConfigurations |
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 dos Testes |
Resultados de execução individual para um teste específico associado a um TestRun. | ✔️ | ✔️ |
|
ResultadosDosTestesDiários/ ResultadosDiários |
Um instantâneo diário agregado de TestResult execuções, agrupado pelo Test (não TestRun). Para consultar um exemplo de relatório, veja Exemplo de relatório de tendência resumida de teste. | ✔️ | ✔️ |
|
TestRun/ TestRuns |
Informações de execução para testes executados sob um pipeline com dados agregados TestResult. | ✔️ | ✔️ |
|
Teste/ Testes |
Propriedades de um caso de teste, como o nome do teste e o responsável pelo 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 |
(Composto) Dados históricos de execução para pontos de teste ao longo do tempo. Para obter um relatório de exemplo, consulte Relatório de exemplo de tendência de execução de teste manual. | ✔️ | ✔️ |
|
TestSuite/ TestSuites |
Informações sobre conjuntos de testes. Para obter detalhes sobre como definir conjuntos de testes, consulte Criar planos de teste e conjuntos de testes. | ✔️ | ✔️ |
Cenários de elaboração de relatórios de entidade de teste
As entidades de teste suportam várias necessidades de relatórios:
-
Acompanhamento da execução de testes: Use
TestResultseTestRunspara dados de execução detalhados -
Métricas de planejamento de teste: uso
TestPointseTestSuitespara planejar a cobertura -
Análise de tendências: Uso
TestResultsDailyeTestPointHistorySnapshotspara tendências históricas -
Cobertura de configuração: Use
TestConfigurationspara análise de testes multiplataforma
Práticas recomendadas para usar o modelo de dados do Google Analytics
Otimização do desempenho
-
Escolha a entidade correta: Use entidades de estado atuais (
WorkItems) para relatórios de estado e entidades instantâneas para tendências - Filtrar antecipadamente: aplique filtros no nível da entidade em vez de após a recuperação de dados
- Limitar intervalos de dados: use filtros de data para restringir consultas de dados históricos
- Use agregações apropriadas: aproveite as funções de agregação internas quando possível
Padrões de projeto de consultas
Consultas sobre estado atual do sistema
/WorkItems?$filter=State ne 'Closed'&$select=WorkItemId,Title,State
Consultas de tendências históricas
/WorkItemSnapshot?$filter=DateSK ge 20241001&$select=WorkItemId,State,DateSK
Navegação de relacionamento
/WorkItems?$expand=Area($select=AreaPath),AssignedTo($select=UserName)
Armadilhas comuns a evitar
-
Usando entidades de revisão para o estado atual: não utilizar
WorkItemRevisionsquandoWorkItemsfor suficiente - Expansão excessiva de relações: expanda apenas as propriedades de navegação necessárias
- Filtros ausentes: sempre filtre grandes conjuntos de entidades para melhorar o desempenho
-
Ignorando entidades compostas: use entidades compostas como
WorkItemSnapshotpara análise de tendências
Considerações sobre a versão
Diferentes versões de API fornecem recursos diferentes:
- v1.0: Entidades básicas de controle de trabalho
- v2.0: Processo adicionado e recursos de filtragem aprimorados
- v3.0-preview: Adicionado o pipeline e entidades de teste
- v4.0-preview: Entidades compostas melhoradas e métricas de pipeline adicionais
Escolha a versão apropriada com base em seus requisitos de relatório e nas entidades que você precisa acessar.
Artigos relacionados
- Diretrizes de consulta do OData Analytics
- Análise WIT
- Dados agregados
- Explorando metadados OData do Google Analytics
- Rastreio do trabalho, processo e limites do projeto
- Design do conjunto de dados de visualizações do Analytics
- Construa consultas OData para a Analítica
- Segurança e permissões do Google Analytics