Introducción al Servicio de Uso y la CLI

Este artículo muestra cómo usar el servicio de uso con la CLI. Se le guiará a través de la configuración de un servidor local para recibir eventos del servicio de uso, se le mostrará cómo enviar métricas de uso al servidor utilizando la CLI, y cómo modificar los eventos del servicio de uso utilizando variables de entorno.

El servicio de uso le permite rastrear métricas de uso para el uso de la CLI por parte de su organización. Habilitar el servicio de uso puede ser una herramienta importante para que su organización realice el monitoreo de cumplimiento de licencias, auditorías de pruebas y asegure que todas las instancias de Axe DevTools para Web estén configuradas según los estándares de su organización.

Para información general sobre el servicio de uso, consulte El Servicio de Uso de Axe DevTools.

Requisitos previos

Necesitas instalar Node.js para usar este ejemplo. Consulta Node.js para el instalador de Node.js.

Configuración de un Servidor Echo

Crea un archivo con el código mostrado a continuación:

const express = require('express')
const bodyParser = require('body-parser')

const app = express()

// Parse JSON bodies.
app.use(bodyParser.json())
// Accept events.
app.post('/:version/event', (req, res) => {
  const event = req.body
  console.log(event)

  // Respond so the client is happy.
  res.status(200)
  res.send('Event accepted!')
})

// Listen for requests.
app.listen(3000)

Llamaremos al archivo echo-server.js. Guárdalo en un nuevo directorio y cambia a ese directorio.

El servidor escucha las solicitudes en el puerto 3000 y escribe el cuerpo de la solicitud recibida en la consola. Así que cada vez que se ejecuta un cliente de API o una prueba de CLI (y el registro de uso está habilitado), el servidor echo escribe el evento de uso recibido.

Instala express y body-parser, dos dependencias necesarias para ejecutar el código anterior:

npm i express body-parser

Inicia el servidor echo:

node echo-server.js

Probando un Sitio con la CLI

Ahora necesitará establecer dos variables de entorno: primero, para activar el servicio de uso, y segundo, para proporcionar la URL para el servidor (el servidor local creado en la sección anterior):

1. export AXE_TRACK_USAGE=true
2. export AXE_METRICS_URL=http://localhost:3000

En Linux o macOS, puede establecer las variables de entorno e invocar un análisis CLI de un sitio web en una sola línea como se muestra aquí:

AXE_TRACK_USAGE=true AXE_METRICS_URL=http://localhost:3000 axe https://broken-workshop.dequelabs.com/

set AXE_TRACK_USAGE=true
set AXE_METRICS_URL=http://localhost:3000

setx AXE_TRACK_USAGE true
setx AXE_METRICS_URL http://localhost:3000

Este comando realiza un análisis utilizando la CLI en el sitio https://broken-workshop.dequelabs.com.

Regrese a la ventana de consola donde está ejecutando el servidor de eco, y verá los eventos recibidos del servidor de eco, un ejemplo de un evento se muestra a continuación:

{
  dateTime: '2023-01-20T20:48:16.864Z',
  productComponent: 'api-cli',
  productName: 'axe-devtools-html',
  version: 'v2',
  event: 'uri: analyze',
  distinctId: 'f542d302-18a0-42a6-ab7f-ec1e42399bfe',
  applicationProperties: {
    target: 'https://broken-workshop.dequelabs.com/',
    target_medium: 'text/html',
    engineVersion: '4.5.2',
    failedRuleCount: 2,
    failedRuleNames: 'color-contrast,image-alt',
    failedItemCount: 12,
    inapplicableRuleCount: 33,
    incompleteRuleCount: 0,
    passedRuleCount: 27,
    testResults: {}
  }
}

Para más información sobre el objeto de evento, consulte El Objeto de Evento.

Cambiando el Evento Usando Variables de Entorno

Puede usar variables de entorno para cambiar las propiedades del evento reportado. Por ejemplo, puede cambiar o agregar la propiedad rolDeTrabajoDeUsuario estableciendo la variable de entorno AXE_USER_JOB_ROLE:

AXE_TRACK_USAGE=true AXE_METRICS_URL=http://localhost:3000 AXE_USER_JOB_ROLE="testing" axe https://broken-workshop.dequelabs.com/

A continuación se muestra un ejemplo de los eventos recibidos por el servidor de eco:

{
  dateTime: '2023-01-20T20:52:23.878Z',
  productComponent: 'api-cli',
  productName: 'axe-devtools-html',
  version: 'v2',
  event: 'uri: analyze',
  distinctId: '9c55a1f8-5177-44ee-a0e3-5dafa5ef9fc9',
  applicationProperties: {
    target: 'https://broken-workshop.dequelabs.com/',
    target_medium: 'text/html',
    engineVersion: '4.5.2',
    failedRuleCount: 2,
    failedRuleNames: 'color-contrast,image-alt',
    failedItemCount: 12,
    inapplicableRuleCount: 33,
    incompleteRuleCount: 0,
    passedRuleCount: 27,
    testResults: {}
  },
  userJobRole: 'testing'}

La propiedad rolDeTrabajoDeUsuario se agregó estableciendo la variable de entorno AXE_USER_JOB_ROLE como se muestra en la línea resaltada.

Para establecer otras propiedades en el evento, consulte Controlando el Servicio de Uso mediante Variables de Entorno.

Próximos Pasos

Para seguir una versión de este tutorial para las APIs de Axe DevTools, consulte Introducción al Servicio de Uso y las APIs.

Para información general sobre el servicio de uso, consulte El Servicio de Uso. Para información de referencia sobre el objeto de evento, consulte Referencia de Eventos del Servicio de Uso.