bezieht sich auf Log4j-Konfigurationsdatei aus einer Log4j-Konfigurationsdatei im Klassenpfad

Question

Ich habe eine gemeinsame Jar, die mehrere Web-Anwendungen verwenden. Alle Webanwendungen verwenden log4j. Jeder hat seine eigene log4j xml-Konfigurationsdatei, die im Wesentlichen die gleiche ist. Ich würde gerne eine gemeinsame log4j-Konfiguration in die mitgelieferte JAR-Datei und in jedes einzelne Web-Projekt legen, in dieser log4j-Konfiguration würde ich gerne in der Lage sein, einfach auf den in der JAR-Datei zu verweisen.

Ich sehe nichts in der Dokumentation, die ausdrücklich besagt, dass dies möglich ist. Ich frage mich, ob ich nur die Konfigurationsdatei aus den Webprojekten entfernen und sie in den allgemeinen jar einkleben könnte, wenn sie automatisch geladen würde, da sie auf dem Klassenpfad ist?

Am Ende möchte ich die Protokollierung einer bestimmten Anwendung für Debugging und Fehlerbehebung anpassen, ohne die allgemeine Konfiguration in der JAR-Datei zu ändern.

Answer 1

Ich war an einem Projekt, wo ich brauchte Dutzende von Web-Anwendungen zu verwalten. Jede der Apps protokollierte etwas anders und es war ein großer Fehler, sie zu verwalten. Ich habe eine Strategie verwendet, die der von Ihnen beschriebenen ähnlich ist, um sie auf log4j zu standardisieren, und es hat sich sehr gut bewährt.

Grundsätzlich habe ich eine einzige common.jar erstellt, die gemeinsamen Code enthält. Diese JAR-Datei enthält eine Datei log4j.xml, die die Protokollebene auf INFO setzt und den Standard-Appender auf stdout für common.jar setzt. Diese log4j-Konfiguration wird als Basis für alle anderen Apps verwendet.

Für dieses Beispiel diese Klasse vorgeben ist innen common.jar:

public class ThirdPartyLib 
{ 
    protected static final Logger log = LogManager.getLogger("third-party-lib"); 
    public void doSomething() 
    { 
     log.debug("Third Party App is about to Do something!"); 
     log.info("Third Party App just did something"); 
    } 
} 

nun alle anderen Web-Anwendungen einfach auf common.jar verlassen können. Zum Beispiel so tun, als diese Klasse in myapp.war ist:

public class MyApp 
{ 
    public void CallThirdParty() 
    { 
     ThirdPartyLib lib = new ThirdPartyLib(); 
     lib.doSomething(); 
    } 
} 

Seit log4j.xml innerhalb common.jar ist, wird dieser Code so etwas wie dies loggt sein. Mit anderen Worten, es gibt keine Notwendigkeit log4j.xml innerhalb myapp.war zu setzen:

2011-01-03 15:49:22,451 [main] INFO third-party-lib - Third Party App just did something 

Nun, wenn Sie wollen/müssen, um die Protokollierung in myapp.war zu steuern, dann einfach eine log4j.xml innen myapp.war platzieren und überschreiben Einstellungen von common.jar. Zum Beispiel könnten Sie die Ebene DEBUG, eingestellt und dann werden Sie sehen:

2011-01-03 16:03:22,928 [main] DEBUG third-party-lib - Third Party App is about to Do something! 
2011-01-03 16:03:22,928 [main] INFO third-party-lib - Third Party App just did something 

UPDATE - Ist es möglich, jede Webapp zu konfigurieren, um separate Datei zu protokollieren?

Ja, definitiv. Beispielsweise können Sie Protokolle an einen RollingFileAppender anstelle von stdout in log4j.xml für myapp.war leiten. Dies ist praktisch, da Sie dann jedes einzelne Webapp-Protokoll in einer eigenen separaten Datei speichern können.

Zusätzlich habe ich einen Servlet-Filter geschrieben (ähnlich dem, was gigadot vorgeschlagen hat), der log4j konfiguriert, um zu prüfen, ob eine log4j.xml auf einem externen Pfad existiert (außerhalb jedes Webapps). Auf diese Weise sind die log4j.xml-Dateien auch außerhalb der Kriege zugänglich und wir können Protokollebenen einstellen, ohne den Servlet-Container neu zu starten (in diesem Fall Tomcat). Wenn die externe Datei log4j.xml nicht vorhanden ist, verwendet sie standardmäßig die Datei log4j.xml für jeden Klassenpfad der Anwendung.

Answer 2

Ich bin nicht sicher, dass helfen kann, aber Sie können wie diese Eigenschaft Speicherort der Datei gesetzt,

java -Dlog4j.configuration=jar:file:/full/path/to/app.jar!/log4j.properties -jar app.jar 

Answer 3

Wenn Sie mehrere jar/war-Dateien haben, jede Datei ihre eigene log4j.xml hat und Sie sich nicht darum kümmern müssen, welche log4j.xml geladen wird, können Sie die Konfiguration explizit selbst laden.

Legen Sie für ein Webapp-Projekt den folgenden Context-Listener als ersten Listener in Ihrer web.xml fest. Dadurch wird log4j von Ihrem bevorzugten Pfad geladen.

<listener> 
    <listener-class>mycompany.server.listener.Log4JInitServletContextListener</listener-class> 
</listener> 

Implementierung von Log4JInitServletContextListener.

Hinweis: Wenn Sie mehrere log4j.xml im selben Pfad haben (was für mehrere JAR-Dateien möglich ist), wird es verwirrend sein, welcher geladen wird. Versuchen Sie also, einen eindeutigen Paketnamen für die Konfigurationsressource in Ihrem allgemeinen Jar zu haben.

Wie Sie sehen, können Sie diese Methode verwenden, um log4j.xml abhängig von der Bedingung zu laden.

package mycompany.server.listener; 

import javax.servlet.ServletContextEvent; 
import javax.servlet.ServletContextListener; 

import org.apache.log4j.xml.DOMConfigurator; 

public class Log4JInitServletContextListener implements ServletContextListener { 

    @Override 
    public void contextInitialized(ServletContextEvent sce) { 
     org.w3c.dom.Element log4jConfigElement = parseFromInputStream(getClass().getResourceAsStream("/unique/package/name/in/common/jar/log4j.xml");); 
     DOMConfigurator.configure(log4jConfigElement); 
    } 

    // omit the rest and implementation of parseFromInputStream method 
}