IBM® FileNet Workplace XT utilizza il prodotto Apache log4j per la gestione della registrazione. Durante la registrazione, informazioni sull'attività dell'applicazione vengono scritte in percorsi di output quali la console o i file. Il personale di supporto e di sviluppo utilizzano le informazioni presenti nelle voci di log per analizzare l'attività dell'applicazione e diagnosticare e risolvere problemi. La registrazione ha solo scopi diagnostici e non fornisce informazioni sulla sicurezza o l'itinerario di controllo.
Il prodotto log4j viene installato durante l'installazione di Workplace XT. Per default, la registrazione non è abilitata durante l'installazione.
Per abilitare o disabilitare la registrazione:
Configurare le impostazioni di registrazione
Il file log4j.properties di esempio presenta una serie di opzioni di default, specificate come coppie keyword=value. Per modificare le impostazioni di default, aprire il file log4j.properties con un editor di testo, modificare e salvare il file. È possibile configurare le impostazioni di registrazione in qualsiasi momento dopo l'installazione. Le modifiche apportate al file di configurazione della registrazione vengono riconosciute automaticamente, non è necessario riavviare l'applicazione o il server di applicazioni.
Gli argomenti di seguito riportati forniscono informazioni su alcune delle opzioni di configurazione della registrazione visualizzate nel file. Per ulteriori informazioni sulle opzioni di registrazione, fare riferimento al sito Web Apache (http://apache.org) in Logging Project e al sito Web di registrazione Apache (http://logging.apache.org/log4j/).
Logger
Un logger scrive richieste di registrazione abilitate agli appender. Nel file log4j.properties, la prima parola chiave descrive il logger root. Il logger root è il logger di livello più elevato nella gerarchia e fornisce impostazioni di default globali; qualsiasi logger secondario che non presenta opzioni esplicitamente impostate eredita il proprio comportamento dal logger root.
Appender
È possibile specificare il punto in cui vengono scritti i dati di log configurando un appender, che invia voci di log formattate ad una destinazione di output specificata. I tipi di destinazioni possono essere un file o la console, l'output può essere reindirizzato ad un log di Windows Event, inoltrato ad un server log4j remoto e così via. Per tutte le opzioni relative alla destinazione di output e alla formattazione, consultare la documentazione Apache log4j. Un singolo logger può avere più di un appender. Ad esempio, è possibile scrivere l'output in una console e in un file contemporaneamente. L'aumento del numero di destinazioni può avere un impatto sulle prestazioni.
In Workplace XT, per default possono essere configurati due appender. Un appender scrive i dati di log nel formato IBM CBE (Common Base Event), che viene utilizzato dagli strumenti IBM Support Assistant per elaborare il log e l'altro appender scrive i dati di log in un formato maggiormente leggibile dall'utente. È possibile modificare l'ultimo appender per ridurre la quantità di output oppure disattivare questo appender completamente.
Livello
Il livello di registrazione specificato determina il tipo e la quantità di informazioni raccolte. Una correlazione diretta esiste tra la quantità di informazioni raccolte e l'impatto sulle prestazioni del sistema.
Il log dell'applicazione Workplace XT supporta livelli INFO, WARN, ERROR e FATAL standard, così come i livelli ALL e OFF. Nella tabella che segue vengono descritti brevemente i livelli standard; per ulteriori informazioni sui livelli, consultare la documentazione Apache log4j.
Livello | Descrizione |
---|---|
INFO | Richiede messaggi informativi che descrivono l'avanzamento dell'applicazione a livello generico. |
WARN | Richiede la registrazione per situazioni potenzialmente pericolose. |
ERROR | Richiede eccezioni di registrazione generate dall'interno dell'applicazione. |
FATAL | Richiede la registrazione solo di eventi di errore molto gravi, che possono presumibilmente determinare il malfunzionamento dell'applicazione. |
Il livello specificato determina la quantità di informazioni raccolte. Una correlazione diretta esiste tra la quantità di informazioni raccolte e l'impatto sulle prestazioni del sistema.
Formato file di output
Quando si configura l'appender, è possibile utilizzare la parola chiave di layout per specificare il formato in cui vengono scritti i dati. Scegliere le parole chiave PatternLayout e ConversionPattern. La parola chiave PatternLayout specifica un particolare modello per le voci di log e la parola chiave ConversionPattern, che identifica il modello di elementi scritti nell'appender, definisce il modello. L'esempio che segue:
log4j.appender.ErrorOutputFile=org.apache.log4j.RollingFileAppender log4j.appender.ErrorOutputFile.layout=org.apache.log4j.PatternLayout log4j.appender.ErrorOutputFile.layout.ConversionPattern=%d [%t] - %-5p %m\r\n
restituisce la seguente voce di log formattata:
2007-05-31 17:36:12:801 [cwrap] - Document/Checkin ConnectionWrapper.send send.before
Per ulteriori informazioni sulle opzioni di formattazione, fare riferimento alla documentazione Apache log4j.
Analizzare l'output
Il personale di supporto può esaminare le voci di un file di log per analizzare l'attività dell'applicazione e diagnosticare i problemi che si verificano nell'applicazione. L'utilizzo degli strumenti ISA (IBM Support Assistant), inoltre, automatizza la fase di analisi. Gli strumenti ISA utilizzano le voci CBE presenti nell'output di registrazione di log4j.
È inoltre possibile utilizzare uno strumento come Apache Chainsaw, un visualizzatore log basato sulla GUI, per esaminare voci di log non CBE.