Il Servizio di Utilizzo di Axe DevTools per il Web
Una panoramica del servizio di utilizzo, che è un servizio REST che traccia l'utilizzo delle API e della CLI 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.
L'invio degli eventi di utilizzo al servizio di utilizzo è un processo separato dall'invio di risultati di accessibilità JSON ai Rapporti Axe. Vedi Segnalazione con la CLI per maggiori informazioni sulla segnalazione.
Il servizio di utilizzo consiste di due parti:
- 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)
- 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.
Per impostazione predefinita, Axe DevTools non registra le informazioni sull'utilizzo. L'utilizzo deve essere abilitato per consentire la raccolta delle metriche di utilizzo. Anche quando è abilitato, il servizio di utilizzo non raccoglie alcuna informazione privata o personale sugli utenti, in quanto è stato progettato pensando alla privacy.
Inizio Rapido
Puoi iniziare a tracciare l'utilizzo seguendo questi passaggi:
- Impostare la variabile d'ambiente AXE_TRACK_USAGE su true per abilitare il monitoraggio dell'uso. Ora, ogni volta che si esegue la CLI o il proprio codice che utilizza le API Axe DevTools for Web, gli eventi di utilizzo saranno inviati al servizio REST di utilizzo di Deque.
- (Facoltativo) Modificare l'URL del server a cui saranno riportati gli eventi di utilizzo modificando la variabile d'ambiente AXE_METRICS_URL (l'URL predefinito è
https://usage.deque.com). Se si modifica questa variabile d'ambiente, è necessario creare il proprio servizio di utilizzo che imiti il servizio di utilizzo pubblico fornito da Deque. Vedere Impostazione di un Server di Eco - (Facoltativo) Impostare AXE_INCLUDE_TEST_RESULTS su true per includere i risultati dei test nei dati inviati al servizio di utilizzo. Impostare questa variabile d'ambiente popolerà l'oggetto testResults nell'oggetto applicationProperties. Vedere Il Riferimento agli Eventi del Servizio di Utilizzo per ulteriori informazioni.
- (Facoltativo) Impostare la variabile d'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 si desidera ignorare qualsiasi uso delle API avvenuto durante il lavoro di sviluppo o test.)
- (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.
- 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.
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.