Aan de slag met de Usage Service en de CLI

Dit artikel laat zien hoe je de usage service met de CLI kunt gebruiken. Je wordt begeleid bij het opzetten van een lokale server om usage service-evenementen te echoën, je zult zien hoe je gebruiksstatistieken naar de server kunt sturen met behulp van de CLI, en hoe je de usage service-evenementen kunt wijzigen met behulp van omgevingsvariabelen.

De gebruiksdienst stelt je in staat om gebruiksstatistieken bij te houden voor het gebruik van de CLI door je organisatie. Het inschakelen van de gebruiksdienst kan een belangrijk hulpmiddel zijn voor je organisatie om nalevingscontroles voor licenties uit te voeren, audit tests te doen en ervoor te zorgen dat alle Axe DevTools for Web-instanties zijn geconfigureerd volgens de standaarden van je organisatie.

Voor overzichtsinformatie over de usage service zie De Axe DevTools Gebruiksdienst.

Vereisten

Je moet Node.js installeren om dit voorbeeld te gebruiken. Zie Node.js voor de Node.js installer.

Een Echo Server opzetten

Maak een bestand aan met de code die hieronder wordt getoond:

const express = require('express')
const bodyParser = require('body-parser')

const app = express()

// Parse JSON bodies.
app.use(bodyParser.json())
// Accept events.
app.post('/:version/event', (req, res) => {
  const event = req.body
  console.log(event)

  // Respond so the client is happy.
  res.status(200)
  res.send('Event accepted!')
})

// Listen for requests.
app.listen(3000)

We zullen het bestand **echo-server.js** noemen. Sla het op in een nieuwe map en ga naar die map.

De server luistert naar aanvragen op poort 3000 en schrijft de body van de ontvangen aanvraag naar de console. Dus elke keer dat een API-client of CLI-test wordt uitgevoerd (en gebruiksregistratie is ingeschakeld), schrijft de echo server de ontvangen gebruiksgebeurtenis.

Installeer **express** en **body-parser**, twee afhankelijkheden die nodig zijn om de bovenstaande code uit te voeren:

npm i express body-parser

Start de echo server:

node echo-server.js

Een Site Testen met de CLI

Je moet nu twee omgevingsvariabelen instellen: eerst om de usage service in te schakelen en ten tweede om de URL voor de server op te geven (de lokale server die in de vorige sectie is gemaakt):

1. export AXE_TRACK_USAGE=true
2. export AXE_METRICS_URL=http://localhost:3000

In Linux of macOS kun je de omgevingsvariabelen instellen en een CLI-scan van een website in één regel uitvoeren zoals hier getoond:

AXE_TRACK_USAGE=true AXE_METRICS_URL=http://localhost:3000 axe https://broken-workshop.dequelabs.com/

set AXE_TRACK_USAGE=true
set AXE_METRICS_URL=http://localhost:3000

setx AXE_TRACK_USAGE true
setx AXE_METRICS_URL http://localhost:3000

Deze opdracht voert een analyse uit met de CLI op de site https://broken-workshop.dequelabs.com.

Ga terug naar het consolevenster waar je de echo server uitvoert, en je zult de ontvangen evenementen van de echo server zien, een voorbeeld van een evenement wordt hieronder getoond:

{
  dateTime: '2023-01-20T20:48:16.864Z',
  productComponent: 'api-cli',
  productName: 'axe-devtools-html',
  version: 'v2',
  event: 'uri: analyze',
  distinctId: 'f542d302-18a0-42a6-ab7f-ec1e42399bfe',
  applicationProperties: {
    target: 'https://broken-workshop.dequelabs.com/',
    target_medium: 'text/html',
    engineVersion: '4.5.2',
    failedRuleCount: 2,
    failedRuleNames: 'color-contrast,image-alt',
    failedItemCount: 12,
    inapplicableRuleCount: 33,
    incompleteRuleCount: 0,
    passedRuleCount: 27,
    testResults: {}
  }
}

Voor meer informatie over het event object, zie Het Event Object.

Het Event Wijzigen met Omgevingsvariabelen

U kunt omgevingsvariabelen gebruiken om de eigenschappen van het gerapporteerde evenement te wijzigen. U kunt bijvoorbeeld de eigenschap userJobRole wijzigen of toevoegen door de AXE_USER_JOB_ROLE omgevingsvariabele in te stellen:

AXE_TRACK_USAGE=true AXE_METRICS_URL=http://localhost:3000 AXE_USER_JOB_ROLE="testing" axe https://broken-workshop.dequelabs.com/

Een voorbeeld van de evenementen ontvangen door de echo server wordt hieronder getoond:

{
  dateTime: '2023-01-20T20:52:23.878Z',
  productComponent: 'api-cli',
  productName: 'axe-devtools-html',
  version: 'v2',
  event: 'uri: analyze',
  distinctId: '9c55a1f8-5177-44ee-a0e3-5dafa5ef9fc9',
  applicationProperties: {
    target: 'https://broken-workshop.dequelabs.com/',
    target_medium: 'text/html',
    engineVersion: '4.5.2',
    failedRuleCount: 2,
    failedRuleNames: 'color-contrast,image-alt',
    failedItemCount: 12,
    inapplicableRuleCount: 33,
    incompleteRuleCount: 0,
    passedRuleCount: 27,
    testResults: {}
  },
  userJobRole: 'testing'}

De eigenschap userJobRole werd toegevoegd door de AXE_USER_JOB_ROLE omgevingsvariabele in te stellen, zoals aangegeven door de gemarkeerde regel.

Om andere eigenschappen in het evenement in te stellen, zie De Usage Service Beheersen via Omgevingsvariabelen.

Volgende Stappen

Om een versie van deze tutorial te volgen voor de Axe DevTools API's, zie Aan de slag met de Usage Service en de APIs.

Om uw gebruik naar Deque te sturen zodat het in de gebruiksstatistieken van Axe Reports verschijnt in plaats van naar een lokale echo-server, zie Uw gebruiksgegevens bekijken in Axe Reports.

Voor overzichtsinformatie over de usage service, zie De Usage Service. Voor referentie-informatie over het event object, zie De Usage Service Event Referentie.