Package org.hawaiiframework.logging.opentracing

Enum OpentracingKibanaLogField

java.lang.Object

java.lang.Enum<OpentracingKibanaLogField>

org.hawaiiframework.logging.opentracing.OpentracingKibanaLogField

All Implemented Interfaces:

Serializable, Comparable<OpentracingKibanaLogField>, KibanaLogField

public enum OpentracingKibanaLogField
extends Enum<OpentracingKibanaLogField>
implements KibanaLogField

Kibana Fields for OpenTracing. All enumeration field names should come from the spec as defined by opentracing.

Some fields are invented, span.id for instance. These fields should be marked as 'invented'.

See Also:

https://github.com/opentracing/specification/blob/master/semantic_conventions.md

Enum Constant Summary

Enum Constants

Enum Constant	Description
HTTP_METHOD
HTTP_STATUS_CODE
HTTP_URL
PEER_ADDRESS
PEER_HOSTNAME
PEER_IPV4
PEER_IPV6
PEER_PORT
PEER_SERVICE
SPAN_ID
SPAN_OPERATION_NAME
TRACE_ID

Method Summary

Modifier and Type	Method	Description
static OpentracingKibanaLogField	fromKey(String key)	Lookup method that does not throw an exception if the specified key is not found.
String	getLogName()	Get the name with which this field will appear in the log.
static OpentracingKibanaLogField	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OpentracingKibanaLogField[]	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

SPAN_ID

public static final OpentracingKibanaLogField SPAN_ID

SPAN_OPERATION_NAME

public static final OpentracingKibanaLogField SPAN_OPERATION_NAME

TRACE_ID

public static final OpentracingKibanaLogField TRACE_ID

HTTP_METHOD

public static final OpentracingKibanaLogField HTTP_METHOD

HTTP_STATUS_CODE

public static final OpentracingKibanaLogField HTTP_STATUS_CODE

HTTP_URL

public static final OpentracingKibanaLogField HTTP_URL

PEER_ADDRESS

public static final OpentracingKibanaLogField PEER_ADDRESS

PEER_HOSTNAME

public static final OpentracingKibanaLogField PEER_HOSTNAME

PEER_IPV4

public static final OpentracingKibanaLogField PEER_IPV4

PEER_IPV6

public static final OpentracingKibanaLogField PEER_IPV6

PEER_PORT

public static final OpentracingKibanaLogField PEER_PORT

PEER_SERVICE

public static final OpentracingKibanaLogField PEER_SERVICE

Method Detail

values

public static OpentracingKibanaLogField[] 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 (OpentracingKibanaLogField c : OpentracingKibanaLogField.values())
    System.out.println(c);

Returns:

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

valueOf

public static OpentracingKibanaLogField valueOf(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:

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

NullPointerException - if the argument is null

getLogName

public 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 OpentracingKibanaLogField fromKey(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 LogField with the given name, or null.