Aplikacja IBM® Enterprise Records zawiera przykładowy plik log4j.properties, który można skonfigurować.
Plik log4j.properties znajduje się w folderze ścieżka_instalacji_ier\ RecordsManagerSweep i można skonfigurować rejestrowanie poprzez określenie w pliku wartości dla następujących opcji:
Do każdego programu rejestrującego w pliku log4j.properties przypisany jest poziom. Jeśli poziom nie zostanie przypisany do programu rejestrującego, wówczas plik log4j automatycznie przypisze poziom nadrzędnego programu rejestrującego do nieprzypisanego programu rejestrującego. Domyślnie do programu rejestrującego przypisywany jest poziom OSTRZEŻENIE.
W pliku log4j.properties można skonfigurować różne ustawienia dla programu rejestrującego, programu dołączającego i układu. W czasie wykonywania plik log4j.properties musi być dostępny dla aplikacji ze ścieżki klasy. Aby przekształcić w komentarz wpisy w pliku przykładowym, należy poprzedzić odpowiednie instrukcje symbolem krzyżyka (#); wpisy oznaczone symbolem krzyżyka (#) nie będą wykonywane w czasie wykonywania.
Aby otworzyć plik log4j.properties, przejdź do folderu ścieżka_instalacji_ier\RecordsManagerSweep, a następnie otwórz plik w edytorze tekstu.
Najpierw należy ustawić program rejestrujący. Można posługiwać się wieloma programami rejestrującymi w celu klasyfikowania typu rejestrowania wymaganego dla aplikacji. W celu włączenia rejestrowania dla wszystkich klas com.filenet.rm i pakietów podrzędnych określ program rejestrujący w sposób określony w następującej instrukcji:
log4j.logger.com.filenet.rmor
Dla programu rejestrującego można określić dowolną nazwę. Na przykład: program rejestrujący można nazwać APILOG, jak w instrukcji:
log4j.logger.com.filenet.rm=warn, APILOG
Należy ustawić poziom rejestrowania w celu określenia poziomu szczegółów komunikatów rejestrowanych przez log4j w czasie wykonywania. log4j obsługuje pięć normalnych poziomów rejestrowania, co przedstawiono w tabeli poniżej.
Poziom | Opis |
---|---|
DEBUG | Przeznaczony dla mniejszych zdarzeń informacyjnych, które są najbardziej użyteczne w celu debugowania aplikacji. |
INFO | Przeznaczony dla komunikatów informacyjnych, które wyróżniają postęp aplikacji na niższym poziomie rozdrobnienia. |
WARN | Przeznaczony dla sytuacji potencjalnie szkodliwych. |
ERROR | Przeznaczony dla zdarzeń błędów, które mogą zezwalać na dalsze działanie aplikacji. |
FATAL | Przeznaczony dla bardzo poważnych zdarzeń błędów, które mogą prowadzić do przerwania działania aplikacji. |
Informacje na temat specjalnych i niestandardowych poziomów rejestrowania zawiera dokumentacja log4j w serwisie WWW Apache. Domyślnie aplikacja jest uruchamiana na poziomie WARN. Ten poziom można w czasie wykonywania zmodyfikować na poziom DEBUG, INFO, ERROR, WARN lub FATAL. Do pliku można również dołączyć kilka instrukcji logger - każda może dotyczyć tego samego programu rejestrującego, ale na różnych poziomach (np. DEBUG dla jednego, a WARN dla innego). Aby przekształcić w komentarz wpisy w pliku przykładowym, należy poprzedzić instrukcję symbolem krzyżyka (#), a następnie przełączyć - odpowiednio do potrzeb - na poziom DEBUG lub WARN. Wpisy oznaczone symbolem krzyżyka (#) nie będą wykonywane w czasie wykonywania. Program rejestrujący, dla którego nie określono poziomu, automatycznie dziedziczy poziom nadrzędnego programu rejestrującego. Domyślnie do programu rejestrującego RM API w programie IBM Enterprise Records przypisywany jest poziom WARN.
Program rejestrujący jest powiązany z jednym lub większą liczbą programów dołączających, dzięki czemu jego komunikaty rejestrowania mogą być zapisywane na nośnikach wyjściowych. W pliku log4j.properties można ustawić różne rodzaje programów dołączających, które wysyłają informacje dot. rejestrowania do określonej lokalizacji wyjściowej. Poniższa tabela zawiera listę wszystkich programów dołączających, które są używane w pliku log4j.properties, a także krótkie opisy i powiązane opcje.
Program dołączający | Opis i fragmenty kodu |
---|---|
NTEventLogAppender | Dołącza do dziennika zdarzeń Microsoft Windows NT. Ten program dołączający może być instalowany i używany tylko w systemie Windows. log4j.appender.APILOG=org.apache.log4j.nt.NTEventLogAppender |
ConsoleAppender | Dołącza komunikaty rejestrowania do strumienia System.out (domyślnie) lub System.err, wykorzystując układ określony przez użytkownika. log4j.appender.APILOG=org.apache.log4j.ConsoleAppender Opcje:
|
FileAppender | Dołącza komunikaty rejestrowania do pliku. log4j.appender.APILOG=org.apache.log4j.FileAppender Opcje:
|
RollingFileAppender | Rozszerza zakres działania programu FileAppender w celu tworzenia kopii zapasowych plików dziennika, gdy pliki osiągną wybraną wielkość. log4j.appender.APILOG=org.apache.log4j.RollingFileAppender Opcje:
|
W pliku log4j.properties można ustawić różne układy, które określają format komunikatu dziennika. Można określić, że komunikaty rejestrowania określają datę, godzinę, nazwę modułu, nazwę wątku itp. Te ustawienia konfiguracji są wykorzystywane w czasie wykonywania podczas rejestrowania komunikatu.
Poniższa tabela zawiera listę wszystkich układów używanych w pliku log4j.properties produktu IBM Enterprise Records wraz z krótkimi opisami i opcjami.
Układ | Opis i fragment kod |
---|---|
SimpleLayout | Powoduje wyświetlenie poziomu, myślnika (-), a następnie tekstu komunikatu rejestrowania. org.apache.log4j.SimpleLayout |
PatternLayout | Formatuje zdarzenia rejestrowania zgodnie z określonym wzorcem konwersji. Wzorce konwersji zawierają tekst literałowy i specyfikatory konwersji. Tekst literałowy jest prezentowany na wyjściu w takim stanie, w jakim się znajduje. Specyfikatory konwersji zawierają znak %, po którym następuje opcjonalny modyfikator formatu i obowiązkowy znak konwersji. Na przykład: %-5p [%t]: %m%n to wzorzec konwersji obejmujący priorytet (znany również jako poziom), specyfikator konwersji, po którym następuje tekst literałowy " [", po którym następuje specyfikator konwersji wątku, po którym następuje tekst literałowy "]: ", po którym następuje specyfikator konwersji i zależny od systemu separator wiersza. org.apache.log4j.PatternLayout Opcje:
|
HTMLLayout | Formatuje dane wyjściowe jako tabelę HTML. org.apache.log4j.HTMLLayout Opcje:
|
Formatuje dane wyjściowe jako XTML. org.apache.log4j.xml.XMLLayout Opcje:
|
Plik log4j.properties dostarczany z produktem IBM Enterprise Records wykorzystuje PatternLayout dla formatu komunikatu rejestrowania. Poniższa tabela zawiera listę wzorców konwersji, które można zadeklarować w pliku konfiguracyjnym, wraz z krótkimi opisami:
Wzorzec | Opis |
---|---|
%t | Nazwa wątku, od którego pochodzi żądanie rejestrowania |
%c | Nazwa programu rejestrującego powiązanego z żądaniem rejestrowania |
%-60c | Wyrównanie nazwy programu rejestrującego do lewej z co najmniej 60 miejscami |
%r | Liczba milisekund, jaka upłynęła od czasu uruchomienia aplikacji |
%p | Poziom instrukcji rejestrowania |
%m | Komunikat |
%Time | Czas, w jakim dochodzi do rejestrowania |
%d | Data zdarzenia rejestrowania |
%n | Nowy wiersz |
Poniższa instrukcja kodu przedstawia sposób włączania PatternLayout i określania prostego wzorca konwersji:
log4j.appender.APILOG.layout=org.apache.log4j.PatternLayout log4j.appender.APILOG.layout.ConversionPattern=%-5p %d {dd MMM yyyy HH:mm:ss,SSS}, -%m, %r, [%M] % n
Na przykład:
WARN, 20 Jun 2005 14:48:20,900, -[enter] getObjectStoreXML(ObjectStores), 102042, [setLoggerMessage] WARN, 20 Jun 2005 14:48:21,100, -[exit] getObjectStoreXML(ObjectStores), 102342, [setLoggerMessage]