Riferimento agli eventi del servizio di utilizzo
Informazioni sulle proprietà della versione 2 degli eventi 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 contenuto applicationProperties oggetto
- L'oggetto testResults (contenuto nell'oggetto applicationProperties ) quando AXE_INCLUDE_TEST_RESULTS è impostato su true
Evento versione 2
La seguente interfaccia TypeScript definisce un evento 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 |
|---|---|
| applicazione | L'applicazione che ha creato questo evento |
| Proprietà dell'applicazione | applicationProperties definito di seguito |
| dateTime | Data e ora (al millisecondo) nel formato ISO-8601, fuso orario UTC |
| dipartimento | Il dipartimento dell'utente all'interno dell'organizzazione |
| devInstance | Se questo utilizzo è considerato un'istanza dello sviluppatore e probabilmente dovrebbe essere filtrato |
| Id distinto | L'uuid univoco dell'utente |
| evento | Tipo di evento come stringa, solitamente valori "analyze" o "uri: analyze" |
| keycloakId | L'ID Keycloak dell'utente |
| connesso | Se l'utente ha effettuato l'accesso |
| organizzazione | L'organizzazione dell'utente |
| componente prodotto | Impostato dalle API per indicare diverse integrazioni come Playwright |
| Versione Componente Prodotto | Una stringa che indica la versione del componente del prodotto |
| productName | Impostato dalle API per indicare l'integrazione che stai utilizzando |
| ID sessione | Un uuid che identifica la sessione (per consentire il raggruppamento degli eventi) |
| ID utente | L'ID dell'utente |
| Ruolo Lavoro Utente | Il ruolo lavorativo dell'utente |
| Stato dell'utente | Lo stato dell'utente |
| Versione | Una stringa che specifica la versione dell'evento, sempre 'v2' |
Id distinto
Il valore distinctId è un uuid impostato per utente ogni volta che vengono registrate le metriche. Dovrebbe essere stabile nel tempo perché viene impostato alla prima esecuzione della CLI o del codice che utilizza le API. Viene memorizzato nel file .Deque/distinct_id nella directory home di ciascun utente.
Proprietà dell'applicazione
L'oggetto applicationProperties contiene informazioni sul conteggio dell'esecuzione del test, come mostrato nell'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 |
|---|---|
| Versione motore | La versione di axe-core utilizzata per i test |
| conteggioElementiFalliti | Numero totale di errori di accessibilità trovati nella pagina web |
| conteggioRegoleFallite | Numero di regole fallite nella pagina |
| failedRuleNames | Stringa separata da virgole dei nomi delle regole che sono fallite |
| inapplicableRuleCount | Numero di regole che non sono state applicate |
| incompleteRuleCount | Numero di regole incomplete |
| passedRuleCount | Numero di regole superate |
| target_medium | Tipo Mime dell'obiettivo |
| destinazione | URL testato |
| testResults | L'oggetto testResults , vedere la sezione successiva per maggiori informazioni |
testResults
L'oggetto testResults è definito come un oggetto axeResults (definito da axe-core). Viene impostato solo se la variabile d'ambiente AXE_INCLUDE_TEST_RESULTS è impostata su true.
interface AxeResults extends EnvironmentData {
toolOptions: RunOptions;
passes: Result[];
violations: Result[];
incomplete: Result[];
inapplicable: Result[];
}Di seguito viene mostrato un esempio di 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 inapplicabile, superati, incompleto e violazioni , che normalmente contengono oggetti Result , non sono stati inclusi.
È possibile visualizzare le definizioni TypeScript per questi oggetti nel repository GitHub axe-core.
Vedere anche
Per tutorial che mostrano come utilizzare il servizio di utilizzo, vedere Introduzione al servizio di utilizzo e alle API e Introduzione al servizio di utilizzo e alla CLI.
Per informazioni generali sul servizio di utilizzo, vedere The axe DevTools for Web Usage Service.