Controllo del Servizio di Utilizzo tramite Variabili di Ambiente

This page is not available in the language you requested. You have been redirected to the English version of the page.
Link to this page copied to clipboard

Informazioni sull'uso delle variabili di ambiente per controllare il servizio di utilizzo o per modificare l'evento che viene riportato al servizio di utilizzo

Not for use with personal data

In questo articolo sono contenute informazioni su come controllare il servizio di utilizzo tramite variabili di ambiente. Puoi:

  • Controllare come funziona il servizio di utilizzo.
  • Modificare l'evento che viene inviato al servizio di utilizzo.

Controllo del Servizio di Utilizzo tramite Variabili di Ambiente

Quattro variabili d'ambiente ti permettono di controllare il servizio di monitoraggio dell'uso. Puoi disabilitare la raccolta delle metriche di utilizzo, modificare l'URL dove vengono riportati i risultati, cambiare l'ID distinto dell'utente e includere i risultati completi di axe-core in ogni evento.

important

Il monitoraggio dell'uso è abilitato di default nel CLI e nelle API Axe DevTools. Per interrompere l'invio degli eventi di utilizzo, imposta AXE_TRACK_USAGE su false, o chiama il metodo enableTracking della tua API con false.

note

Se il tuo client non riesce a contattare il servizio di utilizzo, riproverà sostituendo https con http nell'URL (impostato utilizzando la variabile di ambiente AXE_METRICS_URL).

Cambio dell'Evento Segnalato tramite Variabili di Ambiente

Con le variabili di ambiente seguenti, puoi modificare l'evento che viene riportato al servizio di utilizzo. Ad esempio, puoi cambiare le proprietà reparto o organizzazione su ciascun evento per associare l'uso dell'API o del CLI a un dipartimento o a un'organizzazione specifica.

La colonna Può Sovrascrivere indica se il valore impostato nella variabile di ambiente può sovrascrivere un valore che era già stato impostato programmaticamente tramite la libreria di metriche. Un trattino (—) nella colonna Può Sovrascrivere indica che il concetto non si applica a quella variabile.

Variabili di Ambiente

Nome Tipo Può Sovrascrivere Descrizione
AXE_DISTINCT_ID Stringa — Un identificatore UUID che rimane lo stesso per l'utente connesso (a meno che non venga rigenerato). In Ruby, questa variabile è denominata DEQUE_DISTINCT_ID.
AXE_INCLUDE_TEST_RESULTS Booleano — Imposta su true per includere i risultati completi di axe-core nell'oggetto testResults di ogni evento (predefinito è false). Supportato solo dalla CLI e dalle API di Node.js.
AXE_METRICS_URL Stringa — L'URL dell'endpoint di utilizzo REST (predefinito è https://usage.deque.com)
AXE_TRACK_USAGE Booleano — Imposta su false per disabilitare il servizio di reporting sull'utilizzo. Il reporting è abilitato per impostazione predefinita.
AXE_APPLICATION Stringa falso L'applicazione utilizzata per controllare gli errori di accessibilità
AXE_DEV_INSTANCE Booleano vero Indica se questo evento è dovuto ad azioni di uno sviluppatore software. Utile per marcare e successivamente rimuovere eventi registrati durante lo sviluppo o i test.
AXE_DEPARTMENT Stringa vero Il dipartimento utente all'interno dell'organizzazione
AXE_KEYCLOAK_ID Stringa falso L'ID Keycloak dell'utente
AXE_LOGGED_IN Booleano falso Registra se l'utente è connesso all'applicazione in test
AXE_ORGANIZATION Stringa vero L'organizzazione dell'utente. Per fare sì che il tuo utilizzo appaia nei Rapporti Axe, imposta questo valore sull'ID della tua organizzazione (contatta Deque per ottenerlo).
AXE_SESSION_ID Stringa falso Un UUID che identifica la sessione dell'utente
AXE_USER_ID Stringa falso L'identità di un utente specifico come un indirizzo email, un nome o un ID di accesso. I Rapporti Axe contano gli utenti unici a partire da questo valore.
AXE_USER_JOB_ROLE Stringa falso Il ruolo lavorativo dell'utente
AXE_USER_STATUS Stringa falso Informazioni sullo stato che si desidera associare all'utente

Differenze Tra Linguaggi

La maggior parte di queste variabili d'ambiente si comporta in modo identico nel CLI e in ogni API Axe DevTools. Le eccezioni sono:

  • AXE_INCLUDE_TEST_RESULTS è letto solo dal CLI e dalle API Node.js. Impostarlo non ha effetto sulle API Java, Python, C# o Ruby.
  • AXE_DISTINCT_ID si chiama DEQUE_DISTINCT_ID nell'API Ruby.
  • AXE_METRICS_URL potrebbe non tornare al suo default nelle API Java e Ruby. Se i tuoi eventi di utilizzo non raggiungono Deque, imposta esplicitamente la variabile su https://usage.deque.com.

Vedi Anche

Per tutorial che dimostrano come usare queste variabili di ambiente, vedi Primi Passi con il Servizio di Utilizzo e le API e Introduzione al servizio di utilizzo e la CLI.

Per informazioni generali sul servizio di utilizzo, vedi Il servizio di utilizzo di Axe DevTools per il Web.

Is this page helpful?

Help us improve this page

Still need help?