org.apache.logging.log4j.core.layout.JsonLayout Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of log4j-core Show documentation
Show all versions of log4j-core Show documentation
The Apache Log4j Implementation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache license, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the license for the specific language governing permissions and
* limitations under the license.
*/
package org.apache.logging.log4j.core.layout;
import java.io.IOException;
import java.io.Writer;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
import org.apache.logging.log4j.core.Layout;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.DefaultConfiguration;
import org.apache.logging.log4j.core.config.Node;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
import org.apache.logging.log4j.core.util.KeyValuePair;
/**
* Note: The JsonLayout should be considered to be deprecated. Please use JsonTemplateLayout instead.
*
* Appends a series of JSON events as strings serialized as bytes.
*
* Complete well-formed JSON vs. fragment JSON
*
* If you configure {@code complete="true"}, the appender outputs a well-formed JSON document. By default, with
* {@code complete="false"}, you should include the output as an external file in a separate file to form a
* well-formed JSON document.
*
*
* If {@code complete="false"}, the appender does not write the JSON open array character "[" at the start
* of the document, "]" and the end, nor comma "," between records.
*
* Encoding
*
* Appenders using this layout should have their {@code charset} set to {@code UTF-8} or {@code UTF-16}, otherwise
* events containing non ASCII characters could result in corrupted log files.
*
* Pretty vs. compact JSON
*
* By default, the JSON layout is not compact (a.k.a. "pretty") with {@code compact="false"}, which means the
* appender uses end-of-line characters and indents lines to format the text. If {@code compact="true"}, then no
* end-of-line or indentation is used. Message content may contain, of course, escaped end-of-lines.
*
* Additional Fields
*
* This property allows addition of custom fields into generated JSON.
* {@code
*/
@Plugin(name = "JsonLayout", category = Node.CATEGORY, elementType = Layout.ELEMENT_TYPE, printObject = true)
public final class JsonLayout extends AbstractJacksonLayout {
private static final String DEFAULT_FOOTER = "]";
private static final String DEFAULT_HEADER = "[";
static final String CONTENT_TYPE = "application/json";
public static class Builder> extends AbstractJacksonLayout.Builder
implements org.apache.logging.log4j.core.util.Builder {
@PluginBuilderAttribute
private boolean propertiesAsList;
@PluginBuilderAttribute
private boolean objectMessageAsJsonObject;
@PluginElement("AdditionalField")
private KeyValuePair[] additionalFields;
public Builder() {
setCharset(StandardCharsets.UTF_8);
}
@Override
public JsonLayout build() {
final boolean encodeThreadContextAsList = isProperties() && propertiesAsList;
final String headerPattern = toStringOrNull(getHeader());
final String footerPattern = toStringOrNull(getFooter());
return new JsonLayout(getConfiguration(), isLocationInfo(), isProperties(), encodeThreadContextAsList,
isComplete(), isCompact(), getEventEol(), getEndOfLine(), headerPattern, footerPattern, getCharset(),
isIncludeStacktrace(), isStacktraceAsString(), isIncludeNullDelimiter(), isIncludeTimeMillis(),
getAdditionalFields(), getObjectMessageAsJsonObject());
}
public boolean isPropertiesAsList() {
return propertiesAsList;
}
public B setPropertiesAsList(final boolean propertiesAsList) {
this.propertiesAsList = propertiesAsList;
return asBuilder();
}
public boolean getObjectMessageAsJsonObject() {
return objectMessageAsJsonObject;
}
public B setObjectMessageAsJsonObject(final boolean objectMessageAsJsonObject) {
this.objectMessageAsJsonObject = objectMessageAsJsonObject;
return asBuilder();
}
@Override
public KeyValuePair[] getAdditionalFields() {
return additionalFields;
}
@Override
public B setAdditionalFields(final KeyValuePair[] additionalFields) {
this.additionalFields = additionalFields;
return asBuilder();
}
}
/**
* @deprecated Use {@link #newBuilder()} instead
*/
@Deprecated
protected JsonLayout(final Configuration config, final boolean locationInfo, final boolean properties,
final boolean encodeThreadContextAsList,
final boolean complete, final boolean compact, final boolean eventEol, final String endOfLine,final String headerPattern,
final String footerPattern, final Charset charset, final boolean includeStacktrace) {
super(config, new JacksonFactory.JSON(encodeThreadContextAsList, includeStacktrace, false, false).newWriter(
locationInfo, properties, compact),
charset, compact, complete, eventEol, endOfLine,
PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(headerPattern).setDefaultPattern(DEFAULT_HEADER).build(),
PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(footerPattern).setDefaultPattern(DEFAULT_FOOTER).build(),
false, null);
}
private JsonLayout(final Configuration config, final boolean locationInfo, final boolean properties,
final boolean encodeThreadContextAsList,
final boolean complete, final boolean compact, final boolean eventEol, final String endOfLine,
final String headerPattern, final String footerPattern, final Charset charset,
final boolean includeStacktrace, final boolean stacktraceAsString,
final boolean includeNullDelimiter, final boolean includeTimeMillis,
final KeyValuePair[] additionalFields, final boolean objectMessageAsJsonObject) {
super(config, new JacksonFactory.JSON(encodeThreadContextAsList, includeStacktrace, stacktraceAsString, objectMessageAsJsonObject).newWriter(
locationInfo, properties, compact, includeTimeMillis),
charset, compact, complete, eventEol, endOfLine,
PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(headerPattern).setDefaultPattern(DEFAULT_HEADER).build(),
PatternLayout.newSerializerBuilder().setConfiguration(config).setPattern(footerPattern).setDefaultPattern(DEFAULT_FOOTER).build(),
includeNullDelimiter,
additionalFields);
}
/**
* Returns appropriate JSON header.
*
* @return a byte array containing the header, opening the JSON array.
*/
@Override
public byte[] getHeader() {
if (!this.complete) {
return null;
}
final StringBuilder buf = new StringBuilder();
final String str = serializeToString(getHeaderSerializer());
if (str != null) {
buf.append(str);
}
buf.append(this.eol);
return getBytes(buf.toString());
}
/**
* Returns appropriate JSON footer.
*
* @return a byte array containing the footer, closing the JSON array.
*/
@Override
public byte[] getFooter() {
if (!this.complete) {
return null;
}
final StringBuilder buf = new StringBuilder();
buf.append(this.eol);
final String str = serializeToString(getFooterSerializer());
if (str != null) {
buf.append(str);
}
buf.append(this.eol);
return getBytes(buf.toString());
}
@Override
public Map getContentFormat() {
final Map result = new HashMap<>();
result.put("version", "2.0");
return result;
}
/**
* @return The content type.
*/
@Override
public String getContentType() {
return CONTENT_TYPE + "; charset=" + this.getCharset();
}
/**
* Creates a JSON Layout.
* @param config
* The plugin configuration.
* @param locationInfo
* If "true", includes the location information in the generated JSON.
* @param properties
* If "true", includes the thread context map in the generated JSON.
* @param propertiesAsList
* If true, the thread context map is included as a list of map entry objects, where each entry has
* a "key" attribute (whose value is the key) and a "value" attribute (whose value is the value).
* Defaults to false, in which case the thread context map is included as a simple map of key-value
* pairs.
* @param complete
* If "true", includes the JSON header and footer, and comma between records.
* @param compact
* If "true", does not use end-of-lines and indentation, defaults to "false".
* @param eventEol
* If "true", forces an EOL after each log event (even if compact is "true"), defaults to "false". This
* allows one even per line, even in compact mode.
* @param headerPattern
* The header pattern, defaults to {@code "["} if null.
* @param footerPattern
* The header pattern, defaults to {@code "]"} if null.
* @param charset
* The character set to use, if {@code null}, uses "UTF-8".
* @param includeStacktrace
* If "true", includes the stacktrace of any Throwable in the generated JSON, defaults to "true".
* @return A JSON Layout.
*
* @deprecated Use {@link #newBuilder()} instead
*/
@Deprecated
public static JsonLayout createLayout(
final Configuration config,
final boolean locationInfo,
final boolean properties,
final boolean propertiesAsList,
final boolean complete,
final boolean compact,
final boolean eventEol,
final String headerPattern,
final String footerPattern,
final Charset charset,
final boolean includeStacktrace) {
final boolean encodeThreadContextAsList = properties && propertiesAsList;
return new JsonLayout(config, locationInfo, properties, encodeThreadContextAsList, complete, compact, eventEol,
null, headerPattern, footerPattern, charset, includeStacktrace, false, false, false, null, false);
}
@PluginBuilderFactory
public static > B newBuilder() {
return new Builder().asBuilder();
}
/**
* Creates a JSON Layout using the default settings. Useful for testing.
*
* @return A JSON Layout.
*/
public static JsonLayout createDefaultLayout() {
return new JsonLayout(new DefaultConfiguration(), false, false, false, false, false, false, null,
DEFAULT_HEADER, DEFAULT_FOOTER, StandardCharsets.UTF_8, true, false, false, false, null, false);
}
@Override
public void toSerializable(final LogEvent event, final Writer writer) throws IOException {
if (complete && eventCount > 0) {
writer.append(", ");
}
super.toSerializable(event, writer);
}
}