El Servicio de Uso de Axe DevTools para Web

Este artículo ofrece una visión general del servicio de uso, un servicio que te permite rastrear el uso de las APIs de Axe DevTools y el CLI enviando eventos de uso a los servidores públicos de Deque o a tu propio servidor. Enviar métricas de uso a Deque nos ayuda a entender mejor cómo interactúan nuestros usuarios con nuestros productos para poder seguir mejorándolos.

El servicio de uso consta de dos partes:

1. Un cliente que envía eventos de uso al servicio de uso (a través de la biblioteca de métricas, normalmente llamada por las APIs de Axe DevTools o el CLI)
2. Un servicio REST, usualmente alojado por Deque, que responde a las solicitudes POST que contienen eventos de uso

Los eventos de uso contienen información sobre un análisis de accesibilidad incluyendo la fecha y hora del análisis, el número de reglas de accesibilidad violadas, los nombres de las reglas que fueron violadas y otra información. Si configuras tu propio servicio de uso, puedes usar la información para obtener una visión de cómo se está utilizando Axe DevTools para Web dentro de tu organización. Para información de referencia sobre la estructura de los eventos de uso, consulta La Referencia de Eventos del Servicio de Uso.

Inicio Rápido

Puedes comenzar a rastrear el uso siguiendo estos pasos:

1. Confirme que el seguimiento de uso está habilitado. Está habilitado por defecto, por lo que a menos que haya establecido AXE_TRACK_USAGE en falso, los eventos de uso ya se están enviando al servicio de uso REST de Deque cada vez que ejecute la CLI o su propio código que utilice las APIs de Axe DevTools para Web.
2. (Opcional) Cambie la URL del servidor donde se reportarán los eventos de uso cambiando la variable de entorno AXE_METRICS_URL (la URL por defecto es https://usage.deque.com). Si cambia esta variable de entorno, deberá crear su propio servicio de uso que imite el servicio de uso público proporcionado por Deque. Vea Configuración de un Servidor de Echo
3. (Opcional) Configure AXE_INCLUDE_TEST_RESULTS en true para incluir los resultados de las pruebas en los datos enviados al servicio de uso. Configurar esta variable de entorno llenará el objeto testResults en el objeto applicationProperties. Esta variable solo es compatible con la CLI y las APIs de Node.js. Vea La Referencia de Eventos del Servicio de Uso para más información.
4. (Opcional) Configure la variable de entorno AXE_DEV_INSTANCE en true en las máquinas de los desarrolladores y probadores para permitir que los escaneos de accesibilidad de desarrolladores y probadores se filtren. (Normalmente deseará ignorar cualquier uso de la API que ocurriera durante el trabajo de desarrollo o pruebas).
5. (Opcional) Configura cualquier otra variable de entorno para personalizar los eventos que se reportarán al servicio de uso. Ver Controlar el Servicio de Uso a través de Variables de Entorno.
6. Ejecuta tu código de escaneo de accesibilidad o un escaneo de página del CLI para enviar uso al servicio de uso. Todas las API de Deque utilizan la biblioteca de métricas para crear y enviar eventos al servicio de uso tal como lo has configurado.

Para un tutorial más detallado que muestra cómo usar el servicio de uso con las APIs de Axe DevTools, consulta Empezando con el Servicio de Uso y las API. Para el mismo tutorial mostrando cómo usar el CLI con el servicio de uso, consulta Empezando con el Servicio de Uso y la CLI. Estos tutoriales incluyen pasos para configurar tu propio servidor simple que haga eco de los eventos del servicio de uso en la consola para que puedas ver lo que la biblioteca de métricas envía al servicio de uso. Puedes usar esta configuración para solucionar problemas con el servicio de uso.

Viendo sus Datos de Uso en los Informes de Axe

Si su organización utiliza los Informes de Axe, sus métricas de uso (los informes Uso por Mes y URLs Escaneadas) se completan a partir de los eventos de uso descritos en este artículo. No se completan con los resultados de accesibilidad en JSON que cargue con el subcomando bulk-reports de la CLI: el envío de eventos de uso y la carga de resultados son procesos separados.

Para que sus escaneos aparezcan en las métricas de uso de los Informes de Axe, cada máquina que ejecute un escaneo necesita lo siguiente:

1. Seguimiento de uso habilitado: está activado por defecto, así que asegúrese de que AXE_TRACK_USAGE no esté configurado en falso y que --enable-tracking false no se pase a la CLI.
2. Eventos de uso enviados al servicio público de uso de Deque: deje AXE_METRICS_URL en su valor por defecto de https://usage.deque.com. Si dirige el cliente a su propio servidor, Deque nunca recibe los eventos y los Informes de Axe no tienen nada que mostrar.
3. AXE_ORGANIZATION configurado con el ID de su organización. Los Informes de Axe utilizan este valor para asociar los eventos de uso con su organización; sin él, sus eventos no pueden desvincularse a su cuenta.
4. AXE_USER_ID configurado con un identificador para la persona que realiza el escaneo, como una dirección de correo electrónico. Los Informes de Axe cuentan usuarios únicos a partir de este valor.
5. (Opcional) AXE_DEPARTMENT configurado con el departamento del usuario que realiza el escaneo. El informe Uso por Mes puede agrupar el uso por departamento; los eventos sin esta variable se agrupan bajo Sin Departamento.

Por ejemplo, usando la CLI:

AXE_TRACK_USAGE=true AXE_ORGANIZATION=<your-organization-id> AXE_USER_ID=name@example.com axe https://broken-workshop.dequelabs.com/

Las métricas de uso solo están disponibles para los administradores de Informes de Axe y solo para organizaciones cuyo acceso a Informes de Axe incluye Axe DevTools para Web. Para obtener información sobre cómo leer los informes, vea Trabajando con Informes de Uso en la documentación de los Informes de Axe.

Variables de Entorno

Puedes usar variables de entorno para controlar cómo funciona el servicio de uso y para personalizar los eventos que reporta. Las variables de entorno se dividen en dos categorías:

• Control del servicio de uso: Habilitar o deshabilitar el seguimiento de uso, configurar la URL de reporte, incluir los resultados de las pruebas en los datos de eventos y establecer el ID distinto del usuario.
• Personalización de eventos: Modificar las propiedades en los eventos de uso enviados al servicio, como la organización del usuario, departamento, función laboral y otra información identificativa.

Para una referencia completa de todas las variables de entorno disponibles, consulta Controlar el Servicio de Uso a través de Variables de Entorno.

Véase También

Para más información sobre las propiedades contenidas en los eventos de uso, consulta La Referencia de Eventos del Servicio de Uso.

Para una referencia de las variables de entorno disponibles para controlar el servicio de uso y personalizar eventos, consulta Controlar el Servicio de Uso a través de Variables de Entorno.

Para obtener información sobre cómo leer las métricas de uso en los Informes de Axe, vea Trabajando con Informes de Uso en la documentación de los Informes de Axe.