De Axe DevTools voor Web Usage Service

Dit artikel biedt een overzicht van de verbruiksservice, een service die je in staat stelt om je gebruik van Axe DevTools API's en de CLI bij te houden door gebruiksevenementen te sturen naar ofwel de publiek toegankelijke servers van Deque of je eigen server. Het sturen van gebruiksstatistieken naar Deque helpt ons beter te begrijpen hoe onze gebruikers met onze producten omgaan, zodat we ze kunnen blijven verbeteren.

De usage service bestaat uit twee delen:

1. Een cliënt die gebruiksevenementen naar de verbruiksservice stuurt (via de metrics-bibliotheek, doorgaans aangeroepen door Axe DevTools API's of de CLI)
2. Een REST-service, meestal gehost door Deque, die reageert op POST-verzoeken die gebruiksevenementen bevatten

Gebeurtenissen met gebruiksgegevens bevatten informatie over een toegankelijkheidsscan, inclusief de datum en tijd van de scan, het aantal geschonden toegankelijkheidsregels, de namen van de geschonden regels en andere informatie. Als je je eigen verbruiksservice instelt, 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 gebruiksgebeurtenissen, zie De Gebeurtenisreferentie van de Gebruiksdienst.

Snelle Start

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

1. Stel de omgevingsvariabele AXE_TRACK_USAGE in op true om het bijhouden van gebruik mogelijk te maken. Nu, telkens wanneer je de CLI of je eigen code uitvoert die de Axe DevTools voor Web API's gebruikt, worden gebruiksgebeurtenissen naar de Deque REST-verbruiksservice gestuurd.
2. (Optioneel) Verander de URL van de server waar gebruiksgebeurtenissen zullen worden gerapporteerd door de omgevingsvariabele AXE_METRICS_URL te wijzigen (de standaard-URL is https://usage.deque.com). Als je deze omgevingsvariabele verandert, moet je je eigen verbruiksservice maken die de publieke verbruiksservice 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 verbruiksservice worden gestuurd. Het instellen van deze omgevingsvariabele vult het testResults object in het applicationProperties object. Zie De Gebeurtenisreferentie van de Gebruiksdienst voor meer informatie.
4. (Optioneel) Stel de omgevingsvariabele AXE_DEV_INSTANCE in op true op de apparaten van ontwikkelaars en testers om te zorgen dat toegankelijkheidsscans door ontwikkelaars en testers worden uitgefilterd. (Meestal wil je elk API-gebruik dat tijdens ontwikkeling of testwerk is opgetreden negeren.)
5. (Optioneel) Stel andere omgevingsvariabelen in om de gebeurtenissen die aan de verbruiksservice zullen worden gerapporteerd aan te passen. Zie Het Gebruik van de Dienst 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 meer diepgaande tutorial over hoe je de verbruiksservice met de Axe DevTools API's gebruikt, zie Aan de slag met de Usage Service en de API's. Voor dezelfde tutorial over hoe je de CLI met de verbruiksservice gebruikt, zie Aan de slag met de Usage Service en de CLI. Deze tutorials bevatten stappen om je eigen eenvoudige server in te stellen om de gebeurtenissen van de verbruiksservice naar de console te echoën, zodat je kunt zien wat de metrics-bibliotheek naar de verbruiksservice stuurt. Je kunt deze setup gebruiken om de verbruiksservice te troubleshooten.

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: Schakel gebruiksregistratie in of uit, stel de rapportage-URL in, neem testresultaten op in gebeurtenisgegevens en stel de unieke ID van de gebruiker in.
• Gebeurtenisaanpassing: Wijzig de eigenschappen van de gebruiksgebeurtenissen die naar de service worden gestuurd, zoals de organisatie, de afdeling, de functie van de gebruiker en andere identificerende informatie.

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

Zie Ook

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

Voor een referentie van de omgevingsvariabelen beschikbaar om de verbruiksservice te controleren en gebeurtenissen aan te passen, zie Het Gebruik van de Dienst Beheren via Omgevingsvariabelen.