axe DevTools für Web Usage Service
Eine Übersicht über den Nutzungsdienst, einen REST-Dienst, der die Nutzung von axe DevTools für Web-APIs und der CLI verfolgt.
Dieser Artikel bietet einen Überblick über den Nutzungsdienst, einen Dienst, der es Ihnen ermöglicht, Ihre Nutzung der Axe DevTools-APIs und der CLI zu verfolgen, indem Sie Nutzungsereignisse entweder an die öffentlich zugänglichen Server von Deque oder an Ihren eigenen Server senden. Durch das Senden von Nutzungsmetriken an Deque können wir besser verstehen, wie unsere Benutzer mit unseren Produkten interagieren, sodass wir sie kontinuierlich verbessern können.
Das Senden von Nutzungsereignissen an den Nutzungsdienst ist ein anderer Vorgang als das Senden von JSON-Zugänglichkeitsergebnissen an axe Reports. Weitere Informationen zur Berichterstellung finden Sie unter Berichterstellung mit der CLI .
Der Nutzungsservice besteht aus zwei Teilen:
- Ein Client, der Nutzungsereignisse an den Nutzungsdienst sendet (über die Metrikbibliothek, die normalerweise von den APIs von axe DevTools oder der CLI aufgerufen wird)
- Ein REST-Dienst, der normalerweise von Deque gehostet wird und auf POST-Anfragen antwortet, die Nutzungsereignisse enthalten
Nutzungsereignisse enthalten Informationen zu einem Barrierefreiheitsscan, einschließlich Datum und Uhrzeit des Scans, der Anzahl der verletzten Barrierefreiheitsregeln, den Namen der verletzten Regeln und anderen Informationen. Wenn Sie Ihren eigenen Nutzungsdienst einrichten, können Sie die Informationen nutzen, um Einblicke in die Verwendung von axe DevTools for Web in Ihrer Organisation zu geben. Referenzinformationen zur Struktur von Nutzungsereignissen finden Sie unter The Usage Service Event Reference.
Standardmäßig zeichnet axe DevTools keine Nutzungsinformationen auf. Die Nutzung muss aktiviert sein, um die Erfassung von Nutzungsmetriken zu ermöglichen. Auch wenn der Nutzungsservice aktiviert ist, sammelt er keine privaten oder persönlichen Informationen über seine Benutzer, da er unter Berücksichtigung des Datenschutzes entwickelt wurde.
Schnellstart
Sie können mit der Nutzungsverfolgung beginnen, indem Sie die folgenden Schritte ausführen:
- Setzen Sie die Umgebungsvariable AXE_TRACK_USAGE auf true , um die Nutzungsverfolgung zu aktivieren. Wenn Sie jetzt die CLI oder Ihren eigenen Code ausführen, der die axe DevTools für Web-APIs verwendet, werden Nutzungsereignisse an den Deque REST-Nutzungsdienst 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 Verwendungsdienst erstellen, der den öffentlichen Verwendungsdienst von Deque nachahmt. Siehe Einrichten eines Echo-Servers - (Optional) Setzen Sie AXE_INCLUDE_TEST_RESULTS auf true , um Testergebnisse in die an den Nutzungsdienst gesendeten Daten aufzunehmen. Durch Festlegen dieser Umgebungsvariable wird das Objekt testResults im Objekt applicationProperties gefüllt. Siehe Referenz zu Nutzungsdienstereignissen für weitere Informationen.
- (Optional) Setzen Sie die Umgebungsvariable AXE_DEV_INSTANCE auf den Maschinen von Entwicklern und Testern auf true , damit die Zugänglichkeitsscans von Entwicklern und Testern herausgefiltert werden können. (Normalerweise möchten Sie jegliche API-Verwendung ignorieren, die während der Entwicklungs- oder Testarbeit aufgetreten ist.)
- (Optional) Legen Sie alle anderen Umgebungsvariablen fest, um die Ereignisse anzupassen, die dem Nutzungsdienst gemeldet werden. Siehe Steuern des Nutzungsdienstes über Umgebungsvariablen.
- Führen Sie Ihren Code zum Scannen der Barrierefreiheit oder einen CLI-Seitenscan aus, um die Nutzung an den Nutzungsdienst zu senden. Alle APIs von Deque verwenden die Metrikbibliothek, um Ereignisse gemäß Ihrer Konfiguration zu erstellen und an den Nutzungsdienst zu senden.
Ein ausführlicheres Tutorial zur Verwendung des Nutzungsdiensts mit den axe DevTools-APIs finden Sie unter Erste Schritte mit dem Nutzungsdienst und den APIs. Dasselbe Tutorial, das die Verwendung der CLI mit dem Nutzungsdienst zeigt, finden Sie unter Erste Schritte mit dem Nutzungsdienst und der CLI. Diese Tutorials enthalten Schritte zum Einrichten Ihres eigenen einfachen Servers, um die Ereignisse des Nutzungsdienstes an die Konsole zurückzugeben, sodass Sie sehen können, was die Metrikbibliothek an den Nutzungsdienst sendet. Mit diesem Setup können Sie Probleme mit dem Nutzungsservice beheben.
Siehe auch
Weitere Informationen zu den in den Nutzungsereignissen enthaltenen Eigenschaften finden Sie unter The Usage Service Event Reference.