Configurazione della registrazione

La registrazione può essere utilizzata per il monitoraggio e l'esecuzione del debug di CM Server e delle applicazioni basate sull'API CM.

La registrazione tiene traccia delle operazioni ordinarie effettuate dagli utenti dell'API CM e di CM Server nonché degli errori che si verificano durante l'esecuzione dell'applicazione basata sull'API CM o di CM Server. Le voci di log si trovano nella locale predefinita della macchina oppure in inglese U.S.A. se la locale della macchina non è supportata.

Per impostazione predefinita, la registrazione di CM Server è impostata a livello di INFO. È necessario abilitare la registrazione dell'applicazione basata sull'API CM a livello di INFO.

È possibile configurare i package di registrazione dell'API CM, di WebSphere Application Server e di TSlogger.

Registrazione API CM

La registrazione dell'API CM viene controllate tramite il file logging.properties ubicato nella struttura della directory JDK del JRE utilizzato per eseguire l'applicazione. Ricercare il file logging.properties nella directory jre\lib del JDK (ad esempio, C:\Program Files\IBM\WebSphere\AST\eclipse\jre\lib, C:\jdk_5.0\jre\lib, o C:\Program Files\Java\jre1.5.0_06\lib).

Per impostazione predefinita la registrazione viene disabilitata; è necessario abilitarla a livello di INFO.

Il seguente file logging.properties di esempio contiene voci che illustrano come configurare le impostazioni di log e di traccia per le applicazioni basate sull'API CM:
############################################################
#      Proprietà globali
############################################################
#
# "handlers" specifica un elenco separato da virgole di classi di gestori 
# di log.  Questi gestori saranno installati durante l'avvio della VM.
# Si noti che è necessario che queste classi si trovino sullo stesso percorso classe di sistema.
# Per impostazione predefinita viene configurata solo una ConsoleHandler, che
# visualizzerà solo messaggi a livelli di INFO o superiori.
handlers = java.util.logging.ConsoleHandler

# Per aggiungere anche FileHandler, invece, utilizzare la seguente riga.
#handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler

# Livello di registrazione globale predefinito.
# Specifica i tipi di eventi registrati su
# tutti i logger.  Per qualsiasi funzione data, questo livello globale
# può essere sovrascritto da un livello specifico di funzione
# Si noti che ConsoleHandler dispone inoltre di un'impostazione
# di livello separato per limitare i messaggi stampati alla console.
# La riga successiva consente la registrazione (di tutti gli oggetti logger) a livello di INFO
.level=INFO

############################################################
# Proprietà specifiche del gestore.
# Descrive informazioni di configurazione specifiche per i gestori.
############################################################

# CMLogger - Deve essere sempre abilitato a livello di INFO. 
#
# Non è necessario arrestare e riavviare le applicazioni che utilizzano l'API CM; eventuali modifiche al file

# logging.properties configurato vengono automaticamente rilevate e applicate, entro 10 secondi.
#
# Le seguenti righe indicano che la registrazione dell'oggetto CMLogger avviene a livello di INFO
# e che il file di output di log sarà denominato CMLogger[#].log e ubicato nella directory HOME
# dell'utente che ha effettuato l'accesso; il file di output di log sarà fatto ruotare su 40 file, ognuno dei quali
# è limitato a 40000000 byte.  Le voci di log saranno accodate al file di output del log corrente
# nella rotazione e saranno scritte utilizzando un formato semplice.
#
com.ibm.rational.stp.common.internal.util.CMLogger.level = INFO
com.ibm.rational.stp.common.internal.util.LogHandler.pattern = %h/CMLogger%g.log
com.ibm.rational.stp.common.internal.util.LogHandler.limit = 40000000
com.ibm.rational.stp.common.internal.util.LogHandler.count = 40
com.ibm.rational.stp.common.internal.util.LogHandler.append = true
com.ibm.rational.stp.common.internal.util.LogHandler.formatter = java.util.logging.SimpleFormatter

# CMTracer - Abilitare (Eliminare il simbolo di commento) le voci che seguono solo all'utilizzo temporaneo perché la traccia
# può utilizzare molte risorse.  
#
# Non è necessario arrestare e riavviare le applicazioni che utilizzano l'API CM; eventuali modifiche al file
# logging.properties configurato vengono automaticamente rilevate e applicate, entro 10 secondi.
#
# Le seguenti righe indicano che la traccia dell'oggetto CMTracer avviene a livello di FINER,
# e che il file di output di traccia sarà denominato CMTracer[#].log e ubicato nella directory HOME
# dell'utente che ha effettuato l'accesso; il file di output di traccia sarà fatto ruotare su 40 file, ognuno dei quali
# è limitato a 40000000 byte.  Le voci di traccia saranno accodate al file di output di traccia corrente
# nella rotazione e saranno scritte utilizzando un formato semplice.
#
#com.ibm.rational.stp.common.internal.util.CMTracer.level = FINER
#com.ibm.rational.stp.common.internal.util.TraceHandler.pattern = %h/CMTracer%g.log
#com.ibm.rational.stp.common.internal.util.TraceHandler.limit = 40000000
#com.ibm.rational.stp.common.internal.util.TraceHandler.count = 40
#com.ibm.rational.stp.common.internal.util.TraceHandler.append = true
#com.ibm.rational.stp.common.internal.util.TraceHandler.formatter = java.util.logging.SimpleFormatter

Queste impostazioni risultano in un file di log denominato CMLogger[#].log (e in un file di output di traccia denominato CMTracer[#].log quando il segno di commento è stato eliminato dalle voci CMTracer). Ogni file è ubicato nella directory HOME dell'utente che ha effettuato l'accesso (dove [#] indica il numero di rotazione del file); l'output passa da un file all'altro mano a mano che il file raggiunge la dimensione massima.

L'utilizzo delle voci logging.properties di cui sopra, indica che i record di log deve essere accodato all'estremità del file applicabile e che ciascuna voce viene memorizzata in formato semplice. Le modifiche al file logging.properties vengono automaticamente rilevate e applicate ,entro circa 10 secondi, dall'applicazione basata sull'API CM; non è necessario arrestare e riavviare l'applicazione.

Quando un file di output di log ha raggiunto la dimensione massima (40 MByte), viene creato un nuovo file e quello precedente viene rinominato per contenere l'indicazione di data e ora in cui è stata eseguita la rotazione. Ogni file contiene 40 MB di dati e le voci nuove vengono accodate a quelle esistenti, compresi i riavvii delle applicazioni. Quando il numero di file di log raggiunge il valore 40, la rotazione a un nuovo file determina l'eliminazione automatica del file più vecchio.

Per ulteriori informazioni su come configurare la registrazione Java, fare riferimento al javadoc java.util.logging.FileHandler e java.util.logging.Logger JDK.

Se si crea un file delle proprietà di registrazione personalizzato, è necessario specificarne l'ubicazione nella JVM indicando l'argomento -D. Ad esempio:
java -Djava.util.logging.config.file=C:\myLogPropsFile.properties your_client_java_program_that_uses_CM-API

Configurazione della registrazione e della traccia di WebSphere Application Server

La registrazione e la traccia WebSphere Application Server vengono impostate e configurate utilizzando la console di gestione WebSphere Application Server. È possibile utilizzare questo URL per accedere alla console di gestione WebSphere Application Server:
http://<server-name>:<admin-console-port-number>/ibm/console
dove <server-name> è il nome del sistema CM Server e <admin-console-port> è il numero di porta della console di gestione (per impostazione predefinita 12060 con CM Server o 9060 per altre versioni di WebSphere Application Server).
Nota: la traccia a qualsiasi livello (FINE, FINER o FINEST) per un componente in esecuzione in WebSphere Application Server (inclusi i componenti CM Server) influenzerà negativamente le prestazioni.

A seconda del tipo di Websphere Application Server utilizzato sul sistema CM Server, è possibile apportare modifiche in tempo reale senza dover arrestare e riavviare CM Server. Su gran parte delle pagine di configurazione della registrazione della console di gestione sono presenti due schede: la scheda Configurazione e la scheda Runtime.

Dalla console di gestione, fare clic su Risoluzione dei problemi->Log e traccia e selezionare il server da configurare dall'elenco di server. Selezionare Modifica i livelli di dettaglio di log e la scheda Runtime. Le modifiche apportate alla scheda Runtime diventano effettive non appena vengono salvate; le modifiche apportate alla scheda Configurazione diventano effettive dopo il riavvio del server. Se si desidera che le modifiche siano permanenti, selezionare la casella di spunta Salva anche modifiche runtime alla configurazione. Selezionare il collegamento Componenti. Notare che nella casella è presente *=info. Aprire l'opzione com.ibm.rational.* e selezionare com.ibm.rational.stp.*. Selezionare il livello facendo clic sull'opzione Messaggi e livelli di traccia. Fare clic su OK, quindi fare clic sul collegamento Salva nell'area Messaggi nella parte superiore della pagina che si apre. Le modifiche diventano effettive senza riavviare il server.

Se la versione o la classe di Websphere Application Server sul sistema di CM Server non fornisce una scheda Runtime che abiliti modifiche di configurazione in tempo reale, utilizzare la scheda Configurazione e riavviare il server per rendere effettive le modifiche salvate.

Probabilmente sarà necessario aumentare le impostazioni predefinite delle dimensioni del file di log e del numero di file di log da ruotare. È necessario impostare il numero di file di log da ruotare almeno su 40 e impostare la dimensione del file di log almeno su 40 MB. Nella console di gestione di Websphere Application Server, per modificare le dimensioni del file di log della JVM e le impostazioni di rotazione del file, attenersi alla seguente procedura:
  1. Selezionare Risoluzione dei problemi->Log e traccia.
  2. Selezionare il server pertinente dall'elenco dei server da configurare.
  3. Selezionare Log JVM e quindi fare clic sulla scheda Configurazione (è possibile utilizzare la scheda Runtime per visualizzare il contenuto corrente dei file SystemOut.log e SystemErr.log).
  4. Apportare le relative modifiche alle ubicazioni di SystemOut e SystemErr, alle dimensioni dei file (devono essere almeno pari a 40 MB) e alla quantità di file cronologici da conservare (almeno 40 MB).
  5. Fare clic su OK, quindi fare clic sul collegamento Salva nell'area Messaggi nella parte superiore della pagina che si apre.
I file di log di WebSphere Application Server si trovano nelle seguenti ubicazioni:
  • UNIX : /opt/IBM/RationalSDLC/common/CM/profiles/cmprofile/logs/server1/
  • Linux: /opt/ibm/RationalSDLC/common/CM/profiles/cmprofile/logs/server1/
  • Windows: \Program Files\IBM\RationalSDLC\common\CM\profiles\cmprofile\logs\server1\

TSlogger

TSLogger è destinato alla registrazione dei processi del server ONCRPC di backend. È possibile configurare questo programma di utilità modificando il file tslogger.properties presente nelle seguenti directory:
  • Windows: \Program Files\IBM\RationalSDLC\common\CM\bin\tslogger.properties
  • UNIX: /opt/IBM/RationalSDLC/common/CM/bin/tslogger.properties
  • Linux: /opt/ibm/RationalSDLC/common/CM/bin/tslogger.properties
I file di log e di traccia si trovano nelle seguenti ubicazioni:
  • Windows: \Program Files\IBM\RationalSDLC\common\CM\logs\server1\ccrpc [and \cqrpc]
  • UNIX: /opt/IBM/RationalSDLC/common/CM/logs/server1/ccrpc [and /cqrpc]
  • Linux: /opt/ibm/RationalSDLC/common/CM/logs/server1/ccrpc [and /cqrpc]
I file di log e di traccia includono:
  • SystemOut.log - output di log generale, abilitato alla registrazione a livello di INFO per impostazione predefinita.
  • SystemErr.log - output di errori/eccezioni, abilitato per impostazione predefinita.
  • trace.log - output di traccia, disabilitato per impostazione predefinita.

Il file tslogger.properties ha etichettato le aree in cui è possibile effettuare modifiche nonché l'intervallo di valori accettabili. La registrazione è attiva per impostazione predefinita al livello INFO. Tutti i messaggi INFO, WARNING e SEVERE sono registrati nel file di log. I file di log vengono configurati mediante modifica del file tslogger.properties, tuttavia, il file viene configurato in modo appropriato al momento dell'installazione e non sono richieste modifiche.

Le impostazioni predefinite nel file tslogger.properties sono impostate su valori che non richiedono modifiche. A mano a mano che i file di output raggiungono la dimensione massima, l'output passa al file successivo. Una volta raggiunto il numero massimo di file nella rotazione, il file più vecchio viene rimosso per lasciare posto al file successivo nella rotazione.

Riepilogo livelli di registrazione dal livello più alto a quello più basso:
  • OFF: Disabilita tutte le registrazioni e la traccia.
  • ERROR: Corrisponde a SEVERE in JSR47.
  • WARNING: Corrisponde a WARNING in JSR47.
  • INFO: Corrisponde a INFO in JSR47.
  • DEBUG_MIN: Corrisponde a FINE in JSR47.
  • DEBUG_MID: Corrisponde a FINER in JSR47.
  • DEBUG_MAX: Corrisponde a FINEST in JSR47.
  • ALL: Abilita tutti i livelli di registrazione e di traccia.
Concetti correlati
I file di log ClearQuest e i file delle proprietà di log

Feedback