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
Estas quatro 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, incluir resultados de testes em eventos de uso, mudar a URL onde os resultados são reportados e alterar o ID distinto do usuário.
| Nome | Descrição |
|---|---|
| AXE_DISTINCT_ID | Um identificador uuid que permanece o mesmo para o usuário logado (a menos que seja regenerado) |
| AXE_INCLUDE_TEST_RESULTS | Incluir resultados de teste no **applicationProperties** objeto ao preencher o **testResults** objeto |
| AXE_METRICS_URL | A URL do endpoint de uso REST |
| AXE_TRACK_USAGE | Ativa o relatório do serviço de uso (o padrão é *false*) |
Se o seu cliente não conseguir contatar o serviço de uso, ele tentará novamente substituindo *https* por *http* na URL (definido 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 alterar o evento que é reportado ao serviço de uso. Por exemplo, você pode mudar as propriedades de *departamento* ou *organização* em cada evento para associar o uso da API ou CLI a um departamento ou organização específicos.
Nas tabelas abaixo, a coluna *Pode Sobrescrever* indica se o valor configurado na variável de ambiente pode sobrescrever o valor definido na chamada para a biblioteca de métricas. *Nome do Dado* é o nome da propriedade como aparece no objeto de evento enviado para o serviço de uso.
Variáveis de Ambiente Booleanas
Espera-se que esses valores sejam *true* ou *false*.
| Nome | Nome do Dado | Pode Sobrescrever | Descrição |
|---|---|---|---|
| AXE_DEV_INSTANCE | devInstance | true | Indica se este evento é proveniente de ações de um desenvolvedor de software. Útil para marcar e posteriormente remover eventos registrados durante o desenvolvimento ou testes. |
| AXE_LOGGED_IN | loggedIn | false | Registra se o usuário está conectado à aplicação em teste. |
Variáveis de Ambiente de String
Esses valores são interpretados como strings.
| Nome | Nome dos Dados | Pode Substituir | Descrição |
|---|---|---|---|
| AXE_APPLICATION | application | false | A aplicação que foi usada para verificar erros de acessibilidade |
| AXE_DEPARTMENT | department | true | O departamento do usuário dentro da organização (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | keycloakId | false | O Keycloak ID do usuário |
| AXE_ORGANIZATION | organization | true | A organização do usuário |
| AXE_SESSION_ID | sessionId | false | Um uuid que identifica a sessão do usuário |
| AXE_USER_ID | userId | false | A identidade específica de um usuário, como nome ou ID de login |
| AXE_USER_JOB_ROLE | userJobRole | false | O cargo do usuário |
| AXE_USER_STATUS | userStatus | false | Informações de status que você deseja associar ao usuário |
Veja Também
Para tutoriais demonstrando como usar estas 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.