De Axe DevTools voor Web Usage Service

Dit artikel biedt een overzicht van de usage service, een service waarmee je je gebruik van Axe DevTools API's en de CLI kunt bijhouden door gebruiksevenementen te verzenden naar ofwel de publiek toegankelijke servers van Deque of je eigen server. Het verzenden van gebruiksstatistieken naar Deque helpt ons beter te begrijpen hoe onze gebruikers interactie hebben met onze producten, zodat we ze kunnen blijven verbeteren.

De usage service bestaat uit twee delen:

1. Een client die gebruiksevenementen naar de usage service stuurt (via de metrics-bibliotheek, meestal aangeroepen door Axe DevTools API's of de CLI)
2. Een REST-service, meestal gehost door Deque, die reageert op POST-verzoeken met gebruiksevenementen

Gebruiksevenementen bevatten informatie over een toegankelijkheidsscan, inclusief de datum en tijd van de scan, het aantal overtredingen van toegankelijkheidsregels, de namen van de overtreden regels en andere informatie. Als je je eigen usage service opzet, kun je de informatie gebruiken om inzicht te krijgen in hoe Axe DevTools voor Web binnen je organisatie wordt gebruikt. Voor referentie-informatie over de structuur van gebruiksevenementen, zie De Usage Service Event Reference.

Snelle Start

Je kunt het gebruik volgen door de volgende stappen te volgen:

1. Stel de omgevingsvariabele AXE_TRACK_USAGE in op true om gebruikstracering in te schakelen. Telkens wanneer je de CLI of je eigen code gebruikt die de Axe DevTools voor Web API's gebruikt, worden gebruiksevenementen gepost naar de Deque REST usage service.
2. (Optioneel) Wijzig de URL van de server waar gebruiksevenementen worden gerapporteerd door de AXE_METRICS_URL omgevingsvariabele te wijzigen (de standaard-URL is https://usage.deque.com). Als je deze omgevingsvariabele wijzigt, moet je je eigen usage service maken die de publiek toegankelijke usage service van Deque nabootst. Zie Instellen van een Echo Server
3. (Optioneel) Stel AXE_INCLUDE_TEST_RESULTS in op true om testresultaten op te nemen in de gegevens die naar de usage service worden verzonden. Door deze omgevingsvariabele in te stellen, wordt het testResults object in de applicationProperties object ingevuld. Zie De Usage Service Event Reference voor meer informatie.
4. (Optioneel) Stel de omgevingsvariabele AXE_DEV_INSTANCE in op true op ontwikkelaars- en testersystemen om toegankelijkheidsscans van ontwikkelaars en testers te filteren. (Meestal wil je het gebruik van API's dat tijdens ontwikkelings- of testwerk plaatsvond, negeren.)
5. (Optioneel) Stel andere omgevingsvariabelen in om de evenementen die naar de usage service worden gerapporteerd aan te passen. Zie De Usage Service beheren via Omgevingsvariabelen.
6. Voer je toegankelijkheidsscan-code of een CLI-paginascan uit om gebruik naar de usage service te sturen. Alle API's van Deque gebruiken de metrics-bibliotheek om evenementen te creëren en te posten naar de usage service zoals je die hebt geconfigureerd.

Voor een uitgebreidere tutorial over hoe je de usage service met de Axe DevTools API's kunt gebruiken, zie Aan de slag met de Usage Service en de API's. Voor dezelfde tutorial over hoe je de CLI met de usage service kunt gebruiken, zie Aan de slag met de Usage Service en de CLI. Deze tutorials bevatten stappen om je eigen eenvoudige server op te zetten om de usage service-evenementen naar de console te echoën, zodat je kunt zien wat de metrics-bibliotheek naar de usage service verzendt. Je kunt deze setup gebruiken om de usage service te debuggen.

Omgevingsvariabelen

Je kunt omgevingsvariabelen gebruiken om te bepalen hoe de usage service werkt en om de evenementen die het rapporteert aan te passen. Omgevingsvariabelen vallen in twee categorieën:

• Gebruik servicecontrole: Gebruikstracering in- of uitschakelen, de rapportage-URL instellen, testresultaten opnemen in gebeurtenisgegevens, en de unieke ID van de gebruiker instellen.
• Gebeurtenisaanpassing: Wijzig de eigenschappen van de gebruiksevenementen die naar de service worden verzonden, zoals de organisatie, afdeling, functie en andere identificerende informatie van de gebruiker.

Voor een complete referentie van alle beschikbare omgevingsvariabelen, zie Het Gebruik van de Dienst Beheren via Omgevingsvariabelen.

Zie Ook

Voor meer informatie over de eigenschappen in de gebruiksgebeurtenissen, zie De Gebeurtenisreferentie van de Gebruiksdienst.

Voor een referentie van de omgevingsvariabelen die beschikbaar zijn om de gebruiksservice te beheren en evenementen aan te passen, zie Het Gebruik van de Dienst Beheren via Omgevingsvariabelen.