Introducción al Servicio de Uso y la CLI

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

El servicio de uso le permite realizar un seguimiento de las métricas de 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 monitoreo de cumplimiento de licencias, auditorías de pruebas y garantice que todas las instancias de axe DevTools for Web estén configuradas según los estándares de su organización.

Para obtener información general sobre el servicio de uso, consulte The axe DevTools Usage Service.

Prerrequisitos

Necesita instalar Node.js para utilizar este ejemplo. Consulte Node.js para obtener el instalador de Node.js.

Configuración de un servidor Echo

Cree un archivo que contenga el código que se muestra 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 API o una prueba CLI (y el registro de uso está habilitado), el servidor de eco 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 de eco:

node echo-server.js

Probar un sitio con la CLI

Ahora necesitarás configurar dos variables de entorno: primero, para habilitar 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 configurar las variables de entorno e invocar un escaneo 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 ejecuta un análisis utilizando la CLI en el sitio https://broken-workshop.dequelabs.com.

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

{
  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 obtener más información sobre el objeto de evento, consulte El objeto de evento.

Cambiar el evento mediante variables de entorno

Puede utilizar variables de entorno para cambiar las propiedades del evento informado. Por ejemplo, puede cambiar o agregar la propiedad userJobRole configurando 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 userJobRole se agregó configurando la variable de entorno AXE_USER_JOB_ROLE como se muestra en la línea resaltada.

Para configurar otras propiedades en el evento, consulte Control del servicio de uso a través de variables de entorno.

Próximos pasos

Para seguir una versión de este tutorial para las API de axe DevTools, consulte Introducción al servicio de uso y las API.

Para obtener información general sobre el servicio de uso, consulte El servicio de uso. Para obtener información de referencia sobre el objeto de evento, consulte Referencia de eventos del servicio de uso.