Tracing und Protokollierung für Features in Liberty konfigurieren

Sie können die Tracing- und Protokollierungsmechanismen von Liberty für Liberty-Features verwenden. Der Protokollierungsservice wird vom Liberty-Kernel bereitgestellt, daher müssen Sie kein Feature in der Datei server.xml angeben, um ihn nutzen zu können.

Informationen zu diesem Vorgang

Liberty bietet die folgenden SPIs, mit dem Sie das Tracing und die Protokollierung in Ihrem angepassten Feature-Code integrieren können:
com.ibm.websphere.ras
Das Paket com.ibm.websphere.ras stellt Klassen zu Protokollnachrichten und Tracedatensätzen sowie zu einigen Erweiterungspunkten bereit. Im Allgemeinen kann Feature-Code das Paket java.util.logging verwenden, um Trace und Nachrichten zu protokollieren und die Ausgabe über die Konfiguration der Liberty-Protokollierung zu steuern, aber die erweiterte Funktionalität des WebSphere-Pakets ist manchmal nützlich, und die Tracewächter sind ein wenig effizienter, wenn der Trace inaktiviert wird.
com.ibm.websphere.ras.annotations
Das Paket com.ibm.websphere.ras.annotations enthält Annotationen für die Verwendung mit Klassen in den anderen Paketen. Beispielsweise kann eine @Sensitive-Annotation verwendet werden, um zu verhindern, dass der Inhalt der annotierten Variablen in Trace- oder Nachrichtenausgabe erscheint.
com.ibm.ws.ffdc
Das Paket com.ibm.ws.ffdc Paket stellt Funktionen zum Schreiben von FFDC-Datensätzen (First-Failure Data Capture, Erfassung von Fehlerdaten beim ersten Auftreten) bereit, mit denen Fehler im Zusammenhang mit nicht erwarteten Ausnahmebedingungen behoben werden können.
com.ibm.wsspi.logging
Das Paket com.ibm.wsspi.logging stellt Abfangpunkte von Protokoll- und FFDC-Datensätzen bereit.

Ausführliche Informationen zur Java™-API-Dokumentation für die einzelnen SPIs von Liberty finden Sie im Information Center im Abschnitt Programmierschnittstellen (Javadoc) und darüber hinaus als eigenständige .zip-Datei in einem der Javadoc-Unterverzeichnisse des Verzeichnisses ${wlp.install.dir}/dev.

Vorgehensweise

Im Folgenden wird beschrieben, wie ein Liberty-Beispielfeature mit dem Namen myfeature so konfiguriert wird, dass die Liberty-Tracing- und -Protokollierungsmechanismen verwendet werden.

  1. Geben Sie die Position der Nachrichtendatei für das Feature myfeature und den Namen der Gruppe, der von der Klasse com.ibm.websphere.ras.TraceComponent benötigt wird, an.
    import java.util.ResourceBundle;
    
    public class myFeatureConstants {
    
        public static final String TR_RESOURCE_BUNDLE = 
            "com.mycompany.myFeature.internal.resources.FeatureMessages";
    
        public static final String TR_GROUP = "myFeature";
    
        public static final ResourceBundle messages = ResourceBundle.getBundle(TR_RESOURCE_BUNDLE);
    
    }
  2. Rufen Sie in der Implementierungsklasse des Feature-Service-Codes die Methode register() der Klasse com.ibm.websphere.ras.TraceComponent auf, um die Implementierungsklasse mit dem Trace-Manager, der von Liberty bereitgestellt wird, zu registrieren. Anschließend können Sie den Trace-Manager so konfigurieren, dass dieser die DS-Methoden des Features aufzeichnet.
    ...
    import com.ibm.websphere.ras.Tr;
    import com.ibm.websphere.ras.TraceComponent;
    
    
    public class myFeatureServiceImpl {
    
        private static final TraceComponent tc = Tr.register(myFeatureServiceImpl.class);
    
    
        protected void activate(ComponentContext cc, Map<String, Object> newProps) {
            if (tc.isDebugEnabled()) {
                Tr.debug(tc, "myFeatureComponentImpl activated"); }
    ...
  3. Verwenden Sie die Annotation TraceOptions, um den Gruppennamen des Trace und den Namen der Bundlegruppe anzugeben.
    @TraceOptions(traceGroup = myFeatureConstants.TR_GROUP, messageBundle = 
        myFeatureConstants.TR_RESOURCE_BUNDLE)
    package com.mycompany.myFeature;
    
    import com.ibm.websphere.ras.annotation.TraceOptions;
    import com.mycompany.myfeature.internal.myFeatureConstants;
    ...

Symbol das den Typ des Artikels anzeigt. Taskartikel

Dateiname: twlp_feat_logging.html