Controlando o Serviço de Uso através de Variáveis de Ambiente

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

Informações sobre como usar variáveis de ambiente para controlar o serviço de uso ou alterar o evento que é reportado ao serviço de uso

Not for use with personal data

Este artigo contém informações sobre como controlar o serviço de uso através de variáveis de ambiente. Você pode:

  • Controlar como o serviço de uso opera.
  • Modificar o evento que é enviado para o serviço de uso.

Controlando o Serviço de Uso através de Variáveis de Ambiente

Quatro variáveis de ambiente permitem controlar o serviço de uso. Você pode desativar a coleta de métricas de uso, mudar o URL onde os resultados são relatados, alterar o ID distinto do usuário e incluir os resultados completos do axe-core em cada evento.

important

O relatório de uso está habilitado por padrão no CLI e nas APIs do Axe DevTools. Para impedir que eventos de uso sejam enviados, defina AXE_TRACK_USAGE como false ou chame o método enableTracking da sua API com false.

note

Se o seu cliente não conseguir contatar o serviço de uso, ele tentará novamente substituindo *https* por *http* na URL (definida usando a variável de ambiente AXE_METRICS_URL).

Alterando o Evento Reportado Usando Variáveis de Ambiente

Com as variáveis de ambiente abaixo, você pode mudar o evento que é reportado ao serviço de uso. Por exemplo, você pode alterar as propriedades department ou organization de cada evento para associar o uso da API ou CLI a um departamento ou organização específicos.

A coluna Pode Substituir indica se o valor definido na variável de ambiente pode substituir um valor que já foi configurado programaticamente através da biblioteca de métricas. Um traço (—) na coluna Pode Substituir indica que o conceito não se aplica a essa variável.

Variáveis de Ambiente

Nome Tipo Pode Sobrescrever Descrição
AXE_DISTINCT_ID String — Um identificador UUID que permanece o mesmo para o usuário logado (a menos que seja regenerado). Em Ruby, essa variável é chamada de DEQUE_DISTINCT_ID.
AXE_INCLUDE_TEST_RESULTS Boolean — Defina como true para incluir os resultados completos do axe-core no objeto testResults de cada evento (o padrão é false). Suportado apenas pelo CLI e pelas APIs do Node.js.
AXE_METRICS_URL String — A URL do endpoint de uso REST (o padrão é https://usage.deque.com)
AXE_TRACK_USAGE Boolean — Defina como false para desativar o relatório do serviço de uso. O relatório está ativado por padrão.
AXE_APPLICATION String false O aplicativo que foi utilizado para verificar erros de acessibilidade
AXE_DEV_INSTANCE Boolean true Indica se este evento é resultante das ações de um desenvolvedor de software. Útil para marcar e posteriormente remover eventos registrados durante o desenvolvimento ou teste.
AXE_DEPARTMENT String true O departamento do usuário dentro da organização
AXE_KEYCLOAK_ID String false O ID Keycloak do usuário
AXE_LOGGED_IN Boolean false Registra se o usuário está logado na aplicação em teste
AXE_ORGANIZATION String true A organização do usuário. Para que seu uso apareça nos Relatórios Axe, defina isso para o ID da sua organização (entre em contato com a Deque para obtê-lo).
AXE_SESSION_ID String false Um UUID identificando a sessão do usuário
AXE_USER_ID String false A identidade de um usuário específico, como um endereço de e-mail, nome ou ID de login. Os Relatórios Axe contam usuários únicos a partir deste valor.
AXE_USER_JOB_ROLE String false O cargo do usuário
AXE_USER_STATUS String false Informações de status que você deseja associar ao usuário

Diferenças Entre Linguagens

A maioria dessas variáveis de ambiente se comporta de forma idêntica no CLI e em todas as APIs do Axe DevTools. As exceções são:

  • AXE_INCLUDE_TEST_RESULTS é lido apenas pelo CLI e pelas APIs Node.js. Defini-lo não tem efeito nas APIs Java, Python, C# ou Ruby.
  • AXE_DISTINCT_ID é chamado de DEQUE_DISTINCT_ID na API Ruby.
  • AXE_METRICS_URL pode não voltar ao padrão nas APIs Java e Ruby. Se seus eventos de uso não alcançarem o Deque, defina a variável explicitamente como https://usage.deque.com.

Veja Também

Para tutoriais que demonstram como usar essas variáveis de ambiente, veja Introdução ao Serviço de Uso e as APIs e Introdução ao Serviço de Uso e à CLI.

Para informações gerais sobre o serviço de uso, veja O Serviço de Uso do Axe DevTools para a Web.

Is this page helpful?

Help us improve this page

Still need help?