Aplikacja IBM® FileNet Workplace XT korzysta z produktu Apache log4j w celu zarządzania rejestrowaniem. W trakcie rejestrowania informacje dotyczące aplikacji są zapisywane w lokalizacjach wyjściowych, takich jak konsola czy pliki. Pracownicy działu wsparcia oraz programiści korzystają z informacji zawartych w pozycjach dziennika do analizowania aktywności aplikacji oraz do diagnostyki i rozwiązywania problemów. Rejestrowanie służy wyłącznie do celów diagnostycznych i nie zapewnia zabezpieczeń ani zapisów kontrolnych.
Produkt log4j jest instalowany w trakcie instalowania aplikacji Workplace XT. Domyślnie rejestrowanie nie jest włączone podczas instalacji.
Aby włączyć lub wyłączyć rejestrowanie:
Skonfiguruj ustawienia rejestrowania
Przykładowy plik log4j.properties zawiera zestaw opcji domyślnych, określonych parami słowo_kluczowe=wartość. Aby zmienić wartości domyślne, otwórz plik log4j.properties w edytorze tekstu, zmodyfikuj go odpowiednio do potrzeb i zapisz. Możesz skonfigurować ustawienia rejestrowania w dowolnej chwili po zakończeniu instalowania. Dokonane w pliku konfiguracji rejestrowania zmiany są rozpoznawane automatycznie nie musisz restartować aplikacji ani serwera aplikacji.
W poniższych tematach udostępniono pewne informacje na temat niektórych opcji konfiguracji widocznych w pliku. Więcej informacji na temat opcji rejestrowania można znaleźć w serwisie WWW serwera Apache (http://apache.org), wybierając opcje Logging Project (Projekt - rejestrowanie) oraz serwis WWW rejestrowania serwera Apache (http://logging.apache.org/log4j/).
Program rejestrujący
Program rejestrujący zapisuje aktywne żądania rejestrowania do programów dołączających. W pliku log4j.properties pierwsze słowo kluczowe opisuje główny program rejestrujący. Główny program rejestrujący to program rejestrujący najwyższego poziomu w hierarchii dostarczający globalnych ustawień domyślnych wszelkie podrzędne programy rejestrujące nie mające jawnie ustawionych opcji dziedziczą zachowanie z głównego programu rejestrującego.
Program dołączający
Istnieje możliwość określenia, gdzie zapisywane są dane dziennika, przez skonfigurowanie programu dołączającego, wysyłającego sformatowane pozycje dziennika do określonej lokalizacji docelowej. Typem miejsca docelowego może być plik lub konsola; dane wyjściowe mogą być przekierowywane do dziennika zdarzeń systemu Windows, przekazywane na zdalny serwer log4j, itd. (Wszystkie opcje formatowania oraz miejsc docelowych wymieniono w dokumentacji produktu Apache log4j.) Pojedynczy program rejestrujący może mieć jeden lub więcej programów dołączających. Można na przykład zapisać dane wyjściowe jednocześnie w konsoli oraz w pliku. Zwiększenie liczby miejsc docelowych może jednak wpłynąć na wydajność.
W aplikacji Workplace XT domyślnie są skonfigurowane dwa programy dołączające. Jeden program dołączający zapisuje dane dziennika w formacie IBM Common Base Event (CBE), używanym przez narzędzia IBM Support Assistant do przetwarzania dziennika, zaś drugi program dołączający zapisuje w formacie bardziej czytelnym dla ludzi. Istnieje możliwość zmiany programu dołączającego w późniejszym czasie w celu zredukowania ilości danych wyjściowych; można także zupełnie wyłączyć ten program dołączający.
Poziom
Poziom rejestrowania określony przez użytkownika determinuje typ i ilość gromadzonych informacji. Między liczbą zgromadzonych informacji a wpływem na działanie systemu istnieje bezpośrednia korelacja.
Dziennik aplikacji Workplace XT obsługuje standardowe poziomy INFO, WARN, ERROR i FATAL, a także poziomy ALL i OFF. W poniższej tabeli pokrótce opisano standardowe poziomy; więcej informacji na ich temat zawiera dokumentacja produktu Apache log4j.
Poziom | Opis |
---|---|
INFO | Wymusza komunikaty informacyjne, opisujące postęp działania aplikacji na poziomie ogólnym. |
WARN | Wymusza rejestrowanie sytuacji potencjalnie szkodliwych. |
ERROR | Wymusza rejestrowanie wyjątków zgłaszanych w aplikacji. |
FATAL | Wymusza rejestrowanie wyłącznie bardzo poważnych błędów, które mogłyby prowadzić do awarii aplikacji. |
Poziom określony przez użytkownika determinuje ilość gromadzonych informacji. Między liczbą zgromadzonych informacji a wpływem na działanie systemu istnieje bezpośrednia korelacja.
Format pliku wyjściowego
Podczas konfigurowania programu dołączającego możesz użyć słowa kluczowego układu w celu określenia formatu zapisu danych. Wybierz opcje PatternLayout i ConversionPattern. PatternLayout określa konkretny wzorzec pozycji dziennika, zaś ConversionPattern, identyfikująca wzorzec elementów zapisywanych w programie dołączającym definiuje wzorzec. Rozważmy następujący przykład:
log4j.appender.ErrorOutputFile=org.apache.log4j.RollingFileAppender log4j.appender.ErrorOutputFile.layout=org.apache.log4j.PatternLayout log4j.appender.ErrorOutputFile.layout.ConversionPattern=%d [%t] - %-5p %m\r\n
skutkuje następującą sformatowaną pozycją dziennika:
2007-05-31 17:36:12:801 [cwrap] - Document/Checkin ConnectionWrapper.send send.before
Więcej informacji na temat opcji formatowania zawiera dokumentacja Apache log4j.
Przeanalizuj dane wyjściowe
Pracownicy działu wsparcia mogą zbadać pozycje pliku dziennika w celu przeanalizowania aktywności aplikacji oraz zdiagnozowania problemów w niej występujących. Ponadto użycie narzędzi IBM Support Assistant (ISA) automatyzuje fazę analizy. Narzędzia ISA korzystają z pozycji CBE w danych wyjściowych rejestrowania produktu log4j.
Możesz również skorzystać z narzędzia takiego jak Apache Chainsaw, przeglądarki dzienników opartej na interfejsie GUI, w celu samodzielnego zbadania pozycji dziennika innych niż CBE.