Logback: customize location of configuration file using system property

By setting the system property 'logback.configurationFile', we can customize the location of logback configuraiton file.

 

Example

java -Dlogback.configurationFile=/path/to/config.xml {ApplicaitonClass}
				(OR)

System.setProperty("logback.configurationFile", "/Users/Shared/logback/logback.xml");

 

Find the below working application.

 

Step 1: Create new maven project ‘logback-customize-logback-file-location’.

 

Step 2: Update pom.xml with maven dependencies.

 

pom.xml

<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.sample.app</groupId>
  <artifactId>logback-customize-logback-file-location</artifactId>
  <version>1</version>

  <dependencies>

    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.10</version>
    </dependency>


    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-core</artifactId>
      <version>1.2.10</version>
    </dependency>

    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.36</version>
    </dependency>


  </dependencies>
</project>

 

Step 3: Create logback.xml file under /Users/Shared/logback/ folder.

 

logback.xml

<configuration>

  <statusListener
    class="ch.qos.logback.core.status.OnConsoleStatusListener" />

  <appender name="STDOUT"
    class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
      </pattern>
    </encoder>
  </appender>

  <root level="warn">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

Step 4: Define HelloWorld application.

 

HelloWorld.java

package com.sample.app;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {

  public static void main(String[] args) {

    System.setProperty("logback.configurationFile", "/Users/Shared/logback/logback.xml");

    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.trace("Trace message");
    logger.debug("Debug message");
    logger.info("Info message");
    logger.warn("Warning message");
    logger.error("Error message");

  }
}

Total project structure looks like below.

 

Run HelloWorld.java, you will see below messages in console.

 

 

14:00:37,878 |-INFO in ch.qos.logback.classic.LoggerContext[default] - Found resource [/Users/Shared/logback/logback.xml] at [file:/Users/Shared/logback/logback.xml]
14:00:37,963 |-INFO in ch.qos.logback.classic.joran.action.ConfigurationAction - debug attribute not set
14:00:37,964 |-INFO in ch.qos.logback.core.joran.action.StatusListenerAction - Added status listener of type [ch.qos.logback.core.status.OnConsoleStatusListener]
14:00:38,010 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - About to instantiate appender of type [ch.qos.logback.core.ConsoleAppender]
14:00:38,016 |-INFO in ch.qos.logback.core.joran.action.AppenderAction - Naming appender as [STDOUT]
14:00:38,024 |-INFO in ch.qos.logback.core.joran.action.NestedComplexPropertyIA - Assuming default type [ch.qos.logback.classic.encoder.PatternLayoutEncoder] for [encoder] property
14:00:38,041 |-INFO in ch.qos.logback.classic.joran.action.RootLoggerAction - Setting level of ROOT logger to WARN
14:00:38,042 |-INFO in ch.qos.logback.core.joran.action.AppenderRefAction - Attaching appender named [STDOUT] to Logger[ROOT]
14:00:38,042 |-INFO in ch.qos.logback.classic.joran.action.ConfigurationAction - End of configuration.
14:00:38,044 |-INFO in ch.qos.logback.classic.joran.JoranConfigurator@1df82230 - Registering current configuration as safe fallback point
14:00:38.045 [main] WARN  com.sample.app.HelloWorld - Warning message
14:00:38.046 [main] ERROR com.sample.app.HelloWorld - Error message

You can download complete working application from below link.

https://github.com/harikrishna553/java-libs/tree/master/logback/logback-customize-logback-file-location

 

Previous                                                 Next                                                 Home