Erste Schritte mit dem Verwendungsservice und der CLI

Dieser Artikel zeigt, wie der Verwendungsservice mit der CLI verwendet wird. Sie werden durch die Einrichtung eines lokalen Servers zur Wiedergabe von Verwendungsserviceereignissen geführt. Ihnen wird gezeigt, wie Sie mithilfe der CLI Verwendungsmetriken an den Server senden und wie Sie Verwendungsserviceereignisse mithilfe von Umgebungsvariablen ändern.

Mit dem Nutzungsservice können Sie Nutzungsstatistiken für die CLI-Nutzung Ihrer Organisation verfolgen. Die Aktivierung des Nutzungsdiensts kann für Ihr Unternehmen ein wichtiges Tool sein, um die Lizenzkonformität zu überwachen, Testprüfungen durchzuführen und sicherzustellen, dass alle axe DevTools for Web-Instanzen den Standards Ihres Unternehmens entsprechend konfiguriert sind.

Übersichtsinformationen zum Nutzungsdienst finden Sie unter The axe DevTools Usage Service.

Voraussetzungen

Sie müssen Node.js installieren, um dieses Beispiel zu verwenden. Das Node.js-Installationsprogramm finden Sie unter Node.js .

Einrichten 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 es in einem neuen Verzeichnis und wechseln Sie in dieses Verzeichnis.

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

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 Echoserver:

node echo-server.js

Testen einer Website mit der CLI

Sie müssen nun zwei Umgebungsvariablen festlegen: erstens, um den Nutzungsdienst zu aktivieren, und zweitens, um die URL für den Server anzugeben (den lokalen Server, der im vorherigen Abschnitt erstellt wurde):

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

Unter Linux oder macOS können Sie die Umgebungsvariablen festlegen und einen CLI-Scan einer Website in einer einzigen Zeile aufrufen, 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 Site aus https://broken-workshop.dequelabs.com.

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

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

Weitere Informationen zum Ereignisobjekt finden Sie unter Das Ereignisobjekt.

Ändern des Ereignisses mithilfe von Umgebungsvariablen

Sie können Umgebungsvariablen verwenden, um die Eigenschaften des gemeldeten Events zu ändern. Sie können beispielsweise die Eigenschaft userJobRole ä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/

Nachfolgend sehen Sie ein Beispiel für die vom Echoserver empfangenen Events:

{
  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 Eigenschaft userJobRole wurde durch Festlegen der Umgebungsvariable AXE_USER_JOB_ROLE hinzugefügt, wie in der hervorgehobenen Zeile gezeigt.

Informationen zum Festlegen anderer Eigenschaften im Ereignis finden Sie unter Steuerung des Nutzungsdienstes über Umgebungsvariablen.

Nächster Schritt

Eine Version dieses Tutorials für die axe DevTools-APIs finden Sie unter Erste Schritte mit dem Nutzungsdienst und den APIs.

Übersichtsinformationen zum Nutzungsdienst finden Sie unter Der Nutzungsdienst. Referenzinformationen zum Ereignisobjekt finden Sie unter The Usage Service Event Reference.