Il servizio di utilizzo di axe DevTools for Web
Una panoramica del servizio di utilizzo, che è un servizio REST che tiene traccia dell'utilizzo di axe DevTools per le API Web e la CLI
Questo articolo fornisce una panoramica del servizio di utilizzo, un servizio che consente di monitorare l'utilizzo delle API di axe DevTools e della CLI inviando eventi di utilizzo ai server pubblici di Deque o al proprio server. L'invio di metriche di utilizzo a Deque ci aiuta a comprendere meglio il modo in cui i nostri utenti interagiscono con i nostri prodotti, in modo da poter continuare a migliorarli.
L'invio di eventi di utilizzo al servizio di utilizzo è un processo separato dall'invio di risultati di accessibilità JSON ad axe Reports. Vedere Reporting con la CLI per ulteriori informazioni sulla creazione di report.
Il servizio di utilizzo è composto da due parti:
- Un client che pubblica eventi di utilizzo sul servizio di utilizzo (tramite la libreria di metriche, in genere 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 data e ora della scansione, il numero di regole di accessibilità violate, i nomi delle regole violate e altre informazioni. Se imposti un tuo servizio di utilizzo, puoi usare le informazioni per capire come axe DevTools for Web viene utilizzato nella tua 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. Per consentire la raccolta delle metriche di utilizzo, è necessario abilitare la funzionalità. Anche quando abilitato, il servizio di utilizzo non raccoglie alcuna informazione privata o personale sui suoi utenti, poiché è stato creato pensando alla privacy.
Avvio rapido
Puoi iniziare a monitorare l'utilizzo seguendo questi passaggi:
- Impostare la variabile d'ambiente AXE_TRACK_USAGE su true per abilitare il monitoraggio dell'utilizzo. Ora, ogni volta che esegui la CLI o il tuo codice che utilizza axe DevTools per le API Web, gli eventi di utilizzo verranno pubblicati sul servizio di utilizzo REST Deque.
- (Facoltativo) Modificare l'URL del server in cui verranno segnalati gli eventi di utilizzo modificando la variabile di ambiente AXE_METRICS_URL (l'URL predefinito è
https://usage.deque.com). Se si modifica questa variabile di ambiente, è necessario creare un proprio servizio di utilizzo che imiti il servizio di utilizzo pubblico fornito da Deque. Vedere Impostazione di un server Echo - (Facoltativo) Impostare AXE_INCLUDE_TEST_RESULTS su true per includere i risultati dei test nei dati inviati al servizio di utilizzo. Impostando questa variabile d'ambiente verrà popolato l'oggetto testResults nell'oggetto applicationProperties . Per ulteriori informazioni, vedere Riferimento agli eventi del servizio di utilizzo
- (Facoltativo) Impostare la variabile di ambiente AXE_DEV_INSTANCE su true sui computer degli sviluppatori e dei tester per consentire di filtrare le scansioni di accessibilità degli sviluppatori e dei tester. (In genere è meglio ignorare qualsiasi utilizzo dell'API avvenuto durante lo sviluppo o il test.)
- (Facoltativo) Impostare altre variabili di ambiente per personalizzare gli eventi che verranno segnalati al servizio di utilizzo. Vedere Controllo del servizio di utilizzo tramite variabili ambientali.
- Esegui il 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 pubblicare eventi sul servizio di utilizzo, così come lo hai configurato.
Per un tutorial più approfondito che mostra come utilizzare il servizio di utilizzo con le API di axe DevTools, vedere Introduzione al servizio di utilizzo e alle API. Per lo stesso tutorial che mostra come utilizzare la CLI con il servizio di utilizzo, vedere Introduzione al servizio di utilizzo e alla CLI. Questi tutorial includono i passaggi per configurare un semplice server per visualizzare gli eventi del servizio di utilizzo nella console, in modo da poter vedere cosa la libreria delle metriche invia al servizio di utilizzo. È possibile utilizzare questa configurazione per risolvere i problemi del servizio di utilizzo.
Vedere anche
Per ulteriori informazioni sulle proprietà contenute negli eventi di utilizzo, vedere Riferimento agli eventi del servizio di utilizzo.