Logowanie w MSAL dla Androida

Aplikacje biblioteki Microsoft Authentication Library (MSAL) generują komunikaty dziennika, które mogą pomóc w diagnozowaniu problemów. Aplikacja może skonfigurować rejestrowanie przy użyciu kilku wierszy kodu i mieć niestandardową kontrolę nad poziomem szczegółowości oraz informacją, czy są rejestrowane dane osobiste i organizacyjne. Zalecamy utworzenie implementacji rejestrowania dla biblioteki MSAL oraz umożliwienie użytkownikom przesyłania dzienników w razie problemów z uwierzytelnianiem.

Poziomy rejestrowania

Biblioteka MSAL udostępnia kilka poziomów szczegółów rejestrowania:

• LogAlways: filtrowanie poziomu nie jest stosowane dla tego poziomu dziennika. Komunikaty dziennika wszystkich poziomów zostaną zarejestrowane.
• Krytyczne: dzienniki, które opisują nieodwracalną awarię aplikacji lub systemu albo katastrofalną awarię, która wymaga natychmiastowej uwagi.
• Błąd: wskazuje, że wystąpił problem i został wygenerowany błąd. Służy do debugowania i identyfikowania problemów.
• Ostrzeżenie: Niekoniecznie wystąpił błąd lub awaria, ale ostrzeżenie jest przeznaczone do diagnostyki i identyfikacji problemów.
• Informacje: biblioteka MSAL będzie rejestrować zdarzenia przeznaczone do celów informacyjnych, a niekoniecznie do debugowania.
• Pełne (ustawienie domyślne): biblioteka MSAL rejestruje pełne szczegóły działania.

Uwaga

Nie wszystkie poziomy dziennika są dostępne dla wszystkich zestawów MSAL SDK

Dane osobowe i organizacyjne

Domyślnie logger MSAL nie przechwytuje żadnych wysoce poufnych danych osobowych ani organizacyjnych. Biblioteka udostępnia opcję włączania rejestrowania danych osobistych i organizacyjnych, jeśli zdecydujesz się to zrobić.

Poniższe sekcje zawierają więcej szczegółowych informacji na temat rejestrowania błędów biblioteki MSAL dla aplikacji.

Rejestrowanie w MSAL na Androida za pomocą Javy

Włącz rejestrowanie podczas tworzenia aplikacji, tworząc wywołanie zwrotne rejestrowania. Wywołanie zwrotne przyjmuje następujące parametry:

• tag jest ciągiem przekazywanym do wywołania zwrotnego przez bibliotekę. Jest to skojarzone z wpisem dziennika i może służyć do sortowania komunikatów dziennika.
• logLevel Umożliwia podjęcie decyzji o żądanym poziomie rejestrowania. Obsługiwane poziomy dziennika to: Error, , WarningInfoi Verbose.
• message to zawartość wpisu dziennika.
• containsPII określa, czy komunikaty zawierające dane osobowe, czy dane organizacyjne są rejestrowane. Domyślnie jest to wartość false, aby aplikacja nie rejestrowała danych osobowych. Jeśli containsPII jest true, ta metoda będzie otrzymywać komunikaty dwa razy: raz z parametrem containsPII ustawionym na false i message bez danych osobowych, a drugi raz z parametrem containsPii ustawionym na true, przy czym komunikat może zawierać dane osobowe. W niektórych przypadkach (jeśli wiadomość nie zawiera danych osobowych), wiadomość będzie taka sama.

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');
   }
});

Domyślnie rejestrator biblioteki MSAL nie przechwytuje żadnych danych osobowych ani informacji umożliwiających identyfikację organizacji. Aby włączyć rejestrowanie danych osobowych lub informacji umożliwiających identyfikację organizacji:

Logger.getInstance().setEnablePII(true);

Aby wyłączyć rejestrowanie danych osobowych i danych organizacji:

Logger.getInstance().setEnablePII(false);

Domyślnie rejestrowanie w usłudze Logcat jest wyłączone. Aby włączyć:

Logger.getInstance().setEnableLogcatLog(true);

Następne kroki

Aby uzyskać więcej przykładów kodu, zapoznaj się z przykładami kodu Platforma tożsamości Microsoft.