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 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ä. Mallitiedoston merkintöjä voi kommentoida pois lisäämällä lauseen eteen ristikkomerkin (#). Näin kommentoituja merkintöjä ei suoriteta ajon aikana.
Voit avata log4j.properties-tiedoston siirtymällä kansioon ier_asennuspolku\RecordsManagerSweep ja avaamalla tiedoston tekstinmuokkausohjelmassa.
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.rmor
Voit 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 alla olevasta taulukosta.
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 | Asettaa kirjattaviksi erittäin vakavat virhetapahtumat, joiden takia sovelluksen ajo oletettavasti päättyy. |
Lisätietoja erikoiskirjaustasoista ja mukautetuista kirjaustasoista on Apachen Web-sivustossa olevissa log4j-ohjeissa. Oletusarvon mukaan sovellus käyttää käynnistyessään tasoa WARN. Asetuksen voi muuttaa arvoksi 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 (#). Voit sitten tarpeen mukaan vaihdella asetusten DEBUG ja WARN välillä. Ristikkomerkillä (#) kommentoituja merkintöjä ei suoriteta ajon aikana. Kirjaustoiminto, jonka tasoa ei ole määritetty, perii automaattisesti ylätason kirjaustoiminnon kirjaustason. Oletusarvon mukaan IBM Enterprise Records -sovelluksen RM API -kirjaustoiminnon kirjaustaso on WARN.
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.
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:
|
FileAppender | Liittää lokisanomat tiedostoon. log4j.appender.APILOG=org.apache.log4j.FileAppender Valinnat:
|
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:
|
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.
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 (eli tason) muuntotarkenteesta, jota seuraavat kirjaimellinen teksti "[", säikeen muuntotarkenne, kirjaimellinen teksti "]:", sanoman muuntomäärite ja järjestelmän mukaan määrittyvä rivinerotin. org.apache.log4j.PatternLayout Valinnat:
|
HTMLLayout | Muotoilee tulosteen HTML-taulukoksi. org.apache.log4j.HTMLLayout Valinnat:
|
Muotoilee tulosteen XML-muotoon. org.apache.log4j.xml.XMLLayout Valinnat:
|
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ää:
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
Esimerkki:
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]