Contrôler le service d'utilisation via des variables d'environnement

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Informations sur l'utilisation des variables d'environnement pour contrôler le service d'utilisation ou pour modifier l'événement rapporté au service d'utilisation

Not for use with personal data

Cet article contient des informations sur la façon de contrôler le service d'utilisation via des variables d'environnement. Vous pouvez :

  • Contrôler le fonctionnement du service d'utilisation.
  • Modifier l'événement envoyé au service d'utilisation.

Contrôler le service d'utilisation via des variables d'environnement

Quatre variables d'environnement vous permettent de contrôler le service d'utilisation. Vous pouvez désactiver la collecte des métriques d'utilisation, changer l'URL où les résultats sont rapportés, modifier l'ID distinct de l'utilisateur et inclure les résultats complets de axe-core dans chaque événement.

important

Le rapport d'utilisation est activé par défaut dans la CLI et les API Axe DevTools. Pour arrêter l'envoi des événements d'utilisation, réglez AXE_TRACK_USAGE sur false, ou appelez la méthode enableTracking de votre API avec false.

note

Si votre client ne parvient pas à contacter le service d'utilisation, il réessaiera en remplaçant https par http dans l'URL (définie à l'aide de la variable d'environnement AXE_METRICS_URL).

Modifier l'événement rapporté à l'aide de variables d'environnement

Avec les variables d'environnement ci-dessous, vous pouvez modifier l'événement qui est rapporté au service d'utilisation. Par exemple, vous pouvez changer les propriétés department ou organization sur chaque événement pour associer l'utilisation de l'API ou du CLI à un département ou une organisation spécifique.

La colonne Peut remplacer indique si la valeur définie dans la variable d'environnement peut remplacer une valeur déjà définie de manière programmatique via la bibliothèque de métriques. Un tiret (—) dans la colonne Peut remplacer indique que le concept ne s'applique pas à cette variable.

Variables d'environnement

Nom Type Peut remplacer Description
AXE_DISTINCT_ID Chaîne de caractères — Un identifiant UUID qui reste le même pour l'utilisateur connecté (sauf s'il est régénéré). En Ruby, cette variable est nommée DEQUE_DISTINCT_ID.
AXE_INCLUDE_TEST_RESULTS Booléen — Définir sur true pour inclure les résultats complets de axe-core dans l'objet testResults de chaque événement (la valeur par défaut est false). Pris en charge uniquement par la CLI et les API Node.js.
AXE_METRICS_URL Chaîne de caractères — L'URL du point de terminaison de l'utilisation REST (la valeur par défaut est https://usage.deque.com)
AXE_TRACK_USAGE Booléen — Définir sur false pour désactiver le rapport de service d'utilisation. Le rapport est activé par défaut.
AXE_APPLICATION Chaîne de caractères faux L'application qui a été utilisée pour vérifier les erreurs d'accessibilité
AXE_DEV_INSTANCE Booléen vrai Indique si cet événement provient d'actions d'un développeur logiciel. Utile pour marquer et supprimer ensuite les événements enregistrés pendant le développement ou les tests.
AXE_DEPARTMENT Chaîne de caractères vrai Le département de l'utilisateur au sein de l'organisation
AXE_KEYCLOAK_ID Chaîne de caractères faux L'ID Keycloak de l'utilisateur
AXE_LOGGED_IN Booléen faux Enregistre si l'utilisateur est connecté à l'application en test
AXE_ORGANIZATION Chaîne de caractères vrai L'organisation de l'utilisateur. Pour que votre utilisation apparaisse dans Axe Reports, définissez ceci sur l'ID de votre organisation (contactez Deque pour l'obtenir).
AXE_SESSION_ID Chaîne de caractères faux Un UUID identifiant la session de l'utilisateur
AXE_USER_ID Chaîne de caractères faux L'identité d'un utilisateur spécifique, telle qu'une adresse e-mail, un nom ou un identifiant de connexion. Axe Reports compte les utilisateurs uniques à partir de cette valeur.
AXE_USER_JOB_ROLE Chaîne de caractères faux Le rôle professionnel de l'utilisateur
AXE_USER_STATUS Chaîne de caractères faux Informations de statut que vous souhaitez associer à l'utilisateur

Différences entre les langages

La plupart de ces variables d'environnement se comportent de manière identique à travers la CLI et chaque API Axe DevTools. Les exceptions sont :

  • AXE_INCLUDE_TEST_RESULTS est lu uniquement par la CLI et les API Node.js. Le définir n'a aucun effet sur les APIs Java, Python, C# ou Ruby.
  • AXE_DISTINCT_ID est nommé DEQUE_DISTINCT_ID dans l'API Ruby.
  • AXE_METRICS_URL peut ne pas revenir à sa valeur par défaut dans les API Java et Ruby. Si vos événements d'utilisation n'atteignent pas Deque, définissez explicitement la variable sur https://usage.deque.com.

Voir aussi

Pour des tutoriels démontrant comment utiliser ces variables d'environnement, voir Prise en main avec le service d'utilisation et les API et Premiers pas avec le service d'utilisation et le CLI.

Pour des informations générales sur le service d'utilisation, voir Axe DevTools for Web Service d'utilisation.

Is this page helpful?

Help us improve this page

Still need help?