Erste Schritte mit dem Usage Service und der CLI

Dieser Artikel zeigt, wie man den Usage Service mit der CLI verwendet. Es wird erklärt, wie ein lokaler Server eingerichtet wird, um Ereignisse des Usage Service zu empfangen, wie man Nutzungsmetriken mit der CLI an den Server sendet und wie man Ereignisse des Usage Service mit Umgebungsvariablen ändert.

Der Nutzungsdienst ermöglicht es Ihnen, Nutzungsmetriken für die Verwendung der CLI in Ihrer Organisation zu verfolgen. Die Aktivierung des Nutzungsdienstes kann ein wichtiges Instrument für Ihre Organisation sein, um die Einhaltung von Lizenzvorgaben zu überwachen, Prüfungen durchzuführen und sicherzustellen, dass alle Axe DevTools für Web-Instanzen gemäß den Standards Ihrer Organisation konfiguriert sind.

Für Überblicksinformationen zum Usage Service siehe Der Axe DevTools Nutzungsdienst.

Voraussetzungen

Sie müssen Node.js installieren, um dieses Beispiel verwenden zu können. Siehe Node.js für das Node.js-Installationsprogramm.

Einrichtung eines Echo-Servers

Erstellen Sie eine Datei mit dem unten gezeigten Code:

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)

Wir nennen die Datei echo-server.js. Speichern Sie sie in einem neuen Verzeichnis und wechseln Sie in dieses Verzeichnis.

Der Server hört auf Port 3000 auf Anfragen und schreibt den empfangenen Anfragetext in die Konsole. Jedes Mal, wenn ein API-Client oder ein CLI-Test ausgeführt wird (und die Nutzungsprotokollierung aktiviert ist), schreibt der Echo-Server das empfangene Nutzungsevent.

Installieren Sie express und body-parser, zwei Abhängigkeiten, die zum Ausführen des obigen Codes erforderlich sind:

npm i express body-parser

Starten Sie den Echo-Server:

node echo-server.js

Testen einer Website mit der CLI

Sie müssen nun zwei Umgebungsvariablen setzen: Zuerst, um den Usage Service zu aktivieren, und zweitens, um die URL für den Server bereitzustellen (der im vorherigen Abschnitt erstellte lokale Server):

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

Unter Linux oder macOS können Sie die Umgebungsvariablen setzen und einen CLI-Scan einer Website in einer einzigen Zeile ausführen, wie hier gezeigt:

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

Dieser Befehl führt eine Analyse mithilfe der CLI auf der Seite https://broken-workshop.dequelabs.com aus.

Kehren Sie zum Konsolenfenster zurück, in dem Sie den Echo-Server ausführen, und Sie werden die empfangenen Ereignisse vom Echo-Server sehen, ein Beispiel für ein Ereignis wird unten gezeigt:

{
  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: {}
  }
}

Für weitere Informationen über das Ereignisobjekt siehe Das Ereignisobjekt.

Ändern des Ereignisses mit Umgebungsvariablen

Sie können Umgebungsvariablen verwenden, um die Eigenschaften des gemeldeten Ereignisses zu ändern. Zum Beispiel können Sie die userJobRole Eigenschaft ändern oder hinzufügen, indem Sie die Umgebungsvariable AXE_USER_JOB_ROLE festlegen:

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

Ein Beispiel für die vom Echo-Server empfangenen Ereignisse wird unten gezeigt:

{
  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'}

Die userJobRole Eigenschaft wurde hinzugefügt, indem die Umgebungsvariable AXE_USER_JOB_ROLE wie in der hervorgehobenen Zeile gezeigt, eingestellt wurde.

Um weitere Eigenschaften im Ereignis zu setzen, siehe Steuerung des Usage Service über Umgebungsvariablen.

Nächste Schritte

Um einer Version dieses Tutorials für die Axe DevTools APIs zu folgen, siehe Erste Schritte mit dem Usage Service und den APIs.

Um Ihre Nutzung an Deque zu senden, damit sie in den Nutzungsmetriken von Axe Reports erscheint, anstatt an einen lokalen Echo-Server, siehe Ihre Nutzungsdaten in Axe Reports anzeigen.

Für Überblicksinformationen über den Usage Service siehe Der Usage Service. Für Referenzinformationen über das Ereignisobjekt siehe Referenz zu den Usage Service Ereignissen.