Java的:如何登录生JSON作为JSON和用的logback / SLF4J登录过程中避免逃逸(J

2019-07-22 06:09发布

我在JAX-RS应用程序中使用SLF4J的logback用...我想登录到JSON在我的消息不被再次编码,但印刷原材料到日志文件中这样写道:

目前,它看起来像这样:

{"@timestamp":1363834123012,"@message":"{\"text\":\"From MLK to Barack 
Ob...\n\"}"

但我想有这样的:

  {"@timestamp":1363834123012,"@message": { "text ": "From MLK to Barack 
Ob...\n\}

原因是我想再次解析JSON,并希望避免数据的转义。

我写了一个定制的logback编码器,但我发现没有办法避免的转义。 我可以通过一个对象的logback和更改基于对象的类型设置?

编辑:我已经找到一种方法 - 不完全是优雅 - 作为请求SSCE:

在我的应用

// SLF4J Logger
private static Logger logger = LoggerFactory.getLogger(MyClass.class);
// A logback? Marker
private Marker foo = MarkerFactory.getMarker("foo");
// Jackson ObjectMapper()
ObjectMapper mapper = new ObjectMapper();

// Log something... 
logger.info(foo, mapper.writeValueAsString(json));

我用Logstash编码器的变化在这里找到: https://github.com/logstash/logstash-logback-encoder

package my.package;

import static org.apache.commons.io.IOUtils.*;

import java.io.IOException;
import java.util.Map;
import java.util.Map.Entry;

import org.codehaus.jackson.JsonGenerator.Feature;
import org.codehaus.jackson.JsonNode;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.node.ObjectNode;
import org.slf4j.Marker;

import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.classic.spi.IThrowableProxy;
import ch.qos.logback.classic.spi.ThrowableProxyUtil;
import ch.qos.logback.core.CoreConstants;
import ch.qos.logback.core.encoder.EncoderBase;

public class JsonEncoder extends EncoderBase<ILoggingEvent> {

    private static final ObjectMapper MAPPER = new ObjectMapper().configure(
        Feature.ESCAPE_NON_ASCII, true);
    private static Marker M;

    private boolean immediateFlush = true;

@Override
public void doEncode(ILoggingEvent event) throws IOException {

    M = event.getMarker();

    ObjectNode eventNode = MAPPER.createObjectNode();

    eventNode.put("@timestamp", event.getTimeStamp());
    //
    if (M != null) {
        if (M.getName().equals("foo")) {
            JsonNode j = MAPPER.readTree(event.getFormattedMessage());
            eventNode.put("@foo", j);
        }
    } else {
        eventNode.put("@message", event.getFormattedMessage());
    }
    eventNode.put("@fields", createFields(event));

    write(MAPPER.writeValueAsBytes(eventNode), outputStream);
    write(CoreConstants.LINE_SEPARATOR, outputStream);

    if (immediateFlush) {
        outputStream.flush();
    }

}

private ObjectNode createFields(ILoggingEvent event) {
         // not important here
    return fieldsNode;

}

@Override
public void close() throws IOException {
    write(LINE_SEPARATOR, outputStream);
}

public boolean isImmediateFlush() {
    return immediateFlush;
}

public void setImmediateFlush(boolean immediateFlush) {
    this.immediateFlush = immediateFlush;
}
}

现在的作品! 是啊! 但我想这不是做到这一点的最好办法(序列化,反序列化JSON的...)

Answer 1:

的logback不会做任何不寻常的使用JSON。 这只是被记录为正常的字符串。 逃逸可能是发生在你的结束,除非你在谈论某种JSON的Appender的是正在写出来这种格式。 我敢肯定的logback本身不具备这样的事情,所以你想看看你的地方,而不是从如果这是你的问题得到了追加程序。 一个SSCCE将有助于进一步的故障排除。



Answer 2:

如果你有一个JSON格式的消息,上解决方案的工作,但不是那么好,既然你不想将调用logstash特定代码,每次你用你的记录器中的代码。

只要添加一个

net.logstash.logback.encoder.LogstashEncoder

是不够的,因为消息itsself撑逃脱 。 为了解决这个问题,尝试在logback.xml如下:

<encoder class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
     <providers>
        <timestamp/>
        <version/>
        <loggerName/>
        <pattern>
            <pattern>
                {
                "jsonMessage": "#asJson{%message}"
                }
            </pattern>
        </pattern>
    </providers>
</encoder>

该#asJson模式将取消转义您的消息。



Answer 3:

使用RawJsonAppendingMarker:

log.trace(net.logstash.logback.marker.Markers.appendRaw("jsonMessage", jsonString), null);


Answer 4:

我遇到了同样的问题。 我解决了它与

<encoder
 class="net.logstash.logback.encoder.LogstashEncoder">          
</encoder

代替

<encoder
 class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">

在我的Java代码我使用:

SRV_PERF_LOGGER.info(net.logstash.logback.marker.Markers.appendRaw("message", jackson.writeValueAsString(dto)), null);


Answer 5:

这里是一个更新的(2016)常规的logback配置转储出你的日志,JSON格式的文件,和调试线在控制台中。 我花了一整天要弄清楚,所以我想我会更新线程。

    import ch.qos.logback.classic.encoder.PatternLayoutEncoder
import ch.qos.logback.core.ConsoleAppender
import ch.qos.logback.core.rolling.FixedWindowRollingPolicy
import ch.qos.logback.core.rolling.RollingFileAppender
import ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy
import net.logstash.logback.encoder.LogstashEncoder

import static ch.qos.logback.classic.Level.INFO
import static ch.qos.logback.classic.Level.WARN

def PROJECT_ID = "com.foo"

    appender("file", RollingFileAppender) {
        file = "/tmp/logs/${PROJECT_ID}.json"
        encoder(LogstashEncoder)
        rollingPolicy(FixedWindowRollingPolicy) {
            maxIndex = 1
            fileNamePattern = "logs/${PROJECT_ID}.json.%i"
        }
        triggeringPolicy(SizeBasedTriggeringPolicy) {
            maxFileSize = "1MB"
        }
    }


    appender("STDOUT", ConsoleAppender) {
        encoder(PatternLayoutEncoder) {
            pattern = "%d{HH:mm:ss.SSS} %-5level %logger{36} - %msg%n"
        }
    }

    logger("com.foo", INFO, ["STDOUT", "file"], false)

    root(WARN, ["STDOUT", "file"])


Answer 6:

就在此次来到自己,发现有一篇文章上记录一些recommandations 。

如果你用maven把这个依赖成pom.xml

<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>3.4</version>
</dependency>

并把这样的事情到logback.xml

<configuration>
    <property name="PROJECT_ID" value="example"/>
    <appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>logs/${PROJECT_ID}.json</File>
        <encoder class="net.logstash.logback.encoder.LogstashEncoder"/>
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <maxIndex>1</maxIndex>
            <FileNamePattern>logs/${PROJECT_ID}.json.%i</FileNamePattern>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>1MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
    <logger name="eu.kielczewski" additivity="false" level="INFO">
        <appender-ref ref="file"/>
    </logger>
    <root level="WARN">
        <appender-ref ref="file"/>
    </root>
</configuration>

这将创建example.json下文件logs/ 。 当它的大小达到1MB的文件被卷起一次。

LOGGER.debug(append("object", someObject), "log message");


Answer 7:

我看不出这是造成你的问题的原代码,但我怀疑它可能是这样的

JsonNode logOutput;
String messageJSONAsString;

...

logOutput.put("@message", messageJSONAsString);
logger.info(objectMapper.writeValueAsString(logOutput);

这将在您的输出产生逃脱JSON,因为当你把消息到输出JsonNode,杰克逊将重新逃脱它为您确保输出是有效的JSON。

这里的解决方案是把信息在输出作为ObjectNode,而不是作为一个字符串。 通常你已经访问对象为对象,在这种情况下,你可以做

ObjectNode jsonObject = objectMapper.valueToTree(messageObject);
logOutput.put("@message", jsonObject)

否则,如果你的消息是一个JSON字符串,然后分析它,并把它添加到输出

logoutput.put("@message", objectMapper.readTree(messageJSONAsString));


文章来源: Java: How to log raw JSON as JSON and avoid escaping during logging with logback / slf4j