IBM Enterprise Records, verzia 5.1.2    

Konfigurácia súboru log4j.properties

Aplikácia IBM® Enterprise Records zahŕňa vzorový súbor log4j.properties, ktorý môžete nakonfigurovať.

Súbor log4j.properties je v priečinku ier_install_path\ RecordsManagerSweep a môžete nakonfigurovať správanie protokolovania špecifikáciou hodnôt v tomto súbore pre nasledujúce vlastnosti:

Každému zapisovaču v súbore log4j.properties je priradená úroveň. Ak nepriradíte úroveň zapisovaču, log4j automaticky priradí nepriradenému zapisovaču úroveň rodičovského zapisovača. Štandardne je zapisovaču priradená úroveň WARN.

Súbor log4j.properties môžete nakonfigurovať s rôznymi nastaveniami zapisovača, pripájača a rozloženia. Súbor log4j.properties musí byť dostupný pre aplikáciu v čase vykonávania z cesty triedy. Záznamy vo vzorovom súbore môžete označiť za komentár, keď pred príkaz pridáte symbol mriežky (#). Záznamy označené symbolom mriežky (#) budú v čase vykonávania preskočené.

Na otvorenie súboru log4j.properties choďte do priečinka ier_install_path\RecordsManagerSweep, potom otvorte súbor pomocou textového editora.

Nastavenie zapisovača a úrovne protokolovania

Najskôr musíte nastaviť zapisovač. Môžete mať viacero zapisovačov na klasifikáciu typu protokolovania, ktoré potrebujete pre aplikáciu. Na povolenie protokolovania pre všetky triedy com.filenet.rm a jeho podbalíky, špecifikujte zapisovač ako je ukázané v nasledujúcom príkaze:

log4j.logger.com.filenet.rm 

Alebo môžete špecifikovať ľubovoľné meno pre zapisovač. Napríklad môžete pomenovať váš zapisovač APILOG ako je ukázané v nasledujúcom príkaze:

log4j.logger.com.filenet.rm=warn, APILOG

Musíte nastaviť úroveň protokolovania na vytvorenie detailnej úrovne správ, ktoré zaznamenáva log4j v čase vykonávania. log4j podporuje päť normálnych úrovní protokolovania ako ukazuje nasledujúca tabuľka:

Tabuľka 1. Úroveň správ, ktoré zaznamenáva log4j v čase vykonávania
Úroveň Popis
DEBUG Označuje jemnozrnné informačné udalosti, ktoré sú najužitočnejšie na ladenie aplikácie.
INFO Označuje informačné správy, ktoré zvýrazňujú postup aplikácie na hrubozrnnej úrovni.
WARN Označuje potenciálne škodlivé situácie.
ERROR Označuje chybové udalosti, ktoré stále umožňujú aplikácii pokračovať v chode.
FATAL Označuje udalosti závažných chýb, ktoré môžu spôsobiť zastavenie chodu aplikácie.

Pozrite si dokumentáciu log4j na webovej stránke Apache pre informácie o špeciálnych a vlastných úrovniach protokolovania. Aplikácia štandardne začína v úrovni WARN. Túto úroveň možno v čase vykonávania upraviť na úroveň DEBUG, INFO, ERROR, WARN alebo FATAL. Môžete tiež zahrnúť viaceré príkazy zapisovača, každý pre rovnaký zapisovač, ale s odlišnými úrovňami (napríklad DEBUG pre jednu, WARN pre druhú). Jednu alebo druhú môžete okomentovať vo vzorovom súbore tak, že pred príkaz napíšete symbol mriežky (#). Potom sa môžete v prípade potreby prepínať medzi úrovňami DEBUG a WARN. Záznamy označené symbolom mriežky (#) budú v čase vykonávania preskočené. Zapisovač, ktorý nemá úroveň, automaticky zdedí úroveň jeho rodičovského zapisovača. Zapisovač API má v IBM Enterprise Records štandardne priradenú úroveň WARN.

Nastavenie pripájačov

Zapisovač je priradený k jednému alebo viacerým pripájačom, čo umožňuje, aby boli jeho správy protokolu zapisované do výstupného média. Môžete nastaviť rôzne druhy pripájačov v súbore log4j.properties, ktorý posiela protokolové informácie do špecifikovanej výstupnej lokality. Nasledujúca tabuľka poskytuje zoznam všetkých pripájačov, ktoré sa používajú v súbore log4j.properties spolu so stručnými popismi a súvisiacimi voľbami.

Tabuľka 2. Pripájače, popisy a kódové fragmenty
Pripájač Popis a kódové fragmenty
NTEventLogAppender

Pripája sa k protokolu udalostí Microsoft Windows NT. Tento pripájač možno nainštalovať a používať len na systéme Windows.

log4j.appender.APILOG=org.apache.log4j.nt.NTEventLogAppender
ConsoleAppender

Pripája správy protokolu k toku System.out (predvolené) alebo System.err pomocou rozloženia špecifikovaného užívateľom.

 log4j.appender.APILOG=org.apache.log4j.ConsoleAppender

Voľby:

  • Threshold=WARN: Tento pripájač neprotokoluje žiadne správy s prioritou menšou ako je tu určená priorita, aj keď je táto priorita nastavená na nižšiu úroveň. Toto nastavenie je užitočné pri znižovaní počtu správ, napríklad v protokolovom súbore, pričom sú všetky správy zobrazené na konzole.
  • ImmediateFlush=true: Predvolené nastavenie je true, významné protokolové správy nebudú vôbec ukladané do vyrovnávacej pamäte. Ak je ImmdiateFlush nastavené na hodnotu false, v prípade výskytu problémov v aplikácii nebude niekoľko posledných udalostí protokolu zapísaných na stále médium.
FileAppender

Pripája správy protokolu do súboru.

 log4j.appender.APILOG=org.apache.log4j.FileAppender

Voľby:

  • Threshold=WARN: Tento pripájač neprotokoluje žiadne správy s prioritou menšou ako je tu určená priorita, aj keď je táto priorita nastavená na nižšiu úroveň. Toto nastavenie je užitočné pri znižovaní počtu správ, napríklad v protokolovom súbore, pričom sú všetky správy zobrazené na konzole.
  • ImmediateFlush=true: Nastavenie na hodnotu true zvyčajne znamená, že správy protokolu nebudú vôbec ukladané do vyrovnávacej pamäte. Ak je ImmdiateFlush nastavené na hodnotu false, v prípade výskytu problémov v aplikácii nebude niekoľko posledných udalostí protokolu zapísaných na stále médium.
  • File=mylog.txt: Názov súboru, do ktorého protokolovať. Môžete použiť ${some_property_key} (napríklad systémové vlastnosti java.home alebo user.home) na špecifikáciu cesty.
  • Append=false: Štandardne je nastavené na true, čo znamená pripojiť na koniec súboru. False prepíše súbor pri začiatku každého spúšťania programu.
RollingFileAppender

Rozširuje FileAppender na zálohovanie protokolových súborov, keď dosiahnu určitú veľkosť.

 log4j.appender.APILOG=org.apache.log4j.RollingFileAppender

Voľby:

  • Threshold=INFO: Tento pripájač neprotokoluje žiadne správy s prioritou menšou ako je tu určená priorita, aj keď je táto priorita nastavená na nižšiu úroveň. Toto nastavenie je užitočné pri znižovaní počtu správ, napríklad v protokolovom súbore, pričom sú všetky správy zobrazené na konzole.
  • ImmediateFlush=true: Nastavenie na hodnotu true zvyčajne znamená, že správy protokolu nebudú vôbec ukladané do vyrovnávacej pamäte. Ak je ImmdiateFlush nastavené na hodnotu false, v prípade výskytu problémov v aplikácii nebude niekoľko posledných udalostí protokolu zapísaných na stále médium.
  • File=mylog.txt: Názov súboru, do ktorého protokolovať. Môžete použiť ${some_property_key} (napríklad systémové vlastnosti java.home alebo user.home) na špecifikáciu cesty vopred.
  • Append=false: Štandardne je nastavené na true, čo znamená pripojiť na koniec súboru. False prepíše súbor pri začiatku každého spúšťania programu.
  • MaxFileSize=100 KB: Prípony môžu byť KB, MB alebo GB. Rolovať protokolový súbor, keď je dosiahnutá táto veľkosť. Pripojenie zoberie booleovskú hodnotu, ktorá určuje, či budú výstupné súbory prepísané (false) alebo do nich pripojené (true). Nastavenie hodnoty na false (predvolené) uchráni súbory pre nekonečným zväčšovaním. Použite toto nastavenie vo vývojovom prostredí, kde robíte občasné jednorazové spúšťania. Nastavenie hodnoty na true pripája výstup k existujúcemu protokolovému súboru pri každom spustení JVM. Veľkosť výstupného súboru môžete obmedziť nastavením kľúčového slova MaxFileSize. Napríklad, ak nakonfigurujete výstupný súbor, cjapi_log.txt, s MaxFileSize=128 KB a MaxBackupIndex=1, platí, že keď tento súbor prekročí 128 KB, jeho obsah je automaticky presunutý do súboru cjapi_log.txt.1. Zapisovanie pokračuje do prázdneho súboru cjapi_log.txt.
  • MaxBackupIndex=2: Udržiavať maximálne 2 (napríklad) záložné súbory. Vymaže najstaršie súbory. 0 znamená, že nebudú uchovávané záložné súbory.

Nastavenie rozloženia

V súbore log4j.properties môžete nastaviť rôzne rozloženia, ktoré špecifikujú formát správy protokolu. Môžete určiť, že správa protokolu má obsahovať dátum, čas, názov modulu, názov vlákna a ďalšie informácie. Tieto konfiguračné nastavenia sa použijú v čase vykonávania, keď sa protokoluje správa.

Nasledujúca tabuľka poskytuje zoznam všetkých rozložení, ktoré sa používajú v súbore IBM Enterprise Records log4j.properties spolu so stručnými popismi volieb.

Tabuľka 3. Rozloženia a popisy
Rozloženie Popis a kódový fragment
SimpleLayout

Zobrazí úroveň, potom pomlčku (-) a za ňou text správy protokolu.

org.apache.log4j.SimpleLayout
PatternLayout

Formátuje udalosti protokolovania podľa špecifikovaného vzoru konverzie. Vzory konverzie sú zložené z textu literálu a špecifikátorov konverzie. Text literálu je výstup tak ako je. Špecifikátory konverzie sa skladajú zo znaku %, za ktorým nasleduje voliteľný modifikátor formátu a povinný konverzný znak. Napríklad %-5p [%t]: %m%n je vzor konverzie zložený zo špecifikátora konverzie priority, za ktorým nasleduje text literálu " [". Za týmto reťazcom nasleduje špecifikátor konverzie vlákna a za ním text literálu "]: ". Za týmto reťazcom nasleduje špecifikátor konverzie správy a oddeľovač riadka závislý od systému.

org.apache.log4j.PatternLayout

Voľby:

  • ConversionPattern=%-5p, [%t]:%m%n: Ako naformátovať každú správu protokolu (aké informácie zahrnúť).
HTMLLayout

Formátuje výstup ako tabuľku HTML.

org.apache.log4j.HTMLLayout

Voľby:

  • LocationInfo=true: Názov výstupného súboru Java a číslo riadka. Predvoleným nastavením je hodnota false.
  • Title=My app title: Nastavuje tag <title> HTML. Predvoleným nastavením je Log4J Log Messages.
 

Formátuje výstup ako XML.

org.apache.log4j.xml.XMLLayout

Voľby:

  • LocationInfo=true: Názov výstupného súboru Java a číslo riadka. Predvoleným nastavením je hodnota false.

Súbor log4j.properties dodaný s IBM Enterprise Records používa PatternLayout pre formát správy protokolu. Nasledujúca tabuľka poskytuje zoznam vzorov konverzie, ktoré môžu byť deklarované v konfiguračnom súbore spolu s ich stručnými popismi:

Tabuľka 4. Vzory konverzie a popisy
Vzor Popis
%t Názov vlákna, ktoré urobilo požiadavku na protokolovanie
%c Názov zapisovača priradeného k požiadavke protokolovania
%-60c Názov zapisovača zarovnať doľava v rozsahu minimálne 60 odsadení
%r Počet milisekúnd uplynutých od spustenia aplikácie
%p Úroveň príkazu protokolovania
%m Správa
%Time Čas kedy došlo k protokolovaniu
%d Dátum udalosti protokolovania
%n Nový riadok

Nasledujúci kódový príkaz ukazuje ako povoliť PatternLayout a špecifikovať jednoduchý vzor konverzie:

log4j.appender.APILOG.layout=org.apache.log4j.PatternLayout
log4j.appender.APILOG.layout.ConversionPattern=%-5p %d {dd MMM rrrr HH:mm:ss,SSS}, 
-%m, %r, [%M] % n

Napríklad:

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]


Spätná väzba

Posledná aktualizácia: November 2013
configure_rm_logging.htm

© Copyright IBM Corp. 2013