Registrazione in MSAL per Android
Le app di Microsoft Authentication Library (MSAL) generano messaggi di log che consentono di diagnosticare i problemi. Un'app può configurare la registrazione con alcune righe di codice e avere un controllo personalizzato sul livello di dettaglio, oltre che sulla necessità di registrare o meno i dati personali o dell'organizzazione. È consigliabile creare un'implementazione della registrazione MSAL e fornire agli utenti un modo per inviare i log in caso di problemi di autenticazione.
Livelli di registrazione
MSAL offre diversi livelli di dettaglio della registrazione:
- LogAlways: nessun filtro a livello viene eseguito a questo livello di log. Verranno registrati i messaggi di log di tutti i livelli.
- Critico: log che descrivono un'applicazione o un arresto anomalo del sistema irreversibile o un errore irreversibile che richiede attenzione immediata.
- Errore: indica che si è verificato un errore e che è stato generato un errore. Usato per il debug e l'identificazione dei problemi.
- Avviso: non si è necessariamente verificato un errore o un errore, ma sono destinati alla diagnostica e all'individuazione dei problemi.
- Informativo: MSAL registra gli eventi destinati a scopi informativi non necessariamente destinati al debug.
- Dettagliato (impostazione predefinita): MSAL registra i dettagli completi del comportamento della libreria.
Nota
Non tutti i livelli di log sono disponibili per tutti gli SDK MSAL
Dati personali e dell'organizzazione
Per impostazione predefinita, il logger MSAL non acquisisce dati personali o aziendali estremamente sensibili. La libreria offre la possibilità di abilitare la registrazione dei dati personali e dell'organizzazione se si decide di farlo.
Le sezioni seguenti forniscono altri dettagli sulla registrazione degli errori MSAL per l'applicazione.
Registrazione in MSAL per Android con Java
Attivare l'accesso durante la creazione dell'app creando un callback di registrazione. Il callback accetta questi parametri:
tag
è una stringa passata al callback dalla libreria. È associato alla voce di log e può essere usato per ordinare i messaggi di registrazione.logLevel
consente di decidere il livello di registrazione desiderato. I livelli di log supportati sono:Error
,Warning
,Info
eVerbose
.message
è il contenuto della voce di log.containsPII
specifica se i messaggi contenenti dati personali o i dati dell'organizzazione vengono registrati. Per impostazione predefinita, questa opzione è impostata su false, in modo che l'applicazione non registri i dati personali. SecontainsPII
ètrue
, questo metodo riceverà i messaggi due volte: una volta con ilcontainsPII
parametro impostato sufalse
emessage
senza dati personali e una seconda volta con ilcontainsPii
parametro impostato sutrue
e il messaggio potrebbe contenere dati personali. In alcuni casi (quando il messaggio non contiene dati personali), il messaggio sarà lo stesso.
private StringBuilder mLogs;
mLogs = new StringBuilder();
Logger.getInstance().setExternalLogger(new ILoggerCallback()
{
@Override
public void log(String tag, Logger.LogLevel logLevel, String message, boolean containsPII)
{
mLogs.append(message).append('\n');
}
});
Per impostazione predefinita, il logger MSAL non acquisisce informazioni personali o informazioni identificabili dell'organizzazione. Per abilitare la registrazione di informazioni personali o informazioni identificabili dell'organizzazione:
Logger.getInstance().setEnablePII(true);
Per disabilitare la registrazione dei dati personali e dell'organizzazione:
Logger.getInstance().setEnablePII(false);
Per impostazione predefinita, la registrazione per logcat è disabilitata. Per abilitarla, effettuare i seguenti passaggi:
Logger.getInstance().setEnableLogcatLog(true);
Passaggi successivi
Per altri esempi di codice, vedere esempi di codice di Microsoft Identity Platform.