Изменить уровень приложения вместо уровня регистратора

Question

Моя команда использует Spring Boot Admin для контроля нашего spring application,
В Spring Boot Admin у нас есть возможность изменить logger уровень в Runtime,

у нас есть отдельный регистратор для каждого task (Thread), и если мы хотим видеть журналы консоли только для одного потока, мы отключаем все другие логгеры потоков. Проблема в том, что каждый логгер отправляет свой вывод как для STDOUT а также для определенного файла, и мы хотим отключить только вывод stdout.

Пример конфигурации log4j2.xml:

<Loggers>
   <Logger name="task1" level="info">
     <AppenderRef ref="Console"/>
     <AppenderRef ref="File"/>
   </Logger>
   <Logger name="task2" level="info">
     <AppenderRef ref="Console"/>
     <AppenderRef ref="File"/>
   </Logger>
</Loggers>

Мы перепробовали много решений:

• использовать родительские логгеры в сочетании с аддитивностью и разделять каждого аппендера на разные логгеры. Есть идеи по этому поводу?

Answer 1

Log4j2 не позволяет управлять потоками System.out и System.err по умолчанию.

Чтобы уточнить, как работает консольный логгер: Просто Console appender печатает свой вывод в System.out или System.err. Согласно документации, если вы не укажете цель по умолчанию, она выведет в System.out:

https://logging.apache.org/log4j/2.x/manual/appenders.html

цель || Строка || Либо "SYSTEM_OUT", либо "SYSTEM_ERR". По умолчанию используется значение "SYSTEM_OUT".

---

Вот пример:

log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <Properties>
        <Property name="log-pattern">%d{ISO8601} %-5p %m\n</Property>
    </Properties>
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout>
                <pattern>${log-pattern}</pattern>
            </PatternLayout>
        </Console>
    </appenders>
    <Loggers>
        <logger name="testLogger" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
    </Loggers>
</configuration>

LogApp.java

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class LogApp {
    public static void main(String[] args) {
        Logger log = LogManager.getLogger("testLogger");
        log.info("Logger output test!");
        System.out.println("System out test!");
    }
}

Выход:

2019-01-08T19:08:57,587 INFO  Logger output test!
System out test!

---

Обходной путь для управления системными потоками

Возьмите класс перенаправления потока Дмитрия Павленко

https://sysgears.com/articles/how-to-redirect-stdout-and-stderr-writing-to-a-log4j-appender/

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.Logger;

import java.io.IOException;
import java.io.OutputStream;

/**
  * A change was made on the existing code:
  * - At (LoggingOutputStream#flush) method 'count' could contain 
  *  single space character, this types of logs has been skipped
  */
public class LoggingOutputStream extends OutputStream {
    private static final int DEFAULT_BUFFER_LENGTH = 2048;
    private boolean hasBeenClosed = false;
    private byte[] buf;
    private int count;

    private int curBufLength;

    private Logger log;

    private Level level;

    public LoggingOutputStream(final Logger log,
                               final Level level)
            throws IllegalArgumentException {
        if (log == null || level == null) {
            throw new IllegalArgumentException(
                    "Logger or log level must be not null");
        }
        this.log = log;
        this.level = level;
        curBufLength = DEFAULT_BUFFER_LENGTH;
        buf = new byte[curBufLength];
        count = 0;
    }

    public void write(final int b) throws IOException {
        if (hasBeenClosed) {
            throw new IOException("The stream has been closed.");
        }
        // don't log nulls
        if (b == 0) {
            return;
        }
        // would this be writing past the buffer?
        if (count == curBufLength) {
            // grow the buffer
            final int newBufLength = curBufLength +
                    DEFAULT_BUFFER_LENGTH;
            final byte[] newBuf = new byte[newBufLength];
            System.arraycopy(buf, 0, newBuf, 0, curBufLength);
            buf = newBuf;
            curBufLength = newBufLength;
        }

        buf[count] = (byte) b;
        count++;
    }

    public void flush() {
        if (count <= 1) {
            count = 0;
            return;
        }
        final byte[] bytes = new byte[count];
        System.arraycopy(buf, 0, bytes, 0, count);
        String str = new String(bytes);
        log.log(level, str);
        count = 0;
    }

    public void close() {
        flush();
        hasBeenClosed = true;
    }
}

И создайте собственный регистратор для системного потока вывода, а затем зарегистрируйте его.

Вот полный код использования регистратора:

log4j2.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <Properties>
        <Property name="log-pattern">%d{ISO8601} %-5p %m\n</Property>
    </Properties>
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout>
                <pattern>${log-pattern}</pattern>
            </PatternLayout>
        </Console>
    </appenders>
    <Loggers>
        <logger name="testLogger" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        <logger name="systemOut" level="info" additivity="true"/>
    </Loggers>
</configuration>

SystemLogging.java

import org.apache.logging.log4j.Level;
import org.apache.logging.log4j.LogManager;

import java.io.PrintStream;

public class SystemLogging {
    public void enableOutStreamLogging() {
        System.setOut(createPrintStream("systemOut", Level.INFO));
    }

    private PrintStream createPrintStream(String name, Level level) {
        return new PrintStream(new LoggingOutputStream(LogManager.getLogger(name), level), true);
    }
}

LogApp.java

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public class LogApp {
    public static void main(String[] args) {
        new SystemLogging().enableOutStreamLogging();

        Logger log = LogManager.getLogger("testLogger");
        log.info("Logger output test!");
        System.out.println("System out test!");
    }
}

Окончательный вывод

2019-01-08T19:30:43,456 INFO  Logger output test!
19:30:43.457 [main] INFO  systemOut - System out test!

---

Теперь настройте систему с помощью новой конфигурации регистратора, как вы хотите.

Плюс; если вы не хотите переопределять System.out и просто хочу сохранить его: в библиотеке commons-io есть TeeOutputStream. Вы можете просто заменить оригинал System.out с комбинацией оригинальных System.out а также LoggingOutputStream это будет писать одновременно в оба потока. Это не изменит исходный вывод, но позволит вам сохранить System.out с приложением регистрации.