De Gebeurtenisreferentie van de Gebruiksservice
Informatie over de eigenschappen van versie 2 van de gebruiksservice-gebeurtenis
Dit artikel bevat referentie-informatie over
- De gebeurtenisgegevens die naar de gebruiksservice worden gestuurd (versie 2 van het gebeurtenisobject, EventV2)
- Het bevatte applicationProperties object
- Het testResults object (bevat binnen het applicationProperties object) wanneer AXE_INCLUDE_TEST_RESULTS is ingesteld op true
Versie 2 Gebeurtenis
De volgende TypeScript-interface definieert een versie 2-gebeurtenis:
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
}| Naam | Beschrijving |
|---|---|
| applicatie | De applicatie die deze gebeurtenis heeft gemaakt |
| applicationProperties | applicationProperties hieronder gedefinieerd |
| datumTijd | Datum en tijd (tot op de milliseconde) in ISO-8601 formaat, UTC tijdzone |
| afdeling | De afdeling van de gebruiker binnen de organisatie |
| devInstance | Of dit gebruik als een ontwikkelaarsinstantie wordt beschouwd en waarschijnlijk moet worden uitgefilterd |
| distinctId | De unieke uuid van de gebruiker |
| gebeurtenis | Gebeurtenistype als een string, meestal waarden "analyze" of "uri: analyze" |
| keycloakId | De Keycloak ID van de gebruiker |
| ingelogd | Of de gebruiker is ingelogd |
| organisatie | De organisatie van de gebruiker |
| productComponent | Ingesteld door de API's om verschillende integraties aan te geven zoals Playwright |
| productComponentVersion | Een string die de versie van de productcomponent aangeeft |
| productName | Ingesteld door de API's om de integratie aan te geven die je gebruikt |
| sessionId | Een uuid die de sessie identificeert (om gebeurtenissen te groeperen) |
| userId | De gebruikers-ID |
| userJobRole | De functie van de gebruiker |
| gebruikersstatus | De status van de gebruiker |
| versie | Een string die de versie van het evenement aangeeft, altijd 'v2' |
distinctId
De distinctId-waarde is een uuid die per gebruiker wordt ingesteld wanneer de statistieken worden geregistreerd. Het moet stabiel blijven in de tijd omdat het bij de eerste keer dat de CLI of code die de API's gebruikt wordt uitgevoerd, wordt ingesteld. Het wordt opgeslagen in het .deque/distinct_id-bestand in de home-directory van elke gebruiker.
toepassingseigenschappen
Het toepassingseigenschappen object bevat informatie over het aantal testruns, zoals een voorbeeld hieronder laat zien:
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: {}
},| Eigenschap | Beschrijving |
|---|---|
| engineVersion | De versie van axe-core die wordt gebruikt voor testen |
| aantalGefaaldeItems | Totaal aantal gevonden toegankelijkheidsfouten op de webpagina |
| aantalGefaaldeRegels | Aantal regels die zijn gefaald op de pagina |
| namenVanGefaaldeRegels | Komma-gescheiden string van namen van gefaalde regels |
| aantalNietToepasbareRegels | Aantal regels die niet zijn toegepast |
| aantalOnvolledigeRegels | Aantal regels die onvolledig waren |
| aantalGeslaagdeRegels | Aantal regels die succesvol zijn |
| doel_medium | Mime-typering van doel |
| doel | Geteste URL |
| testResultaten | Het testResultaten object, zie het volgende gedeelte voor meer informatie |
testResultaten
Het testResultaten object is gedefinieerd als een bijlResultaten object (gedefinieerd door axe-core). Het wordt alleen ingesteld wanneer je de omgevingsvariabele AXE_INCLUDE_TEST_RESULTS hebt ingesteld op waar.
interface AxeResults extends EnvironmentData {
toolOptions: RunOptions;
passes: Result[];
violations: Result[];
incomplete: Result[];
inapplicable: Result[];
}Het volgende is een voorbeeld van een testResultaten object:
{
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: []
}Voor de duidelijkheid werden de nietToepasbaar, geslaagd, onvolledig en overtredingen arrays, die normaal gesproken Resultaat objecten bevatten, niet opgenomen.
Je kunt de TypeScript-definities voor deze objecten zien in de axe-core GitHub-repository.
Zie ook
Voor tutorials die demonstreren hoe je de gebruiksdienst kunt gebruiken, zie Aan de slag met de Usage Service en de API's en Aan de slag met de Usage Service en de CLI.
Voor algemene informatie over de gebruiksdienst, zie De Axe DevTools voor Web Gebruiksdienst.