Le service d'utilisation de axe DevTools for Web
Un aperçu du service d'utilisation, qui est un service REST qui suit l'utilisation d'axe DevTools pour les API Web et la CLI
Cet article fournit un aperçu du service d'utilisation, un service qui vous permet de suivre votre utilisation des API axe DevTools et de la CLI en envoyant des événements d'utilisation soit aux serveurs publics de Deque, soit à votre propre serveur. L'envoi de mesures d'utilisation à Deque nous aide à mieux comprendre comment nos utilisateurs interagissent avec nos produits afin que nous puissions continuer à les améliorer.
L'envoi d'événements d'utilisation au service d'utilisation est un processus distinct de l'envoi de résultats d'accessibilité JSON aux axe Reports. Consultez Création de rapports avec l'interface de ligne de commande pour plus d'informations sur la création de rapports.
Le service d'utilisation se compose de deux parties :
- Un client qui publie des événements d'utilisation sur le service d'utilisation (via la bibliothèque de métriques, généralement appelée par les API axe DevTools ou la CLI)
- Un service REST, généralement hébergé par Deque, qui répond aux requêtes POST contenant des événements d'utilisation
Les événements d'utilisation contiennent des informations sur une analyse d'accessibilité, notamment la date et l'heure de l'analyse, le nombre de règles d'accessibilité violées, les noms des règles qui ont été violées et d'autres informations. Si vous configurez votre propre service d'utilisation, vous pouvez utiliser les informations pour donner un aperçu de la manière dont axe DevTools for Web est utilisé au sein de votre organisation. Pour obtenir des informations de référence sur la structure des événements d'utilisation, consultez Référence des événements du service d'utilisation.
Par défaut, axe DevTools n'enregistre pas les informations d'utilisation. Le usage doit être activé pour permettre la collecte des mesures d'usage. Même lorsqu'il est activé, le service d'utilisation ne collecte aucune information privée ou personnelle sur ses utilisateurs car il a été conçu dans un souci de confidentialité.
Démarrage rapide
Vous pouvez commencer à suivre le usage en suivant ces étapes :
- Définissez la variable d'environnement AXE_TRACK_USAGE sur true pour activer le suivi de l'utilisation. Désormais, chaque fois que vous exécutez l’interface de ligne de commande ou votre propre code qui utilise les API axe DevTools for Web, les événements d’utilisation seront publiés sur le service d’utilisation REST Deque.
- (Facultatif) Modifiez l'URL du serveur sur lequel les événements d'utilisation seront signalés en modifiant la variable d'environnement AXE_METRICS_URL (l'URL par défaut est
https://usage.deque.com). Si vous modifiez cette variable d’environnement, vous devez créer votre propre service d’utilisation qui imite le service d’utilisation public fourni par Deque. Voir Configuration d'un serveur Echo - (Facultatif) Définissez AXE_INCLUDE_TEST_RESULTS sur true pour inclure les résultats des tests dans les données envoyées au service d'utilisation. La définition de cette variable d'environnement peuplera l'objet testResults dans l'objet applicationProperties . Consultez Référence des événements du service d'utilisation pour plus d'informations.
- (Facultatif) Définissez la variable d'environnement AXE_DEV_INSTANCE sur true sur les machines des développeurs et des testeurs pour permettre le filtrage des analyses d'accessibilité des développeurs et des testeurs. (En général, vous souhaiterez ignorer toute utilisation de l'API qui s'est produite pendant le développement ou les tests.)
- (Facultatif) Définissez d’autres variables d’environnement pour personnaliser les événements qui seront signalés au service d’utilisation. Voir Contrôle du service d'utilisation via des variables d'environnement.
- Exécutez votre code d’analyse d’accessibilité ou une analyse de page CLI pour envoyer les données d'utilisation au service d’utilisation. Toutes les API de Deque utilisent la bibliothèque de métriques pour créer et publier des événements sur le service d'utilisation tel que vous l'avez configuré.
Pour un didacticiel plus détaillé montrant comment utiliser le service d'utilisation avec les API axe DevTools, consultez Premiers pas avec le service d'utilisation et les API. Pour le même didacticiel montrant comment utiliser la CLI avec le service d'utilisation, consultez Premiers pas avec le service d'utilisation et la CLI. Ces didacticiels incluent des étapes pour configurer votre propre serveur simple pour écho les événements du service d'utilisation à la console afin que vous puissiez voir ce que la bibliothèque de métriques envoie au service d'utilisation. Vous pouvez utiliser cette configuration pour dépanner le service d'utilisation.
Voir aussi
Pour plus d'informations sur les propriétés contenues dans les événements d'utilisation, consultez Référence des événements du service d'utilisation.