Práticas recomendadas do Google Analytics

  • Artigo

Serviços de DevOps do Azure | Azure DevOps Server 2022 - Azure DevOps Server 2019

O Analytics é a plataforma de relatórios para o Azure DevOps, que lhe permite obter informações dos seus dados e tomar decisões orientadas por dados. O Google Analytics é otimizado para acesso rápido de leitura e agregações baseadas em servidor e fornece várias ferramentas para visualizar e analisar seus dados. Neste artigo, partilhamos algumas práticas recomendadas para utilizar o Analytics no Azure DevOps.

Pré-requisitos

  • Para visualizar dados do Google Analytics e consultar o serviço, você precisa ser membro de um projeto com acesso Básico ou superior. Por padrão, todos os membros do projeto recebem permissões para consultar o Google Analytics e definir exibições do Google Analytics.
  • Para saber mais sobre outros pré-requisitos relacionados à ativação de serviços e recursos e atividades gerais de controle de dados, consulte Permissões e pré-requisitos para acessar o Google Analytics.
  • Se você for um desenvolvedor de extensão, consulte as diretrizes de consulta do OData Analytics.

Familiarize-se com os metadados do Google Analytics

Consulte os metadados do Google Analytics para obter familiaridade com os tipos de entidade, conjuntos de entidades, propriedades e listas enumeradas. Para obter mais informações, consulte Consultar o serviço Analytics, Metadados OData do Analytics e Referência de entidades e propriedades para Painéis do Azure.

Estruture sua consulta para retornar os dados de que você precisa

Para consultar o conjunto de dados mínimo necessário para criar seu relatório, siga estas práticas:

Escolha o conjunto de entidades para dar suporte ao seu relatório

Embora haja vários EntitySets suportados no modelo de dados do Google Analytics, apenas alguns são usados para gerar relatórios.EntitySets usados para criar relatórios se enquadram em três categorias:

  • Atual: Contém informações sobre a configuração atual do EntityTypes contido no EntitySet.
  • Snapshot: entidades compostas que combinam dados históricos e relacionados a datas. As entidades de instantâneo destinam-se a ser usadas para dar suporte a relatórios de agregação.
  • Revisão: Contém informações históricas. Por exemplo, WorkItemRevision mantém dados sobre o histórico de itens de trabalho.

Aqui está uma referência rápida para os EntityTypes a serem especificados para dar suporte a relatórios. Para obter uma descrição de cada um desses EntityTypes, consulte Modelo de dados para análise.

Dados do Azure DevOps Atual Instantâneo Revisão
Azure Boards WorkItems WorkItemSnapshot
WorkItemBoardSnapshot		 WorkItemRevisions
Pipelines do Azure Pipelines
PipelineTasks		 ParallelPipelineJobsSnapshot
PipelineRuns, PipelineRunActivityResults
Pipelines e testes do Azure TestResultsDaily TestRuns
Planos de Teste do Azure Tests
TestConfiguration
TestPoints
WorkItems		 TestResultsDaily
TestPointHistorySnapshot

Especificar partes de consulta na ordem em que são executadas

A ordem recomendada para as várias partes de consulta é especificá-las na seguinte ordem, que é a ordem em que são avaliadas. Para obter uma descrição de cada parte da consulta, consulte Consultar o serviço do Google Analytics, Opções de consulta.

  1. $apply
  2. $filter
  3. $orderby
  4. $expand
  5. $select
  6. $skip
  7. $top

Todas as consultas devem conter uma $apply cláusula ou $select , caso contrário, você pode receber uma mensagem de aviso.

Limitar as colunas solicitadas na consulta

Você especifica colunas de dados a serem retornadas usando a $select cláusula. Com a personalização, os itens de trabalho podem ter vários campos associados a eles. Quanto mais propriedades ou campos uma consulta fizer referência, mais caro será processá-la. Considere o relatório que deseja gerar e certifique-se de que está solicitando apenas os campos necessários.

Por exemplo, para retornar os campos ID, Tipo de Item de Trabalho, Título e Estado de um conjunto filtrado de itens de trabalho, especifique a seguinte $select cláusula: $select=WorkItemId, WorkItemType, Title, State.

Para procurar a lista de propriedades e seus nomes de campo correspondentes, consulte Referência de entidades e propriedades para Painéis do Azure.

Criar consultas de pré-visualização

As consultas de visualização são consultas que retornam um único registro ou um pequeno subconjunto de registros. Ao criar uma consulta de visualização, pode refiná-la para garantir que está a solicitar os dados de que necessita. Começando com uma consulta mínima, você pode criar sua consulta para garantir que está especificando os registros desejados e os dados de coluna necessários.

Usando o apply=aggregate($count as Count), você pode identificar o número de registros que está solicitando. Por exemplo, a sintaxe a seguir consulta o número de itens de trabalho para o projeto Fabrikam Fibra .

https://analytics.dev.azure.com/content-learn/Content/_odata/v4.0-preview/WorkItems? $apply=aggregate($count as Count)

A resposta retorna um total de 1415 itens de trabalho.

{
  "@odata.context": "https://analytics.dev.azure.com/fabrikam/Fabrikam Fbier/_odata/v4.0-preview/$metadata#WorkItems(Count)",
   "value": [
  {
     "@odata.id": null,
   "Count": 1415
  }
  ]
}

Limitar consultas a projetos aos quais você tem acesso

As consultas de escopo do projeto retornam informações sobre um único projeto, enquanto as consultas de escopo da organização são projetadas para retornar informações que cruzam os limites do projeto. As consultas com escopo da organização exigem permissões de usuário mais amplas ou restrições de escopo cuidadosas para garantir que sua consulta não seja bloqueada devido à falta de permissões de projeto.

Se você tiver acesso a um ou mais projetos, mas não a todos os projetos, e enviar uma consulta com escopo da organização, receberá uma mensagem de erro.

"VS403496: The query results include data in one or more projects for which you do not have access. Add one or more projects filters to specify the project(s) you have access to in 'WorkItems' entity. If you're using $expand or navigation properties, project filter is required for those entities. More information can be found here: https://go.microsoft.com/fwlink/?LinkId=786441."

Para saber mais, consulte Consultas de escopo do projeto e da organização.

Rever mensagens de aviso e erro

O Google Analytics analisa cada consulta recebida em busca de violações às suas regras. Ele retorna mensagens de aviso quando deteta uma violação. Recomendamos que você revise essas mensagens para corrigir ou melhorar a estrutura da consulta.

Limites de taxa e limitação

As consultas feitas ao Analytics for Azure DevOps Services estão sujeitas a limites de taxa. Se forem enviadas demasiadas consultas que solicitem o retorno de grandes quantidades de dados num curto espaço de tempo, o serviço poderá estar sujeito a limitação. Para obter mais informações, consulte Limites de taxa e uso.

Pode rever a utilização do serviço e de indivíduos acedendo a Utilização das Definições>da Organização e exercendo os filtros. Por exemplo, a imagem a seguir mostra o uso por Jamal Hartnett para o serviço Analytics.

Captura de ecrã da página Utilização para um único utilizador e Análise.