Controlando o Serviço de Uso através de Variáveis de Ambiente
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
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
Três variáveis de ambiente permitem que você controle o serviço de uso. Você pode ativar ou desativar a coleta de métricas de uso, alterar a URL onde os resultados são reportados e mudar o ID distinto do usuário.
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) |
AXE_METRICS_URL |
String | — | A URL do endpoint de uso REST |
AXE_TRACK_USAGE |
Boolean | — | Ativa o relatório de serviço de uso (padrão é false) |
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 |
AXE_SESSION_ID |
String | false | Um UUID identificando a sessão do usuário |
AXE_USER_ID |
String | false | A identidade específica de usuário, como nome ou ID de login |
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 |
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.