O Serviço de Uso do Axe DevTools para Web

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

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

Not for use with personal data

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.

important

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:

  1. 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)
  2. 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.

note

O relatório de uso está habilitado por padrão no CLI e nas APIs do Axe DevTools, e os eventos são enviados para o serviço público de uso da Deque. Para impedir que sejam enviados, configure a variável de ambiente AXE_TRACK_USAGE para false. Os eventos coletados por padrão não contêm informações pessoais sobre o usuário; as variáveis de personalização de eventos descritas em Controlando o Serviço de Uso via Variáveis de Ambiente permitem adicionar valores identificadores, como um ID de usuário, se você desejar.

Início Rápido

Você pode começar a rastrear o uso seguindo estes passos:

  1. Confirme que o rastreamento de uso está ativado. Ele está ativado por padrão, portanto, a menos que você tenha definido AXE_TRACK_USAGE para falso, os eventos de uso já estão sendo enviados para o serviço de uso REST da Deque sempre que você executar o CLI ou seu próprio código que utiliza as APIs do Axe DevTools para Web.
  2. (Opcional) Altere o URL do servidor para onde os eventos de uso serão reportados mudando a variável de ambiente AXE_METRICS_URL (o 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 público de uso fornecido pela Deque. Veja Configuração de um Servidor Echo
  3. (Opcional) Defina AXE_INCLUDE_TEST_RESULTS para true para incluir os resultados dos testes nos dados enviados para o serviço de uso. Configurar essa variável de ambiente irá preencher o objeto testResults dentro do objeto applicationProperties. Esta variável é suportada apenas pelo CLI e as APIs do Node.js. Veja Referência de Eventos do Serviço de Uso para mais informações.
  4. (Opcional) Defina a variável de ambiente AXE_DEV_INSTANCE para true nas máquinas dos desenvolvedores e testadores para permitir que as verificações de acessibilidade de desenvolvedores e testadores sejam filtradas. (Normalmente, você vai querer ignorar qualquer uso da API que ocorreu durante o trabalho de desenvolvimento ou testes.)
  5. (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.
  6. 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.

Visualizando Seus Dados de Uso nos Relatórios Axe

Se a sua organização usa Relatórios Axe, suas métricas de uso (os relatórios Uso por Mês e URLs Escaneadas) são preenchidas a partir dos eventos de uso descritos neste artigo. Elas não são preenchidas pelos resultados de acessibilidade em JSON que você faz upload com o subcomando bulk-reports do CLI: enviar eventos de uso e fazer upload de resultados são processos separados.

Para que suas verificações apareçam nas métricas de uso dos Relatórios Axe, cada máquina que realiza uma verificação precisa do seguinte:

  1. Rastreamento de uso mantido ativado: ele está ativado por padrão, portanto, certifique-se de que AXE_TRACK_USAGE não está definido como falso e que --enable-tracking false não é passado para o CLI.
  2. Eventos de uso enviados para o serviço público de uso da Deque: deixe AXE_METRICS_URL em seu padrão de https://usage.deque.com. Se você apontar o cliente para o seu próprio servidor, a Deque nunca receberá os eventos e os Relatórios Axe não terão nada para exibir.
  3. AXE_ORGANIZATION definido para o ID da sua organização. Os Relatórios Axe usam esse valor para associar eventos de uso à sua organização; sem ele, seus eventos não podem ser vinculados à sua conta.
  4. AXE_USER_ID definido para um identificador da pessoa que está realizando a verificação, como um endereço de e-mail. Os Relatórios Axe contam usuários únicos a partir deste valor.
  5. (Opcional) AXE_DEPARTMENT definido para o departamento do usuário que está realizando a verificação. O relatório Uso por Mês pode agrupar uso por departamento; eventos sem esta variável são agrupados sob Sem Departamento.

Por exemplo, usando o CLI:

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

O ID da sua organização não é mostrado na interface dos Relatórios Axe. Para obtê-lo, entre em contato diretamente com seu representante da Deque, entre em contato conosco através do nosso suporte técnico, ou envie-nos um e-mail.

As métricas de uso estão disponíveis apenas para administradores dos Relatórios Axe, e apenas para organizações cujo acesso aos Relatórios Axe inclui o Axe DevTools para Web. Para informações sobre como ler os relatórios em si, veja Trabalhando com Relatórios de Uso na documentação dos Relatórios Axe.

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.

Para informações sobre como ler as métricas de uso nos Relatórios Axe, veja Trabalhando com Relatórios de Uso na documentação dos Relatórios Axe.

Is this page helpful?

Help us improve this page

Still need help?