IBM Enterprise Records, 5.1.2-es változat    

A log4j.properties fájl beállítása

Az IBM® Enterprise Records alkalmazás tartalmaz egy minta log4j.properties fájlt, melyet konfigurálhat.

A log4j.properties fájl az ier_telepítési_útvonal\ RecordsManagerSweep mappában található, és a fájlban található alábbi tulajdonságok értékének megadásával konfigurálhatja a naplózást:

A log4j.properties fájlban szereplő minden naplózóhoz szint van hozzárendelve. Ha nem rendel szintet egy naplózóhoz, akkor a log4j automatikusan hozzárendeli a szülő naplózó szintjét a hozzá nem rendelt naplózóhoz. Alapértelmezésben a FIGYELMEZTETÉS szint van a naplózókhoz rendelve.

A log4j.properties fájlt a naplózó (Logger), a hozzáfűző (Appender) és az elrendezés (Layout) különböző beállításaival konfigurálhatja. A log4j.properties fájlnak az osztályútvonalon kell rendelkezésre állnia az alkalmazás számára futás közben. A mintafájl bejegyzései megjegyzéssé alakíthatók a bejegyzéshez kettőskereszt (#) előtagot adva. Futás közben a rendszer kihagyja a kettőskereszt (#) szimbólummal jelölt bejegyzéseket.

A log4j.properties fájl megnyitásához nyissa meg az ier_telepítési_útvonal\RecordsManagerSweep mappát, majd nyissa meg a fájlt szövegszerkesztőben.

Naplózó és naplózási szint beállítása

Először meg kell adnia a naplózót. Számos naplózó áll rendelkezésre az alkalmazáshoz szükséges naplózási típus osztályozásához. A com.filenet.rm és alcsomagjai összes osztályának naplózását a következő bejegyzésben módon engedélyezheti:

log4j.logger.com.filenet.rm 

A naplózó számára tetszőleges nevet adhat meg. Például adhatja a naplózónak az APILOG nevet a következő bejegyzésben látható módon:

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

Meg kell adnia a log4j által futás közben rögzített üzenetek részletességi szintjét a naplózási szint megadásával. A log4j öt normál naplózási szintet támogat, ezek az alábbi táblázatban láthatók:

1. Táblázat A log4j által futás közben rögzített üzenetek szintje
Szint Leírás
DEBUG A magas részletességű információs eseményeket gyűjti, melyek leginkább az alkalmazások hibakeresésekor hasznosak.
INFO Azokat az információs üzeneteket gyűjti, melyek kiemelik az alkalmazás előrehaladását egy kevésbé részletes szinten.
WARN A potenciálisan veszélyes helyzetekről tudósít.
ERROR Olyan hibaeseményekről tudósít, amelyek bekövetkezésekor még elképzelhető, hogy az érintett alkalmazás folytatni tudja a futást.
FATAL Az alkalmazás futásának befejezését okozó súlyos hibaeseményekről tudósít.

A speciális s egyéni naplózási szintekről tekintse meg a log4j dokumentációját az Apache webhelyén. Alapértelmezésben az alkalmazás a WARN szinten fut. Ez a szint a DEBUG, INFO, ERROR, WARN és FATAL szintre módosítható futás közben. Megadhat több, naplózóra vonatkozó bejegyzést is, melyek ugyanazon naplózóra, de más szintre (például az egyik a DEBUG, a másik a WARN szintre) vonatkoznak. A mintafájl nem használt bejegyzéseit megjegyzéssé alakíthatja a bejegyzéshez kettőskereszt (#) előtagot adva. Ezután igény szerint válthat a DEBUG és a WARN szint között. Futás közben a rendszer kihagyja a kettőskereszt (#) szimbólummal jelölt bejegyzéseket. A szinttel nem rendelkező naplózók automatikusan szülőjük szintjét öröklik. Alapértelmezésben a WARN szint van hozzárendelve az API-naplózóhoz az IBM Enterprise Records programban.

Hozzáfűzők megadása

A naplózók hozzáfűzőkhöz vannak társítva, melyek lehetővé teszik a naplóüzenetek kimeneti adathordozóra írását. A log4j.properties fájlban különféle hozzáfűzők adhatók meg, melyek a naplóinformációkat a megadott kimenet helyre küldik. A következő táblázatban látható lista a log4j.properties fájlban használt összes hozzáfűzőről, és egy rövid leírás, illetve a kapcsolódó beállítások is olvasható.

2. Táblázat Hozzáfűzők, leírások és töredékek
Hozzáfűző Leírás és kódtöredékek
NTEventLogAppender

A Microsoft Windows NT Eseménynaplóhoz végez hozzáfűzést. Ez a hozzáfűző csak Windows rendszeren telepíthető és használható.

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

A naplóüzeneteket a System.out (alapértelmezés) vagy a System.err adatfolyamhoz fűzi hozzá a felhasználó által megadott elrendezéssel.

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

Beállítások:

  • Threshold=WARN: Ez a hozzáfűző az itt megadottnál kisebb prioritású üzeneteket nem naplózza még akkor sem, ha a prioritás kisebb szintre van beállítva. Ez a beállítás az üzenetek számának csökkentéséhez hasznos, például a fájlnaplókban az összes üzenet megjelenítésekor a konzolon.
  • ImmediateFlush=true: Az alapértelmezett beállítás a true, mely azt jelenti, hogy a naplóüzenetek egyáltalán nem kerülnek a pufferbe. Ha az ImmdiateFlush értéke false, az utolsó néhány naplóesemény nem kerül állandó adathordozóra, amikor a probléma fellép az alkalmazással.
FileAppender

Naplóüzeneteket fűz a fájlhoz.

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

Beállítások:

  • Threshold=WARN: Ez a hozzáfűző az itt megadottnál kisebb prioritású üzeneteket nem naplózza még akkor sem, ha a prioritás kisebb szintre van beállítva. Ez a beállítás az üzenetek számának csökkentéséhez hasznos, például a fájlnaplókban az összes üzenet megjelenítésekor a konzolon.
  • ImmediateFlush=true: Az alapértelmezett beállítás a true, mely azt jelenti, hogy a naplóüzenetek egyáltalán nem kerülnek a pufferbe. Ha az ImmdiateFlush értéke false, az utolsó néhány naplóesemény nem kerül állandó adathordozóra, amikor a probléma fellép az alkalmazással.
  • File=mylog.txt: A naplózáshoz használt fájl neve. Az elérési út megadásához a ${tulajdonság_kulcs} (például java.home vagy user.home rendszertulajdonság) formátumot használhatja.
  • Append=false: Alapértelmezésben értéke true, amely a fájl végéhez történő hozzáfűzést jelent. A false érték a program minden indításakor felülírja a fájlt.
RollingFileAppender

Úgy terjeszti ki a FileAppender hozzáfűzőt, hogy a naplófájlokról biztonsági mentést készítsen, ha azok elérnek egy adott méretet.

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

Beállítások:

  • Threshold=INFO: Ez a hozzáfűző az itt megadottnál kisebb prioritású üzeneteket nem naplózza még akkor sem, ha a prioritás kisebbre van beállítva. Ez a beállítás az üzenetek számának csökkentéséhez hasznos, például a fájlnaplókban az összes üzenet megjelenítésekor a konzolon.
  • ImmediateFlush=true: Az alapértelmezett beállítás a true, mely azt jelenti, hogy a naplóüzenetek egyáltalán nem kerülnek a pufferbe. Ha az ImmdiateFlush értéke false, az utolsó néhány naplóesemény nem kerül állandó adathordozóra, amikor a probléma fellép az alkalmazással.
  • File=mylog.txt: A naplózáshoz használt fájl neve. Az elérési út megadásához a ${tulajdonság_kulcs} (például java.home vagy user.home rendszertulajdonság) formátumot használhatja.
  • Append=false: Alapértelmezésben értéke true, amely a fájl végéhez történő hozzáfűzést jelent. A false érték a program minden indításakor felülírja a fájlt.
  • MaxFileSize=100 KB: Az utótag lehet KB, MB vagy GB. E méret elérése után a napló átfordul. Az Append logikai értéket fogad, mely meghatározza, hogy a kimeneti fájlok felülírásra kerülnek (false), vagy a program hozzáfűzi azokhoz a bejegyzéseket (true). A false (alapértelmezett) érték megadása megakadályozza a fájlok korlátlan növekedését. Ezt a beállítást fejlesztői környezetben használja, ahol alkalmankénti futtatásokat végez. A true érték megadásakor a kimenet hozzáfűzésre kerül a meglévő naplófájlhoz a JVM minden futtatásakor. A kimeneti fájl mérete a MaxFileSize kulcsszó megadásával korlátozható. Ha például beállítja a cjapi_log.txt kimeneti fájlt a MaxFileSize=128 KB és a MaxBackupIndex=1 értékkel, akkor, ha a fájl túllépi a 128 KB-os méretet, tartalma automatikusan a cjapi_log.txt.1 fájlba kerül. Az írás folytatódik egy üres cjapi_log.txt fájlba.
  • MaxBackupIndex=2: Legfeljebb 2 biztonsági mentési fájl fenntartása. Törli a legrégebbi fájlokat. A 0 megadásakor nincsenek biztonsági mentési fájlok.

Elrendezések megadása

A log4j.properties fájlban a naplóüzenetek formátumát meghatározó különböző elrendezéseket adhat meg. Megadhatja, hogy a naplóüzenet tartalmazza a dátumot, időt, modulnevet, szálnevet vagy más információkat. A konfigurációs beállításokat futás közben, az üzenet naplózásakor használja a program.

A következő táblázatban látható lista a IBM Enterprise Records log4j.properties fájljában használt összes elrendezésről, és egy rövid leírás, illetve a kapcsolódó beállítások is olvashatók.

3. Táblázat Elrendezések és leírásuk
Elrendezés Leírás és kódtöredék
SimpleLayout

Kiírja a szintet, majd egy kötőjelet (-) ír, melyet a naplóüzenet szövege követ.

org.apache.log4j.SimpleLayout
PatternLayout

A megadott átalakítási minta szerint formázza a naplózási eseményeket. Az átalakítási minták literális szövegből és átalakítási kulcsszavakból állnak. A literális szöveget a program szó szerint írja ki. Az átalakítási kulcsszavak a % karakterrel kezdődnek, ezt egy elhagyható formátummódosító követi, majd a kötelező átalakítási karakter zárja a kulcsszót. Például a %-5p [%t]: %m%n olyan átalakítási minta, melyben a prioritásátalakítási kulcsszót a " [" literális szöveg követi. Ezt a karaktersorozatot a szálátalakítási kulcsszó követi, mely mögött a "]: " literális szöveg áll. A karaktersorozatot üzenetátalakítási kulcsszó és egy rendszerfüggő sorelválasztó követi.

org.apache.log4j.PatternLayout

Beállítások:

  • ConversionPattern=%-5p, [%t]:%m%n: Az egyes naplóüzenetek formázása (belefoglalt információk).
HTMLLayout

A kimenetet HTML táblázatként formázza.

org.apache.log4j.HTMLLayout

Beállítások:

  • LocationInfo=true: Kimenete a Javaâ fájlnév és a sorszám. Az alapértelmezett beállítás a false.
  • Title=Saját alkalmazás címe: A <title> HTML-címke megadása. Az alapértelmezett beállítás a Log4J naplóüzenetek.
 

A kimenetet XML-fájlként formázza.

org.apache.log4j.xml.XMLLayout

Beállítások:

  • LocationInfo=true: Kimenete a Java fájlnév és a sorszám. Az alapértelmezett beállítás a false.

Az IBM Enterprise Records alkalmazáshoz biztosított log4j.properties fájl a PatternLayout naplóüzenet-formátumot használja. Az alábbi táblázatban található lista a konfigurációs fájlban deklarálható átalakítási mintákról, valamint ezek rövid leírása is olvasható:

4. Táblázat Átalakítási minták és leírásuk
Minta Leírás
%t A naplókérést küldő szál neve
%c A naplókéréshez társított naplózó neve
%-60c A naplózó nevének balra igazítása legalább 60 szóközön belül
%r Az alkalmazás indítása óta eltelt ezredmásodpercek száma
%p A naplóbejegyzés szintje
%m Üzenet
%Time A naplózás időpontja
%d A naplózási esemény dátuma
%n Új sor

A következő kódbejegyzés mutatja be a PatternLayout engedélyezését, és egy egyszerű átalakítási minta megadását:

log4j.appender.APILOG.layout=org.apache.log4j.PatternLayout
log4j.appender.APILOG.layout.ConversionPattern=%-5p %d {nn HHH éééé ÓÓ:pp:mm,EEE}, 
-%m, %r, [%M] % n

Például:

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]


Visszajelzés

Legutóbbi frissítés: 2013 november
configure_rm_logging.htm

© Copyright IBM 2013