koeln.niemeier.log4j2.json

Class SimpleJsonLayout

koeln.niemeier.log4j2.json.SimpleJsonLayout

public class SimpleJsonLayout

A layout rendering structured JSON log lines.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SimpleJsonLayout.Companion Factory object used to generate new SimpleJsonLayout.

Field Summary

Fields

Modifier and Type	Field and Description
static SimpleJsonLayout.Companion	Companion Factory object used to generate new SimpleJsonLayout.

Constructor Summary

Constructors

Constructor and Description
SimpleJsonLayout(org.apache.logging.log4j.core.config.Configuration config, java.util.List<java.lang.String> ignoredPackages) A layout rendering structured JSON log lines.

Method Summary

Modifier and Type	Method and Description
static SimpleJsonLayout	createLayout(org.apache.logging.log4j.core.config.Configuration config, java.lang.String ignoredStackTracePackages) Creates a SimpleJsonLayout.
java.lang.String	getContentType()
java.lang.String	toSerializable(org.apache.logging.log4j.core.LogEvent event) Formats the event as a JSON string.

Field Detail

Companion

public static SimpleJsonLayout.Companion Companion

Factory object used to generate new SimpleJsonLayout.

Constructor Detail

SimpleJsonLayout

public SimpleJsonLayout(org.apache.logging.log4j.core.config.Configuration config,
                        java.util.List<java.lang.String> ignoredPackages)

A layout rendering structured JSON log lines.

Method Detail

getContentType

public java.lang.String getContentType()

Returns:

The JSON content type.

toSerializable

public java.lang.String toSerializable(org.apache.logging.log4j.core.LogEvent event)

Formats the event as a JSON string.

createLayout

public static SimpleJsonLayout createLayout(org.apache.logging.log4j.core.config.Configuration config,
                                            java.lang.String ignoredStackTracePackages)

Creates a SimpleJsonLayout.

Parameters:

config - The plugin configuration.

ignoredStackTracePackages - A comma-separated list of packages to be ignored on rendering the stack trace.

Returns:

A SimpleJsonLayout.