Package io.honeycomb.beeline

Class DefaultBeeline

java.lang.Object

io.honeycomb.beeline.DefaultBeeline

public class DefaultBeeline
extends Object

DefaultBeeline is a singleton representing an initialized Beeline and its collaborator classes It uses a simple set of defaults and provides a few convenience wrappers. If you need a more specialized configuration, see the Beeline class and our docs at https://docs.honeycomb.io/getting-data-in/java/beeline/

Method Summary

Modifier and Type	Method	Description
void	addField(String key, Object value)	Add a field to the active Span.
void	close()
void	endTrace()	endTrace ends the currently active trace on the thread it is called from
Span	getActiveSpan()	Returns the span that is currently active on this thread - the one that is top of the stack.
Beeline	getBeeline()	getBeeline returns the Beeline in this instance for times when the convenience wrappers aren't sufficient
static DefaultBeeline	getInstance(String dataset, String serviceName, String writeKey)
static DefaultBeeline	getInstance(String dataset, String serviceName, String writeKey, URI apiHost, io.honeycomb.libhoney.TransportOptions transportOptions)
void	sendActiveSpan()	Sends the currently active span.
Span	startSpan(String spanName)	Starts a new span with the given span name.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DefaultBeeline getInstance(String dataset,
                                         String serviceName,
                                         String writeKey)

getInstance

public static DefaultBeeline getInstance(String dataset,
                                         String serviceName,
                                         String writeKey,
                                         URI apiHost,
                                         io.honeycomb.libhoney.TransportOptions transportOptions)

startSpan

public Span startSpan(String spanName)

Starts a new span with the given span name. If no trace is active, starts a new trace, and returns the root span. To send this span, call Span.close().

Parameters:

spanName - will be set in the name field of this span

Returns:

a Span

addField

public void addField(String key,
                     Object value)

Add a field to the active Span.

The field key will be prefixed with "app." to make it part of the "app" namespace for user-added fields. This is to avoid clashes and distinguish it from standard fields provided by automatic instrumentations like the "Spring Beeline".

Example

 if (underAttack) {
      beeline.addField("alert-message", "We are under attack!");
 }
 

Parameters:

key - of the field.

value - of the field.

See Also:

getActiveSpan()

getActiveSpan

public Span getActiveSpan()

Returns the span that is currently active on this thread - the one that is top of the stack.

Note, this method is null-safe - a "noop" span is returned if no trace is currently active. This may be due to the current execution not being instrumented or because the trace was not sampled.

Example

 if (underAttack) {
      final Span currentSpan = beeline.getActiveSpan()
           .addField("alert-message", "We are under attack!")
           .addField("alert-level", "red");
 }
 

Returns:

the active span.

sendActiveSpan

public void sendActiveSpan()

Sends the currently active span.

getBeeline

public Beeline getBeeline()

getBeeline returns the Beeline in this instance for times when the convenience wrappers aren't sufficient

Returns:

Beeline

endTrace

public void endTrace()

endTrace ends the currently active trace on the thread it is called from

close

public void close()