Package org.hawaiiframework.logging.model

Class KibanaLogFields

java.lang.Object

org.hawaiiframework.logging.model.KibanaLogFields

public final class KibanaLogFields
extends Object

Class that holds the extra fields used for Kibana logging.

Log lines for Kibana will contain all fields set, until the log fields are cleared by invoking clear().

Since:

2.0.0

Author:

Rutger Lubbers, Paul Klos

Method Summary

Modifier and Type	Method	Description
static void	clear()	Removes all values set for all fields.
static void	clear(KibanaLogField field)	Removes the value for the field field.
static void	clear(KibanaLogField... fields)	Removes the value for the fields fields.
static String	get(KibanaLogField field)	Retrieves the value for the field.
static KibanaLogContext	getContext()	Create a new log context for the current thread's kibana log fields.
static String	getOrDefault(KibanaLogField field, String defaultValue)	Retrieves the value for the field.
static String	getValuesAsLogString()	Getter for the log string.
static void	populateFromContext(KibanaLogContext logContext)	Update log fields based on the KibanaLogContext.
static KibanaLogField	tag(KibanaLogField field, int value)	Sets the Kibana log field field to the value.
static KibanaLogField	tag(KibanaLogField field, Enum<?> value)	Sets the Kibana log field field to the value.
static KibanaLogField	tag(KibanaLogField field, String value)	Sets the Kibana log field field to the value.
static KibanaLogField	tag(KibanaLogField field, Collection<String> values)	Sets the Kibana log field field to the value.
static AutoCloseableKibanaLogField	tagCloseable(KibanaLogField field, int value)	Sets the Kibana log field field to the value, returns an auto closeable.
static AutoCloseableKibanaLogField	tagCloseable(KibanaLogField field, Enum<?> value)	Sets the Kibana log field field to the value, returns an auto closeable.
static AutoCloseableKibanaLogField	tagCloseable(KibanaLogField field, String value)	Sets the Kibana log field field to the value, returns an auto closeable.
static AutoCloseableKibanaLogField	tagCloseable(KibanaLogField field, Collection<String> values)	Sets the Kibana log field field to the value, returns an auto closeable.

Methods inherited from class java.lang.Object

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

Method Detail

tag

public static KibanaLogField tag(KibanaLogField field,
                                 Enum<?> value)

Sets the Kibana log field field to the value.

tag

public static KibanaLogField tag(KibanaLogField field,
                                 int value)

Sets the Kibana log field field to the value.

tag

public static KibanaLogField tag(KibanaLogField field,
                                 String value)

Sets the Kibana log field field to the value.

tag

public static KibanaLogField tag(KibanaLogField field,
                                 Collection<String> values)

Sets the Kibana log field field to the value.

tagCloseable

public static AutoCloseableKibanaLogField tagCloseable(KibanaLogField field,
                                                       Enum<?> value)

Sets the Kibana log field field to the value, returns an auto closeable.

tagCloseable

public static AutoCloseableKibanaLogField tagCloseable(KibanaLogField field,
                                                       int value)

Sets the Kibana log field field to the value, returns an auto closeable.

tagCloseable

public static AutoCloseableKibanaLogField tagCloseable(KibanaLogField field,
                                                       String value)

Sets the Kibana log field field to the value, returns an auto closeable.

tagCloseable

public static AutoCloseableKibanaLogField tagCloseable(KibanaLogField field,
                                                       Collection<String> values)

Sets the Kibana log field field to the value, returns an auto closeable.

get

public static String get(KibanaLogField field)

Retrieves the value for the field. It will return null if no value is set.

getOrDefault

public static String getOrDefault(KibanaLogField field,
                                  String defaultValue)

Retrieves the value for the field. It will return defaultValue if no value is set.

clear

public static void clear(KibanaLogField field)

Removes the value for the field field.

clear

public static void clear(KibanaLogField... fields)

Removes the value for the fields fields.

clear

public static void clear()

Removes all values set for all fields.

getValuesAsLogString

public static String getValuesAsLogString()

Getter for the log string.

Returns:

the log string

populateFromContext

public static void populateFromContext(KibanaLogContext logContext)

Update log fields based on the KibanaLogContext.

See getContext().

getContext

public static KibanaLogContext getContext()

Create a new log context for the current thread's kibana log fields.

See KibanaLogContext.registerKibanaLogFieldsInThisThread().