El servicio de uso de axe DevTools for Web
Una descripción general del servicio de uso, que es un servicio REST que rastrea el uso de axe DevTools para API web y CLI
Este artículo proporciona una descripción general del servicio de uso, un servicio que le permite realizar un seguimiento de su uso de las API de axe DevTools y la CLI enviando eventos de uso a los servidores públicos de Deque o a su propio servidor. Enviar métricas de uso a Deque nos ayuda a comprender mejor cómo nuestros usuarios interactúan con nuestros productos para que podamos 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 JSON] a axe Reports.(glossary#json-accessibility-results) Consulte Informes con la CLI para obtener más información sobre los informes.
El servicio de uso consta de dos partes:
- Un cliente que publica eventos de uso en el 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 análisis de accesibilidad, incluida la fecha y la hora del análisis, la cantidad de reglas de accesibilidad violadas, los nombres de las reglas que se violaron y otra información. Si configura su propio servicio de uso, puede utilizar la información para obtener información sobre cómo se utiliza axe DevTools for Web dentro de su organización. Para obtener información de referencia sobre la estructura de los eventos de uso, consulte Referencia de eventos del servicio de uso.
De forma predeterminada, axe DevTools no registra información de uso. La funcionalidad debe estar habilitada 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 fue creado teniendo en cuenta la privacidad.
Inicio rápido
Puede comenzar a rastrear el uso siguiendo estos pasos:
- Establezca la variable de entorno AXE_TRACK_USAGE en true para habilitar el seguimiento del uso. Ahora, cada vez que ejecute la CLI o su propio código que utiliza las axe DevTools for Web APIs, los eventos de uso se publicarán en el servicio de uso REST de Deque.
- (Opcional) Cambie 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 cambia esta variable de entorno, deberá crear su propio servicio de uso que imite el servicio de uso público proporcionado por Deque. Consulte Configuración de un servidor Echo - (Opcional) Establezca AXE_INCLUDE_TEST_RESULTS en true para incluir los resultados de la prueba en los datos enviados al servicio de uso. Al establecer esta variable de entorno, se completará el objeto testResults en el objeto applicationProperties . Consulte Referencia de eventos del servicio de uso para obtener más información.
- (Opcional) Establezca la variable de entorno AXE_DEV_INSTANCE en verdadero en las máquinas de los desarrolladores y evaluadores para permitir que se filtren los análisis de accesibilidad de los desarrolladores y evaluadores. (Por lo general, querrás ignorar cualquier uso de API que se haya producido durante el trabajo de desarrollo o prueba).
- (Opcional) Configure otras variables de entorno para personalizar los eventos que se informarán al servicio de uso. Consulte Control del servicio de uso a través de variables de entorno.
- Ejecute su código de escaneo de accesibilidad o un escaneo de página a través de la línea de comandos para enviar el uso al servicio de uso. Todas las API de Deque utilizan la biblioteca de métricas para crear y publicar eventos en el servicio de uso tal como lo ha configurado.
Para obtener un tutorial más detallado que muestre cómo usar el servicio de uso con las API de axe DevTools, consulte Introducción al servicio de uso y las API. Para obtener el mismo tutorial que muestra cómo usar la CLI con el servicio de uso, consulte Introducción al servicio de uso y la CLI. Estos tutoriales incluyen pasos para configurar su propio servidor simple para mostrar los eventos del servicio de uso en la consola para que pueda ver lo que la biblioteca de métricas envía al servicio de uso. Puede utilizar esta configuración para solucionar problemas con el servicio de uso.
Consulte también
Para obtener más información sobre las propiedades contenidas en los eventos de uso, consulte Referencia de eventos del servicio de uso.