ClearQuest CM API-Protokollierung konfigurieren

Sie können die ClearQuest CM API-Protokollierung konfigurieren.

Informationen zu diesem Vorgang

Die ClearQuest CM API-Protokollierung wird mithilfe der Datei logging.properties gesteuert, die der JRE zugeordnet ist, die Ihre Anwendung ausführt. Die Datei logging.properties befindet sich im Verzeichnis jre\lib Ihres JDK.

Die Protokollierung ist standardmäßig inaktiviert. Sie sollten die Protokollierung auf der Stufe INFO aktivieren.

Die folgende Musterdatei logging.properties zeigt, wie Protokolleinstellungen für Anwendungen konfiguriert werden, die die ClearQuest CM APIs verwenden.
############################################################
#      Globale Eigenschaften
############################################################
#
# "handlers" gibt eine Liste mit durch Kommas getrennten
# Protokollhandlerklassen an. Diese Handler werden während
# des Starts der VM installiert. Beachten Sie, dass sich diese
# Klassen im Systemklassenpfad befinden müssen. Standardmäßig
# wird nur ein ConsoleHandler konfiguriert, der nur Nachrichten
# auf der Stufe INFO und höheren Stufen anzeigt.
handlers = java.util.logging.ConsoleHandler

# Um auch den FileHandler hinzuzufügen, verwenden Sie stattdessen
# die folgende Zeile.
#handlers= java.util.logging.FileHandler, java.util.logging.ConsoleHandler

# Standardmäßig verwendete globale Protokollierungsstufe
# Diese gibt an, welche Arten von Ereignissen von allen Protokollfunktionen
# protokolliert werden. Diese globale Protokollstufe kann für jedes Tool
# durch eine toolspezfische Stufe überschrieben werden. Beachten Sie, dass
# der ConsoleHandler ebenfalls über eine separate Einstellung für die
# Protokollstufe verfügt, um die an die Konsole ausgegebenen Nachrichten
# zu begrenzen.
# Mit der nächsten Zeile wird die Protokollierung auf der Stufe INFO (für
# alle Protokollfunktionsobjekte) aktiviert.
.level=INFO

############################################################
# Handlerspezifische Eigenschaften
# Beschreibung der spezifischen Konfiguration für Handler
############################################################

# CMLogger - Sollte immer auf der Protokollstufe INFO aktiviert werden.
#
# Die folgenden Zeilen geben an, dass die Protokollierung für das CMLogger-Objekt
# auf der Stufe INFO erfolgen soll, der Protokollausgabedatei der Name CMLogger[#].log
# zugeordnet wird und die Datei in das Ausgangsverzeichnis des angemeldeten
# Benutzers gestellt wird. Die Protokollausgabe wird im Rotationsprinzip in 20
# Dateien geschrieben, von denen jede auf 20.000.000 Byte begrenzt ist. An die
# aktuelle Protokollausgabedatei im Rotationssystem werden Protokolleinträge
# angehängt, die in einem einfachen Format geschrieben werden.
#
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 = 20000000
com.ibm.rational.stp.common.internal.util.LogHandler.count = 20
com.ibm.rational.stp.common.internal.util.LogHandler.append = true
com.ibm.rational.stp.common.internal.util.LogHandler.formatter = java.util.logging.SimpleFormatter

# CMTracer - Aktivieren Sie die folgenden Einträge (durch Entfernen der Kommentarzeichen)
# nur vorübergehend, da die Traceerstellung ressourcenintensiv sein kann.
#
# Die folgenden Zeilen geben an, dass die Traceerstellung für das CMTracer-Objekt
# auf der Stufe FINER erfolgen soll, der Traceausgabedatei der Name CMTracer[#].log
# zugeordnet wird und die Datei in das Ausgangsverzeichnis des angemeldeten
# Benutzers gestellt wird. Die Traceausgabe wird im Rotationsprinzip in 20
# Dateien geschrieben, von denen jede auf 20.000.000 Byte begrenzt ist. An die
# aktuelle Traceausgabedatei im Rotationssystem werden Traceeinträge angehängt,
# die in einem einfachen Format geschrieben werden.
#
#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 = 20000000
#com.ibm.rational.stp.common.internal.util.TraceHandler.count = 20
#com.ibm.rational.stp.common.internal.util.TraceHandler.append = true
#com.ibm.rational.stp.common.internal.util.TraceHandler.formatter = java.util.logging.SimpleFormatter

Diese Einstellungen haben zur Folge, dass eine Protokolldatei mit dem Namen CMLogger[#].log erstellt wird; dabei gibt [#] die Nummer der Datei im Rotationssystem an. Die Dateien befinden sich im Ausgangsverzeichnis des angemeldeten Benutzers; die Ausgabe wird jeweils von Datei zu Datei fortgeschrieben, sobald eine Datei voll ist.

Die Einträge in der Datei logging.properties in dem vorherigen Beispiel geben an, dass die Protokolldatensätze am Ende der gültigen Datei angehängt werden sollen und dass jeder Eintrag in einem einfachem Format gespeichert werden soll. Sie müssen die Anwendung stoppen und erneut starten, damit die Änderungen an der Datei erkannt werden.

Wenn eine Protokollausgabedatei voll ist, wird eine neue Datei erstellt und die vorherige Datei wird umbenannt und enthält das Datum und die Zeitmarke der Dateirotation. Jede Datei kann 20 MB Daten aufnehmen; neue Einträge werden an die vorhandenen Einträge angehängt, auch nach Neustarts von Anwendungen. Wenn die Anzahl der Protokolldateien 20 erreicht, hat die Rotation zu einer neuen Datei zur Folge, dass die älteste Datei gelöscht wird.

Weitere Informationen zum Konfigurieren der Java-Protokollierung finden Sie in der Javadoc-Dokumentation zu Ihrem JDK für java.util.logging.Logger und java.util.logging.FileHandler.

Wenn Sie eine Datei mit angepassten Protokolleigenschaften erstellen, müssen Sie die Position der Datei mithilfe des Arguments -D angeben. Beispiel:

java -Djava.util.logging.config.file=C:\myLogPropsFile.properties Ihr_Client-Java-Programm_das_CM-API_verwendet

Feedback