org.hawaiiframework.logging.model

Enum KibanaLogFieldNames

java.lang.Object

java.lang.Enum<KibanaLogFieldNames>

org.hawaiiframework.logging.model.KibanaLogFieldNames

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<KibanaLogFieldNames>, KibanaLogField

public enum KibanaLogFieldNames
extends java.lang.Enum<KibanaLogFieldNames>
implements KibanaLogField

This enum represents keys for data that is stored in the logging MDC.

Since:

2.0.0

Author:

Rutger Lubbers, Paul Klos

Enum Constant Summary

Enum Constants

Enum Constant and Description
CALL_DURATION
CALL_ID
CALL_RESULT
CALL_TYPE
CLIENT_IP
HTTP_STATUS
LEVEL
LOG_LOCATION
LOG_TYPE
MESSAGE
METHOD
REQUEST_DURATION
REQUEST_ID
SESSION_ID
TASK_ID
THREAD
TIMESTAMP
TX_DURATION
TX_ID
TX_ID_SUB
URI
USER

Method Summary

Modifier and Type	Method and Description
static KibanaLogFieldNames	fromKey(java.lang.String key) Lookup method that does not throw an exception if the specified key is not found.
java.lang.String	getLogName() Get the name with which this field will appear in the log.
static KibanaLogFieldNames	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static KibanaLogFieldNames[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.hawaiiframework.logging.model.KibanaLogField

matches

Enum Constant Detail

SESSION_ID

public static final KibanaLogFieldNames SESSION_ID

TX_ID

public static final KibanaLogFieldNames TX_ID

TX_ID_SUB

public static final KibanaLogFieldNames TX_ID_SUB

TX_DURATION

public static final KibanaLogFieldNames TX_DURATION

REQUEST_ID

public static final KibanaLogFieldNames REQUEST_ID

REQUEST_DURATION

public static final KibanaLogFieldNames REQUEST_DURATION

CALL_ID

public static final KibanaLogFieldNames CALL_ID

CALL_TYPE

public static final KibanaLogFieldNames CALL_TYPE

CALL_DURATION

public static final KibanaLogFieldNames CALL_DURATION

CALL_RESULT

public static final KibanaLogFieldNames CALL_RESULT

TASK_ID

public static final KibanaLogFieldNames TASK_ID

URI

public static final KibanaLogFieldNames URI

METHOD

public static final KibanaLogFieldNames METHOD

USER

public static final KibanaLogFieldNames USER

HTTP_STATUS

public static final KibanaLogFieldNames HTTP_STATUS

CLIENT_IP

public static final KibanaLogFieldNames CLIENT_IP

LOG_TYPE

public static final KibanaLogFieldNames LOG_TYPE

THREAD

public static final KibanaLogFieldNames THREAD

LEVEL

public static final KibanaLogFieldNames LEVEL

TIMESTAMP

public static final KibanaLogFieldNames TIMESTAMP

LOG_LOCATION

public static final KibanaLogFieldNames LOG_LOCATION

MESSAGE

public static final KibanaLogFieldNames MESSAGE

Method Detail

values

public static KibanaLogFieldNames[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KibanaLogFieldNames c : KibanaLogFieldNames.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KibanaLogFieldNames valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getLogName

public java.lang.String getLogName()

Description copied from interface: KibanaLogField

Get the name with which this field will appear in the log.

Specified by:

getLogName in interface KibanaLogField

Returns:

the kibana log's field name.

fromKey

public static KibanaLogFieldNames fromKey(java.lang.String key)

Lookup method that does not throw an exception if the specified key is not found.

Parameters:

key - the key to look for

Returns:

the MdcKey with the given name, or null