Le service d'utilisation Axe DevTools pour le Web

Cet article fournit un aperçu du service de suivi d'utilisation, un service qui vous permet de suivre votre utilisation des API Axe DevTools et du CLI en envoyant des événements d'utilisation soit aux serveurs publics de Deque, soit à votre propre serveur. Envoyer des métriques d'utilisation à Deque nous aide à mieux comprendre comment nos utilisateurs interagissent avec nos produits afin que nous puissions continuer à les améliorer.

Le service d'utilisation se compose de deux parties :

1. Un client qui envoie des événements d'utilisation au service de suivi d'utilisation (via la bibliothèque de métriques, généralement appelée par les API Axe DevTools ou le CLI)
2. Un service REST, généralement hébergé par Deque, qui répond aux demandes POST contenant des événements d'utilisation

Les événements d'utilisation contiennent des informations sur un scan d'accessibilité, y compris la date et l'heure du scan, 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 de suivi d'utilisation, vous pouvez utiliser les informations pour avoir un aperçu de la façon 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, voir La référence des événements du service d’utilisation.

Démarrage rapide

Vous pouvez commencer à suivre l'utilisation en suivant ces étapes :

1. Confirmez que le suivi d'utilisation est activé. Il l'est par défaut, donc à moins que vous n'ayez défini AXE_TRACK_USAGE sur false, les événements d'utilisation sont déjà envoyés au service d'utilisation REST de Deque chaque fois que vous exécutez l'interface en ligne de commande ou votre propre code utilisant les API Axe DevTools pour le Web.
2. (Facultatif) Modifiez l'URL du serveur où 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
3. (Facultatif) Définissez AXE_INCLUDE_TEST_RESULTS sur true pour inclure les résultats de test dans les données envoyées au service d'utilisation. Définir cette variable d'environnement remplira l'objet testResults dans l'objet applicationProperties. Cette variable est prise en charge uniquement par l'interface en ligne de commande et les API Node.js. Voir La référence des événements du service d’utilisation pour plus d'informations.
4. (Facultatif) Définissez la variable d'environnement AXE_DEV_INSTANCE sur true sur les machines des développeurs et des testeurs pour permettre de filtrer les analyses d'accessibilité des développeurs et des testeurs. (Habituellement, vous voudrez ignorer toute utilisation de l'API survenue pendant le développement ou le travail de test.)
5. (Optionnel) Définissez toute autre variable d'environnement pour personnaliser les événements qui seront rapportés au service de suivi d'utilisation. Voir Contrôle du service d’utilisation via les variables d’environnement.
6. Exécutez votre code de balayage d'accessibilité ou une analyse de page CLI pour envoyer des informations 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 vers le service d'utilisation tel que vous l'avez configuré.

Pour un tutoriel plus approfondi montrant comment utiliser le service de suivi d'utilisation avec les API Axe DevTools, voir Premiers pas avec le service d'utilisation et les API. Pour le même tutoriel montrant comment utiliser le CLI avec le service de suivi d'utilisation, voir Premiers pas avec le service d'utilisation et l'interface en ligne de commande. Ces tutoriels incluent des étapes pour configurer votre propre simple serveur pour échoer les événements du service de suivi d'utilisation sur la console, afin que vous puissiez voir ce que la bibliothèque de métriques envoie au service de suivi d'utilisation. Vous pouvez utiliser cette configuration pour résoudre les problèmes du service de suivi d'utilisation.

Visualisation de vos données d'utilisation dans les rapports Axe

Si votre organisation utilise les rapports Axe, ses métriques d'utilisation (les rapports Utilisation par mois et URL analysées) sont remplies à partir des événements d'utilisation décrits dans cet article. Elles ne sont pas remplies par les résultats d'accessibilité JSON que vous téléchargez avec la sous-commande bulk-reports de l'interface en ligne de commande : l'envoi des événements d'utilisation et le téléchargement des résultats sont des processus distincts.

Pour que vos analyses apparaissent dans les métriques d'utilisation des rapports Axe, chaque machine qui exécute une analyse a besoin de ce qui suit :

1. Suivi d'utilisation laissé activé : il est activé par défaut, alors assurez-vous que AXE_TRACK_USAGE n'est pas défini sur false et que --enable-tracking false n'est pas passé à l'interface en ligne de commande.
2. Événements d'utilisation envoyés au service public d'utilisation de Deque : laissez AXE_METRICS_URL à sa valeur par défaut de https://usage.deque.com. Si vous pointez le client vers votre propre serveur, Deque ne reçoit jamais les événements et les rapports Axe n'ont rien à afficher.
3. AXE_ORGANIZATION défini sur l'ID de votre organisation. Les rapports Axe utilisent cette valeur pour associer les événements d'utilisation à votre organisation ; sans elle, vos événements ne peuvent pas être associés à votre compte.
4. AXE_USER_ID défini sur un identifiant pour la personne exécutant l'analyse, tel qu'une adresse e-mail. Les rapports Axe comptent les utilisateurs uniques à partir de cette valeur.
5. (Facultatif) AXE_DEPARTMENT défini sur le département de l'utilisateur exécutant l'analyse. Le rapport Utilisation par mois peut regrouper l'utilisation par département ; les événements sans cette variable sont regroupés sous Aucun département.

Par exemple, en utilisant l'interface en ligne de commande :

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

Les métriques d'utilisation sont uniquement disponibles pour les administrateurs des rapports Axe, et seulement pour les organisations dont l'accès aux rapports Axe inclut Axe DevTools pour le Web. Pour des informations sur la lecture des rapports eux-mêmes, voir Utilisation des rapports d'utilisation dans la documentation des rapports Axe.

Variables d'environnement

Vous pouvez utiliser des variables d'environnement pour contrôler le fonctionnement du service d'utilisation et personnaliser les événements qu'il rapporte. Les variables d'environnement se répartissent en deux catégories :

• Contrôle du service d'utilisation : Activer ou désactiver le suivi d'utilisation, définir l'URL de rapport, inclure les résultats des tests dans les données d'événement, et définir l'ID distinct de l'utilisateur.
• Personnalisation des événements : Modifier les propriétés des événements d'utilisation envoyés au service, telles que l'organisation de l'utilisateur, le département, le rôle professionnel, et d'autres informations d'identification.

Pour une référence complète de toutes les variables d'environnement disponibles, voir Contrôle du service d’utilisation via les variables d’environnement.

Voir aussi

Pour plus d'informations sur les propriétés contenues dans les événements d'utilisation, voir La référence des événements du service d’utilisation.

Pour une référence des variables d'environnement disponibles pour contrôler le service de suivi d'utilisation et personnaliser les événements, voir Contrôle du service d’utilisation via les variables d’environnement.

Pour des informations sur la lecture des métriques d'utilisation dans les rapports Axe, voir Utilisation des rapports d'utilisation dans la documentation des rapports Axe.