Referenz für das Nutzungssicherungsereignis

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Informationen über die Eigenschaften der Version 2 des Nutzungssicherungsereignisses

Not for use with personal data

Dieser Artikel enthält Referenzinformationen über

  • Die Ereignisdaten, die an den Nutzungssicherungsdienst gesendet werden (Version 2 des Ereignisobjekts, EventV2)
  • Sein enthaltenes applicationProperties-Objekt
  • Das testResults-Objekt (enthalten im applicationProperties-Objekt), wenn AXE_INCLUDE_TEST_RESULTS auf true gesetzt ist

Ereignis Version 2

Das folgende TypeScript-Interface 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
application Die Anwendung, die dieses Ereignis erstellt hat
applicationProperties applicationProperties unten definiert
dateTime Datum und Uhrzeit (bis zur Millisekunde) im ISO-8601-Format, UTC-Zeitzone
department Die Abteilung des Benutzers innerhalb der Organisation
devInstance Ob diese Nutzung als Entwicklerinstanz betrachtet wird und wahrscheinlich herausgefiltert werden sollte
distinctId Die eindeutige UUID des Benutzers
event Ereignistyp als Zeichenkette, üblicherweise "analyze" oder "uri: analyze"-Werte
keycloakId Die Keycloak-ID des Benutzers
loggedIn Ob der Benutzer eingeloggt ist
organization Die Organisation des Benutzers
productComponent Von den APIs festgelegt, um verschiedene Integrationen wie Playwright anzuzeigen
productComponentVersion Eine Zeichenkette, die die Version der Produktkomponente angibt
productName Von den APIs festgelegt, um die verwendete Integration anzuzeigen
sessionId Eine UUID zur Identifizierung der Sitzung (um Ereignisse zu gruppieren)
userId Die ID des Benutzers
userJobRole Die Jobrolle des Benutzers
userStatus Der Status des Benutzers
version Eine Zeichenkette, die die Version des Ereignisses angibt, immer „v2“

distinctId

Der Wert von distinctId ist eine UUID, die für jeden Benutzer gesetzt wird, sobald die Metriken aufgezeichnet werden. Sie sollte über die Zeit stabil bleiben, da sie beim ersten Start des CLI oder Codes, der die APIs nutzt, festgelegt wird. Sie wird in der Datei .deque/distinct_id im Home-Verzeichnis jedes Benutzers gespeichert.

applicationProperties

Das applicationProperties-Objekt enthält Informationen über die Anzahl des Testlaufs, wie das Beispiel unten 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
engineVersion Die Version von axe-core, die für das Testen verwendet wird
failedItemCount Gesamtzahl der Barrierefreiheitsfehler, die auf der Webseite gefunden wurden
failedRuleCount Anzahl der Regeln, die auf der Seite fehlgeschlagen sind
failedRuleNames Kommagetrennte Zeichenkette mit Namen der Regeln, die fehlgeschlagen sind
inapplicableRuleCount Anzahl der Regeln, die nicht angewendet wurden
incompleteRuleCount Anzahl der Regeln, die unvollständig waren
passedRuleCount Anzahl der Regeln, die bestanden wurden
target_medium MIME-Typ des Ziels
Ziel Getestete URL
testResults Das testResults-Objekt, siehe den nächsten Abschnitt für weitere Informationen

testResults

Das testResults-Objekt wird als ein axeResults-Objekt definiert (definiert durch axe-core). Es wird nur gesetzt, wenn Sie die AXE_INCLUDE_TEST_RESULTS-Umgebungsvariable auf true gesetzt haben, was nur durch die CLI und die Node.js-APIs unterstützt wird.

interface AxeResults extends EnvironmentData {
  toolOptions: RunOptions;
  passes: Result[];
  violations: Result[];
  incomplete: Result[];
  inapplicable: Result[];
}

Das folgende zeigt 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: []
}

Aus Gründen der Kürze wurden die inapplicable-, passes-, incomplete- und violations-Arrays, die normalerweise Result-Objekte enthalten, nicht aufgenommen.

Sie können die TypeScript-Definitionen für diese Objekte im axe-core GitHub-Repo sehen.

Siehe auch

Für Anleitungen, die zeigen, wie der Nutzungsdienst verwendet wird, siehe Erste Schritte mit dem Usage Service und den APIs und Erste Schritte mit dem Usage Service und dem CLI.

Für allgemeine Informationen zum Nutzungsdienst siehe Der Axe DevTools für Web-Nutzungsdienst.

Is this page helpful?

Help us improve this page

Still need help?