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 tracciare l'utilizzo delle API e della CLI di Axe DevTools inviando eventi di utilizzo ai server pubblici di Deque o al proprio server. L'invio delle metriche di utilizzo a Deque ci aiuta a comprendere meglio come gli utenti interagiscono con i nostri prodotti, per poterli migliorare continuamente.
L'invio degli eventi di utilizzo al servizio di utilizzo è un processo distinto dall'invio dei risultati di accessibilità JSON ai Rapporti Axe. Vedi Segnalazione con la CLI per ulteriori 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, normalmente chiamata dalle API di Axe DevTools o dalla CLI)
- Un servizio REST, solitamente ospitato da Deque, che risponde alle richieste POST contenenti eventi di utilizzo
Gli eventi di utilizzo contengono informazioni su una scansione di accessibilità tra cui la data e l'ora della scansione, il numero di regole di accessibilità violate, i nomi delle regole violate e altre informazioni. Se si imposta un proprio servizio di utilizzo, si può utilizzare queste informazioni per ottenere una visione su come Axe DevTools per il Web viene utilizzato all'interno della propria organizzazione. Per informazioni di riferimento sulla struttura degli eventi di utilizzo, vedere 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:
- Imposta la variabile di ambiente AXE_TRACK_USAGE su true per abilitare il tracciamento dell'utilizzo. Ora, ogni volta che esegui la CLI o il tuo codice che utilizza le API di Axe DevTools per il Web, gli eventi di utilizzo verranno inviati al servizio di utilizzo REST di Deque.
- (Opzionale) Cambia l'URL del server a cui verranno segnalati gli eventi di utilizzo modificando la variabile di ambiente AXE_METRICS_URL (l'URL predefinito è
https://usage.deque.com). Se modifichi questa variabile di ambiente, devi creare il tuo servizio di utilizzo che imiti il servizio di utilizzo pubblico fornito da Deque. Vedi Impostazione di un Server di Eco - (Opzionale) Imposta AXE_INCLUDE_TEST_RESULTS su true per includere i risultati dei test nei dati inviati al servizio di utilizzo. L'impostazione di questa variabile di ambiente popolerà l'oggetto testResults nell'oggetto applicationProperties . Vedi Riferimento agli Eventi del Servizio di Utilizzo per maggiori informazioni.
- (Opzionale) Imposta la variabile di ambiente AXE_DEV_INSTANCE su true sui computer di sviluppatori e tester per consentire l'esclusione delle scansioni di accessibilità di sviluppatori e tester. (Di solito, vorrai ignorare qualsiasi utilizzo delle API avvenuto durante il lavoro di sviluppo o di testing.)
- (Opzionale) Imposta qualsiasi altra variabile di ambiente per personalizzare gli eventi che verranno segnalati al servizio di utilizzo. Vedi Controllo del Servizio di Utilizzo tramite Variabili di 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 su come usare il servizio di utilizzo con le API di Axe DevTools, vedi Guida Introduttiva al Servizio di Utilizzo e alle API. Per lo stesso tutorial su come usare la CLI con il servizio di utilizzo, vedi Guida Introduttiva al Servizio di Utilizzo e alla CLI. Questi tutorial includono i passaggi per impostare il proprio server semplice per mostrare gli eventi del servizio di utilizzo sulla console in modo da poter vedere cosa invia la libreria di metriche al servizio di utilizzo. Puoi usare questa configurazione per risolvere problemi con il 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: Abilita o disabilita il tracciamento dell'utilizzo, imposta l'URL di segnalazione, include i risultati dei test nei dati degli eventi e imposta l'ID distintivo dell'utente.
- Personalizzazione degli eventi: Modifica le proprietà sugli eventi di utilizzo inviati al servizio, come l'organizzazione dell'utente, il dipartimento, il ruolo lavorativo e altre informazioni identificative.
Per un riferimento completo di tutte le variabili d'ambiente disponibili, vedi Controllare il Servizio di Utilizzo tramite Variabili d'Ambiente.
Vedi Anche
Per ulteriori informazioni sulle proprietà contenute negli eventi di utilizzo, vedi 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, vedi Controllare il Servizio di Utilizzo tramite Variabili d'Ambiente.