Log4J: Как мне перенаправить OutputStream или Writer на записывающее устройство (я) регистратора?

У меня есть метод, который запускается асинхронно после запуска, используя OutputStream или Writer в качестве параметра.

Он действует как адаптер записи для OutputStream или Writer (это сторонний API, который я не могу изменить).

Как я мог передать внутренний OutputStream или Writer Log4J к этому методу?
... потому что Log4J проглатывает System.out и System.err, который я использовал раньше.

Источник

7 ответов

Решение

Я предлагаю, почему бы вам не написать свой OutputStream тогда?! Я собирался написать один для вас, но я нашел этот хороший пример в сети, посмотрите!

LogOutputStream.java

/*
 * Jacareto Copyright (c) 2002-2005
 * Applied Computer Science Research Group, Darmstadt University of
 * Technology, Institute of Mathematics & Computer Science,
 * Ludwigsburg University of Education, and Computer Based
 * Learning Research Group, Aachen University. All rights reserved.
 *
 * Jacareto is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * Jacareto is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with Jacareto; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 */

package jacareto.toolkit.log4j;


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

import java.io.OutputStream;

/**
 * This class logs all bytes written to it as output stream with a specified logging level.
 *
 * @author <a href="mailto:cspannagel@web.de">Christian Spannagel</a>
 * @version 1.0
 */
public class LogOutputStream extends OutputStream {
    /** The logger where to log the written bytes. */
    private Logger logger;

    /** The level. */
    private Level level;

    /** The internal memory for the written bytes. */
    private String mem;

    /**
     * Creates a new log output stream which logs bytes to the specified logger with the specified
     * level.
     *
     * @param logger the logger where to log the written bytes
     * @param level the level
     */
    public LogOutputStream (Logger logger, Level level) {
        setLogger (logger);
        setLevel (level);
        mem = "";
    }

    /**
     * Sets the logger where to log the bytes.
     *
     * @param logger the logger
     */
    public void setLogger (Logger logger) {
        this.logger = logger;
    }

    /**
     * Returns the logger.
     *
     * @return DOCUMENT ME!
     */
    public Logger getLogger () {
        return logger;
    }

    /**
     * Sets the logging level.
     *
     * @param level DOCUMENT ME!
     */
    public void setLevel (Level level) {
        this.level = level;
    }

    /**
     * Returns the logging level.
     *
     * @return DOCUMENT ME!
     */
    public Level getLevel () {
        return level;
    }

    /**
     * Writes a byte to the output stream. This method flushes automatically at the end of a line.
     *
     * @param b DOCUMENT ME!
     */
    public void write (int b) {
        byte[] bytes = new byte[1];
        bytes[0] = (byte) (b & 0xff);
        mem = mem + new String(bytes);

        if (mem.endsWith ("\n")) {
            mem = mem.substring (0, mem.length () - 1);
            flush ();
        }
    }

    /**
     * Flushes the output stream.
     */
    public void flush () {
        logger.log (level, mem);
        mem = "";
    }
}
Источник

Вы можете использовать Log4j IOStreams

Компонент IOStreams является расширением API Log4j, которое предоставляет многочисленные классы из java.io, которые могут либо записывать в Logger при записи в другой OutputStream или Writer, либо содержимое, считываемое InputStream или Reader, может прослушиваться Logger.

Вы можете создать OutputStream следующим образом:

OutputStream outputStream = IoBuilder
            .forLogger(logger)
            .buildOutputStream();

Ниже приведен пример с Appium, который запускается программно и управляет журналом с помощью log4j.

    final Logger logger = LogManager.getLogger(getClass());

    cap = new DesiredCapabilities();
    cap.setCapability("noReset", "false");

    //Build the Appium service
    builder = new AppiumServiceBuilder();
    builder.withIPAddress("127.0.0.1");
    builder.usingPort(4723);
    builder.withCapabilities(cap);
    builder.withArgument(GeneralServerFlag.SESSION_OVERRIDE);
    builder.withArgument(GeneralServerFlag.LOG_LEVEL,"debug");

    //Start the server with the builder
    service = AppiumDriverLocalService.buildService(builder);

    OutputStream outputStream = IoBuilder
            .forLogger(logger)
            .buildOutputStream();
    service.addOutPutStream(outputStream);

    service.start();

Надеюсь это поможет!!!

Источник

Building on Arthur Neves answer, I transferred this for Slf4J. I also improved this a bit using StringBuffer and directly casting byte to char:

import java.io.OutputStream;

import org.slf4j.Logger;

public class LogOutputStream extends OutputStream {
    private final Logger logger;

    /** The internal memory for the written bytes. */
    private StringBuffer mem;

    public LogOutputStream( final Logger logger ) {
        this.logger = logger;
        mem = new StringBuffer();
    }

    @Override
    public void write( final int b ) {
        if ( (char) b == '\n' ) {
            flush();
            return;
        }
        mem = mem.append( (char) b );
    }

    @Override
    public void flush() {
        logger.info( mem.toString() );
        mem = new StringBuffer();
    }
}
Источник

Источник: http://sysgears.com/articles/how-to-redirect-stdout-and-stderr-writing-to-a-log4j-appender/

Blockquote

Log4j не позволяет перехватывать сообщения stdout и stderr из коробки. Однако, если вы используете сторонние компоненты и должны регистрировать сообщения, которые они сбрасывают в потоки, вы можете сделать небольшой трюк и реализовать собственный поток вывода, который поддерживает ведение журнала.

Это уже было сделано Джимом Муром (см. LoggingOutputStream в исходном коде log4j). Единственная проблема заключается в том, что Jim Moore LoggingOutputStream требует org.apache.log4j.Category и org.apache.log4j.Priority, которые теперь частично устарели.

Вот модифицированный LoggingOutputStream, который избегает устаревших методов:

public class LoggingOutputStream extends OutputStream {

    /**
     * Default number of bytes in the buffer.
     */
    private static final int DEFAULT_BUFFER_LENGTH = 2048;

    /**
     * Indicates stream state.
     */
    private boolean hasBeenClosed = false;

    /**
     * Internal buffer where data is stored.
     */
    private byte[] buf;

    /**
     * The number of valid bytes in the buffer.
     */
    private int count;

    /**
     * Remembers the size of the buffer.
     */
    private int curBufLength;

    /**
     * The logger to write to.
     */
    private Logger log;

    /**
     * The log level.
     */
    private Level level;

    /**
     * Creates the Logging instance to flush to the given logger.
     *
     * @param log         the Logger to write to
     * @param level       the log level
     * @throws IllegalArgumentException in case if one of arguments
     *                                  is  null.
     */
    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;
    }

    /**
     * Writes the specified byte to this output stream.
     *
     * @param b the byte to write
     * @throws IOException if an I/O error occurs.
     */
    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++;
    }

    /**
     * Flushes this output stream and forces any buffered output
     * bytes to be written out.
     */
    public void flush() {
        if (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;
    }

    /**
     * Closes this output stream and releases any system resources
     * associated with this stream.
     */
    public void close() {
        flush();
        hasBeenClosed = true;
    }
}

Теперь вы можете перехватывать сообщения, которые сбрасываются в stderr или stdout, следующим образом:

System.setErr(new PrintStream(new LoggingOutputStream(
        Logger.getLogger("outLog"), Level.ERROR)));

Конфигурация log4j.properties:

log4j.logger.outLog=error, out_log

log4j.appender.out_log=org.apache.log4j.RollingFileAppender
log4j.appender.out_log.file=/logs/error.log
log4j.appender.out_log.MaxFileSize=10MB
log4j.appender.out_log.threshold=error

Дмитрий Павленко, SysGears

Blockquote

Источник

Просматривая здесь ответы, кажется, что ни один из них явно не учитывает декодирование байтов в строки (расширяет CharSequence). bytes есть chars не эквивалентны (см. OutputStream vs Writer в Java). Простой нелатинский символ, например, может быть представлен как последовательность байтов: E7 BE BC (последовательность в кодировке UTF-8).

Причины, по которым другие не учитывают конкретную кодировку:

  • (char) b преобразует нелатинские символы без интерпретации UTF-8, поэтому 羼 становится ç¾¼, или «Роберт» становится «Рубертом» ( о, дома, я видел это много раз ). Возможно, вам более знакома эта красота:  (Спецификация UTF-8)
  • new String(bytes)создает строку «с использованием кодировки платформы по умолчанию», которая зависит от того, где вы запускаете код, поэтому вы, вероятно, получите разное поведение на сервере и локальных машинах. Это лучше, чем (char)b, потому что вы можете указать хотя бы кодировку.
  • log4j-iostreamsIoBuilder по умолчанию также использует кодировку платформы по умолчанию, но ее можно настроить. Кроме того, это не общее решение, работает только в том случае, если вы используете SLF4J вместо Log4j 2. Хотя это был вопрос OP 😅.

(Простите мой Kotlin, вы можете сделать то же самое на Java с другим синтаксисом.)

      private fun loggerStream(outputLine: (line: String) -> Unit): PipedOutputStream {
    val output = PipedOutputStream()
    val input = PipedInputStream(output).bufferedReader()
    thread(isDaemon = true) {
        input.lineSequence().forEach(outputLine)
    }
    return output
}

С помощью этого решения:

  • Переход производительный (буферизованный)
  • Кодировка указывается согласованно (bufferedReader имеет параметр по умолчанию: charset = Charsets.UTF_8, при необходимости можно изменить)
  • Накладные расходы на кодирование происходят в фоновом потоке, хотя это немного странно, но именно так работают конвейеры.
  • Код простой / высокоуровневый
    (без байтовых массивов, индексов, копий, конструкторов String и т. Д.)

Примечание: я использую это для перенаправления вывода Selenium ChromeDriver (по умолчанию на stderr) в SLF4J через Log4J 2:

          val service = ChromeDriverService.createServiceWithConfig(options).apply {
        sendOutputTo(loggerStream(LoggerFactory.getLogger(ChromeDriver::class.java)::info))
    }
    val driver = ChromeDriver(service, options)
Источник

Прочитав ответ /questions/2027054/log4j-kak-mne-perenapravit-outputstream-ili-writer-na-zapisyivayuschee-ustrojstvo-ya-registratora/2027057#2027057 , я начал просматривать существующие OutputStreamреализации, и я наткнулся на org.apache.commons.exec.LogOutputStream.

Вам просто нужно включить его в свой проект, например, с Maven:

      // ...
<dependencies>
    // ...
    <dependency>
        <groupId>org.apache.commons</groupId>
        <artifactId>commons-exec</artifactId>
        <version>1.3</version>
    </dependency>
    // ...
</dependencies>
// ...

И это пример реализации, который я использую в проекте с использованием Selenium с драйвером Chrome и Google Flogger:

      package com.vk.logging;

import com.google.common.flogger.FluentLogger;
import org.apache.commons.exec.LogOutputStream;

import java.util.List;
import java.util.logging.Level;

public class FloggerOutputStream extends LogOutputStream {
    
    // TODO This can be replaced with your favorite logger
    private static final FluentLogger LOGGER = FluentLogger.forEnclosingClass();

    private static final List<Level> KNOWN_LEVELS = List.of(
            Level.OFF,
            Level.SEVERE,
            Level.WARNING,
            Level.INFO,
            Level.CONFIG,
            Level.FINE,
            Level.FINER,
            Level.FINEST,
            Level.ALL
    );

    @Override
    protected void processLine(String line, int logLevel) {
        // TODO This can be replaced with your favorite logger
        LOGGER.at(findClosestLevel(logLevel))
              .log(line);
    }

    private Level findClosestLevel(int logLevel) {
        try {
            return Level.parse(String.valueOf(logLevel));
        } catch (IllegalArgumentException e) {
            // Find the closest level
            for (Level knownLevel : KNOWN_LEVELS) {
                if (knownLevel.intValue() < logLevel) {
                    return knownLevel;
                }
            }
        }

        throw new IllegalArgumentException(
                "Log level " + logLevel + " cannot be mapped to a known log level");
    }
}

В норме не должно быть никаких странностей logLevelно этот угловой случай управляется путем нахождения ближайшего известного уровня журнала.

Надеюсь это поможет

Источник

Так как предыдущий пример Writer, направленный на Log4J, прекратился: http://www.opensource.apple.com/source/JBoss/JBoss-737/jboss-all/common/src/main/org/jboss/logging/util/LoggerWriter.java

Источник
Другие вопросы по тегам