Referência do Evento do Serviço de Uso
Informações sobre as propriedades da versão 2 do evento do serviço de uso
Este artigo contém informações de referência sobre
- Os dados do evento que são enviados para o serviço de uso (versão 2 do objeto de evento, EventV2)
- Seu objeto applicationProperties contido
- O objeto testResults (contido dentro do objeto applicationProperties) quando AXE_INCLUDE_TEST_RESULTS é configurado para true
Evento da Versão 2
A interface TypeScript a seguir define um evento da versão 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 | Descrição |
|---|---|
| application | A aplicação que criou este evento |
| applicationProperties | applicationProperties definido abaixo |
| dateTime | Data e hora (até o milissegundo) no formato ISO-8601, fuso UTC |
| department | O departamento do usuário dentro da organização |
| devInstance | Se este uso é considerado uma instância do desenvolvedor e provavelmente deve ser filtrado |
| distinctId | O uuid distinto do usuário |
| event | Tipo de evento como uma string, geralmente valores "analyze" ou "uri: analyze" |
| keycloakId | O ID do Keycloak do usuário |
| loggedIn | Se o usuário está logado |
| organization | A organização do usuário |
| productComponent | Definido pelas APIs para indicar diferentes integrações, como Playwright |
| productComponentVersion | Uma string indicando a versão do componente do produto |
| productName | Definido pelas APIs para indicar a integração que você está usando |
| sessionId | Um uuid identificando a sessão (para permitir a agrupação de eventos) |
| userId | O ID do usuário |
| userJobRole | A função do trabalho do usuário |
| userStatus | O status do usuário |
| versão | Uma string especificando a versão do evento, sempre 'v2' |
distinctId
O valor distinctId é um uuid que é definido por usuário sempre que as métricas são registradas. Ele deve ser estável ao longo do tempo porque é definido na primeira execução do CLI ou do código que utiliza as APIs. Está armazenado no arquivo .deque/distinct_id no diretório home de cada usuário.
applicationProperties
O objeto applicationProperties contém informações de contagem sobre a execução do teste, como exemplo abaixo mostra:
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: {}
},| Propriedade | Descrição |
|---|---|
| versãoEngine | A versão do axe-core usada para teste |
| contagemItensFalhos | Número total de erros de acessibilidade encontrados na página |
| contagemRegrasFalhas | Número de regras que falharam na página |
| nomesRegrasFalhas | String separada por vírgula com os nomes das regras que falharam |
| contagemRegrasInaplicáveis | Número de regras que não foram aplicadas |
| contagemRegrasIncompletas | Número de regras que estavam incompletas |
| contagemRegrasPassadas | Número de regras que passaram |
| medium_alvo | Tipo MIME do alvo |
| alvo | URL testada |
| testResults | O objeto testResults, veja a próxima seção para mais informações |
testResults
O objeto testResults é definido como um objeto axeResults (definido pelo axe-core). Ele é configurado apenas quando você define a variável de ambiente AXE_INCLUDE_TEST_RESULTS para true.
interface AxeResults extends EnvironmentData {
toolOptions: RunOptions;
passes: Result[];
violations: Result[];
incomplete: Result[];
inapplicable: Result[];
}Abaixo está um exemplo de um objeto 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: []
}Para brevidade, os arrays inaplicável, passa, incompleto e violações, que normalmente contêm objetos Resultado, não foram incluídos.
Você pode ver as definições de TypeScript desses objetos no repositório do GitHub do axe-core.
Veja Também
Para tutoriais que demonstram como usar o serviço de uso, veja Introdução ao Serviço de Uso e às APIs e Introdução ao Serviço de Uso e ao CLI.
Para informações gerais sobre o serviço de uso, veja O Axe DevTools para o Serviço de Uso Web.