O Serviço de Uso do Axe DevTools para Web
Uma visão geral do serviço de uso, que é um serviço REST que rastreia o uso das APIs do Axe DevTools para Web e a CLI
Este artigo fornece uma visão geral do serviço de uso, um serviço que permite rastrear seu uso das APIs e da CLI do Axe DevTools enviando eventos de uso para os servidores públicos da Deque ou para o seu próprio servidor. Enviar métricas de uso para a Deque nos ajuda a entender melhor como nossos usuários interagem com nossos produtos para que possamos continuar a melhorá-los.
Enviar eventos de uso para o serviço de uso é um processo separado de enviar resultados de acessibilidade em JSON para os Relatórios Axe. Consulte Reportando com o CLI para mais informações sobre relatórios.
O serviço de uso consiste em duas partes:
- Um cliente que envia eventos de uso para o serviço de uso (via a biblioteca de métricas, normalmente chamada pelas APIs do Axe DevTools ou pela CLI)
- Um serviço REST, geralmente hospedado pela Deque, que responde a solicitações POST contendo eventos de uso
Os eventos de uso contêm informações sobre uma varredura de acessibilidade, incluindo data e hora da varredura, número de regras de acessibilidade violadas, nomes das regras que foram violadas, e outras informações. Se você configurar seu próprio serviço de uso, poderá usar as informações para obter insights sobre como o Axe DevTools for Web está sendo usado dentro de sua organização. Para informações de referência sobre a estrutura dos eventos de uso, veja Referência de Eventos do Serviço de Uso.
Por padrão, o Axe DevTools não registra informações de uso. O uso deve ser ativado para permitir a coleta de métricas de uso. Mesmo quando ativado, o serviço de uso não coleta nenhuma informação privada ou pessoal de seus usuários, pois foi criado com a privacidade em mente.
Início Rápido
Você pode começar a rastrear o uso seguindo estes passos:
- Defina a variável de ambiente AXE_TRACK_USAGE para true para habilitar o rastreamento de uso. Agora, sempre que você executar a CLI ou seu próprio código que usa as APIs do Axe DevTools for Web, eventos de uso serão enviados para o serviço de uso REST da Deque.
- (Opcional) Altere a URL do servidor onde os eventos de uso serão relatados alterando a variável de ambiente AXE_METRICS_URL (a URL padrão é
https://usage.deque.com). Se você alterar esta variável de ambiente, precisará criar seu próprio serviço de uso que imite o serviço de uso público fornecido pela Deque. Veja Configuração de um Servidor Echo - (Opcional) Configure AXE_INCLUDE_TEST_RESULTS para true para incluir resultados de teste nos dados enviados ao serviço de uso. A configuração desta variável de ambiente preencherá o objeto testResults no objeto applicationProperties. Veja Referência de Eventos do Serviço de Uso para mais informações.
- (Opcional) Configure a variável de ambiente AXE_DEV_INSTANCE para true nas máquinas de desenvolvedores e testadores para permitir que varreduras de acessibilidade de desenvolvedores e testadores sejam filtradas. (Normalmente, você vai querer ignorar qualquer uso de API que ocorreu durante o trabalho de desenvolvimento ou teste.)
- (Opcional) Configure quaisquer outras variáveis de ambiente para personalizar os eventos que serão relatados ao serviço de uso. Veja Controlando o Serviço de Uso via Variáveis de Ambiente.
- Execute seu código de varredura de acessibilidade ou uma varredura de página da CLI para enviar uso ao serviço de uso. Todas as APIs da Deque usam a biblioteca de métricas para criar e enviar eventos para o serviço de uso conforme você o configurou.
Para um tutorial mais aprofundado mostrando como usar o serviço de uso com as APIs do Axe DevTools, veja Iniciando-se com o Serviço de Uso e as APIs. Para o mesmo tutorial mostrando como usar a CLI com o serviço de uso, veja Iniciando-se com o Serviço de Uso e a CLI. Esses tutoriais incluem etapas para configurar seu próprio servidor simples para ecoar os eventos do serviço de uso no console para que você possa ver o que a biblioteca de métricas envia para o serviço de uso. Você pode usar essa configuração para solucionar problemas do serviço de uso.
Variáveis de Ambiente
Você pode usar variáveis de ambiente para controlar como o serviço de uso opera e para personalizar os eventos que ele reporta. As variáveis de ambiente se dividem em duas categorias:
- Controle do serviço de uso: Ative ou desative o rastreamento de uso, defina a URL de relatório, inclua resultados de teste nos dados de eventos e defina o ID distinto do usuário.
- Personalização de eventos: Modifique as propriedades nos eventos de uso enviados ao serviço, como a organização do usuário, departamento, cargo e outras informações de identificação.
Para uma referência completa de todas as variáveis de ambiente disponíveis, veja Controlando o Serviço de Uso via Variáveis de Ambiente.
Veja Também
Para mais informações sobre as propriedades contidas nos eventos de uso, veja Referência de Eventos do Serviço de Uso.
Para uma referência das variáveis de ambiente disponíveis para controlar o serviço de uso e personalizar eventos, veja Controlando o Serviço de Uso via Variáveis de Ambiente.