El Servicio de Uso de Axe DevTools para Web
Una visión general del servicio de uso, que es un servicio REST que rastrea el uso de las API de Axe DevTools para Web y la CLI
Este artículo proporciona una visión general del servicio de uso, un servicio que le permite rastrear su uso de las API de Axe DevTools y la 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 envío de eventos de uso al servicio de uso es un proceso separado del envío de resultados de accesibilidad en JSON a los Informes Axe. Consulte Informes con el CLI para obtener más información sobre informes.
El servicio de uso consta de dos partes:
- Un cliente que envía eventos de uso al servicio de uso (a través de la biblioteca de métricas, generalmente llamada por las API de Axe DevTools o la CLI)
- Un servicio REST, generalmente alojado por Deque, que responde a solicitudes POST que contienen eventos de uso
Los eventos de uso contienen información sobre un escaneo de accesibilidad, incluyendo la fecha y hora del escaneo, 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 utilizar la información para obtener una visión de cómo se usa 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.
Por defecto, Axe DevTools no registra información de uso. Es necesario habilitar el uso para permitir la recopilación de métricas de uso. Incluso cuando está habilitado, el servicio de uso no recopila ninguna información privada o personal de sus usuarios, ya que se diseñó con la privacidad en mente.
Inicio Rápido
Puedes comenzar a rastrear el uso siguiendo estos pasos:
- Configura la variable de entorno AXE_TRACK_USAGE a true para habilitar el seguimiento de uso. Ahora, cada vez que ejecutes la CLI o tu propio código que utiliza las API de Axe DevTools para Web, los eventos de uso se enviarán al servicio de uso REST de Deque.
- (Opcional) Cambia la URL del servidor donde se informarán los eventos de uso cambiando la variable de entorno AXE_METRICS_URL (la URL predeterminada es
https://usage.deque.com). Si cambias esta variable de entorno, necesitas crear tu propio servicio de uso que emule el servicio de uso público proporcionado por Deque. Consulta Configuración de un Servidor de Echo - (Opcional) Configura AXE_INCLUDE_TEST_RESULTS a 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 . Consulta La Referencia de Eventos del Servicio de Uso para más información.
- (Opcional) Configura la variable de entorno AXE_DEV_INSTANCE a true en las máquinas de los desarrolladores y testers para permitir filtrar los escaneos de accesibilidad de desarrolladores y testers. (Usualmente querrás ignorar cualquier uso de API que haya ocurrido durante el trabajo de desarrollo o pruebas.)
- (Opcional) Configura cualquier otra variable de entorno para personalizar los eventos que se informarán al servicio de uso. Consulta Controlar el Servicio de Uso a través de Variables de Entorno.
- 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 muestre cómo usar el servicio de uso con las API de Axe DevTools, consulta Empezando con el Servicio de Uso y las API. Para el mismo tutorial que muestra cómo usar la 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 para hacer 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 del servicio de uso.
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 informe, incluir resultados de pruebas en los datos de eventos y establecer la ID distinta del usuario.
- Personalización de eventos: Modificar las propiedades en los eventos de uso enviados al servicio, como la organización del usuario, departamento, rol de trabajo y otra información de identificación.
Para una referencia completa de todas las variables de entorno disponibles, vea Controlar el Servicio de Uso a través de Variables de Entorno.
Véase También
Para obtener más información sobre las propiedades contenidas en los eventos de uso, vea 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, vea Controlar el Servicio de Uso a través de Variables de Entorno.