IBM Enterprise Records, Versió 5.1.2    

Configuració del fitxer log4j.properties

L'aplicació IBM® Enterprise Records inclou un fitxer log4j.properties d'exemple que es pot configurar.

El fitxer log4j.properties es troba a la carpeta ier_install_path\ RecordsManagerSweep i podeu configurar el comportament de registre especificant valors al fitxer per a les propietats següents:

S'assigna un nivell a cada registrador del fitxer log4j.properties. Si no assigneu un nivell a un registrador, log4j assigna de forma automàtica el nivell del registrador pare al registrador sense assignar. Per defecte, s'assigna el nivell WARN (avís) a un registrador.

Podeu configurar el fitxer log4j.properties amb paràmetres diferents de registrador, afegidor i disseny. El fitxer log4j.properties ha d'estar disponible per a l'aplicació en temps d'execució a la variable class path. Podeu comentar les entrades del fitxer de mostra afegint com a prefix a la sentència un símbol de coixinet (#). Les entrades marcades amb el símbol de coixinet(#) no s'executen en temps d'execució.

Per obrir el fitxer log4j.properties, aneu a la carpeta ier_install_path\RecordsManagerSweep i obriu el fitxer amb un editor de text.

Definició del nivell de registrador i registre

Primer heu de definir el registrador. Podeu tenir diversos registradors per classificar el tipus de registre que us cal per a l'aplicació. Per habilitar el registre per a totes les classes de com.filenet.rm i els seus subpaquets, especifiqueu el registrador com es mostra a la sentència següent:

log4j.logger.com.filenet.rm 

O podeu especificar qualsevol nom per al registrador. Per exemple, podeu anomenar el registrador APILOG com es mostra a la sentència següent:

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

Cal que definiu un nivell de registre per establir el nivell de detalls dels missatges registrats per log4j en temps d'execució. log4j admet cinc nivells normals de registre, com es mostra a la taula següent:

Taula 1. Nivell de missatges registrats per log4j en temps d'execució
Nivell Descripció
DEBUG Designa les incidències informatives refinades que són les més útils per depurar una aplicació.
INFO Designa missatges informatius que ressalten el progrés de l'aplicació a un nivell no refinat.
WARN Designa situacions potencialment perjudicials.
ERROR Designa incidències d'error que permeten que l'aplicació continuï executant-se.
FATAL Designa incidències d'errors greus que poden causar l'aturada de l'aplicació.

Consulteu la documentació de log4j al lloc web d'Apache per obtenir informació sobre nivells de registre especials i personalitzats. Per defecte, l'aplicació comença al nivell WARN. Aquest nivell es pot modificar als nivells DEBUG, INFO, ERROR, WARN, o FATAL en temps d'execució. També podeu incloure diverses sentències de registre, cadascuna per al mateix registrador però amb diferents nivells (com ara DEBUG per a un, WARN per a un altre). Podeu comentar-ne un o l'altre al fitxer d'exemple afegint com a prefix abans de la sentència un símbol de coixinet (#). A continuació, canviar, segons convingui, del nivell DEBUG al WARN. Les entrades marcades amb el símbol del coixinet (#) no s'executen en temps d'execució. Un registrador que no té un nivell hereta de forma automàtica el nivell del seu registrador pare. Per defecte, s'assigna el nivell WARN al registrador API IBM Enterprise Records.

Definició d'afegidors

Un registrador s'associa amb un o més afegidors per permetre que els seus missatges de registres s'escriguin al suport de sortida. Podeu definir diferents tipus d'afegidors al fitxer log4j.properties que envia la informació de registre a la ubicació de sortida especificada. A la taula següent es proporciona una llista de tots els afegidors que s'utilitzen al fitxer log4j.properties i descripcions breus i opcions relacionades.

Taula 2. Afegidors, descripcions i fragments de codi
Afegidor Descripció i fragments de codi
NTEventLogAppender

Afegeix al registre d'incidències del Microsoft Windows NT. Aquest afegidor només es pot instal·lar i utilitzar en un sistema Windows.

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

Afegeix missatges de registre al corrent de System.out (valor per defecte) o de System.err amb un disseny especificat per l'usuari.

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

Opcions:

  • Threshold=WARN: aquest afegidor no registra cap missatge amb una prioritat inferior a l'especificada aquí encara que la prioritat del registrador es defineixi a un nivell més baix. Aquest paràmetre és útil per reduir el número de missatges, per exemple, en un fitxer de registres mentre es mostren tots els missatges a la consola.
  • ImmediateFlush=true: el paràmetre per defecte és true, és a dir, els missatges de registre no s'emmagatzemen a la memòria intermèdia. Si ImmdiateFlush es defineix en fals, és possible que les darreres incidències de registre no s'escriguin en un suport constant quan el problema es produeixi amb l'aplicació.
FileAppender

Afegeix missatges de registre a un fitxer.

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

Opcions:

  • Threshold=WARN: aquest afegidor no registra cap missatge amb una prioritat inferior a l'especificada aquí encara que la prioritat del registrador es defineixi a un nivell més baix. Aquest paràmetre és útil per reduir el número de missatges, per exemple, en un fitxer de registres mentre es mostren tots els missatges a la consola.
  • ImmediateFlush=true: per defecte, es defineix com a true, és a dir, els missatges de registre no s'emmagatzemen a la memòria intermèdia. Si ImmdiateFlush es defineix en fals, és possible que les darreres incidències de registre no s'escriguin en un suport constant quan el problema es produeixi amb l'aplicació.
  • File=mylog.txt: nom del fitxer on cal registra. Podeu utilitzar ${clau_propietat} (per exemple, java.home o user.home system properties) per especificar el camí d'accés.
  • Append=false: per defecte es defineix com a true, és a dir, afegir al final del fitxer. Amb el valor false se sobreescriu el fitxer al principi de cada execució del programa.
RollingFileAppender

Amplia FileAppender per fer una copia de seguretat dels fitxers de registre quan assoleixen una certa mida.

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

Opcions:

  • Threshold=INFO: aquest afegidor no registra cap missatge amb una prioritat inferior a l'especificada aquí encara que la prioritat del registrador es defineixi com a més baixa. Aquest paràmetre és útil per reduir el número de missatges, per exemple, en un fitxer de registres mentre es mostren tots els missatges a la consola.
  • ImmediateFlush=true: per defecte, es defineix com a true, és a dir, els missatges de registre no s'emmagatzemen a la memòria intermèdia. Si ImmdiateFlush es defineix en fals, és possible que les darreres incidències de registre no s'escriguin en un suport constant quan el problema es produeixi amb l'aplicació.
  • File=mylog.txt: nom del fitxer on cal registra. Podeu utilitzar ${clau_propietat} (per exemple, java.home o user.home system properties) per especificar el camí d'accés al davant.
  • Append=false: per defecte, es defineix com a true, és a dir, afegir al final del fitxer. Amb el valor false se sobreescriu el fitxer al principi de cada execució del programa.
  • MaxFileSize=100 KB: els sufixos poden ser KB, MB, o GB. Desplega el fitxer de registre després que s'assoleixi aquesta mida. L'addició pren un valor booleà que determina si els fitxers de sortida se sobreescriuran (fals) o s'afegiran (cert). Si aquest valor es defineix com a fals (valor per defecte) evita que els fitxers augmentin sense límit. Utilitzeu aquest paràmetre en un entorn de desenvolupament on feu execucions ocasionals. Si es defineix el valor com a true s'afegeix la sortida a un fitxer de registre existent a cada execució de la JVM. Podeu limitar la mida del fitxer de sortida definint la paraula clau MaxFileSize. Per exemple, si configureu un fitxer de sortida, cjapi_log.txt, amb MaxFileSize=128 KB i MaxBackupIndex=1, quan el fitxer superi els 128 KB, el seu contingut es mourà automàticament a cjapi_log.txt.1. L'escriptura continua en un fitxer cjapi_log.txt buit.
  • MaxBackupIndex=2: manté un màxim de 2 fitxers de còpia de seguretat (per exemple). Esborra fitxers antics. 0 significa que no es conserva cap fitxer de còpia de seguretat.

Definició de dissenys

Podeu definir dissenys al fitxer log4j.properties que especifiqui el format format del missatge de registre. Podeu especificar que els missatges de registre inclouen la data, l'hora, el nom del mòdul, el nom del fi i qualsevol altra informació. Aquests paràmetres de configuració s'utilitzen en temps d'execució mentre es registra el missatge.

A la taula següent es proporciona una llista dels dissenys que s'utilitzen al fitxer log4j.properties de l'IBM Enterprise Records i descripcions breus i opcions relacionades.

Taula 3. Dissenys i descripcions
Disseny Descripció i fragments de codi
SimpleLayout

Imprimeix el nivell, seguit d'un guionet i, finalment, el text del missatge de registre.

org.apache.log4j.SimpleLayout
PatternLayout

Formata les incidències de registre segons un patró de conversió especificat. Els patrons de conversió consten de text literal i especificadors de conversió. El text literal es general tal qual. Els especificadors de conversió consten del caràcter % seguit d'un modificador de format opcional i un caràcter de conversió obligatori. Per exemple, %-5p [%t]: %m%n és un patró de conversió que consta d'un especificador de conversió de prioritat seguit del text literal " [". La cadena va seguida d'un especificador de conversió de fil, seguit del text literal "]: ". La cadena va seguida per un especificador de conversió de missatges i un separador de línies dependent del sistema.

org.apache.log4j.PatternLayout

Opcions:

  • ConversionPattern=%-5p, [%t]:%m%n: com formatar cada missatge de registre (quin informació cal incloure).
HTMLLayout

Formata la sortida com a taula HTML.

org.apache.log4j.HTMLLayout

Opcions:

  • LocationInfo=true: genera el nom del fitxer Java i el número de línia. El valor per defecte és false.
  • Title=My app title: defineix l'etiqueta <title> d'HTML. El paràmetre per defecte és Log4J Log Messages.
 

Format la sortida com a XML.

org.apache.log4j.xml.XMLLayout

Opcions:

  • LocationInfo=true: genera el nom del fitxer Java i el número de línia. El valor per defecte és false.

El fitxer log4j.properties que es proporciona amb l'IBM Enterprise Records utilitza PatternLayout per al format de missatge de registre. La taula següent proporciona una llista de patrons de conversió que es poden declarar en el fitxer de configuració i les seves descripcions breus:

Taula 4. Patrons de conversió i descripcions
Patró Descripció
%t Nom del fil que fa la sol·licitud de registre
%c Nom del registrador associat amb la sol·licitud de registre
%-60c Alinea a l'esquerra el nom del registrador dins un mínim de 60 espais
%r Nombre de mil·lisegons transcorreguts des de l'inici de l'aplicació
%p Nivell de la sentència de registre
%m Missatge
%Time Hora a la qual té lloc el registre
%d Data de la incidència de registre
%n Salt de línia

La sentència de codi següent mostra com habilitar PatternLayout i especificar un patró de conversió senzill:

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

Per exemple:

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]


Comentaris

Darrera actualització: Novembre de 2013
configure_rm_logging.htm

© Copyright IBM Corp. 2013