Logboekregistratie in MSAL voor Android

  • Artikel

De MSAL-apps (Microsoft Authentication Library) genereren logboekberichten waarmee problemen kunnen worden vastgesteld. Een app kan logboekregistratie met een paar regels code configureren en aangepaste controle hebben over het detailniveau en of persoonlijke en organisatorische gegevens al dan niet worden vastgelegd. U wordt aangeraden een IMPLEMENTATIE van MSAL-logboekregistratie te maken en gebruikers een manier te bieden om logboeken in te dienen wanneer ze verificatieproblemen ondervinden.

Logboekregistratieniveaus

MSAL biedt verschillende niveaus van logboekregistratiedetails:

  • LogAlways: Er wordt geen niveaufiltering uitgevoerd op dit logboekniveau. Logboekberichten van alle niveaus worden vastgelegd.
  • Kritiek: logboeken die een onherstelbare toepassing of systeemcrash beschrijven, of een onherstelbare fout waarvoor onmiddellijke aandacht is vereist.
  • Fout: Geeft aan dat er iets mis is gegaan en er een fout is gegenereerd. Wordt gebruikt voor foutopsporing en het identificeren van problemen.
  • Waarschuwing: er is niet noodzakelijkerwijs een fout of fout opgetreden, maar zijn bedoeld voor diagnostische gegevens en het aanwijzen van problemen.
  • Informatief: MSAL zal gebeurtenissen vastleggen die zijn bedoeld voor informatieve doeleinden, niet noodzakelijkerwijs bedoeld voor foutopsporing.
  • Uitgebreid (standaard): MSAL registreert de volledige details van het gedrag van de bibliotheek.

Notitie

Niet alle logboekniveaus zijn beschikbaar voor alle MSAL SDK's

Persoonlijke en organisatorische gegevens

Standaard legt de MSAL-logboekregistratie geen zeer gevoelige persoonlijke of organisatorische gegevens vast. De bibliotheek biedt de optie om persoonlijke en organisatiegegevens in te schakelen als u dit wilt doen.

In de volgende secties vindt u meer informatie over MSAL-foutenlogboekregistratie voor uw toepassing.

Aanmelden in MSAL voor Android met java

Schakel logboekregistratie in bij het maken van apps door een callback voor logboekregistratie te maken. De callback gebruikt deze parameters:

  • tag is een tekenreeks die door de bibliotheek wordt doorgegeven aan de callback. Deze is gekoppeld aan de logboekvermelding en kan worden gebruikt om logboekregistratieberichten te sorteren.
  • logLevel hiermee kunt u bepalen welk niveau van logboekregistratie u wilt. De ondersteunde logboekniveaus zijn: Error, Warning, Infoen Verbose.
  • message is de inhoud van de logboekvermelding.
  • containsPII geeft aan of berichten met persoonsgegevens of organisatiegegevens worden geregistreerd. Dit is standaard ingesteld op false, zodat uw toepassing geen persoonlijke gegevens in een logboek opgeeft. Als containsPII dat het is true, ontvangt deze methode de berichten twee keer: eenmaal met de containsPII parameter ingesteld op false en zonder message persoonlijke gegevens, en een tweede keer met de containsPii parameter die is ingesteld true op en het bericht kan persoonlijke gegevens bevatten. In sommige gevallen (wanneer het bericht geen persoonlijke gegevens bevat), is het bericht hetzelfde.
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');
   }
});

Standaard legt de MSAL-logboekregistratie geen persoonlijke gegevens of organisatorische identificeerbare informatie vast. U kunt de logboekregistratie van persoonsgegevens of organisatorische identificeerbare gegevens inschakelen:

Logger.getInstance().setEnablePII(true);

Persoonlijke gegevens en organisatiegegevens voor logboekregistratie uitschakelen:

Logger.getInstance().setEnablePII(false);

Logboekregistratie naar logcat is standaard uitgeschakeld. U kunt deze als volgt inschakelen:

Logger.getInstance().setEnableLogcatLog(true);

Volgende stappen

Raadpleeg codevoorbeelden voor Microsoft Identity Platform voor meer codevoorbeelden.