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 a través de variables de entorno. Puede:
- Controlar el funcionamiento del 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 utilización. 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 la identificación distintiva del usuario.
| Nombre | Descripción |
|---|---|
| AXE_DISTINCT_ID | Un identificador uuid que permanece igual para el usuario que inició sesión (a menos que se vuelva a generar) |
| AXE_INCLUDE_TEST_RESULTS | En el objeto applicationProperties , complete el objeto testResults con los resultados de la prueba. |
| AXE_METRICS_URL | La URL del punto final de uso de REST |
| AXE_TRACK_USAGE | Habilita los informes de uso del servicio (el valor predeterminado es falso) |
Si su cliente no puede comunicarse con el servicio de uso, lo intentará nuevamente reemplazando https por http en la URL (establecida mediante la variable de entorno AXE_METRICS_URL).
Cambiar el evento informado mediante 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íficos.
En las tablas siguientes, la columna Puede anular indica si el valor establecido en la variable de entorno puede anular 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 del dato | Puede sobrescribir | Descripción |
|---|---|---|---|
| AXE_DEV_INSTANCE | Instancia de desarrollo | verdadero | Indica si este evento proviene de acciones de un desarrollador de software. Útil para marcar y eliminar posteriormente eventos registrados durante el desarrollo o las pruebas. |
| AXE_LOGGED_IN | Conectado | false | Registra si el usuario ha iniciado sesión en la aplicación bajo prueba. |
Variables de entorno de cadena
Estos valores se interpretan como cadenas.
| Nombre | Nombre del dato | Puede sobrescribir | Descripción |
|---|---|---|---|
| AXE_APPLICATION | aplicación | false | La aplicación que se utilizó para comprobar errores de accesibilidad |
| AXE_DEPARTMENT | departamento | verdadero | El departamento del usuario dentro de la organización (AXE_ORGANIZATION) |
| AXE_KEYCLOAK_ID | keycloakId | false | El ID de [Keycloak] del usuario(https://keycloak.org) |
| AXE_ORGANIZACIÓN | organización | verdadero | La organización del usuario |
| AXE_SESSION_ID | Id. de sesión | false | Un uuid que identifica la sesión del usuario |
| AXE_USER_ID | ID de usuario | false | La identidad de un usuario específico, como el nombre o el ID de inicio de sesión |
| AXE_USER_JOB_ROLE | rol de trabajo de usuario | false | El rol laboral del usuario |
| AXE_USUARIO_ESTADO | estado del usuario | false | Información de estado que desea asociar con el usuario |
Consulte también
Para obtener tutoriales que demuestren cómo usar estas variables de entorno, consulte Introducción al servicio de uso y las API y Introducción al servicio de uso y la CLI.
Para obtener información general acerca del servicio de uso, consulte The axe DevTools for Web Usage Service.