Introduzione al Servizio di Utilizzo e alla CLI

Questo articolo mostra come utilizzare il servizio di utilizzo con la CLI. Verrai guidato nella configurazione di un server locale per fare l'echo degli eventi del servizio di utilizzo, ti verrà mostrato come inviare metriche di utilizzo al server tramite la CLI e come modificare gli eventi del servizio di utilizzo tramite variabili di ambiente.

Il servizio di utilizzo consente di monitorare le metriche di utilizzo dell'interfaccia a riga di comando (CLI) nella propria organizzazione. L'abilitazione del servizio di utilizzo può rivelarsi uno strumento importante per la tua organizzazione per monitorare la conformità delle licenze, testare gli audit e garantire che tutte le istanze di axe DevTools for Web siano configurate secondo gli standard della tua organizzazione.

Per informazioni generali sul servizio di utilizzo, vedere The axe DevTools Usage Service.

Prerequisiti

Per utilizzare questo esempio è necessario installare Node.js. Per il programma di installazione di Node.js, vedere Node.js .

Impostazione di un server Echo

Creare un file contenente il codice mostrato di seguito:

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)

Chiameremo il file echo-server.js. Salvatelo in una nuova directory e cambiate a quella directory.

Il server ascolta le richieste sulla porta 3000 e scrive il corpo della richiesta ricevuta sulla console. Pertanto, ogni volta che viene eseguito un test di client API o CLI (e la registrazione dell'utilizzo è abilitata), il server echo scrive l'evento di utilizzo ricevuto.

Installate express e body-parser, due dipendenze necessarie per eseguire il codice sopra:

npm i express body-parser

Avviate il server echo:

node echo-server.js

Test di un sito con la CLI

Ora dovrai impostare due variabili di ambiente: innanzitutto, per abilitare il servizio di utilizzo e, in secondo luogo, per fornire l'URL per il server (il server locale creato nella sezione precedente):

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

In Linux o macOS, è possibile impostare le variabili di ambiente e richiamare una scansione CLI di un sito Web su una singola riga, come mostrato di seguito:

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

Questo comando esegue un'analisi utilizzando la CLI sul sito https://broken-workshop.dequelabs.com.

Ritorna alla finestra della console in cui stai eseguendo il server echo e vedrai gli eventi ricevuti dal server echo; di seguito è riportato un esempio di 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: {}
  }
}

Per ulteriori informazioni sull'oggetto evento, vedere L'oggetto evento.

Modifica dell'evento tramite variabili d'ambiente

È possibile utilizzare le variabili di ambiente per modificare le proprietà dell'evento segnalato. Ad esempio, è possibile modificare o aggiungere la proprietà userJobRole impostando la variabile di ambiente 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/

Di seguito è riportato un esempio degli eventi ricevuti dal server echo:

{
  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 proprietà userJobRole è stata aggiunta impostando la variabile di ambiente AXE_USER_JOB_ROLE come mostrato dalla riga evidenziata.

Per impostare altre proprietà nell'evento, vedere Controllo del servizio di utilizzo tramite variabili d'ambiente.

Prossimi passi

Per seguire una versione di questo tutorial per le API di axe DevTools, vedere Introduzione al servizio di utilizzo e alle API.

Per informazioni generali sul servizio di utilizzo, vedere Il servizio di utilizzo. Per informazioni di riferimento sull'oggetto evento, vedere Riferimento all'evento del servizio di utilizzo.