Contrôle du service d'utilisation via des variables d'environnement
Informations sur l'utilisation des variables d'environnement pour contrôler le service d'utilisation ou pour modifier l'événement signalé au service d'utilisation
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 qui est envoyé au service d'utilisation.
Contrôle du service d'utilisation via des variables d'environnement
Ces quatre variables d’environnement vous permettent de contrôler l’utilisation du service. Vous pouvez activer ou désactiver la collecte de mesures d'utilisation, inclure les résultats des tests avec les événements d'utilisation, modifier l'URL où les résultats sont rapportés et modifier l'ID distinct de l'utilisateur.
| Nom | Description |
|---|---|
| AXE_DISTINCT_ID | Un identifiant UUID qui reste le même pour l'utilisateur connecté (sauf s'il est régénéré) |
| AXE_INCLUDE_TEST_RESULTS | Inclure les résultats des tests dans l'objet applicationProperties en renseignant l'objet testResults |
| AXE_METRICS_URL | L'URL du point d'accès d'utilisation REST |
| AXE_TRACK_USAGE | Active le rapport d'utilisation du service (la valeur par défaut est false) |
Si votre client ne parvient pas à contacter le service d'utilisation, il réessayera en remplaçant https par http dans l'URL (définie à l'aide de la variable d'environnement AXE_METRICS_URL).
Modification de l'événement signalé à l'aide de variables d'environnement
Avec les variables d’environnement ci-dessous, vous pouvez modifier l’événement signalé au service d’utilisation. Par exemple, vous pouvez modifier les propriétés du département ou organisation sur chaque événement pour associer l'utilisation de l'API ou de la CLI à un département ou une organisation spécifique.
Dans les tableaux ci-dessous, la colonne Peut remplacer indique si la valeur définie dans la variable d'environnement peut remplacer la valeur définie dans l'appel à la bibliothèque de métriques. Nom de la donnée est le nom de la propriété tel qu'il apparaît dans l'objet événement envoyé au service d'utilisation.
Variables d'environnement booléennes
Ces valeurs sont censées être vrai ou faux.
| Nom | Nom de la donnée | Peut surcharger | Description |
|---|---|---|---|
| AXE_DEV_INSTANCE | devInstance | vrai | Indique si cet événement provient des actions d'un développeur de logiciel. Utile pour marquer et supprimer ultérieurement les événements enregistrés pendant le développement ou les tests. |
| AXE_LOGGED_IN | connecté | false | Enregistre si l'utilisateur est connecté à l'application testée. |
Variables d'environnement de chaîne de caractères
Ces valeurs sont interprétées comme des chaînes.
| Nom | Nom de la donnée | Peut surcharger | Description |
|---|---|---|---|
| AXE_APPLICATION | application | false | L'application qui a été utilisée pour vérifier les erreurs d'accessibilité |
| AXE_DEPARTMENT | département | vrai | Le service de l'utilisateur au sein de l'organisation (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | keycloakId | false | L'ID Keycloak de l'utilisateur |
| AXE_ORGANISATION | organisation | vrai | L'organisation de l'utilisateur |
| AXE_SESSION_ID | sessionId | false | Un uuid identifiant la session de l'utilisateur |
| ID_UTILISATEUR_AXE | ID de l'utilisateur | false | L'identité d'un utilisateur spécifique, comme son nom ou son identifiant de connexion |
| RÔLE_TRAVAIL_UTILISATEUR_AXE | rôle de l'utilisateurJob | false | Le rôle professionnel de l'utilisateur |
| AXE_UTILISATEUR_ÉTAT | Statut de l'utilisateur | false | Informations sur le statut que vous souhaitez associer à l'utilisateur |
Voir aussi
Pour des tutoriels montrant comment utiliser ces variables d'environnement, consultez Premiers pas avec le service d'utilisation et les API et Premiers pas avec le service d'utilisation et l'interface de ligne de commande.
Pour des informations générales sur le service d'utilisation, voir axe DevTools for Web Usage Service.