Le service d'utilisation Axe DevTools pour le Web
Une vue d'ensemble du service d'utilisation, qui est un service REST permettant de suivre l'utilisation des API et de l'interface en ligne de commande d'Axe DevTools pour le Web
Cet article donne un aperçu du service d'utilisation, un service qui vous permet de suivre votre utilisation des API Axe DevTools et de l'interface en ligne de commande 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.
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 Rapports Axe. Voir Rapport avec l'outil CLI 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 au service d'utilisation (via la bibliothèque de métriques, généralement appelée par les API Axe DevTools ou l'interface en ligne de commande)
- 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é, y compris la date et l'heure de l'analyse, le nombre de règles d'accessibilité enfreintes, les noms des règles enfreintes, et d'autres informations. Si vous installez votre propre service d'utilisation, vous pouvez utiliser les informations pour obtenir un aperçu de la façon dont Axe DevTools pour le Web est utilisé au sein de votre organisation. Pour obtenir des informations de référence sur la structure des événements d'utilisation, voyez Référence des événements du service d'utilisation.
Par défaut, Axe DevTools ne recueille pas d'informations d'utilisation. Vous devez activer l'utilisation pour permettre la collecte des métriques d'utilisation. Même lorsque l'utilisation est activée, le service ne collecte aucune information privée ou personnelle sur ses utilisateurs, car il a été conçu en tenant compte de la confidentialité.
Démarrage rapide
Vous pouvez commencer à suivre l'utilisation en suivant ces étapes :
- Définissez la variable d'environnement AXE_TRACK_USAGE sur true pour activer le suivi d'utilisation. Désormais, chaque fois que vous exécutez l'interface en ligne de commande ou votre propre code utilisant les API Axe DevTools pour le Web, des événements d'utilisation seront envoyés au service REST d'utilisation de Deque.
- (Optionnel) Changez l'URL du serveur où les événements d'utilisation seront rapporté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 - (Optionnel) Définissez AXE_INCLUDE_TEST_RESULTS sur true pour inclure les résultats de tests dans les données envoyées au service d'utilisation. Définir cette variable d'environnement remplira l'objet testResults dans l'objet applicationProperties . Voir Référence des événements du service d'utilisation pour plus d'informations.
- (Optionnel) 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. (En général, vous voudrez ignorer toute utilisation des API qui s'est produite pendant les travaux de développement ou de test.)
- (Optionnel) Définissez toute autre variable d'environnement pour personnaliser les événements qui seront rapportés au service d'utilisation. Voir Contrôler le service d'utilisation via des variables d'environnement.
- 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 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 l'interface en ligne de commande avec le service 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 renvoyer 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.
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 de tests dans les données d'événements 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 d’utilisation et personnaliser les événements, voir Contrôle du service d’utilisation via les variables d’environnement.