Il Servizio di Utilizzo di Axe DevTools per il Web

Questo articolo fornisce una panoramica del servizio di utilizzo, un servizio che consente di monitorare l'uso delle API Axe DevTools e della CLI inviando eventi di utilizzo ai server pubblici di Deque o al proprio server. Inviare i dati di utilizzo a Deque ci aiuta a comprendere meglio come gli utenti interagiscono con i nostri prodotti in modo da poterli migliorare continuamente.

Il servizio di utilizzo consiste di due parti:

1. Un client che invia eventi di utilizzo al servizio di utilizzo (tramite la libreria di metriche, chiamata tipicamente dalle API Axe DevTools o dalla CLI)
2. Un servizio REST, solitamente ospitato da Deque, che risponde a richieste POST contenenti eventi di utilizzo

Gli eventi di utilizzo contengono informazioni su una scansione di accessibilità, inclusi data e ora della scansione, il numero di regole di accessibilità violate, i nomi delle regole violate e altre informazioni. Se si configura il proprio servizio di utilizzo, è possibile utilizzare le informazioni per ottenere una panoramica su come Axe DevTools for Web viene utilizzato all'interno della propria organizzazione. Per informazioni di riferimento sulla struttura degli eventi di utilizzo, vedere Il Riferimento agli Eventi del Servizio di Utilizzo.

Inizio Rapido

Puoi iniziare a tracciare l'utilizzo seguendo questi passaggi:

1. Conferma che il tracciamento dell'uso sia abilitato. È abilitato per impostazione predefinita, quindi a meno che tu non abbia impostato AXE_TRACK_USAGE su false, gli eventi di utilizzo sono già inviati al servizio REST di monitoraggio dell'uso di Deque ogni volta che esegui il CLI o il tuo codice che utilizza le API di Axe DevTools per il Web.
2. (Facoltativo) Cambia l'URL del server a cui verranno riportati gli eventi di uso modificando la variabile di ambiente AXE_METRICS_URL (l'URL predefinito è https://usage.deque.com). Se cambi questa variabile di ambiente, devi creare il tuo servizio di monitoraggio che imiti il servizio pubblico fornito da Deque. Vedi Impostazione di un Server di Eco
3. (Facoltativo) Imposta AXE_INCLUDE_TEST_RESULTS su true per includere i risultati dei test nei dati inviati al servizio di monitoraggio dell'uso. Impostare questa variabile di ambiente popolerà l'oggetto testResults nell'oggetto applicationProperties. Questa variabile è supportata solo dal CLI e dalle API di Node.js. Vedi Il Riferimento agli Eventi del Servizio di Utilizzo per maggiori informazioni.
4. (Facoltativo) Imposta la variabile di ambiente AXE_DEV_INSTANCE su true sui computer di sviluppatori e tester per consentire di filtrare le scansioni di accessibilità di sviluppatori e tester. (Di solito vorrai ignorare qualsiasi utilizzo delle API avvenuto durante il lavoro di sviluppo o testing.)
5. (Facoltativo) Impostare qualsiasi altra variabile d'ambiente per personalizzare gli eventi che saranno riportati al servizio di utilizzo. Vedere Controllare il Servizio di Utilizzo tramite Variabili d'Ambiente.
6. Esegui il tuo codice di scansione dell'accessibilità o una scansione della pagina CLI per inviare l'utilizzo al servizio di utilizzo. Tutte le API di Deque utilizzano la libreria di metriche per creare e inviare eventi al servizio di utilizzo come hai configurato.

Per un tutorial più approfondito che mostra come utilizzare il servizio di utilizzo con le API Axe DevTools, vedere Guida Introduttiva al Servizio di Utilizzo e alle API. Per lo stesso tutorial che mostra come utilizzare la CLI con il servizio di utilizzo, vedere Guida Introduttiva al Servizio di Utilizzo e alla CLI. Questi tutorial includono i passaggi per configurare un proprio semplice server per riecheggiare gli eventi del servizio di utilizzo alla console, in modo da poter vedere cosa invia la libreria di metriche al servizio di utilizzo. È possibile utilizzare questa configurazione per risolvere i problemi del servizio di utilizzo.

Visualizzazione dei Dati di Uso nei Report Axe

Se la tua organizzazione utilizza i Report Axe, le sue metriche di utilizzo (i report Utilizzo per Mese e URL Scansionati) sono popolate dagli eventi di uso descritti in questo articolo. Non sono popolati dai risultati di accessibilità JSON che carichi con il sottocomando bulk-reports del CLI: l'invio di eventi di uso e il caricamento dei risultati sono processi separati.

Affinché le tue scansioni appaiano nelle metriche di uso dei Report Axe, ogni macchina che esegue una scansione deve avere quanto segue:

1. Tracciamento dell'uso lasciato abilitato: è attivo per impostazione predefinita, quindi assicurati che AXE_TRACK_USAGE non sia impostato su false e che --enable-tracking false non sia passato al CLI.
2. Eventi di uso inviati al servizio pubblico di monitoraggio dell'uso di Deque: lascia AXE_METRICS_URL al suo valore predefinito di https://usage.deque.com. Se punti il client al tuo server, Deque non riceve mai gli eventi e i Report Axe non hanno nulla da visualizzare.
3. AXE_ORGANIZATION impostato sull'ID della tua organizzazione. I Report Axe utilizzano questo valore per associare gli eventi di uso con la tua organizzazione; senza di esso, i tuoi eventi non possono essere associati al tuo account.
4. AXE_USER_ID impostato su un identificatore per la persona che esegue la scansione, come un indirizzo email. I Report Axe contano gli utenti unici a partire da questo valore.
5. (Facoltativo) AXE_DEPARTMENT impostato sul dipartimento dell'utente che esegue la scansione. Il report Utilizzo per Mese può raggruppare l'uso per dipartimento; gli eventi senza questa variabile sono raggruppati sotto Nessun Dipartimento.

Per esempio, utilizzando il CLI:

AXE_TRACK_USAGE=true AXE_ORGANIZATION=<your-organization-id> AXE_USER_ID=name@example.com axe https://broken-workshop.dequelabs.com/

Le metriche di uso sono disponibili solo per gli amministratori dei Report Axe, e solo per le organizzazioni il cui accesso ai Report Axe include Axe DevTools per il Web. Per informazioni sulla lettura dei report stessi, consulta Lavorare con i Report di Uso nella documentazione dei Report Axe.

Variabili di Ambiente

Puoi usare le variabili di ambiente per controllare il funzionamento del servizio di utilizzo e personalizzare gli eventi che segnala. Le variabili di ambiente si suddividono in due categorie:

• Controllo del servizio di utilizzo: Abilitare o disabilitare il monitoraggio dell'uso, impostare l'URL di segnalazione, includere i risultati dei test nei dati degli eventi e impostare l'ID distinto dell'utente.
• Personalizzazione degli eventi: Modificare le proprietà negli eventi di utilizzo inviati al servizio, come l'organizzazione dell'utente, il reparto, il ruolo lavorativo e altre informazioni identificative.

Per un riferimento completo di tutte le variabili d'ambiente disponibili, vedere Controllare il Servizio di Utilizzo tramite Variabili d'Ambiente.

Vedi Anche

Per ulteriori informazioni sulle proprietà contenute negli eventi di utilizzo, vedere Il Riferimento agli Eventi del Servizio di Utilizzo.

Per un riferimento delle variabili d'ambiente disponibili per controllare il servizio di utilizzo e personalizzare gli eventi, vedere Controllare il Servizio di Utilizzo tramite Variabili d'Ambiente.

Per informazioni sulla lettura delle metriche di uso nei Report Axe, consulta Lavorare con i Report di Uso nella documentazione dei Report Axe.