Control del Servicio de Uso mediante Variables de Entorno
Información sobre el uso de variables de entorno para controlar el servicio de uso o para cambiar el evento que se informa al servicio de uso
Este artículo contiene información sobre cómo controlar el servicio de uso mediante variables de entorno. Puede:
- Controlar cómo opera el servicio de uso.
- Modificar el evento que se envía al servicio de uso.
Control del Servicio de Uso mediante Variables de Entorno
Estas cuatro variables de entorno le permiten controlar el servicio de uso. Puede habilitar o deshabilitar la recopilación de métricas de uso, incluir resultados de pruebas con eventos de uso, cambiar la URL donde se informan los resultados y cambiar el ID distinto del usuario.
| Nombre | Descripción |
|---|---|
| AXE_DISTINCT_ID | Un identificador uuid que permanece igual para el usuario conectado (a menos que se regenere) |
| AXE_INCLUDE_TEST_RESULTS | Incluir resultados de pruebas en el objeto applicationProperties rellenando el objeto testResults . |
| AXE_METRICS_URL | La URL del endpoint de uso REST |
| AXE_TRACK_USAGE | Habilita el informe del servicio de uso (el valor por defecto es false) |
Si su cliente no puede contactar con el servicio de uso, intentará nuevamente reemplazando https con http en la URL (establecida usando la variable de entorno AXE_METRICS_URL).
Cambio del Evento Reportado Usando Variables de Entorno
Con las variables de entorno a continuación, puede cambiar el evento que se informa al servicio de uso. Por ejemplo, puede cambiar las propiedades de departamento u organización en cada evento para asociar el uso de API o CLI a un departamento u organización específico.
En las tablas siguientes, la columna Puede Sobrescribir indica si el valor establecido en la variable de entorno puede sobrescribir el valor que se estableció en la llamada a la biblioteca de métricas. Nombre de Datos es el nombre de la propiedad tal como aparece en el objeto de evento enviado al servicio de uso.
Variables de Entorno Booleanas
Se espera que estos valores sean true o false.
| Nombre | Nombre de Datos | Puede Sobrescribir | Descripción |
|---|---|---|---|
| AXE_DEV_INSTANCE | instanciaDev | true | Indica si este evento proviene de las acciones de un desarrollador de software. Útil para marcar y posteriormente eliminar eventos registrados durante el desarrollo o las pruebas. |
| AXE_LOGGED_IN | iniciadoSesion | false | Registra si el usuario ha iniciado sesión en la aplicación en prueba. |
Variables de Entorno String
Estos valores se interpretan como cadenas de texto.
| Nombre | Nombre de Datos | Puede Sobrescribirse | Descripción |
|---|---|---|---|
| AXE_APPLICATION | aplicación | false | La aplicación que se usó para verificar errores de accesibilidad |
| AXE_DEPARTMENT | departamento | true | El departamento del usuario dentro de la organización (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | keycloakId | false | El ID de Keycloak del usuario |
| AXE_ORGANIZATION | organización | true | La organización del usuario |
| AXE_SESSION_ID | sessionId | false | Un uuid que identifica la sesión del usuario |
| AXE_USER_ID | userId | false | La identidad específica de un usuario, como nombre o ID de inicio de sesión |
| AXE_USER_JOB_ROLE | userJobRole | false | El rol laboral del usuario |
| AXE_USER_STATUS | userStatus | false | Información de estado que desea asociar con el usuario |
Véase también
Para tutoriales que demuestran cómo usar estas variables de entorno, consulte Introducción al Servicio de Uso y las APIs y Comenzando con el Servicio de Uso y la CLI.
Para obtener información general sobre el servicio de uso, consulte El Servicio de Uso de Axe DevTools para Web.