Der Axe DevTools für Web Usage Service

Dieser Artikel bietet einen Überblick über den Nutzungdienst, einen Dienst, der es Ihnen ermöglicht, Ihre Nutzung der Axe DevTools APIs und des CLI zu verfolgen, indem Sie Nutzungsereignissen entweder an die öffentlich zugänglichen Server von Deque oder an Ihren eigenen Server senden. Das Senden von Nutzungsmetriken an Deque hilft uns, besser zu verstehen, wie unsere Benutzer mit unseren Produkten interagieren, damit wir sie weiter verbessern können.

Der Usage Service besteht aus zwei Teilen:

1. Ein Client, der Nutzungsereignissen an den Nutzungsdienst sendet (über die Metrikbibliothek, typischerweise aufgerufen von Axe DevTools APIs oder dem CLI)
2. Ein REST-Dienst, meist von Deque gehostet, der auf POST-Anfragen mit Nutzungsereignissen antwortet

Nutzungsereignisse enthalten Informationen über einen Barrierefreiheitsscan, einschließlich Datum und Uhrzeit des Scans, der Anzahl der verletzten Barrierefreiheitsregeln, der Namen der verletzten Regeln und anderer Informationen. Wenn Sie Ihren eigenen Nutzungsdienst einrichten, können Sie die Informationen nutzen, um Einblick in die Nutzung von Axe DevTools for Web in Ihrem Unternehmen zu geben. Für Referenzinformationen über die Struktur von Nutzungsereignissen siehe Das Referenzhandbuch für Nutzungsvorgang-Events.

Schnellstart

Sie können die Nutzung verfolgen, indem Sie die folgenden Schritte ausführen:

1. Bestätigen Sie, dass das Nutzungs-Tracking aktiviert ist. Es ist standardmäßig aktiviert, daher werden, sofern Sie AXE_TRACK_USAGE nicht auf false gesetzt haben, Nutzungsereignisse bereits an den Deque REST-Nutzungsdienst gesendet, sobald Sie das CLI oder Ihren eigenen Code, der die Axe DevTools für Web-APIs verwendet, ausführen.
2. (Optional) Ändern Sie die URL des Servers, an den Nutzungsereignisse gemeldet werden, indem Sie die Umgebungsvariable AXE_METRICS_URL ändern (die Standard-URL ist https://usage.deque.com). Wenn Sie diese Umgebungsvariable ändern, müssen Sie Ihren eigenen Nutzungsdienst erstellen, der den öffentlich zugänglichen Nutzungsdienst von Deque nachahmt. Siehe Einrichten eines Echo-Servers
3. (Optional) Setzen Sie AXE_INCLUDE_TEST_RESULTS auf true, um Testergebnisse in die Daten einzuschließen, die an den Nutzungsdienst gesendet werden. Durch das Setzen dieser Umgebungsvariable wird das testResults-Objekt im applicationProperties-Objekt gefüllt. Diese Variable wird nur vom CLI und den Node.js-APIs unterstützt. Siehe Das Referenzhandbuch für Nutzungsvorgang-Events für weitere Informationen.
4. (Optional) Setzen Sie die Umgebungsvariable AXE_DEV_INSTANCE auf true auf den Maschinen von Entwicklern und Testern, um Entwickler- und Tester-Zugriffsscans herauszufiltern. (Normalerweise möchten Sie die Nutzung von APIs ignorieren, die während der Entwicklungs- oder Testarbeit stattgefunden hat.)
5. (Optional) Setzen Sie beliebige andere Umgebungsvariablen, um die Ereignisse anzupassen, die an den Nutzungsdienst gemeldet werden. Siehe Steuerung des Nutzungsdienstes über Umgebungsvariablen.
6. Führen Sie Ihren Code zur Barrierefreiheitsüberprüfung oder einen CLI-Page-Scan aus, um die Nutzung an den Usage Service zu senden. Alle APIs von Deque nutzen die Metrik-Bibliothek, um Ereignisse zu erstellen und an den Usage Service zu senden, wie Sie es konfiguriert haben.

Für ein ausführlicheres Tutorial, das zeigt, wie der Nutzungsdienst mit den Axe DevTools APIs verwendet wird, siehe Erste Schritte mit dem Usage Service und den APIs. Für dasselbe Tutorial zur Verwendung des CLI mit dem Nutzungsdienst, siehe Erste Schritte mit dem Usage Service und der CLI. Diese Tutorials umfassen Schritte zum Einrichten eines einfachen Servers, der die Ereignisse des Nutzungsdienstes an die Konsole ausgibt, sodass Sie sehen können, was die Metrikbibliothek an den Nutzungsdienst sendet. Sie können diese Einrichtung zur Fehlerbehebung im Nutzungsdienst verwenden.

Ihre Nutzungsdaten in Axe-Berichten einsehen

Wenn Ihre Organisation Axe-Berichte verwendet, werden deren Nutzungsmetrik (die Nutzung pro Monat- und Gescannten URLs-Berichte) aus den in diesem Artikel beschriebenen Nutzungsereignissen erstellt. Sie werden nicht aus den JSON-Zugänglichkeitsergebnissen erstellt, die Sie mit dem CLI bulk-reports-Unterbefehl hochladen: das Senden von Nutzungsereignissen und das Hochladen von Ergebnissen sind separate Prozesse.

Damit Ihre Scans in den Nutzungsmetriken von Axe-Berichten erscheinen, benötigt jede Maschine, die einen Scan durchführt, Folgendes:

1. Nutzungs-Tracking bleibt aktiviert: es ist standardmäßig eingeschaltet, stellen Sie also sicher, dass AXE_TRACK_USAGE nicht auf false gesetzt ist und dass --enable-tracking false nicht an das CLI übergeben wird.
2. Nutzungsereignisse werden an den öffentlichen Nutzungsdienst von Deque gesendet: lassen Sie AXE_METRICS_URL auf dem Standardwert von https://usage.deque.com. Wenn Sie den Client auf Ihren eigenen Server verweisen, erhält Deque die Ereignisse nie und Axe-Berichte hat nichts anzuzeigen.
3. AXE_ORGANIZATION auf die ID Ihrer Organisation gesetzt. Axe-Berichte verwenden diesen Wert, um Nutzungsereignisse mit Ihrer Organisation zu verknüpfen; ohne ihn können Ihre Ereignisse nicht mit Ihrem Konto übereinstimmen.
4. AXE_USER_ID auf einen Identifikator der Person gesetzt, die den Scan durchführt, wie z.B. eine E-Mail-Adresse. Axe-Berichte zählen eindeutige Benutzer anhand dieses Wertes.
5. (Optional) AXE_DEPARTMENT auf die Abteilung des scanenden Benutzers gesetzt. Der Nutzung pro Monat-Bericht kann die Nutzung nach Abteilung gruppieren; Ereignisse ohne diese Variable werden unter Keine Abteilung gruppiert.

Zum Beispiel mit dem CLI:

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

Die Nutzungsmetriken sind nur für Axe-Berichtsadministratoren verfügbar und nur für Organisationen, deren Axe-Berichtszugang Axe DevTools für Web umfasst. Für Informationen zum Lesen der Berichte selbst siehe Arbeiten mit Nutzungsberichten in der Axe-Berichtsdokumentation.

Umgebungsvariablen

Sie können Umgebungsvariablen verwenden, um zu steuern, wie der Usage Service arbeitet und um die Ereignisse zu individualisieren, die er meldet. Umgebungsvariablen fallen in zwei Kategorien:

• Steuerung des Usage Service: Aktivieren oder deaktivieren Sie die Nutzungsverfolgung, setzen Sie die Berichts-URL, fügen Sie Testergebnisse zu den Ereignisdaten hinzu und setzen Sie die eindeutige Benutzer-ID.
• Anpassung der Ereignisse: Ändern Sie die Eigenschaften der an den Dienst gesendeten Nutzungsereignisse, wie die Organisation des Benutzers, Abteilung, Berufsrolle und andere identifizierende Informationen.

Für eine vollständige Referenz aller verfügbaren Umgebungsvariablen siehe Steuerung des Nutzungsdienstes über Umgebungsvariablen.

Siehe auch

Weitere Informationen zu den in den Nutzungsereignissen enthaltenen Eigenschaften finden Sie unter Das Referenzhandbuch für Nutzungsvorgang-Events.

Eine Referenz der verfügbaren Umgebungsvariablen zur Steuerung des Nutzungsdienstes und zur Anpassung der Ereignisse finden Sie unter Steuerung des Nutzungsdienstes über Umgebungsvariablen.

Für Informationen zum Lesen der Nutzungsmetriken in Axe-Berichten siehe Arbeiten mit Nutzungsberichten in der Axe-Berichtsdokumentation.