Partilhar via

Registos no MSAL para Android

  • Artigo

Os aplicativos da Biblioteca de Autenticação da Microsoft (MSAL) geram mensagens de log que podem ajudar a diagnosticar problemas. Um aplicativo pode configurar o registro em log com algumas linhas de código e ter controle personalizado sobre o nível de detalhe e se os dados pessoais e organizacionais são ou não registrados. Recomendamos que você crie uma implementação de log MSAL e forneça uma maneira para os usuários enviarem logs quando tiverem problemas de autenticação.

Níveis de registo

O MSAL fornece vários níveis de detalhes de registro:

  • LogAlways: Nenhuma filtragem de nível é feita neste nível de log. Mensagens de log de todos os níveis serão registradas.
  • Crítico: logs que descrevem uma falha irrecuperável do aplicativo ou do sistema, ou uma falha catastrófica que requer atenção imediata.
  • Erro: indica que algo deu errado e um erro foi gerado. Usado para depuração e identificação de problemas.
  • Aviso: Não houve necessariamente um erro ou falha, mas destinam-se a diagnósticos e identificação de problemas.
  • Informativo: o MSAL registrará eventos destinados a fins informativos não necessariamente destinados à depuração.
  • Detalhado (padrão): o MSAL registra todos os detalhes do comportamento da biblioteca.

Nota

Nem todos os níveis de log estão disponíveis para todos os SDKs do MSAL

Dados pessoais e organizacionais

Por padrão, o registrador MSAL não captura nenhum dado pessoal ou organizacional altamente sensível. A biblioteca oferece a opção de habilitar o registro de dados pessoais e organizacionais se você decidir fazê-lo.

As seções a seguir fornecem mais detalhes sobre o log de erros MSAL para seu aplicativo.

Efetuando login no MSAL para Android usando Java

Ative o logon na criação do aplicativo criando um retorno de chamada de log. O retorno de chamada usa estes parâmetros:

  • tag é uma cadeia de caracteres passada para o retorno de chamada pela biblioteca. Ele está associado à entrada de log e pode ser usado para classificar mensagens de log.
  • logLevel permite que você decida qual nível de registro você deseja. Os níveis de log suportados são: Error, Warning, Infoe Verbose.
  • message é o conteúdo da entrada de log.
  • containsPII Especifica se as mensagens que contêm dados pessoais ou dados organizacionais são registradas. Por padrão, isso é definido como false, para que seu aplicativo não registre dados pessoais. Se containsPII for true, este método receberá as mensagens duas vezes: uma vez com o containsPII parâmetro definido como false e sem message dados pessoais, e uma segunda vez com o containsPii parâmetro definido como true e a mensagem pode conter dados pessoais. Em alguns casos (quando a mensagem não contém dados pessoais), a mensagem será a mesma.
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');
   }
});

Por padrão, o registrador MSAL não capturará nenhuma informação pessoal identificável ou informação organizacional identificável. Para habilitar o registro de informações pessoais identificáveis ou informações organizacionais identificáveis:

Logger.getInstance().setEnablePII(true);

Para desativar o registo de dados pessoais e dados da organização:

Logger.getInstance().setEnablePII(false);

Por padrão, o registro no logcat está desativado. Para ativar:

Logger.getInstance().setEnableLogcatLog(true);

Próximos passos

Para obter mais exemplos de código, consulte Exemplos de código da plataforma de identidade da Microsoft.