Referencia de eventos del servicio de uso
Información sobre las propiedades de la versión 2 del evento del servicio de uso
Este artículo contiene información de referencia sobre
- Los datos del evento que se envían al servicio de uso (versión 2 del objeto de evento, EventV2)
- Su objeto contenido applicationProperties
- El objeto testResults (incluido en el objeto applicationProperties ) cuando AXE_INCLUDE_TEST_RESULTS se establece en verdadero
Evento de la versión 2
La siguiente interfaz TypeScript define un evento de versión 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
}| Nombre | Descripción |
|---|---|
| aplicación | La aplicación que creó este evento |
| Propiedades de la aplicación | applicationProperties definido a continuación |
| dateTime | Fecha y hora (al milisegundo) en formato ISO-8601, zona horaria UTC |
| departamento | El departamento del usuario dentro de la organización |
| Instancia de desarrollo | Si este uso se considera una instancia de desarrollador y probablemente debería ser excluida |
| distinctId | El uuid único del usuario |
| evento | Tipo de evento como cadena, generalmente valores "analyze" o "uri: analyze" |
| keycloakId | El Keycloak ID del usuario |
| conectado | Si el usuario ha iniciado sesión |
| organización | La organización del usuario |
| componente del producto | Establecido por las API para indicar diferentes integraciones como Playwright |
| Versión del componente del producto | Una cadena que indica la versión del componente del producto. |
| Nombre del producto | Establecido por las API para indicar la integración que estás utilizando |
| Id. de sesión | Un uuid que identifica la sesión (para permitir agrupar eventos) |
| ID de usuario | El ID del usuario |
| rolDeTrabajoUsuario | El rol laboral del usuario |
| Estado del usuario | El estado del usuario |
| Versión | Una cadena que especifica la versión del evento, siempre 'v2' |
distinctId
El valor distinctId es un uuid que se establece por usuario cada vez que se registran las métricas. Debe ser estable a lo largo del tiempo porque se configura durante la primera ejecución de la CLI o del código que utiliza las API. Se almacena en el archivo .deque/distinct_id en el directorio de inicio de cada usuario.
Propiedades de la aplicación
El objeto applicationProperties contiene información de recuento sobre la ejecución de la prueba, como se muestra en el siguiente ejemplo:
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: {}
},| Propiedad | Descripción |
|---|---|
| Versión del motor | La versión de axe-core utilizada para las pruebas |
| Conteo de elementos fallidos | Número total de errores de accesibilidad encontrados en la página web |
| Conteo de reglas fallidas | Número de reglas que fallaron en la página |
| failedRuleNames | Cadena separada por comas de nombres de reglas que fallaron |
| inapplicableRuleCount | Número de reglas que no se aplicaron |
| incompleteRuleCount | Número de reglas que estaban incompletas |
| passedRuleCount | Número de reglas que pasaron |
| target_medium | Tipo MIME del objetivo |
| target | URL probada |
| testResults | El objeto testResults , consulte la siguiente sección para obtener más información |
testResults
El objeto testResults se define como un objeto axeResults (definido por axe-core). Solo se establece cuando ha establecido la variable de entorno AXE_INCLUDE_TEST_RESULTS en true.
interface AxeResults extends EnvironmentData {
toolOptions: RunOptions;
passes: Result[];
violations: Result[];
incomplete: Result[];
inapplicable: Result[];
}A continuación se muestra un ejemplo de un 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 abreviar, no se incluyeron las matrices de inapplicable, passes, incomplete y violations , que normalmente contienen objetos Result .
Puede ver las definiciones de TypeScript para estos objetos en el repositorio de GitHub axe-core.
Consulte también
Para obtener tutoriales que demuestran cómo utilizar el servicio de uso, consulte Introducción al servicio de uso y las API y Introducción al servicio de uso y la CLI.
Para obtener información general acerca del servicio de uso, consulte The axe DevTools for Web Usage Service.