Logowanie zdarzeń

FoxIDs domyślnie rejestruje ostrzeżenia, błędy, błędy krytyczne i zdarzenia. Wpisy w dzienniku zawierają sygnaturę czasową oraz odpowiedni kontekst żądania lub tożsamości, taki jak adres IP klienta, o ile jest dostępny. W celu diagnostyki można włączyć dodatkowe ślady i metryki dla poszczególnych środowisk.

Rozwiązywanie problemów z błędami w przeglądarce

Strona błędu w przeglądarce pokazuje ogólny komunikat w przypadku nieoczekiwanych błędów, wraz z czasem i identyfikatorem operacji, jeśli jest dostępny. Jeśli można zidentyfikować sekwencję logowania lub czynności na koncie, strona pokazuje również jej identyfikator. Użyj identyfikatora operacji, aby znaleźć nieudane żądanie, a identyfikatora sekwencji, aby śledzić powiązane operacje w dziennikach w FoxIDs Control lub w skonfigurowanym miejscu docelowym logów. Znane sytuacje, z których można odzyskać poprawne działanie, takie jak przekroczenie limitu czasu logowania, mogą wyświetlać szczegółowe wskazówki i możliwość ponowienia próby. Jeśli funkcja nie jest dostępna w bieżącym planie, strona pokazuje nazwę planu i wskazówki dotyczące przejścia na wyższy plan. Procesy dotyczące konta mogą również dostarczać konkretny, zlokalizowany komunikat interfejsu, na przykład o brakującym numerze telefonu wymaganym do uwierzytelniania dwuskładnikowego.

Techniczne komunikaty wyjątków, ślady stosu i dane diagnostyczne konektora nie są wyświetlane na ogólnej stronie błędu w żadnym środowisku hostingu. Jeśli sama obsługa błędów zawiedzie, strona awaryjna również pozostawia szczegóły techniczne w dziennikach. Przeglądaj dzienniki diagnostyczne wyłącznie z autoryzowanym dostępem administratora; nie udostępniaj ich treści nieuwierzytelnionemu podmiotowi wywołującemu.

Miejsca docelowe logów

Ustaw miejsce docelowe logów za pomocą polecenia Settings__Options__Log. Polecenie FoxIDs obsługuje trzy opcje:

• Stdout zapisuje logi w wyjściu konsoli. Rozwiązanie to nadaje się do niewielkich wdrożeń typu Docker i Kubernetes, w których platforma hostingowa gromadzi logi konsoli.
• OpenSearchAndStdoutErrors zapisuje logi z możliwością wyszukiwania w usłudze OpenSearch, a także zapisuje błędy w wyjściu konsoli. Jest to rozwiązanie powszechnie stosowane we wdrożeniach typu Kubernetes.
• ApplicationInsights wysyła logi z możliwością wyszukiwania do usługi Azure Application Insights. Jest to rozwiązanie powszechnie stosowane we wdrożeniach w środowisku Azure.

FoxIDs Control może przeszukiwać logi oraz dane dotyczące użytkowania i audytu, jeśli skonfigurowano opcję OpenSearchAndStdoutErrors lub ApplicationInsights. W przypadku opcji Stdout należy korzystać z funkcji logowania udostępnianych przez platformę hostingową.

Format stdout i minimalny poziom

FoxIDs używa standardowej konfiguracji rejestrowania .NET Console w sekcji Logging:Console dla danych wyjściowych zapisywanych do stdout. Używany jest prosty formater tekstowy, chyba że skonfigurowano inny. Dostarczone wdrożenie Kubernetes wybiera formater JSON, dzięki czemu każdy wpis logu może być zbierany jako pojedynczy wiersz danych strukturalnych.

W przypadku formatera JSON tekst logu jest zapisywany w Message, właściwości kontekstowe, takie jak RequestId, RequestPath, tenant i środowisko, są zapisywane jako osobne pola w State, a szczegóły wyjątków są zapisywane w Exception. Metryki zawierają również liczbową wartość State.Value. Wpisy JSON domyślnie używają znaczników czasu UTC w formacie yyyy-MM-ddTHH:mm:ss.fffZ. Prosty formater zachowuje wielowierszową reprezentację tekstową.

Ustaw formater JSON za pomocą zmiennej środowiskowej:

Logging__Console__FormatterName=json

Domyślne wartości znacznika czasu można zastąpić za pomocą standardowych opcji formatera, na przykład:

Logging__Console__FormatterOptions__TimestampFormat=yyyy-MM-ddTHH:mm:ssZ
Logging__Console__FormatterOptions__UseUtcTimestamp=true

Minimalny poziom rejestrowania Console to domyślnie Trace, co zachowuje wszystkie typy logów włączone w ustawieniach logowania środowiska FoxIDs. Minimalny poziom można zwiększyć niezależnie dla każdego wdrożenia, na przykład:

Logging__Console__LogLevel__Default=Information

Minimalny poziom wpływa na dane wyjściowe stdout w następujący sposób:

Minimalny poziom rejestrowania Console jest dodatkowym filtrem. Nie włącza śladów ani metryk wyłączonych w ustawieniach logowania środowiska.

Logi w FoxIDs Control

Otwórz Dzienniki w FoxIDs Control Client, aby przełączać się między dziennikami operacyjnymi, dziennikami użytkowania, zapisami audytowymi oraz ustawieniami dzienników środowiska.

Logi

Zakładka Logi umożliwia przeszukiwanie wpisów w logach operacyjnych. Wybierz zakres czasowy i typy logów, a opcjonalnie wprowadź tekst wyszukiwania, aby zawęzić wyniki. Domyślnie zaznaczone są błędy i ostrzeżenia. W standardowym środowisku domyślnie zaznaczone są również zdarzenia, natomiast ślady i metryki są dostępne, jeśli zostały włączone w ustawieniach logów środowiska.

Żądania odrzucone przed przekierowaniem do tenanta i środowiska są klasyfikowane jako odrzucone żądania i wykluczane ze zwykłych zdarzeń. W tenancie głównym wybierz odrzucone żądania, aby zbadać je według ścieżki żądania, metody HTTP i dostępnego kontekstu żądania. Odrzucone żądania nie są dostępne w innych tenantach.

Powiązane wpisy są pogrupowane według sekwencji i operacji, dzięki czemu można prześledzić przebieg procesu uwierzytelniania lub żądania oraz sprawdzić związane z nim zdarzenia, właściwości kontekstowe i wyjątki.

Użycie

Zakładka Użycie zawiera podsumowanie aktywności dla wybranego zakresu czasowego i interwału. Można uwzględnić metody uwierzytelniania, użytkowników, logowania, żądania tokenów, dodatkowe operacje oraz wywołania Control API.

Wybrany zakres administracji określa, które zastosowania są wyświetlane:

• W środowisku standardowym wynik zawiera dane dotyczące wykorzystania w tym środowisku.
• W środowisku głównym dzierżawcy wynik zawiera dane dotyczące wykorzystania dla całego dzierżawcy i można go ograniczyć do konkretnego środowiska.
• W środowisku głównym dzierżawcy głównego wynik zawiera dane dotyczące wykorzystania dla całego wdrożenia platformy FoxIDs i można go ograniczyć do konkretnego dzierżawcy i środowiska.

Dzienniki audytowe

Zakładka Audyt rejestruje istotną dla bezpieczeństwa aktywność użytkowników i zmiany administracyjne. Wyszukiwanie w dziennikach audytowych jest dostępne z OpenSearchAndStdoutErrors oraz ApplicationInsights; nie jest dostępne, gdy miejscem docelowym dziennika jest Stdout.

Wybierz zakres czasu do siedmiu dni i opcjonalnie wprowadź tekst wyszukiwania. Wyszukiwanie zwraca maksymalnie 300 najnowszych pasujących wpisów i wyświetla ostrzeżenie, gdy wynik został skrócony. Tekst jest dopasowywany do nazwy zdarzenia, typu audytu, akcji, identyfikatorów użytkownika, metody uwierzytelniania, identyfikatora rejestracji lub dokumentu, dzierżawy, środowiska i zmienionych danych.

Wpisy audytowe mają następujące typy:

Każdy wpis zawiera typ audytu i dostępny kontekst. Aktywność użytkownika może obejmować identyfikator użytkownika, adres e-mail, numer telefonu, nazwę użytkownika, identyfikator sesji i metodę uwierzytelniania. Rejestrowane są tylko identyfikatory dostępne w oświadczeniach logowania lub sesji. Rejestracja aplikacji uwierzytelniającej zawiera również jej RegistrationId.

Dla wpisu Data pole DataType określa rodzaj danych konfiguracyjnych, DocumentId wskazuje element, którego dotyczy zmiana, a Action ma wartość Create, Update, Save lub Delete. Sformatowane dane JSON pokazują zmienione wartości wraz z wartościami before i after, gdy ma to zastosowanie. Poufne właściwości, takie jak sekrety, skróty, wartości nonce i klucze, są maskowane.

Wybrany zakres administracyjny określa, które wpisy audytowe można przeszukiwać:

• W zwykłym środowisku wynik zawiera wpisy dla tego środowiska.
• W środowisku głównym dzierżawy wynik zawiera wpisy dla tej dzierżawy i można go ograniczyć do konkretnego środowiska.
• W środowisku głównym dzierżawy głównej wynik zawiera wpisy dla całej instalacji FoxIDs i można go ograniczyć do dzierżawy i środowiska.

Ustawienia logów

Otwórz Logs > Settings, aby skonfigurować poziom szczegółowości danych diagnostycznych rejestrowanych dla wybranego środowiska:

• Ślad informacji logowania rejestruje szczegóły dotyczące sekwencji logowania i wylogowania.
• Ślad oświadczeń rejestruje oświadczenia otrzymane oraz przekazane lub wydane przez metody uwierzytelniania i rejestracje aplikacji.
• Ślad komunikatów rejestruje surowe komunikaty protokołu otrzymane i wysłane.
• Metryka rejestruje czasy odpowiedzi i przepustowość.

Ostrzeżenia, błędy, błędy krytyczne i zdarzenia są nadal rejestrowane niezależnie od tych ustawień.

Ślady oświadczeń i komunikatów mogą zawierać dane osobowe, tokeny oraz inne poufne treści protokołów. Należy je włączać wyłącznie wtedy, gdy jest to konieczne do celów diagnostycznych, ograniczyć dostęp do magazynu logów oraz zastosować odpowiedni okres przechowywania.

Strumień logów

Strumień dzienników przekazuje wybrane typy dzienników do zewnętrznego repozytorium niezależnie od skonfigurowanego głównego miejsca docelowego dzienników. Na przykład dodaj strumień dzienników Application Insights w usłudze Azure i wybierz typy dzienników, które mają być wysyłane do serwisu FoxIDs.

Powiązana dokumentacja

• Zapytaj o dzienniki, audyt i użycie za pomocą Control API- Monitorowanie i sprawdzanie stanu
• FoxIDs Control Client i API
• Wdrożenie w Kubernetes
• Wdrożenie w Azure
• Transformacje oświadczeń i śledzenie diagnostyczne oświadczeń