Maven – Exclude log4j.properties in Jar file

This example shows you how to use Maven to exclude the log4j.properties file from your Jar file.

Note
Please, DO NOT include the log4j.properties into the final Jar file, it will cause multiple log4j.properties files in the classpath, if someone is depending on your Jar, you may accidentally override their logging configurations, depends which Jar is loaded first.
pom.xml

<project>

  <build>
    <plugins>

	<!-- Make this jar executable -->
	<plugin>
		<groupId>org.apache.maven.plugins</groupId>
		<artifactId>maven-jar-plugin</artifactId>
		<configuration>
		        <!-- exclude log4j.properties -->
			<excludes>
				<exclude>**/log4j.properties</exclude>
			</excludes>
			<archive>
			    <manifest>
				<addClasspath>true</addClasspath>
				<mainClass>com.mkyong.core.utils.testing</mainClass>
				<classpathPrefix>dependency-jars/</classpathPrefix>
		            </manifest>
			</archive>
		</configuration>
	</plugin>

    </plugins>
  </build>

</project>

Please pass in your log4j.properties file via log4j.configuration system property like this


$ java -jar -Dlog4j.configuration=file:/full_path/log4j.properties final.jar

mkyong

Founder of Mkyong.com, passionate Java and open-source technologies. If you enjoy my tutorials, consider making a donation to these charities.

3 Comments
Most Voted
Newest Oldest
Inline Feedbacks
View all comments
Pratik Patil
7 years ago

Thanks you sir

Yusuf
8 years ago

When I run this, I get:

Error: Unable to access jarfile .configuration=file:D:devProjectsrrm_biptargetconflog4j.properties

I try to execute:
java -jar -Dlog4j.configuration=file:fullpathtolog4j.properties -jar my_jar.jar

I think after -jar, it directly waits for a jar, not options.

Thanks.

tomcatgeek
11 years ago

How would you provide log4j for tomcat container?