Riferimento sugli eventi del servizio di utilizzo
Informazioni sulle proprietà della versione 2 dell'evento del servizio di utilizzo
Questo articolo contiene informazioni di riferimento su
- I dati dell'evento che vengono inviati al servizio di utilizzo (versione 2 dell'oggetto evento,
EventV2) - Il suo oggetto
applicationPropertiescontenuto - L'oggetto
testResults(contenuto all'interno dell'oggettoapplicationProperties) quandoAXE_INCLUDE_TEST_RESULTSè impostato sutrue
Evento Versione 2
La seguente interfaccia TypeScript definisce un evento di versione 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
}| Nome | Descrizione |
|---|---|
| application | L'applicazione che ha creato questo evento |
| proprietàApplicazione | proprietàApplicazione definito di seguito |
| dateTime | Data e ora (al millisecondo) in formato ISO-8601, fuso orario UTC |
| department | Il dipartimento dell'utente all'interno dell'organizzazione |
| devInstance | Se questo utilizzo è considerato un'istanza di sviluppo e probabilmente dovrebbe essere filtrato |
| distinctId | L'id univoco dell'utente |
| event | Tipo di evento come stringa, di solito valori "analyze" o "uri: analyze" |
| keycloakId | L'ID Keycloak dell'utente |
| loggedIn | Se l'utente è connesso |
| organization | L'organizzazione dell'utente |
| productComponent | Impostato dalle API per indicare diverse integrazioni come Playwright |
| productComponentVersion | Una stringa che indica la versione del componente del prodotto |
| productName | Impostato dalle API per indicare l'integrazione in uso |
| sessionId | Un uuid che identifica la sessione (per consentire il raggruppamento degli eventi) |
| userId | L'ID dell'utente |
| userJobRole | La posizione lavorativa dell'utente |
| statoUtente | Lo stato dell'utente |
| versione | Una stringa che specifica la versione dell'evento, sempre 'v2' |
distinctId
Il valore distinctId è un uuid impostato per ciascun utente ogni volta che le metriche vengono registrate. Dovrebbe essere stabile nel tempo perché viene impostato al primo avvio del CLI o del codice che utilizza le API. È memorizzato nel file .deque/distinct_id nella directory home di ciascun utente.
proprietàApplicazione
L'oggetto applicationProperties contiene informazioni sul conteggio dell'esecuzione del test, come mostra l'esempio seguente:
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: {}
},| Proprietà | Descrizione |
|---|---|
| versioneMotore | La versione di axe-core utilizzata per il test |
| conteggioElementiFalliti | Numero totale di errori di accessibilità trovati sulla pagina web |
| conteggioRegoleFallite | Numero di regole che non sono state superate sulla pagina |
| nomiRegoleFallite | Stringa separata da virgole dei nomi delle regole non superate |
| conteggioRegoleInapplicabili | Numero di regole che non sono state applicate |
| conteggioRegoleIncomplete | Numero di regole che erano incomplete |
| conteggioRegoleSuperate | Numero di regole che sono state superate |
| tipo_mime_target | Tipo mime del target |
| target | URL testato |
| risultatiTest | L'oggetto testResults, vedere la sezione successiva per maggiori informazioni |
risultatiTest
L'oggetto testResults è definito come un oggetto axeResults (definito da axe-core). Viene impostato solo quando si è impostata la variabile d'ambiente AXE_INCLUDE_TEST_RESULTS su true, che è supportato solo dal CLI e dalle API di Node.js.
interface AxeResults extends EnvironmentData {
toolOptions: RunOptions;
passes: Result[];
violations: Result[];
incomplete: Result[];
inapplicable: Result[];
}Il seguente esempio mostra un oggetto 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: []
}Per brevità, gli array inapplicable, passes, incomplete e violations, che normalmente contengono oggetti Result, non sono stati inclusi.
Puoi vedere le definizioni TypeScript per questi oggetti nel repo di GitHub di axe-core.
Vedi Anche
Per tutorial che dimostrano come utilizzare il servizio di utilizzo, vedi Iniziare con il Servizio di Utilizzo e le API e Iniziare con il Servizio di Utilizzo e la CLI.
Per informazioni generali sul servizio di utilizzo, vedi Il servizio di utilizzo di Axe DevTools per il Web.