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. Controleer of gebruikstracering is ingeschakeld. Het is standaard ingeschakeld, dus tenzij u AXE_TRACK_USAGE hebt ingesteld op onwaar, worden gebruiksgebeurtenissen al naar de Deque REST-gebruiksservice gestuurd telkens wanneer u de CLI draait of uw eigen code gebruikt die de Axe DevTools voor Web API's gebruikt.
2. (Optioneel) Verander de URL van de server waar gebruiksgebeurtenissen worden gerapporteerd door de omgevingsvariabele AXE_METRICS_URL te veranderen (de standaard-URL is https://usage.deque.com). Als u deze omgevingsvariabele wijzigt, moet u uw eigen gebruiksservice maken die de openbare gebruiksservice 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 gebruiksservice worden gestuurd. Het instellen van deze omgevingsvariabele vult het testResults object in het applicationProperties object. Deze variabele wordt alleen ondersteund door de CLI en de Node.js API's. Zie De Gebeurtenisreferentie van de Gebruiksdienst voor meer informatie.
4. (Optioneel) Stel de omgevingsvariabele AXE_DEV_INSTANCE in op true op de machines van ontwikkelaars en testers om ontwikkelaar- en tester-toegankelijkheidsscans uit te filteren. (Meestal wilt u elk API-gebruik negeren dat tijdens ontwikkelings- of testwerk heeft plaatsgevonden.)
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.

Uw gebruiksgegevens bekijken in Axe Reports

Als uw organisatie Axe Reports gebruikt, worden de gebruiksstatistieken (de Gebruik per maand en Gescreende URL's rapporten) gevuld vanuit de in dit artikel beschreven gebruiksgebeurtenissen. Ze worden niet gevuld door de JSON-toegankelijkheidsresultaten die u uploadt met de bulk-reports subcommand van de CLI: het verzenden van gebruiksgebeurtenissen en het uploaden van resultaten zijn afzonderlijke processen.

Voor uw scans om in de gebruiksstatistieken van Axe Reports te verschijnen, heeft elke machine die een scan uitvoert het volgende nodig:

1. Gebruikstracering blijft ingeschakeld: het is standaard ingeschakeld, dus zorg ervoor dat AXE_TRACK_USAGE niet is ingesteld op onwaar en dat --enable-tracking false niet aan de CLI is doorgegeven.
2. Gebruiksgebeurtenissen worden verzonden naar de openbare gebruiksservice van Deque: laat AXE_METRICS_URL op de standaardwaarde van https://usage.deque.com staan. Als u de cliënt naar uw eigen server wijst, ontvangt Deque de gebeurtenissen nooit en heeft Axe Reports niets om weer te geven.
3. AXE_ORGANIZATION ingesteld op het ID van uw organisatie. Axe Reports gebruikt deze waarde om gebruiksgebeurtenissen aan uw organisatie te koppelen; zonder dit kunnen uw gebeurtenissen niet aan uw account worden gekoppeld.
4. AXE_USER_ID ingesteld op een identificatie voor de persoon die de scan uitvoert, zoals een e-mailadres. Axe Reports telt unieke gebruikers van deze waarde.
5. (Optioneel) AXE_DEPARTMENT ingesteld op de afdeling van de gebruiker die de scan uitvoert. Het Gebruik per maand verslag kan gebruik per afdeling groeperen; gebeurtenissen zonder deze variabele worden gegroepeerd onder Geen afdeling.

Bijvoorbeeld, gebruikmakend van de CLI:

AXE_TRACK_USAGE=true AXE_ORGANIZATION=<your-organization-id> AXE_USER_ID=name@example.com axe https://broken-workshop.dequelabs.com/

De gebruiksstatistieken zijn alleen beschikbaar voor Axe Reports beheerders, en alleen voor organisaties waarvan de Axe Reports toegang Axe DevTools voor Web omvat. Voor informatie over het lezen van de rapporten zelf, zie Werken met Gebruikersrapporten in de Axe Reports documentatie.

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.

Voor informatie over het lezen van de gebruiksstatistieken in Axe Reports, zie Werken met Gebruikersrapporten in de Axe Reports documentatie.