Introduzione al Servizio di Utilizzo e CLI

Questo articolo mostra come utilizzare il servizio di utilizzo con il CLI. Sarai guidato attraverso l'impostazione di un server locale per ricevere eventi del servizio di utilizzo, ti verrà mostrato come inviare metriche di utilizzo al server utilizzando il CLI, e come modificare gli eventi del servizio di utilizzo utilizzando variabili d'ambiente.

Il servizio di utilizzo consente di monitorare le metriche di utilizzo per l'uso del CLI da parte della tua organizzazione. Abilitare il servizio di utilizzo può essere uno strumento importante per la tua organizzazione per effettuare il monitoraggio della conformità delle licenze, audit dei test, e garantire che tutte le istanze di Axe DevTools per il Web siano configurate secondo gli standard della tua organizzazione.

Per informazioni generali sul servizio di utilizzo vedere Il servizio di utilizzo di Axe DevTools.

Prerequisiti

Devi installare Node.js per utilizzare questo esempio. Consulta Node.js per il programma di installazione di Node.js.

Impostare un Server Echo

Crea 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. Salvalo in una nuova directory e passa a quella directory.

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

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

npm i express body-parser

Avvia il server echo:

node echo-server.js

Testare un Sito con il CLI

Ora dovrai impostare due variabili d'ambiente: prima per abilitare il servizio di utilizzo e, successivamente, per fornire l'URL del server (il server locale creato nella sezione precedente):

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

Su Linux o macOS, puoi impostare le variabili d'ambiente e avviare una scansione CLI di un sito web in un unico comando come mostrato qui:

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 il CLI sul sito https://broken-workshop.dequelabs.com.

Torna alla finestra della console dove stai eseguendo il server echo, e vedrai gli eventi ricevuti dal server echo, un esempio di un evento è mostrato sotto:

{
  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.

Modificare l'Evento Usando Variabili d'Ambiente

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

Un esempio degli eventi ricevuti dal server echo è mostrato sotto:

{
  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 d'ambiente AXE_USER_JOB_ROLE come mostrato dalla riga evidenziata.

Per impostare altre proprietà nell'evento, vedere Controllare il Servizio di Utilizzo tramite Variabili d'Ambiente.

Prossimi Passi

Per seguire una versione di questo tutorial per le API di Axe DevTools, consulta Introduzione al Servizio di Utilizzo e le API.

Per inviare il tuo utilizzo a Deque in modo che appaia nelle metriche di utilizzo dei rapporti Axe anziché a un server echo locale, consulta Visualizzazione dei dati di utilizzo nei rapporti Axe.

Per informazioni generali sul servizio di utilizzo, vedere Il Servizio di Utilizzo. Per informazioni di riferimento sull'oggetto evento, vedere Riferimento agli Eventi del Servizio di Utilizzo.