IBM Enterprise Records, versio 5.1.2    

Log4j.properties-tiedoston kokoonpanon määritys

IBM Enterprise Records -sovellukseen sisältyy log4j.properties-mallitiedosto, jonka kokoonpanon voi määrittää.

Tiedosto log4j.properties on kansiossa ier_asennuspolku\ RecordsManagerSweep. Voit määrittää kirjauksen toimintatavan antamalla tiedostoon ominaisuuksien arvot seuraaviin kohtiin:

Kullekin log4j.properties-tiedostoon sisältyvälle kirjaustoiminnolle määritetään taso. Jos et määritä tasoa, log4j määrittää kirjaustoiminnolle automaattisesti saman tason, joka ylätason kirjaustoiminnolla on. Kirjaustoiminnon tason oletusarvo on WARN (varoitus).

Log4j.properties-tiedostoon voi määrittää eri asetukset kirjaustoiminnolle, liittämistoiminnolle ja asettelulle. Log4j.properties-tiedoston tulee olla ajon aikana luokkapolussa sovelluksen käytettävissä. Voit sitten kommentoida merkintöjä pois lisäämällä mallitiedostoon lauseen eteen ristikkomerkin (#). Ristikkomerkillä (#) kommentoidut merkinnät ohitetaan ajon aikana.

Voit avata log4j.properties-tiedoston siirtymällä kansioon ier_asennuspolku\RecordsManagerSweep ja avaamalla tiedoston tekstinmuokkausohjelmassa.

Kirjaustoiminnon ja kirjaustason asetus

Ensin on asetettava kirjaustoiminto. Voit käyttää useita kirjaustoimintoja, jos haluat luokitella sovelluksessa tarvittavat kirjauslajit. Voit ottaa käyttöön kaikkien com.filenet.rm-luokkien ja -alipakettien kirjauksen määrittämällä kirjaustoiminnon kuten seuraavassa lauseessa:

log4j.logger.com.filenet.rm 

Voit myös antaa kirjaustoiminnolle haluamasi nimen. Voit antaa sille esimerkiksi nimen APILOG seuraavan lauseen tapaan:

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

Kirjaustason asetuksella tulee määrittää tarkkuus, jota log4j noudattaa kirjatessaan sanomia ajon aikana. Log4j tukee viittä tavallista kirjaustasoa, jotka käyvät ilmi seuraavasta taulukosta:

Taulukko 1. Log4j-toiminnon ajonaikaisesti kirjaamien sanomien taso
Taso Kuvaus
DEBUG Asettaa kirjattaviksi tarkat ilmoitustapahtumat, joista on suuri hyöty sovelluksen vianmäärityksessä.
INFO Asettaa kirjattaviksi ilmoitussanomat, jotka kuvaavat sovelluksen etenemistä pääpiirteissään.
WARN Asettaa kirjattaviksi mahdollisesti haitalliset tilanteet.
ERROR Asettaa kirjattaviksi sellaiset virhetapahtumat, joiden ilmettyä sovelluksen ajo saattaa kuitenkin jatkua.
FATAL Tarkoittaa vakavia virhetapahtumia, jotka voivat keskeyttää sovelluksen ajon.

Lisätietoja erikoiskirjaustasoista ja mukautetuista kirjaustasoista on Apachen Web-sivustossa olevissa log4j-ohjeissa. Oletusarvon mukaan sovellus käyttää käynnistyessään tasoa WARN. Tasolle voi määrittää arvon DEBUG, INFO, ERROR, WARN tai FATAL ajon aikana. Voit myös sisällyttää tiedostoon samalle kirjaustoiminnolle useita kirjaustoiminnon lauseita, joista kussakin on eri kirjaustaso (esimerkiksi toisessa DEBUG ja toisessa WARN). Voit sitten kommentoida jommankumman pois lisäämällä mallitiedostoon lauseen eteen ristikkomerkin (#). Tämän jälkeen voit siirtyä tarpeen mukaan tasojen DEBUG ja WARN välillä. Ristikkomerkillä (#) kommentoidut merkinnät ohitetaan ajon aikana. Kirjaustoiminto, jonka tasoa ei ole määritetty, perii automaattisesti ylätason kirjaustoiminnon kirjaustason. Oletusarvon mukaan IBM Enterprise Records -sovelluksen API-kirjaustoiminnon kirjaustaso on WARN.

Liittämistoimintojen asetus

Kirjaustoimintoon yhdistetään yksi tai useampia liittämistoimintoja, jotta lokisanomat kirjoittuvat johonkin tulostuskohteeseen. Tiedostoon log4j.properties voi määrittää erilaisia liittämistoimintoja, jotta tiedosto lähettää lokitiedot määritettyyn tulostussijaintiin. Seuraavassa taulukossa on luettelo kaikista log4j.properties-tiedostossa käytetyistä liittämistoiminnoista lyhyine kuvauksineen ja toimintoihin liittyvine valintoineen.

Taulukko 2. Liittämistoiminnot, kuvaukset ja koodikatkelmat
Liittämistoiminto Kuvaus ja koodikatkelmat
NTEventLogAppender

Liittää tiedot Microsoft Windows NT Event Log -tapahtumalokiin. Tämän liittämistoiminnon voi asentaa ja sitä voi käyttää ainoastaan Windows-järjestelmässä.

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

Liittää lokisanomat System.out-tiedostoon (oletusarvo) tai System.err-tietovirtaan ja noudattaa käyttäjän määrittämää asettelua.

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

Valinnat:

  • Threshold=WARN: Tämä liittämistoiminto ei kirjaa lokiin sanomia, joiden prioriteetti on pienempi kuin tässä määritetty, vaikka prioriteettiraja olisi asetettu pienemmäksi. Asetus on hyödyllinen, jos halutaan esimerkiksi vähentää sanomien määrää tiedostolokissa samalla, kun kaikki sanomat näkyvät ohjauspäätteessä.
  • ImmediateFlush=true: Oletusasetus on true, joka tarkoittaa, että lokisanomia ei puskuroida ollenkaan. Jos asetuksen ImmdiateFlush arvona on false, muutama tuorein lokitapahtuma ei kirjoitu pysyvään tallennusvälineeseen, jos sovelluksessa ilmenee ongelma.
FileAppender

Liittää lokisanomat tiedostoon.

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

Valinnat:

  • Threshold=WARN: Tämä liittämistoiminto ei kirjaa lokiin sanomia, joiden prioriteetti on pienempi kuin tässä määritetty, vaikka prioriteettiraja olisi asetettu pienemmäksi. Asetus on hyödyllinen, jos halutaan esimerkiksi vähentää sanomien määrää tiedostolokissa samalla, kun kaikki sanomat näkyvät ohjauspäätteessä.
  • ImmediateFlush=true: Oletusasetus on true, joka tarkoittaa, että lokisanomia ei puskuroida ollenkaan. Jos asetuksen ImmdiateFlush arvona on false, muutama tuorein lokitapahtuma ei kirjoitu pysyvään tallennusvälineeseen, jos sovelluksessa ilmenee ongelma.
  • File=omaloki.txt: Sen tiedoston nimi, johon lokisanomat kirjataan. Voit määrittää polun merkkijonon ${jokin_ominaisuuden_avain} avulla (esimerkiksi järjestelmäominaisuus java.home tai user.home).
  • Append=false: Oletusarvo on true, joka tarkoittaa, että lokisanomat liitetään tiedoston loppuun. Asetus false korvaa tiedoston aina, kun ohjelman ajo alkaa uudestaan.
RollingFileAppender

On FileAppender-toiminnon laajennus, jonka perusteella järjestelmä varmistuskopioi lokitiedostot aina, kun ne saavuttavat tietyn koon.

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

Valinnat:

  • Threshold=INFO: Tämä liittämistoiminto ei kirjaa lokiin sanomia, joiden prioriteetti on pienempi kuin tässä määritetty, vaikka prioriteettiraja olisi asetettu pienemmäksi. Asetus on hyödyllinen, jos halutaan esimerkiksi vähentää sanomien määrää tiedostolokissa samalla, kun kaikki sanomat näkyvät ohjauspäätteessä.
  • ImmediateFlush=true: Oletusasetus on true, joka tarkoittaa, että lokisanomia ei puskuroida ollenkaan. Jos asetuksen ImmdiateFlush arvona on false, muutama tuorein lokitapahtuma ei kirjoitu pysyvään tallennusvälineeseen, jos sovelluksessa ilmenee ongelma.
  • File=omaloki.txt: Sen tiedoston nimi, johon lokisanomat kirjataan. Voit määrittää etukäteen polun merkkijonon ${jokin_ominaisuuden_avain} avulla (esimerkiksi järjestelmäominaisuus java.home tai user.home).
  • Append=false: Oletusarvo on true, joka tarkoittaa, että lokisanomat liitetään tiedoston loppuun. Asetus false korvaa tiedoston aina, kun ohjelman ajo alkaa uudestaan.
  • MaxFileSize=100 KB: Loppuliite voi olla KB, MB tai GB. Kirjaus on kiertävä ja jatkuu lokitiedoston alusta, kun tässä määritetty koko on saavutettu. Tälle asetukselle määritetään totuusarvo, jonka perusteella toiminto selvittää, tuleeko tulostustiedostot korvata (false) vai lisätäänkö tiedot niihin (true). Kun arvona on false (oletusarvo), tiedostot eivät kasva määrättömästi. Asetusta kannattaa käyttää kehitysympäristöissä, joissa tehdään ajoittaisia kerta-ajoja. Kun arvona on true, tuloste liitetään nykyisen lokitiedoston loppuun jokaisella JVM-ajokerralla. Voit rajoittaa tulostustiedoston kokoa asettamalla MaxFileSize-avainsanan. Jos määrität esimerkiksi tulostustiedoston cjapi_log.txt sekä asetukset MaxFileSize=128 KB ja MaxBackupIndex=1, tiedoston sisältö siirretään automaattisesti tiedostoon cjapi_log.txt.1 ja kirjaus jatkuu tyhjään cjapi_log.txt-tiedostoon, kun lokitiedoston koko ylittää 128 kilotavun rajan.
  • MaxBackupIndex=2: Säilytettävien varmistuskopiotiedostojen enimmäismäärä on (esimerkiksi) 2. Poistaa vanhimmat tiedostot. Arvo 0 tarkoittaa, että varmistuskopiotiedostoja ei säilytetä.

Asettelujen asetus

Voit asettaa log4j.properties-tiedostoon erilaisia asetteluja, jotka määrittävät lokisanoman muodon. Voit määrittää lokisanomien sisällöksi muun muassa päivämäärän, kellonajan, moduulin nimen ja säikeen nimen. Näitä kokoonpanoasetuksia käytetään ajonaikaisesti sanomaa kirjattaessa.

Seuraavassa taulukossa on luettelo kaikista IBM Enterprise Records -sovelluksen log4j.properties-tiedostossa käytetyistä asetteluista lyhyine kuvauksineen ja niihin liittyvine valintoineen.

Taulukko 3. Asettelut ja kuvaukset
Asettelu Kuvaus ja koodikatkelma
SimpleLayout

Tulostaa tason, ajatusviivan (-) ja lokisanoman tekstin.

org.apache.log4j.SimpleLayout
PatternLayout

Muotoilee kirjaustapahtumat määritetyn muuntokaavan mukaan. Muuntokaavat koostuvat kirjaimellisesta tekstistä ja muuntotarkenteista. Kirjaimellinen teksti tulostuu sellaisenaan. Muuntotarkenteet koostuvat %-merkistä ja sitä seuraavista valinnaisesta muotomääritteestä ja pakollisesta muuntomerkistä. Esimerkiksi muuntokaava %-5p [%t]: %m%n koostuu prioriteetin muuntotarkenteesta, jota seuraa kirjaimellinen teksti " [". Sitä seuraavat säikeen muuntotarkenne ja kirjaimellinen teksti "]: ". Tätä merkkijonoa seuraavat sanoman muuntomäärite ja järjestelmän mukaan määrittyvä rivinerotin.

org.apache.log4j.PatternLayout

Valinnat:

  • ConversionPattern=%-5p, [%t]:%m%n: Määrittää, miten kukin lokisanoma tulee muotoilla (eli mitä tietoja siihen tulee sisällyttää).
HTMLLayout

Muotoilee tulosteen HTML-taulukoksi.

org.apache.log4j.HTMLLayout

Valinnat:

  • LocationInfo=true: Tulostaa Java-tiedoston nimen ja rivinumeron. Oletusasetus on false.
  • Title=Oman sovelluksen otsikko: Määrittää HTML-tiedoston <title>-tunnisteen. Oletusasetus on Log4J Log Messages.
 

Muotoilee tulosteen XML-muotoon.

org.apache.log4j.xml.XMLLayout

Valinnat:

  • LocationInfo=true: Tulostaa Java-tiedoston nimen ja rivinumeron. Oletusasetus on false.

IBM Enterprise Records -sovelluksen mukana toimitettu log4j.properties-tiedosto käyttää lokisanoman muotoa PatternLayout. Seuraavassa taulukossa on lyhyet kuvaukset sisältävä luettelo muuntokaavoista, joita kokoonpanotiedostossa voi käyttää:

Taulukko 4. Muuntokaavat ja kuvaukset
Kaava Kuvaus
%t Lokipyynnön tekevän säikeen nimi.
%c Lokipyyntöön liittyvän kirjaustoiminnon nimi.
%-60c Kirjaustoiminnon nimen tasaus vasemmalle vähintään 60 merkkivälin verran.
%r Sovelluksen aloituksesta kulunut aika millisekunteina.
%p Lokilauseen taso.
%m Sanoma
%Time Lokiinkirjauksen tapahtuma-aika.
%d Lokiinkirjauksen tapahtumapäivämäärä.
%n Uusi rivi.

Seuraava koodilause havainnollistaa, miten PatternLayout-asettelu otetaan käyttöön ja miten yksinkertainen muuntokaava määritetään:

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

Esimerkiksi:

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]


Palaute

Päivitetty viimeksi: Marraskuu 2013
configure_rm_logging.htm

© Copyright IBM Corp. 2013