Best practices voor analyse

  • Artikel

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

Analytics is het rapportageplatform voor Azure DevOps, waarmee u inzicht kunt krijgen in uw gegevens en gegevensgestuurde beslissingen kunt nemen. Analyse is geoptimaliseerd voor snelle leestoegang en serveraggregaties en biedt verschillende hulpprogramma's voor het visualiseren en analyseren van uw gegevens. In dit artikel delen we enkele aanbevolen procedures voor het gebruik van Analytics in Azure DevOps.

Vereisten

  • Als u analysegegevens wilt bekijken en een query wilt uitvoeren op de service, moet u lid zijn van een project met basic-toegang of hoger. Standaard krijgen alle projectleden machtigingen om query's uit te voeren op Analytics en analyseweergaven te definiëren.
  • Zie Machtigingen en vereisten voor toegang tot Analytics voor meer informatie over andere vereisten met betrekking tot het inschakelen van services en functies en algemene activiteiten voor het bijhouden van gegevens.

Vertrouwd raken met de metagegevens van Analytics

Voer een query uit op de metagegevens van Analytics om vertrouwd te raken met de entiteitstypen, entiteitssets, eigenschappen en geïnventareerde lijsten. Zie Query's uitvoeren op de Analytics-service, metagegevens van Analytics OData en entiteiten en eigenschappen voor Azure Boards voor meer informatie.

Structureer uw query om de gegevens te retourneren die u nodig hebt

Volg deze procedures om een query uit te voeren op de minimale gegevensset die u nodig hebt om uw rapport te maken:

Kies de entiteit die is ingesteld ter ondersteuning van uw rapport

Hoewel er verschillende EntitySets worden ondersteund in het analysegegevensmodel, worden er slechts enkele gebruikt om rapporten te genereren.EntitySets wordt gebruikt voor het maken van rapporten in drie categorieën:

  • Huidig: Bevat informatie over de huidige configuratie van de EntityTypes ingesloten EntitySet.
  • Momentopname: samengestelde entiteiten die historische en datumgerelateerde gegevens combineren. Momentopname-entiteiten zijn bedoeld om aggregatierapporten te ondersteunen.
  • Revisie: Bevat historische informatie. Onderhoudt bijvoorbeeld WorkItemRevision gegevens over de geschiedenis van werkitems.

Hier volgt een beknopt overzicht van de EntityTypes die u kunt opgeven om rapporten te ondersteunen. Zie Het gegevensmodel voor analyse voor een beschrijving van elk van deze EntityTypes.

Azure DevOps-gegevens Huidig Momentopname Revisie
Azure Boards WorkItems WorkItemSnapshot
WorkItemBoardSnapshot		 WorkItemRevisions
Azure-pipelines Pipelines
PipelineTasks		 ParallelPipelineJobsSnapshot
PipelineRuns, PipelineRunActivityResults
Azure Pipelines and Tests TestResultsDaily TestRuns
Azure Test Plans Tests
TestConfiguration
TestPoints
WorkItems		 TestResultsDaily
TestPointHistorySnapshot

Queryonderdelen opgeven in de volgorde waarin ze worden uitgevoerd

De aanbevolen volgorde voor de verschillende queryonderdelen is om ze in de volgende volgorde op te geven. Dit is de volgorde waarin ze worden geëvalueerd. Zie Query the Analytics-service, queryopties, voor een beschrijving van elk queryonderdeel.

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

Alle query's moeten een $apply of $select component bevatten, anders ontvangt u mogelijk een waarschuwingsbericht.

De kolommen beperken die u in uw query aanvraagt

U geeft kolommen met gegevens op die moeten worden geretourneerd met behulp van de $select component. Met aanpassing kunnen er talloze velden aan werkitems zijn gekoppeld. Hoe meer eigenschappen of velden een query verwijst, hoe duurder het is om te verwerken. Houd rekening met het rapport dat u wilt genereren en zorg ervoor dat u alleen de velden aanvraagt die u nodig hebt.

Als u bijvoorbeeld de velden Id, Type werkitem, Titel en Status wilt retourneren voor een gefilterde set werkitems, geeft u de volgende $select component op: $select=WorkItemId, WorkItemType, Title, State

Als u de lijst met eigenschappen en de bijbehorende veldnamen wilt opzoeken, raadpleegt u de naslaginformatie over entiteiten en eigenschappen voor Azure Boards.

Voorbeeldquery's maken

Voorbeeldquery's zijn query's die één record of een kleine subset records retourneren. Door een voorbeeldquery te maken, kunt u uw query verfijnen om ervoor te zorgen dat u de gegevens aanvraagt die u nodig hebt. Door te beginnen met een minimale query, kunt u uw query samenstellen om ervoor te zorgen dat u de gewenste records en de gewenste kolomgegevens opgeeft.

Met behulp van de apply=aggregate($count as Count), kunt u het aantal records dat u aanvraagt identificeren. Met de volgende syntaxis wordt bijvoorbeeld het aantal werkitems voor het Fabrikam Fiber-project opgevraagd.

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

Het antwoord retourneert in totaal 1415 werkitems.

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

Query's beperken tot projecten waarvoor u toegang hebt

Projectbereikquery's retourneren informatie over één project, terwijl query's binnen het organisatiebereik zijn ontworpen om informatie te retourneren die projectgrenzen overschrijden. Voor query's in het bereik van de organisatie zijn bredere gebruikersmachtigingen of zorgvuldige bereikbeperkingen vereist om ervoor te zorgen dat uw query niet wordt geblokkeerd vanwege een gebrek aan projectmachtigingen.

Als u toegang hebt tot een of meer projecten, maar niet alle projecten en u een query binnen het bereik van de organisatie verzendt, ontvangt u een foutbericht.

"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."

Zie Project- en organisatiequery's voor meer informatie.

Waarschuwings- en foutberichten bekijken

Analytics controleert elke query die deze ontvangt op schendingen van de regels. Er worden waarschuwingsberichten geretourneerd wanneer een schending wordt gedetecteerd. U wordt aangeraden deze berichten te controleren om de querystructuur te corrigeren of te verbeteren.

Frequentielimieten en bandbreedtebeperking

Query's die worden uitgevoerd in Analytics voor Azure DevOps Services, zijn onderhevig aan frequentielimieten. Als er te veel query's worden verzonden die het retourneren van grote hoeveelheden gegevens binnen een korte periode aanvragen, kan de service onderhevig zijn aan beperking. Zie Frequentie- en gebruikslimieten voor meer informatie.

U kunt het gebruik van de service en voor personen bekijken door naar Organisatie Instellingen> Gebruiker te gaan en de filters uit te oefenen. In de volgende afbeelding ziet u bijvoorbeeld het gebruik van Jamal Hartnett naar de Analytics-service.

Schermopname van de pagina Gebruik voor één gebruiker en Analyse.