Der Axe DevTools für Web Usage Service
Ein Überblick über den Usage Service, ein REST-Service, der die Nutzung der Axe DevTools für Web-APIs und der CLI verfolgt
Dieser Artikel bietet einen Überblick über den Usage Service, einen Dienst, der es Ihnen ermöglicht, Ihre Nutzung der Axe DevTools APIs und der CLI zu verfolgen, indem er Nutzungsereignisse entweder an die öffentlich zugänglichen Server von Deque oder an Ihren eigenen Server sendet. Das Senden von Nutzungsmetriken an Deque hilft uns zu verstehen, wie unsere Benutzer mit unseren Produkten umgehen, damit wir sie weiterhin verbessern können.
Das Senden von Nutzungsvorgängen an den Nutzungsdienst ist ein separater Vorgang vom Senden von JSON-Zugänglichkeitsergebnissen an Axe Reports. Siehe Berichterstellung mit dem CLI , um weitere Informationen über die Berichterstattung zu erhalten.
Der Usage Service besteht aus zwei Teilen:
- Ein Client, der Nutzungsereignisse an den Usage Service sendet (über die Metrik-Bibliothek, typischerweise aufgerufen von Axe DevTools APIs oder der CLI)
- Ein REST-Service, normalerweise von Deque gehostet, der auf POST-Anforderungen mit Nutzungsereignissen
antwortet. Nutzungsereignisse enthalten Informationen über einen Barrierefreiheitsscan, einschließlich des Datums und der Uhrzeit des Scans, der Anzahl der verletzten Barrierefreiheitsregeln, der Namen der verletzten Regeln und weiterer Informationen. Wenn Sie Ihren eigenen Usage Service einrichten, können Sie diese Informationen nutzen, um Einblicke zu gewinnen, wie Axe DevTools für Web in Ihrer Organisation verwendet wird. Für Referenzinformationen über die Struktur von Nutzungsereignissen siehe The Usage Service Event Reference.
Standardmäßig zeichnet Axe DevTools keine Nutzungsinformationen auf. Die Nutzung muss aktiviert werden, um die Erfassung von Nutzungsmetriken zu ermöglichen. Selbst bei aktivierter Nutzung sammelt der Usage Service keine privaten oder persönlichen Informationen über seine Benutzer, da er mit Blick auf Datenschutz entwickelt wurde.
Schnellstart
Sie können die Nutzung verfolgen, indem Sie die folgenden Schritte ausführen:
- Setzen Sie die Umgebungsvariable AXE_TRACK_USAGE auf true , um die Nutzungsverfolgung zu aktivieren. Jetzt, wann immer Sie die CLI oder Ihren eigenen Code ausführen, der die Axe DevTools für Web APIs nutzt, werden Nutzungsereignisse an den Deque REST Usage Service gesendet.
- (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 Usage Service erstellen, der den öffentlich zugänglichen Usage Service von Deque nachbildet. Siehe Einrichten eines Echo-Servers - (Optional) Setzen Sie AXE_INCLUDE_TEST_RESULTS auf true , um Testergebnisse in die an den Usage Service gesendeten Daten einzubeziehen. Das Setzen dieser Umgebungsvariable wird das testResults -Objekt in dem applicationProperties -Objekt auffüllen. Siehe The Usage Service Event Reference für weitere Informationen.
- (Optional) Setzen Sie die Umgebungsvariable AXE_DEV_INSTANCE auf true auf den Rechnern von Entwicklern und Testern, um Entwickler- und Tester-Scans zur Barrierefreiheit herauszufiltern. (In der Regel möchten Sie jegliche API-Nutzung ignorieren, die während der Entwicklungs- oder Testarbeiten stattgefunden hat.)
- (Optional) Setzen Sie alle weiteren Umgebungsvariablen, um die Ereignisse zu anzupassen, die an den Usage Service gemeldet werden. Siehe Steuerung des Usage Service über Umgebungsvariablen.
- 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 zur Nutzung des Usage Service mit den Axe DevTools APIs siehe Erste Schritte mit dem Usage Service und den APIs. Für das gleiche Tutorial zur Nutzung der CLI mit dem Usage Service siehe Erste Schritte mit dem Usage Service und der CLI. Diese Tutorials beinhalten Schritte zum Einrichten Ihres eigenen einfachen Servers, um die Usage Service-Ereignisse in der Konsole widerzuspiegeln, sodass Sie sehen können, was die Metrik-Bibliothek an den Usage Service sendet. Sie können dieses Setup verwenden, um den Usage Service zu überprüfen.
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 der Nutzungsverfolgung, Einrichten der Melde-URL, Einbeziehen von Testergebnissen in die Ereignisdaten und Festlegen der eindeutigen Benutzer-ID.
- Anpassung der Ereignisse: Ändern Sie die Eigenschaften der an den Service gesendeten Nutzungsereignisse, wie z.B. die Organisation des Benutzers, Abteilung, Berufsrolle und andere identifizierende Informationen.
Einen vollständigen Überblick über alle verfügbaren Umgebungsvariablen finden Sie unter Steuerung des Nutzungsdienstes über Umgebungsvariablen.
Siehe auch
Für weitere Informationen zu den in den Nutzungsvorgängen enthaltenen Eigenschaften siehe Das Referenzhandbuch für Nutzungsvorgang-Events.
Für eine Übersicht über die Umgebungsvariablen zur Steuerung des Nutzungsdienstes und zur Anpassung der Ereignisse, siehe Steuerung des Nutzungsdienstes über Umgebungsvariablen.