La référence des événements du service d'utilisation
Informations sur les propriétés de la version 2 de l'événement de service d'utilisation
Cet article contient des informations de référence sur
- Les données d'événement qui sont envoyées au service d'utilisation (version 2 de l'objet événement, EventV2)
- Son objet contenu applicationProperties
- L'objet testResults (contenu dans l'objet applicationProperties ) lorsque AXE_INCLUDE_TEST_RESULTS est défini sur true
Événement Version 2
L'interface TypeScript suivante définit un événement de version 2 :
interface EventV2 {
version: 'v2'
productName: string
productComponent: string
productComponentVersion: string
event: string
dateTime: Date
keycloakId?: string
distinctId: string
userId?: string
organization?: string
department?: string
application?: string
devInstance?: boolean
sessionId?: string
userStatus?: string
loggedIn?: boolean
applicationProperties?: Record<string, any>
userJobRole?: string
}| Nom | Description |
|---|---|
| application | L'application qui a créé cet événement |
| propriétés de l'application | applicationProperties défini ci-dessous |
| date et heure | Date et heure (à la milliseconde près) au format ISO-8601, fuseau horaire UTC |
| département | Le département de l'utilisateur au sein de l'organisation |
| Instance de développement | Si cette utilisation est considérée comme une instance de développement et doit probablement être filtrée |
| IdDistinct | L'UUID distinct de l'utilisateur |
| événement | Type d'événement sous forme de chaîne, généralement les valeurs « analyser » ou « uri : analyser » |
| keycloakId | L'ID Keycloak de l'utilisateur |
| connecté | Si l'utilisateur est connecté |
| organisation | L'organisation de l'utilisateur |
| Composant du produit | Défini par les API pour indiquer différentes intégrations telles que Playwright |
| Version du composant du produit | Une chaîne indiquant la version du composant du produit |
| Nom du produit | Défini par les API pour indiquer l'intégration que vous utilisez |
| sessionId | Un uuid identifiant la session (pour permettre le regroupement des événements) |
| ID de l'utilisateur | L'identifiant de l'utilisateur |
| rôle de l'utilisateurJob | Le rôle professionnel de l'utilisateur |
| Statut de l'utilisateur | Le statut de l'utilisateur |
| version | Une chaîne spécifiant la version de l'événement, toujours « v2 » |
IdDistinct
La valeur distinctId est un uuid défini par utilisateur chaque fois que les métriques sont enregistrées. Il doit être stable dans le temps car il est défini lors de la première exécution de la CLI ou du code qui utilise les API. Il est stocké dans le fichier .Deque/distinct_id dans le répertoire personnel de chaque utilisateur.
propriétés de l'application
L'objet applicationProperties contient des informations de comptage sur l'exécution du test, comme le montre l'exemple ci-dessous :
applicationProperties: {
target: 'https://broken-workshop.dequelabs.com/',
target_medium: 'text/html',
engineVersion: '4.5.2',
failedRuleCount: 2,
failedRuleNames: 'color-contrast,label',
failedItemCount: 5,
inapplicableRuleCount: 39,
incompleteRuleCount: 2,
passedRuleCount: 21,
testResults: {}
},| Propriété | Description |
|---|---|
| Version du moteur | La version d'axe-core utilisée pour les tests |
| Nombre d'éléments ayant échoué | Nombre total d'erreurs d'accessibilité trouvées sur la page Web |
| Nombre de règles ayant échoué | Nombre de règles ayant échoué sur la page |
| nomsDesRèglesÉchouées | Chaîne de noms de règles ayant échoué, séparée par des virgules |
| compteRèglesInapplicables | Nombre de règles qui n'ont pas été appliquées |
| incompleteRuleCount | Nombre de règles incomplètes |
| passedRuleCount | Nombre de règles validées |
| target_medium | Type MIME de la cible |
| cible | URL testée |
| testResults | L'objet testResults , voir la section suivante pour plus d'informations |
testResults
L'objet testResults est défini comme un objet axeResults (défini par axe-core). Elle n'est définie que lorsque vous avez défini la variable d'environnement AXE_INCLUDE_TEST_RESULTS sur true.
interface AxeResults extends EnvironmentData {
toolOptions: RunOptions;
passes: Result[];
violations: Result[];
incomplete: Result[];
inapplicable: Result[];
}Ce qui suit montre un exemple d'objet testResults :
{
testEngine: {
name: "axe-core",
version: "4.4.1"
},
testRunner: {
name: "axe"
},
testEnvironment: {
userAgent: "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML,like Gecko) Version/16.0 Safari/605.1.15",
windowWidth: 1280,
windowHeight: 720
},
timestamp: "2023-02-02T20:09:04.785Z",
url: "https://broken-workshop.dequelabs.com/",
toolOptions: {
reporter: "v1"
},
inapplicable: [],
passes: [],
incomplete: [],
violations: []
}Par souci de concision, les tableaux inapplicables, validés, incomplets et violations , qui contiennent normalement des objets Résultat , n'ont pas été inclus.
Vous pouvez voir les définitions TypeScript pour ces objets dans le dépôt GitHub axe-core.
Voir aussi
Pour des tutoriels montrant comment utiliser le service d'utilisation, 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.