Ability to customize log file name when logging.path is set

[xak2000]

With the current implementation, when logging.path is set to some value and logging.file is not set, the logging file name is always spring.log.

spring-boot/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/LogFile.java

Lines 105 to 108 in c115ee1

	public void applyTo(Properties properties) {
	put(properties, LoggingSystemProperties.LOG_PATH, this.path);
	put(properties, LoggingSystemProperties.LOG_FILE, toString());
	}

spring-boot/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/logging/LogFile.java

Lines 117 to 122 in c115ee1

	public String toString() {
	if (StringUtils.hasLength(this.file)) {
	return this.file;
	}
	return new File(this.path, "spring.log").getPath();
	}

I want to be able to set logging.path for several microservices at once, using environment variable for example:

LOGGING_PATH=/var/log/services

This works, but all services start to write their logs into signle /var/log/services/spring.log file.

To prevent this, I added custom logback-spring.xml to each application and also one logback-base.xml into common module (that all microservices depend on).

I added these lines into logback-base.xml:

<included>
    <springProperty scope="context" name="APPLICATION_NAME" source="spring.application.name"/>
    <property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${java.io.tmpdir:-/tmp}/services}/${APPLICATION_NAME:-service}.log}"/>
    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <include resource="org/springframework/boot/logging/logback/console-appender.xml" />
    <include resource="org/springframework/boot/logging/logback/file-appender.xml" />
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</included>

This is how logback-spring.xml looks in each application:

<configuration>
    <include resource="logback-base.xml"/>
</configuration>

The idea is to store all logs in the same path, but each log file have it's own name, based on spring.application.name.

But this doesn't work when only logging.path is set, because LogFile class always explicitly sets LOG_FILE system property, using it's toString() method and adding spring.log as file name.

Maybe LogFile can be enhanced to allow to set some strategy that provides an ability to customize log file name (when it is not explicitly set)? Some LogFileNameCustomizer bean or something.

Or maybe at least we can make spring.application.name to be default log file name if this property is set and logging.file is not set? (this is breaking change though, but it can be hidden under some flag).

[mbhave]

I think this would be a generally useful feature. Let's see what the rest of the team thinks.

[wilkinsona]

This sounds useful to me too.

Some LogFileNameCustomizer bean or something.

This approach won't be possible as logging configuration is needed before any beans are available.

[rhamedy]

Depending on the outcome of the design work as well as complexity of the fix, I would be happy to work on this issue 🙂

[ckoutsouridis]

in our case, we created a an extra application listener and registered it under: META-INF/spring.factories

org.springframework.context.ApplicationListener=\
com.OurListener

the content of the listener was something along:

    private void onApplicationEnvironmentPreparedEvent(
            ApplicationEnvironmentPreparedEvent event) {
        Environment environment = event.getEnvironment();
        String springApp = environment.getProperty("spring.application.name");
        String applicationName = springApp == null ? "application" : springApp;

        if (environment.getProperty("logging.path") == null) {
            System.setProperty("logging.path", "logs");
        }
        if (environment.getProperty("logging.file") == null) {
            String logFileName = applicationName + ".log";
            System.setProperty("logging.file", environment.getProperty("logging.path") + "/" + logFileName);
        }

and the order of the listener was: LoggingApplicationListener.DEFAULT_ORDER - 1;

the main motivation for the above was to have a property logging.path that would point to a folder, so that we could use it as well in configuring logback-access to write in the same directory without duplicating the path.

Since this is a breaking change with existing semantics and i think in 2.2 the properties will be renamed to logging.file.name and logging.file.path i think it's a nice excuse to apply this behaviour in the new properties as defaults and as @xak2000 suggested, make spring.application.name the default file name instead of spring.

[jwenjian]

I finally know that why my logging.file.name not working, I'm using 2.1.11.

But there is no version description in spring doc: https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html

So maybe put a new "Version since"column in the right of the table to do this?

[mbhave]

@jwenjian The docs are tied to the version of Spring Boot. https://docs.spring.io/spring-boot/docs/current/reference/html/appendix-application-properties.html points to the current GA release which at the time of writing is the 2.2.x line. You can get the 2.1.x docs, by going to https://docs.spring.io/spring-boot/docs/2.1.13.RELEASE/reference/html/common-application-properties.html.