Skip to content

Add StructuredLoggingJsonEncoder #972

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+319 −43
Open

Add StructuredLoggingJsonEncoder #972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
99 changes: 56 additions & 43 deletions logback-classic/src/main/java/ch/qos/logback/classic/encoder/JsonEncoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,37 +89,37 @@ public class JsonEncoder extends EncoderBase<ILoggingEvent> {

public static final String STEP_ARRAY_NAME_ATTRIBUTE = "stepArray";

private static final char OPEN_OBJ = '{';
private static final char CLOSE_OBJ = '}';
private static final char OPEN_ARRAY = '[';
private static final char CLOSE_ARRAY = ']';
protected static final char OPEN_OBJ = '{';
protected static final char CLOSE_OBJ = '}';
protected static final char OPEN_ARRAY = '[';
protected static final char CLOSE_ARRAY = ']';

private static final char QUOTE = DOUBLE_QUOTE_CHAR;
private static final char SP = ' ';
private static final char ENTRY_SEPARATOR = COLON_CHAR;
protected static final char QUOTE = DOUBLE_QUOTE_CHAR;
protected static final char SP = ' ';
protected static final char ENTRY_SEPARATOR = COLON_CHAR;

private static final String COL_SP = ": ";
protected static final String COL_SP = ": ";

private static final String QUOTE_COL = "\":";
protected static final String QUOTE_COL = "\":";

private static final char VALUE_SEPARATOR = COMMA_CHAR;
protected static final char VALUE_SEPARATOR = COMMA_CHAR;

private boolean withSequenceNumber = true;
protected boolean withSequenceNumber = true;

private boolean withTimestamp = true;
private boolean withNanoseconds = true;
protected boolean withTimestamp = true;
protected boolean withNanoseconds = true;

private boolean withLevel = true;
private boolean withThreadName = true;
private boolean withLoggerName = true;
private boolean withContext = true;
private boolean withMarkers = true;
private boolean withMDC = true;
private boolean withKVPList = true;
private boolean withMessage = true;
private boolean withArguments = true;
private boolean withThrowable = true;
private boolean withFormattedMessage = false;
protected boolean withLevel = true;
protected boolean withThreadName = true;
protected boolean withLoggerName = true;
protected boolean withContext = true;
protected boolean withMarkers = true;
protected boolean withMDC = true;
protected boolean withKVPList = true;
protected boolean withMessage = true;
protected boolean withArguments = true;
protected boolean withThrowable = true;
protected boolean withFormattedMessage = false;

@Override
public byte[] headerBytes() {
Expand All @@ -138,7 +138,7 @@ public byte[] encode(ILoggingEvent event) {

if (withTimestamp) {
appendValueSeparator(sb, withSequenceNumber);
appenderMemberWithLongValue(sb, TIMESTAMP_ATTR_NAME, event.getTimeStamp());
appenderTimestamp(sb, event);
}

if (withNanoseconds) {
Expand Down Expand Up @@ -179,7 +179,7 @@ public byte[] encode(ILoggingEvent event) {

if (withMessage) {
sb.append(VALUE_SEPARATOR);
appenderMember(sb, MESSAGE_ATTR_NAME, jsonEscape(event.getMessage()));
appenderMessage(sb, event);
}

if (withFormattedMessage) {
Expand All @@ -194,12 +194,25 @@ public byte[] encode(ILoggingEvent event) {
if (withThrowable)
appendThrowableProxy(sb, THROWABLE_ATTR_NAME, event.getThrowableProxy());

appenderExtra(sb, event);

sb.append(CLOSE_OBJ);
sb.append(CoreConstants.JSON_LINE_SEPARATOR);
return sb.toString().getBytes(UTF_8_CHARSET);
}

void appendValueSeparator(StringBuilder sb, boolean... subsequentConditionals) {
protected void appenderMessage(StringBuilder sb, ILoggingEvent event) {
appenderMember(sb, MESSAGE_ATTR_NAME, jsonEscape(event.getMessage()));
}

protected void appenderExtra(StringBuilder sb, ILoggingEvent event) {
}

protected void appenderTimestamp(StringBuilder sb, ILoggingEvent event) {
appenderMemberWithLongValue(sb, TIMESTAMP_ATTR_NAME, event.getTimeStamp());
}

protected void appendValueSeparator(StringBuilder sb, boolean... subsequentConditionals) {
boolean enabled = false;
for (boolean subsequent : subsequentConditionals) {
if (subsequent) {
Expand All @@ -212,7 +225,7 @@ void appendValueSeparator(StringBuilder sb, boolean... subsequentConditionals) {
sb.append(VALUE_SEPARATOR);
}

private void appendLoggerContext(StringBuilder sb, LoggerContextVO loggerContextVO) {
protected void appendLoggerContext(StringBuilder sb, LoggerContextVO loggerContextVO) {

sb.append(QUOTE).append(CONTEXT_ATTR_NAME).append(QUOTE_COL);
if (loggerContextVO == null) {
Expand All @@ -231,7 +244,7 @@ private void appendLoggerContext(StringBuilder sb, LoggerContextVO loggerContext

}

private void appendMap(StringBuilder sb, String attrName, Map<String, String> map) {
protected void appendMap(StringBuilder sb, String attrName, Map<String, String> map) {
sb.append(QUOTE).append(attrName).append(QUOTE_COL);
if (map == null) {
sb.append(NULL_STR);
Expand All @@ -253,11 +266,11 @@ private void appendMap(StringBuilder sb, String attrName, Map<String, String> ma
sb.append(CLOSE_OBJ);
}

private void appendThrowableProxy(StringBuilder sb, String attributeName, IThrowableProxy itp) {
protected void appendThrowableProxy(StringBuilder sb, String attributeName, IThrowableProxy itp) {
appendThrowableProxy(sb, attributeName, itp, true);
}

private void appendThrowableProxy(StringBuilder sb, String attributeName, IThrowableProxy itp, boolean appendValueSeparator) {
protected void appendThrowableProxy(StringBuilder sb, String attributeName, IThrowableProxy itp, boolean appendValueSeparator) {

if (appendValueSeparator)
sb.append(VALUE_SEPARATOR);
Expand Down Expand Up @@ -316,7 +329,7 @@ private void appendThrowableProxy(StringBuilder sb, String attributeName, IThrow

}

private void appendSTEPArray(StringBuilder sb, StackTraceElementProxy[] stepArray, int commonFrames) {
protected void appendSTEPArray(StringBuilder sb, StackTraceElementProxy[] stepArray, int commonFrames) {
sb.append(QUOTE).append(STEP_ARRAY_NAME_ATTRIBUTE).append(QUOTE_COL).append(OPEN_ARRAY);

int len = stepArray != null ? stepArray.length : 0;
Expand Down Expand Up @@ -351,19 +364,19 @@ private void appendSTEPArray(StringBuilder sb, StackTraceElementProxy[] stepArra
sb.append(CLOSE_ARRAY);
}

private void appenderMember(StringBuilder sb, String key, String value) {
protected void appenderMember(StringBuilder sb, String key, String value) {
sb.append(QUOTE).append(key).append(QUOTE_COL).append(QUOTE).append(value).append(QUOTE);
}

private void appenderMemberWithIntValue(StringBuilder sb, String key, int value) {
protected void appenderMemberWithIntValue(StringBuilder sb, String key, int value) {
sb.append(QUOTE).append(key).append(QUOTE_COL).append(value);
}

private void appenderMemberWithLongValue(StringBuilder sb, String key, long value) {
protected void appenderMemberWithLongValue(StringBuilder sb, String key, long value) {
sb.append(QUOTE).append(key).append(QUOTE_COL).append(value);
}

private void appendKeyValuePairs(StringBuilder sb, ILoggingEvent event) {
protected void appendKeyValuePairs(StringBuilder sb, ILoggingEvent event) {
List<KeyValuePair> kvpList = event.getKeyValuePairs();
if (kvpList == null || kvpList.isEmpty())
return;
Expand All @@ -382,7 +395,7 @@ private void appendKeyValuePairs(StringBuilder sb, ILoggingEvent event) {
sb.append(CLOSE_ARRAY);
}

private void appendArgumentArray(StringBuilder sb, ILoggingEvent event) {
protected void appendArgumentArray(StringBuilder sb, ILoggingEvent event) {
Object[] argumentArray = event.getArgumentArray();
if (argumentArray == null)
return;
Expand All @@ -399,7 +412,7 @@ private void appendArgumentArray(StringBuilder sb, ILoggingEvent event) {
sb.append(CLOSE_ARRAY);
}

private void appendMarkers(StringBuilder sb, ILoggingEvent event) {
protected void appendMarkers(StringBuilder sb, ILoggingEvent event) {
List<Marker> markerList = event.getMarkerList();
if (markerList == null)
return;
Expand All @@ -416,25 +429,25 @@ private void appendMarkers(StringBuilder sb, ILoggingEvent event) {
sb.append(CLOSE_ARRAY);
}

private String jsonEscapedToString(Object o) {
protected String jsonEscapedToString(Object o) {
if (o == null)
return NULL_STR;
return jsonEscapeString(o.toString());
}

private String nullSafeStr(String s) {
protected String nullSafeStr(String s) {
if (s == null)
return NULL_STR;
return s;
}

private String jsonEscape(String s) {
protected String jsonEscape(String s) {
if (s == null)
return NULL_STR;
return jsonEscapeString(s);
}

private void appendMDC(StringBuilder sb, ILoggingEvent event) {
protected void appendMDC(StringBuilder sb, ILoggingEvent event) {
Map<String, String> map = event.getMDCPropertyMap();
sb.append(VALUE_SEPARATOR);
sb.append(QUOTE).append(MDC_ATTR_NAME).append(QUOTE_COL).append(SP).append(OPEN_OBJ);
Expand All @@ -452,7 +465,7 @@ private void appendMDC(StringBuilder sb, ILoggingEvent event) {
sb.append(CLOSE_OBJ);
}

boolean isNotEmptyMap(Map map) {
protected boolean isNotEmptyMap(Map map) {
if (map == null)
return false;
return !map.isEmpty();
Expand Down
106 changes: 106 additions & 0 deletions ...ck-classic/src/main/java/ch/qos/logback/classic/encoder/StructuredLoggingJsonEncoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
/*
* Logback: the reliable, generic, fast and flexible logging framework.
* Copyright (C) 1999-2023, QOS.ch. All rights reserved.
*
* This program and the accompanying materials are dual-licensed under
* either the terms of the Eclipse Public License v1.0 as published by
* the Eclipse Foundation
*
* or (per the licensee's choosing)
*
* under the terms of the GNU Lesser General Public License version 2.1
* as published by the Free Software Foundation.
*/

package ch.qos.logback.classic.encoder;

import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.classic.spi.IThrowableProxy;
import ch.qos.logback.classic.spi.LoggerContextVO;
import ch.qos.logback.classic.spi.StackTraceElementProxy;
import ch.qos.logback.core.CoreConstants;
import ch.qos.logback.core.encoder.EncoderBase;
import org.slf4j.Marker;
import org.slf4j.event.KeyValuePair;

import java.time.Instant;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static ch.qos.logback.core.CoreConstants.COLON_CHAR;
import static ch.qos.logback.core.CoreConstants.COMMA_CHAR;
import static ch.qos.logback.core.CoreConstants.DOUBLE_QUOTE_CHAR;
import static ch.qos.logback.core.CoreConstants.UTF_8_CHARSET;
import static ch.qos.logback.core.encoder.JsonEscapeUtil.jsonEscapeString;
import static ch.qos.logback.core.model.ModelConstants.NULL_STR;

/**
*
*
* https://jsonlines.org/ https://datatracker.ietf.org/doc/html/rfc8259
*/
public class StructuredLoggingJsonEncoder extends JsonEncoder {

protected boolean withTimestampSeconds = false;
protected boolean withTimestampNanos = false;
protected boolean withTime = false;
protected boolean withSeverity = true;

public StructuredLoggingJsonEncoder() {
super();
withArguments = false;
withLevel = false;
}

@Override
protected void appenderTimestamp(StringBuilder sb, ILoggingEvent event) {
sb.append(QUOTE).append("timestamp").append(QUOTE_COL);
sb.append(OPEN_OBJ);
Instant timestamp = event.getInstant();
appenderMemberWithLongValue(sb, "seconds", timestamp.getEpochSecond());
sb.append(VALUE_SEPARATOR);
appenderMemberWithIntValue(sb, "nanos", timestamp.getNano());
sb.append(CLOSE_OBJ);
}

@Override
protected void appenderExtra(StringBuilder sb, ILoggingEvent event) {
Instant timestamp = event.getInstant();
if (withTimestampSeconds) {
sb.append(VALUE_SEPARATOR);
appenderMemberWithLongValue(sb, "timestampSeconds", timestamp.getEpochSecond());
}
if (withTimestampNanos) {
sb.append(VALUE_SEPARATOR);
appenderMemberWithIntValue(sb, "timestampNanos", timestamp.getNano());
}
if (withTime) {
sb.append(VALUE_SEPARATOR);
appenderMember(sb, "time", java.time.format.DateTimeFormatter.ISO_INSTANT.format(timestamp));
}
if (withSeverity) {
sb.append(VALUE_SEPARATOR);
String levelStr = event.getLevel() != null ? event.getLevel().levelStr : NULL_STR;
appenderMember(sb, "severity",levelStr);
}
}

@Override
protected void appenderMessage(StringBuilder sb, ILoggingEvent event) {
appenderMember(sb, MESSAGE_ATTR_NAME, jsonEscapeString(event.getFormattedMessage()));
}

public void setWithTimestampSeconds(boolean withTimestampSeconds) {
this.withTimestampSeconds = withTimestampSeconds;
}

public void setWithTimestampNanos(boolean withTimestampNanos) {
this.withTimestampNanos = withTimestampNanos;
}

public void setWithTime(boolean withTime) {
this.withTime = withTime;
}
}
Loading