Rejestrowanie w MSAL dla Androida

Aplikacje 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 mechanizmu rejestrowania zdarzeń w bibliotece MSAL oraz zapewnienie użytkownikom możliwości przesyłania logów, gdy wystąpią problemy z uwierzytelnianiem.

Poziomy rejestrowania

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

• LogAlways: Na tym poziomie dziennika nie stosuje się filtrowania. Wiadomości dziennika na wszystkich poziomach będą rejestrowane.
• 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 służą one do diagnostyki i identyfikowania problemów.
• Informacje: biblioteka MSAL będzie rejestrować zdarzenia przeznaczone do celów informacyjnych niekoniecznie przeznaczone do debugowania.
• Pełne (ustawienie domyślne): biblioteka MSAL rejestruje pełne szczegóły zachowania biblioteki.

Note

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

Dane osobowe i organizacyjne

Domyślnie rejestrator MSAL nie rejestruje żadnych szczególnie chronionych danych osobowych ani danych 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.

Logowanie w bibliotece MSAL dla systemu Android przy użyciu Java

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

• tag to łańcuch znaków przekazywany przez bibliotekę do funkcji callback. Jest powiązany z wpisem dziennika i może być używany do sortowania komunikatów dziennika.
• logLevel Umożliwia podjęcie decyzji o żądanym poziomie rejestrowania. Obsługiwane poziomy logowania to: Error, Warning, Info i 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 otrzyma komunikaty dwa razy: raz z parametrem containsPII ustawionym na false oraz z message bez danych osobowych, a po raz drugi z parametrem containsPii ustawionym na true i 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.