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
applicationPropertiesobject - Het
testResultsobject (bevat in hetapplicationPropertiesobject) wanneerAXE_INCLUDE_TEST_RESULTSis ingesteld optrue
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
actor?: 'human' | 'automation'
teams?: { id: string; name: string }[]
}| Naam | Beschrijving |
|---|---|
| acteur | Of een persoon (human) of een geautomatiseerde pijplijn (automation) de test heeft uitgevoerd. Ingesteld door de CLI, de Node.js API's en de Ruby API. Zie acteur. |
| applicatie | De applicatie die deze gebeurtenis heeft gemaakt |
| toepassingseigenschappen | toepassingseigenschappen 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) |
| teams | De teams die de test uitvoeren, als een array van { id, name }-objecten. Ingesteld door de CLI, de Node.js API's en de Ruby API. Zie teams. |
| 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.
acteur
De CLI, de Node.js API's en de Ruby API stellen actor in op automation wanneer een van deze omgevingsvariabelen is ingesteld op een andere waarde dan false of 0: CI, BUILD_NUMBER, BUILDKITE, CIRCLECI, CODEBUILD_BUILD_ID, GITHUB_ACTIONS, GITLAB_CI, JENKINS_URL, TEAMCITY_VERSION, TF_BUILD of BITBUCKET_BUILD_NUMBER. Anders is actor human. Stel de omgeving variabele AXE_ACTOR in op human of automation om de detectie te negeren. Het @axe-devtools/browser-pakket kan geen omgevingsvariabelen lezen wanneer het in een browser draait, dus het rapporteert daar human.
teams
De teams array registreert de teams waarvan de leden de test hebben uitgevoerd. De CLI, de Node.js API's en de Ruby API sturen deze altijd, als een lege array ([]) wanneer geen teams zijn ingesteld. U levert zelf de teams, met de AXE_TEAMS omgevingsvariabele, de --set-teams-optie van de CLI, uw Node.js API's setTeams-methode of de for_teams-clausule of teams configuratie-eigenschap van de Ruby API. Elk team is een object met string-eigenschappen id en name:
[{ "id": "1", "name": "Web" }]Inschrijvingen zonder een string id en name worden weggelaten. Een waarde die niet kan worden gelezen of geen JSON-array is, wordt genegeerd en het evenement wordt nog steeds verzonden.
toepassingseigenschappen
Het applicationProperties object bevat informatie over het aantal testruns, zoals een voorbeeld hieronder laat zien:
applicationProperties: {
advancedRules: { enabled: false, value: 'disabled', source: 'unavailable' },
target: 'https://broken-workshop.dequelabs.com/',
targetMedium: 'text/html',
urlCount: 1,
engineVersion: '4.14.0',
failedRuleCount: 2,
failedRuleNames: 'color-contrast,label',
failedItemCount: 5,
criticalIssueCount: 3,
seriousIssueCount: 2,
moderateIssueCount: 0,
minorIssueCount: 0,
needsReviewItemCount: 4,
inapplicableRuleCount: 39,
incompleteRuleCount: 2,
passedRuleCount: 21,
testResults: {}
},| Eigenschap | Beschrijving |
|---|---|
| geavanceerdeRegels | Of geavanceerde regels draaiden. De CLI, de Node.js API's en de Ruby API draaien nooit geavanceerde regels, dus dit is altijd { enabled: false, value: 'disabled', source: 'unavailable' }. |
| commando | Het CLI-commando dat de scan uitvoerde, zoals spec of bulk-spec. Alleen verzonden door de CLI. |
| kritiekeProbleemAantal | Aantal elementen met een kritiek impact die falen |
| 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 |
| kleinProbleemAantal | Aantal elementen met een kleine impact die falen |
| matigProbleemAantal | Aantal elementen met een matige impact die falen |
| controleNodigAantal | Aantal elementen die controle nodig hebben |
| aantalOnvolledigeRegels | Aantal regels die onvolledig waren |
| aantalGeslaagdeRegels | Aantal regels die succesvol zijn |
| ernstigProbleemAantal | Aantal elementen met een ernstige impact die falen |
| doel | Geteste URL |
| doelMedium | Mime-type van het doel. Voor versie 4.14.0 heette dit target_medium. |
| testResultaten | Het testResults object, zie het volgende gedeelte voor meer informatie |
| urlAantal | Aantal verschillende URL's geanalyseerd. Een CLI-spec-pagina waarvan de acties navigeren en opnieuw analyseren meldt meer dan 1. |
testResultaten
Het testResults object wordt gedefinieerd als een axeResults object (gedefinieerd door axe-core). Het wordt alleen ingesteld wanneer je de AXE_INCLUDE_TEST_RESULTS omgevingsvariabele hebt ingesteld op true, wat alleen wordt ondersteund door de CLI en de Node.js API's.
interface AxeResults extends EnvironmentData {
toolOptions: RunOptions;
passes: Result[];
violations: Result[];
incomplete: Result[];
inapplicable: Result[];
}Het volgende is een voorbeeld van een testResults 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 inapplicable, passes, incomplete en violations arrays, die normaal gesproken Result 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.
