com.github.kristofa.brave

Enum BraveHttpHeaders

java.lang.Object

java.lang.Enum<BraveHttpHeaders>

com.github.kristofa.brave.BraveHttpHeaders

All Implemented Interfaces:

Serializable, Comparable<BraveHttpHeaders>

public enum BraveHttpHeaders
extends Enum<BraveHttpHeaders>

Contains the header keys that are used to represent trace id, span id, parent span id, sampled.

The names correspond with the zipkin header values.

These can be used to submit as HTTP header in a new request.

Author:

kristof

Enum Constant Summary

Enum Constants

Enum Constant and Description
ParentSpanId Parent span id http header field name.
Sampled Sampled http header field name.
SpanId Span id http header field name.
SpanName Span name as submitted by client.
TraceId Trace id http header field name.

Method Summary

Methods

Modifier and Type	Method and Description
String	getName()
static BraveHttpHeaders	valueOf(String name) Returns the enum constant of this type with the specified name.
static BraveHttpHeaders[]	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

Enum Constant Detail

TraceId

public static final BraveHttpHeaders TraceId

Trace id http header field name.

SpanId

public static final BraveHttpHeaders SpanId

Span id http header field name.

ParentSpanId

public static final BraveHttpHeaders ParentSpanId

Parent span id http header field name.

Sampled

public static final BraveHttpHeaders Sampled

Sampled http header field name. Indicates if this trace should be sampled or not.

SpanName

public static final BraveHttpHeaders SpanName

Span name as submitted by client.

By default we will use the URL as span name but when we want to do grouping and aggregation of service requests using URL is not always a good idea as it might contain variable parameters that make it difficult to match same service requests. Providing a separate name for it can help.

Method Detail

values

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

Returns:

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

valueOf

public static BraveHttpHeaders 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

getName

public String getName()