Log4J bei mehreren Modulen

[DaBe1812]

Hi,
ich habe ein Problem in meinem Projekt beim Testen.
Ich verwende Log4j2 als Logger. Mein Projekt besteht aus vielen kleinen Modulen, von denen die meisten komplett selbstständig lauffähig sind. Packe ich jetzt in jedes meiner Module in den resources-Ordner eine log4j2.xml, dann loggt das Modul beim Testen sauber da hin, wo ich es gerne hätte.
Wenn ich jetzt aber ein Modul kompilieren, welches mehrere dieser Einzelmodule enthält, dann wird scheinbar irgendeine dieser log4j2.xml genommen und als DIE log4j2.xml verwendet.
D.h. das logging ist mehr oder minder zwar da, aber ich unterscheide z.B. für die Untermodule den Dateinamen in den geloggt werden soll und dann gibt es keine Aufspaltung und der Dateiname ist irgendeiner.
Beholfen habe ich mir jetzt damit, dass ich in keinem meiner Module eine log4j2.xml habe, sondern nur in dem "Hauptmodul" welches die anderen verwendet. Da habe ich dann mehrere File-Appender eingetragen und das System funktioniert. Aber beim testen der Einzelmodule bekomme ich jetzt kein Logging mehr und muss eigentlich alles, was ich schnell in der Konsole checken möchte mit System.out testen, was ich dann hinterher wieder entfernen muss, weil es eigentlich nicht schön ist.

Gibt es hier irgendeine Möglichkeit, dass das logging in beiden Fällen funktioniert? Am besten sogar mit einer log4j2-Konfiguration in jedem einzelnen Projekt, weil ich dann Konfigurationen viel einfache nachpflegen kann und muss nicht immer erst noch das Modul suchen in welchem die log4j2.xml liegt.

 

[KonradN]

Was genau machst Du denn, um die Module zusammen zu führen. Das klingt für mich etwas danach, dass Du eine FAT Jar baust und dann gibt es halt mehrere log4j2.xml Dateien und "eine gewinnt".

In so einem Szenario gehe ich hin, uns sage, dass von den Abhängigkeiten eben die gemeinsame Datei nicht mitgenommen werden soll und damit habe ich dann im Hauptprojekt genau die Version, die ich brauche und in der ich dann ja genau weiss, was ich so alles brauche.

Oder Du hast alle möglichen jar Dateien und dann wird halt die log4j2.xml genommen, die zuerst im Classpath kommt?

Daher beschreib bitte etwas genauer dein Szenario.

Edit: Und natürlich kannst Du Dir auch https://logging.apache.org/log4j/2.x/manual/configuration.html anschauen. Da wird die Suchreihenfolge im Detail beschrieben sowie die Möglichkeiten, die Du hast (z.B. über die Property log4j2.configurationFile Property.

 

[DaBe1812]

Jupp, wir reden über eine FAT-Jar, d.h. alle Module sind gebuildet und werden dann im Über-Modul als Depenencies mit eingebunden. Theoretisch könnte man tatsächlich die log4j2.xml beim Builden weglassen, weil das Jar-File später auf jeden Fall nicht Standalone verwendet wird.

 

[KonradN]

Dann ist es doch erst einmal einfach. Beim Bau der FAT Jar lässt Du die log4j2.xml weg.

Beim Shade Plugin gibst Du einfach einen Filter an. Bei jedem Filter kannst Du angeben:

• artifact- das ist ein groupId:archetypeId wobei Du auch Wildcards verwenden kannst wie :
• in excludes ein oder mehrere exclude - das wäre dann z.B. hier /log4j2.xml

Das ist eine durchaus übliche Vorgehensweise z.B. auch um Signaturen zu entfernen, die enthalten sein könnten.

Aber natürlich kannst Du auch generell die log4j2.xml aus den jar Dateien entfernen.

 

[DaBe1812]

Cool, bei Ant ging das ähnlich, aber da ich noch am Lernen bin mit Maven muss ich jetzt erstmal lesen, wie das mit dem Shade Plugin geht. Bzw. bin ich mir fast sicher, dass ich da auch ein Beispiel in deiner riesigen POM finden werde.

 

[KonradN]

Nein, in den beiden GitHub Projekten wird das shade Plugin nicht genutzt. Aber ein Beispiel kann ich Dir aus einem meiner anderen Projekte geben:

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>${maven.shade.plugin}</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <shadedArtifactAttached>true</shadedArtifactAttached>
                    <shadedClassifierName>full</shadedClassifierName>
                    <transformers>
                        <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
                        <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                            <manifestEntries>
                                <Main-Class>${main.class}</Main-Class>
                                <Build-Version>1.0</Build-Version>
                            </manifestEntries>
                        </transformer>
                    </transformers>
                    <filters>
                        <filter>
                            <artifact>*:*</artifact>
                            <excludes>
                                <exclude>META-INF/MANIFEST.MF</exclude>
                                <exclude>**/module-info.class</exclude>
                                <exclude>META-INF/LICENSE.txt</exclude>
                                <exclude>META-INF/LICENSE.md</exclude>
                                <exclude>META-INF/LICENSE</exclude>
                                <exclude>META-INF/NOTICE.md</exclude>
                                <exclude>META-INF/NOTICE</exclude>
                                <exclude>META-INF/*.SF</exclude>
                                <exclude>META-INF/*.DSA</exclude>
                                <exclude>META-INF/*.RSA</exclude>
                            </excludes>
                        </filter>
                    </filters>
                </configuration>
            </plugin>

Bei der Konfiguration sind en paar Dinge, die ich kurz erläutern möchte:

                    <shadedArtifactAttached>true</shadedArtifactAttached>
                    <shadedClassifierName>full</shadedClassifierName>

Standard Verhalten ist, dass das original jar umbenannt wurde und das shade jar dann an die Stelle des originalen jar Files kommt. Das wird hier ausgeschaltet und das shade jar wird ein -full.jar am Ende bekommen.

ServiceTransformer sorgt dafür, dass die Services der Abhängigkeiten alle weiter funktionieren. Also z.B. wenn Du JDBC Treiber einbinden musst oder so.

                        <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                            <manifestEntries>
                                <Main-Class>${main.class}</Main-Class>
                                <Build-Version>1.0</Build-Version>
                            </manifestEntries>
                        </transformer>

Ich schreibe das Manifest noch einmal selbst. Daher auch das ausfiltern der Manifest Dateien in den excludes.

Die Filter sind nicht zu übersehen - da nehme ich halt diverse Dinge raus:

• allen Artefakte (:) - das betrifft auch das eigene Artefakt/Projekt
• alle Manifests - daher schreibe ich ein eigenes.
• module-info.class wird komplett entfernt. Das ** kommt, weil man das auch in Unterordnern kommen kann (für spezifische Java Versionen)
• paar Lizenz und Notice Dateien - Wenn das shade Plugin meckert, dann fixe ich das in der Regel.
• die letzten Drei Einträge kommen von signierten jar Dateien.

Das wäre dann das Beispiel mit kurzer Erklärug.

 

[DaBe1812]

Moin, jetzt hatte ich tatsächlich das erste Teilprojekt mit einem Fehler und habe mich gleich an den Einbau gemacht. Meine POM sieht jetzt so aus:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <artifactId>simplechecktools</artifactId>
        <groupId>intern.pips</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <groupId>intern.pips.simplechecktools</groupId>
    <artifactId>Checker</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <properties>
        <main.class>intern.pips.simplecheck.checker.Checker</main.class>
        <main.module>AppModule</main.module>
        <link.name>${project.artifactId}</link.name>
        <launcher>${project.artifactId}</launcher>
        <appName>${project.artifactId}</appName>
        <jar.filename>${project.artifactId}</jar.filename>
    </properties>

    <dependencies>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.6.0</version>
                <configuration>
                    <archive>
                        <manifest>
                            <mainClass>${main.class}</mainClass>
                        </manifest>
                    </archive>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                </configuration>
                <executions>
                    <execution>
                        <configuration>
                            <finalName>${jar.filename}</finalName>
                        </configuration>
                        <id>make-assembly</id> <!-- this is used for inheritance merges -->
                        <phase>package</phase> <!-- bind to the packaging phase -->
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
                <version>${maven.shade.plugin}</version>
                <executions>
                    <execution>
                        <phase>package</phase>
                        <goals>
                            <goal>shade</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <shadedArtifactAttached>true</shadedArtifactAttached>
                    <shadedClassifierName>full</shadedClassifierName>
                    <filters>
                        <filter>
                            <artifact>*:*</artifact>
                            <excludes>
                                <exclude>**/log4j2.xml</exclude>
                            </excludes>
                        </filter>
                    </filters>
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

Ergebnis ist, dass ich jetzt eine "dependency-reduced-pom.xml" habe und im Target Folder ist die log4j2.xml trotzdem drin. Was habe ich jetzt falsch gemacht?

 

[KonradN]

Ergebnis ist, dass ich jetzt eine "dependency-reduced-pom.xml"

Ja, denn das erstellte jar hat ja jetzt keine dependencies mehr. Wenn Du also diese jar Datei in einem anderen Projekt verwenden wolltest, dann würdest Du ja dieses veränderte pom haben wollen.

und im Target Folder ist die log4j2.xml trotzdem drin.

Da verstehe ich gerade nicht: Im target Folder ist die log4j2.xml? Oder meinst Du im -full.jar File?

Der Filter gibt ja an, was nicht in das full-jar File kommen sollen.

 

[DaBe1812]

Da verstehe ich gerade nicht: Im target Folder ist die log4j2.xml? Oder meinst Du im -full.jar File?

Alles klar, das war mein Denkfehler, ich hab in den TARGET-Folder im Projekt geschaut. In der -full.jar fehlt die log4j2.xml.

Ja, denn das erstellte jar hat ja jetzt keine dependencies mehr. Wenn Du also diese jar Datei in einem anderen Projekt verwenden wolltest, dann würdest Du ja dieses veränderte pom haben wollen.

Das verstehe ich nicht. Was bedeutet in dem Fall keine Dependencies? Weil alles, was dazu gehört schon im Jar-File drin ist?

Und dann noch die Frage, wenn ich mit das Maven Goual install ausführe, dann ist es ja in meinem lokalen Maven Repo, muss ich dann etwas bestimmtes in den POMs angeben, die die jar dann verwenden sollen, damit auch diese jar und nicht eine der beiden anderen gegriffen wird?