Control del Servicio de Uso mediante Variables de Entorno

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

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

Not for use with personal data

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

Cuatro variables de entorno te permiten controlar el servicio de uso. Puedes desactivar la recopilación de métricas de uso, cambiar la URL donde se informan los resultados, cambiar el ID distintivo del usuario e incluir los resultados completos de axe-core en cada evento.

important

El reporte de uso está habilitado por defecto en la CLI y las API de Axe DevTools. Para evitar que se envíen eventos de uso, establece AXE_TRACK_USAGE a false, o llama al método enableTracking de tu API con false.

note

Si su cliente no puede contactar 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 siguientes variables de entorno, puede cambiar el evento que se reporta al servicio de uso. Por ejemplo, puede cambiar las propiedades departamento o organización en cada evento para asociar el uso de API o CLI a un departamento u organización específicos.

La columna Puede Sobrescribirse indica si el valor establecido en la variable de entorno puede sobrescribir un valor que ya fue establecido programáticamente a través de la biblioteca de métricas. Un guion (—) en la columna Puede Sobrescribirse indica que el concepto no aplica a esa variable.

Variables de entorno

Nombre Tipo Puede sobrescribir Descripción
AXE_DISTINCT_ID Cadena — Un identificador UUID que permanece igual para el usuario registrado (a menos que se regenere). En Ruby, esta variable se llama DEQUE_DISTINCT_ID.
AXE_INCLUDE_TEST_RESULTS Booleano — Configúrelo en true para incluir los resultados completos de axe-core en el objeto testResults de cada evento (el valor predeterminado es false). Compatible solo con el CLI y las API de Node.js.
AXE_METRICS_URL Cadena — La URL del punto final de uso de REST (el valor predeterminado es https://usage.deque.com)
AXE_TRACK_USAGE Booleano — Configúrelo en false para desactivar la generación de informes del servicio de uso. El informe está habilitado de forma predeterminada.
AXE_APPLICATION Cadena falso La aplicación que se utilizó para verificar errores de accesibilidad
AXE_DEV_INSTANCE Booleano verdadero Indica si este evento es producto de las acciones de un desarrollador de software. Útil para marcar y luego eliminar eventos registrados durante el desarrollo o las pruebas.
AXE_DEPARTMENT Cadena verdadero El departamento del usuario dentro de la organización
AXE_KEYCLOAK_ID Cadena falso El ID de Keycloak del usuario
AXE_LOGGED_IN Booleano falso Registra si el usuario está conectado a la aplicación bajo prueba
AXE_ORGANIZATION Cadena verdadero La organización del usuario. Para que su uso aparezca en Axe Reports, configúrelo con el ID de su organización (contacte a Deque para obtenerlo).
AXE_SESSION_ID Cadena falso Un UUID que identifica la sesión del usuario
AXE_USER_ID Cadena falso La identidad específica de un usuario, como una dirección de correo electrónico, nombre o ID de inicio de sesión. Axe Reports cuenta usuarios únicos a partir de este valor.
AXE_USER_JOB_ROLE Cadena falso El rol laboral del usuario
AXE_USER_STATUS Cadena falso Información de estado que desea asociar con el usuario

Diferencias entre lenguajes

La mayoría de estas variables de entorno se comportan de manera idéntica en la CLI y en cada API de Axe DevTools. Las excepciones son:

  • AXE_INCLUDE_TEST_RESULTS es leído solo por la CLI y las API de Node.js. Configurarlo no tiene efecto en las API de Java, Python, C# o Ruby.
  • AXE_DISTINCT_ID se llama DEQUE_DISTINCT_ID en la API de Ruby.
  • AXE_METRICS_URL puede no volver a su valor predeterminado en las API de Java y Ruby. Si tus eventos de uso no llegan a Deque, establece la variable explícitamente a https://usage.deque.com.

Véase también

Para tutoriales que demuestren 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.

Is this page helpful?

Help us improve this page

Still need help?