Die Ereignisreferenz des Nutzungsservice
Informationen zu den Eigenschaften der Version 2 des Nutzungsservice-Ereignisses
Dieser Artikel enthält Referenzinformationen über
- Die Ereignisdaten, die an den Nutzungsdienst gesendet werden (Version 2 des Ereignisobjekts, EventV2)
- Das enthaltene applicationProperties Objekt
- Das testResults -Objekt (enthalten im applicationProperties -Objekt), wenn AXE_INCLUDE_TEST_RESULTS auf true gesetzt ist
Version 2-Ereignis
Die folgende TypeScript-Schnittstelle definiert ein Ereignis der 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
}| Name | Beschreibung |
|---|---|
| Anwendung | Die Anwendung, die dieses Ereignis erstellt hat |
| Anwendungseigenschaften | applicationProperties unten definiert |
| Datum/Uhrzeit | Datum und Uhrzeit (auf die Millisekunde genau) im Format ISO-8601, UTC-Zeitzone |
| Abteilung | Die Abteilung des Benutzers innerhalb der Organisation |
| Entwicklerinstanz | Ob diese Verwendung als Entwicklerinstanz gilt und möglicherweise herausgefiltert werden sollte |
| Eindeutige ID | Die eindeutige UUID des Benutzers |
| Ereignis | Ereignistyp als String, normalerweise „analyze“ oder „uri:analyze“-Werte |
| KeycloakId | Die Keycloak ID des Benutzers |
| loggedIn | Ob der Benutzer angemeldet ist |
| Organisation | Die Organisation des Benutzers |
| Produktkomponente | Wird von den APIs festgelegt, um verschiedene Integrationen anzuzeigen, wie beispielsweise Playwright |
| Produktkomponentenversion | Eine Zeichenfolge, die die Version der Produktkomponente angibt |
| Produktname | Wird von den APIs festgelegt, um die von Ihnen verwendete Integration anzuzeigen |
| Sitzungs-ID | Eine UUID zur Identifizierung der Sitzung (um das Gruppieren von Ereignissen zu ermöglichen) |
| Benutzer-ID | Die Benutzer-ID |
| benutzerJobRolle | Die berufliche Rolle des Benutzers |
| Benutzerstatus | Der Status des Benutzers |
| Version | Eine Zeichenfolge, die die Version des Ereignisses angibt, immer „v2“ |
Eindeutige ID
Der distinctId-Wert ist eine UUID, die pro Benutzer festgelegt wird, wenn die Metriken aufgezeichnet werden. Es sollte über die Zeit stabil bleiben, da es beim ersten Ausführen der CLI oder des Codes, der die APIs verwendet, festgelegt wird. Es wird in der Datei .deque/distinct_id im Home-Verzeichnis jedes Benutzers gespeichert.
Anwendungseigenschaften
Das applicationProperties -Objekt enthält Zählinformationen zum Testlauf, wie das folgende Beispiel zeigt:
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: {}
},| Eigenschaft | Beschreibung |
|---|---|
| Engine-Version | Die zum Testen verwendete Version von axe-core |
| Anzahl fehlgeschlagener Elemente | Gesamtzahl der auf der Webseite gefundenen Zugänglichkeitsfehler |
| Anzahl fehlgeschlagener Regeln | Anzahl der Regeln, die auf der Seite fehlgeschlagen sind |
| failedRuleNames | Durch Kommas getrennte Zeichenfolge mit Namen fehlgeschlagener Regeln |
| inapplicableRuleCount | Anzahl der Regeln, die nicht angewendet wurden |
| unvollständige-Regelanzahl | Anzahl unvollständiger Regeln |
| bestandeneRegelAnzahl | Anzahl der Regeln, die bestanden haben |
| Zielmedium | MIME-Typ des Ziels |
| Ziel | Getestete URL |
| testResults | Das testResults -Objekt, weitere Informationen finden Sie im nächsten Abschnitt |
testResults
Das testResults -Objekt wird als ein axeResults -Objekt definiert (definiert durch axe-core). Es wird nur festgelegt, wenn Sie die Umgebungsvariable AXE_INCLUDE_TEST_RESULTS auf true gesetzt haben.
interface AxeResults extends EnvironmentData {
toolOptions: RunOptions;
passes: Result[];
violations: Result[];
incomplete: Result[];
inapplicable: Result[];
}Nachfolgend sehen Sie ein Beispiel für ein testResults -Objekt:
{
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: []
}Der Kürze halber wurden die Arrays inapplicable, passes, incomplete und violations , die normalerweise Ergebnis Objekte enthalten, nicht einbezogen.
Sie können die TypeScript-Definitionen für diese Objekte im axe-core GitHub-Repo sehen.
Siehe auch
Tutorials zur Verwendung des Nutzungsdiensts finden Sie unter Erste Schritte mit dem Nutzungsdienst und den APIs und Erste Schritte mit dem Nutzungsdienst und der CLI.
Allgemeine Informationen zum Nutzungsdienst finden Sie unter The axe DevTools for Web Usage Service.