Loggning i MSAL för Android

  • Artikel

MSAL-appar (Microsoft Authentication Library) genererar loggmeddelanden som kan hjälpa dig att diagnostisera problem. En app kan konfigurera loggning med några rader kod och ha anpassad kontroll över detaljnivån och om personliga data och organisationsdata loggas eller inte. Vi rekommenderar att du skapar en MSAL-loggningsimplementering och tillhandahåller ett sätt för användare att skicka loggar när de har autentiseringsproblem.

Loggningsnivåer

MSAL innehåller flera nivåer av loggningsinformation:

  • LogAlways: Ingen nivåfiltrering görs på den här loggnivån. Loggmeddelanden på alla nivåer loggas.
  • Kritisk: Loggar som beskriver ett oåterkalleligt program eller en systemkrasch, eller ett oåterkalleligt fel som kräver omedelbar uppmärksamhet.
  • Fel: Anger att något har gått fel och att ett fel har genererats. Används för att felsöka och identifiera problem.
  • Varning! Det har inte nödvändigtvis förekommit ett fel eller fel, men är avsedda för diagnostik och hitta problem.
  • Information: MSAL loggar händelser som är avsedda för informationsändamål som inte nödvändigtvis är avsedda för felsökning.
  • Utförligt (standard): MSAL loggar fullständig information om biblioteksbeteendet.

Kommentar

Alla loggnivåer är inte tillgängliga för alla MSAL SDK:s

Personliga och organisatoriska data

Som standard samlar MSAL-loggaren inte in några mycket känsliga personliga data eller organisationsdata. Biblioteket ger möjlighet att aktivera loggning av personliga data och organisationsdata om du bestämmer dig för att göra det.

Följande avsnitt innehåller mer information om MSAL-felloggning för ditt program.

Logga in MSAL för Android med Java

Aktivera loggning när appen skapas genom att skapa ett återanrop för loggning. Återanropet tar dessa parametrar:

  • tag är en sträng som skickas till återanropet av biblioteket. Den är associerad med loggposten och kan användas för att sortera loggningsmeddelanden.
  • logLevel gör att du kan bestämma vilken loggningsnivå du vill ha. Loggnivåerna som stöds är: Error, Warning, Infooch Verbose.
  • message är innehållet i loggposten.
  • containsPII anger om meddelanden som innehåller personliga data eller organisationsdata loggas. Som standard är detta inställt på false, så att ditt program inte loggar personliga data. Om containsPII är truetar den här metoden emot meddelandena två gånger: en gång med parametern containsPII inställd på false och message utan personliga data, och en andra gång med parametern containsPii inställd på true och meddelandet kan innehålla personliga data. I vissa fall (när meddelandet inte innehåller personliga data) blir meddelandet detsamma.
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');
   }
});

Som standard samlar MSAL-loggaren inte in någon personlig identifierbar information eller organisations identifierbar information. Så här aktiverar du loggning av personlig identifierbar information eller organisations identifierbar information:

Logger.getInstance().setEnablePII(true);

Så här inaktiverar du loggning av personliga data och organisationsdata:

Logger.getInstance().setEnablePII(false);

Loggning till logcat är inaktiverad som standard. För att aktivera:

Logger.getInstance().setEnableLogcatLog(true);

Nästa steg

Fler kodexempel finns i Microsofts identitetsplattform kodexempel.