Naplózás az Androidhoz készült MSAL-ben

  • Cikk

A Microsoft Authentication Library (MSAL)-alkalmazások olyan naplóüzeneteket hoznak létre, amelyek segíthetnek a problémák diagnosztizálásában. Az alkalmazások néhány sornyi kóddal konfigurálhatják a naplózást, és egyéni vezérléssel szabályozhatják a részletesség szintjét, valamint azt, hogy a rendszer naplózza-e a személyes és szervezeti adatokat. Javasoljuk, hogy hozzon létre egy MSAL-naplózási implementációt, és biztosítson módot a felhasználók számára, hogy hitelesítési problémák esetén küldjenek naplókat.

Naplózási szintek

Az MSAL több szintű naplózási részletet biztosít:

  • LogAlways: Ezen a naplószinten nem történik szintszűrés. A rendszer minden szinten naplózza az üzeneteket.
  • Kritikus: Helyreállíthatatlan alkalmazást vagy rendszerösszeomlást vagy azonnali figyelmet igénylő katasztrofális hibát leíró naplók.
  • Hiba: Azt jelzi, hogy hiba történt, és hiba történt. Hibakeresésre és problémák azonosítására szolgál.
  • Figyelmeztetés: Nem feltétlenül volt hiba vagy hiba, de diagnosztikára és problémák rögzítésére szolgál.
  • Tájékoztató: Az MSAL olyan eseményeket naplóz, amelyek nem feltétlenül hibakeresésre szolgálnak.
  • Részletes (alapértelmezett): Az MSAL naplózza a kódtár viselkedésének teljes részleteit.

Feljegyzés

Nem minden naplószint érhető el az összes MSAL SDK-hoz

Személyes és szervezeti adatok

Alapértelmezés szerint az MSAL-naplózó nem rögzíti a bizalmas személyes vagy szervezeti adatokat. A kódtár lehetővé teszi a személyes és szervezeti adatok naplózását, ha úgy dönt, hogy ezt teszi.

Az alábbi szakaszok további részleteket nyújtanak az alkalmazás MSAL-hibanaplózásáról.

Bejelentkezés androidos MSAL-be Java használatával

Naplózási visszahívás létrehozásával kapcsolja be a naplózást az alkalmazás létrehozásakor. A visszahívás a következő paramétereket veszi igénybe:

  • tag a kódtár által a visszahívásnak átadott sztring. A naplóbejegyzéshez van társítva, és a naplózási üzenetek rendezésére használható.
  • logLevel lehetővé teszi a kívánt naplózási szint kiválasztását. A támogatott naplószintek a következők: Error, Warning, Infoés Verbose.
  • message a naplóbejegyzés tartalma.
  • containsPII meghatározza, hogy a rendszer naplózza-e a személyes adatokat tartalmazó üzeneteket vagy a szervezeti adatokat. Alapértelmezés szerint ez hamis értékre van állítva, így az alkalmazás nem naplózza a személyes adatokat. Ha containsPII igen true, ez a módszer kétszer kapja meg az üzeneteket: egyszer a containsPII paraméter beállításakor false és a message személyes adatok nélkül, majd egy második alkalommal, amikor a containsPii paraméter be van állítva true , és az üzenet személyes adatokat tartalmazhat. Bizonyos esetekben (ha az üzenet nem tartalmaz személyes adatokat), az üzenet ugyanaz lesz.
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');
   }
});

Alapértelmezés szerint az MSAL-naplózó nem rögzít személyes azonosításra alkalmas adatokat vagy szervezeti azonosításra alkalmas adatokat. Személyes azonosításra alkalmas adatok vagy szervezeti azonosításra alkalmas adatok naplózásának engedélyezése:

Logger.getInstance().setEnablePII(true);

Személyes adatok és szervezeti adatok naplózásának letiltása:

Logger.getInstance().setEnablePII(false);

Alapértelmezés szerint a logcatbe való naplózás le van tiltva. Az engedélyezéshez:

Logger.getInstance().setEnableLogcatLog(true);

Következő lépések

További kódmintákért tekintse meg Microsoft Identitásplatform kódmintákat.