Module logstash.logback.encoder

Package net.logstash.logback.argument

Class StructuredArguments

java.lang.Object

net.logstash.logback.argument.StructuredArguments

public class StructuredArguments
extends Object

Factory for creating StructuredArguments.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_KEY_VALUE_MESSAGE_FORMAT_PATTERN	The default message format used when writing key value pairs to the log message.
static final String	VALUE_ONLY_MESSAGE_FORMAT_PATTERN	A message format pattern that will only write the argument value to a log message (i.e. it won't write the key).

Method Summary

Modifier and Type	Method	Description
static StructuredArgument	a(String fieldName, Object... objects)	Abbreviated convenience method for calling array(String, Object...).
static StructuredArgument	array(String fieldName, Object... objects)	Adds a field to the JSON event whose key is fieldName and whose value is a JSON array of objects AND a string version of the array to the formatted message.
static StructuredArgument	defer(Supplier<? extends StructuredArgument> structuredArgumentSupplier)	Defer the evaluation of the argument until actually required.
static StructuredArgument	e(Map<?,?> map)	Abbreviated convenience method for calling entries(Map).
static StructuredArgument	entries(Map<?,?> map)	Adds a "key":"value" entry for each Map entry to the JSON event AND map.toString() to the formatted message.
static StructuredArgument	f(Object object)	Abbreviated convenience method for calling fields(Object).
static StructuredArgument	fields(Object object)	Adds a "key":"value" entry for each field in the given object to the JSON event AND object.toString() to the formatted message.
static StructuredArgument	keyValue(String key, Object value)	Convenience method for calling keyValue(String, Object, String) using the DEFAULT_KEY_VALUE_MESSAGE_FORMAT_PATTERN.
static StructuredArgument	keyValue(String key, Object value, String messageFormatPattern)	Adds "key":"value" to the JSON event AND name/value to the formatted message using the given messageFormatPattern.
static StructuredArgument	kv(String key, Object value)	Abbreviated convenience method for calling keyValue(String, Object).
static StructuredArgument	kv(String key, Object value, String messageFormatPattern)	Abbreviated convenience method for calling keyValue(String, Object, String).
static StructuredArgument	r(String fieldName, String rawJsonValue)	Abbreviated convenience method for calling raw(String, String).
static StructuredArgument	raw(String fieldName, String rawJsonValue)	Adds the rawJsonValue to the JSON event AND the rawJsonValue to the formatted message.
static String	toString(Object arg)	Format the argument into a string.
static StructuredArgument	v(String key, Object value)	Abbreviated convenience method for calling value(String, Object).
static StructuredArgument	value(String key, Object value)	Adds "key":"value" to the JSON event AND value to the formatted message (without the key).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_KEY_VALUE_MESSAGE_FORMAT_PATTERN

public static final String DEFAULT_KEY_VALUE_MESSAGE_FORMAT_PATTERN

The default message format used when writing key value pairs to the log message.

See Also:

• Constant Field Values

VALUE_ONLY_MESSAGE_FORMAT_PATTERN

public static final String VALUE_ONLY_MESSAGE_FORMAT_PATTERN

A message format pattern that will only write the argument value to a log message (i.e. it won't write the key).

See Also:

• Constant Field Values

Method Details

keyValue

public static StructuredArgument keyValue(String key,
 Object value)

Convenience method for calling keyValue(String, Object, String) using the DEFAULT_KEY_VALUE_MESSAGE_FORMAT_PATTERN.

Basically, adds "key":"value" to the JSON event AND name=value to the formatted message.

Parameters:

key - the key (field name)

value - the value

Returns:

a pre-populated StructuredArgument instance

See Also:

• ObjectAppendingMarker
• keyValue(String, Object, String)
• DEFAULT_KEY_VALUE_MESSAGE_FORMAT_PATTERN

kv

public static StructuredArgument kv(String key,
 Object value)

Abbreviated convenience method for calling keyValue(String, Object).

Parameters:

key - the key (field name)

value - the value

Returns:

a pre-populated StructuredArgument instance

See Also:

• keyValue(String, Object)

keyValue

public static StructuredArgument keyValue(String key,
 Object value,
 String messageFormatPattern)

Adds "key":"value" to the JSON event AND name/value to the formatted message using the given messageFormatPattern.

Parameters:

key - the key (field name)

value - the value

messageFormatPattern - the pattern used to concatenate the key and the value

Returns:

a pre-populated StructuredArgument instance

See Also:

• ObjectAppendingMarker

kv

public static StructuredArgument kv(String key,
 Object value,
 String messageFormatPattern)

Abbreviated convenience method for calling keyValue(String, Object, String).

Parameters:

key - the key (field name)

value - the value

messageFormatPattern - the pattern used to concatenate the key and the value

Returns:

a pre-populated StructuredArgument instance

See Also:

• keyValue(String, Object, String)

value

public static StructuredArgument value(String key,
 Object value)

Adds "key":"value" to the JSON event AND value to the formatted message (without the key).

Parameters:

key - the key (field name)

value - the value

Returns:

a pre-populated StructuredArgument instance

See Also:

• keyValue(String, Object, String)
• VALUE_ONLY_MESSAGE_FORMAT_PATTERN

v

public static StructuredArgument v(String key,
 Object value)

Abbreviated convenience method for calling value(String, Object).

Parameters:

key - the key (field name)

value - the value

Returns:

a pre-populated StructuredArgument instance

See Also:

• value(String, Object)

entries

public static StructuredArgument entries(Map<?,?> map)

Adds a "key":"value" entry for each Map entry to the JSON event AND map.toString() to the formatted message.

Parameters:

map - Map holding the key/value pairs

Returns:

a pre-populated StructuredArgument instance

See Also:

• MapEntriesAppendingMarker

e

public static StructuredArgument e(Map<?,?> map)

Abbreviated convenience method for calling entries(Map).

Parameters:

map - Map holding the key/value pairs

Returns:

a pre-populated StructuredArgument instance

See Also:

• entries(Map)

fields

public static StructuredArgument fields(Object object)

Adds a "key":"value" entry for each field in the given object to the JSON event AND object.toString() to the formatted message.

Parameters:

object - the object to write fields from

Returns:

a pre-populated StructuredArgument instance

See Also:

• ObjectFieldsAppendingMarker

f

public static StructuredArgument f(Object object)

Abbreviated convenience method for calling fields(Object).

Parameters:

object - the object to write fields from

Returns:

a pre-populated StructuredArgument instance

See Also:

• fields(Object)

array

public static StructuredArgument array(String fieldName,
 Object... objects)

Adds a field to the JSON event whose key is fieldName and whose value is a JSON array of objects AND a string version of the array to the formatted message.

Parameters:

fieldName - field name

objects - elements of the array to write under the fieldName key

Returns:

a pre-populated StructuredArgument instance

See Also:

• ObjectAppendingMarker

a

public static StructuredArgument a(String fieldName,
 Object... objects)

Abbreviated convenience method for calling array(String, Object...).

Parameters:

fieldName - field name

objects - elements of the array to write under the fieldName key

Returns:

a pre-populated StructuredArgument instance

See Also:

• array(String, Object...)

raw

public static StructuredArgument raw(String fieldName,
 String rawJsonValue)

Adds the rawJsonValue to the JSON event AND the rawJsonValue to the formatted message.

Parameters:

fieldName - field name

rawJsonValue - the raw JSON value

Returns:

a pre-populated StructuredArgument instance

See Also:

• RawJsonAppendingMarker

r

public static StructuredArgument r(String fieldName,
 String rawJsonValue)

Abbreviated convenience method for calling raw(String, String).

Parameters:

fieldName - field name

rawJsonValue - the raw JSON value

Returns:

a pre-populated StructuredArgument instance

See Also:

• raw(String, String)

defer

public static StructuredArgument defer(Supplier<? extends StructuredArgument> structuredArgumentSupplier)

Defer the evaluation of the argument until actually required.

Parameters:

structuredArgumentSupplier - a supplier for the argument value

Returns:

a pre-populated StructuredArgument instance

See Also:

• DeferredStructuredArgument

toString

public static String toString(Object arg)

Format the argument into a string. This method mimics the slf4j behavior: array objects are formatted as array using Arrays.toString(long[]), non array object using String.valueOf(java.lang.Object).

See org.slf4j.helpers.MessageFormatter#deeplyAppendParameter(StringBuilder, Object, Map)}

Parameters:

arg - the argument to format

Returns:

formatted string version of the argument