eu.plumbr.api

Class Plumbr

java.lang.Object

eu.plumbr.api.Plumbr

public class Plumbr
extends java.lang.Object

This class consists of static methods which can be used to either create a new Span or access the currently active Span. If Plumbr Agent is attached and supports this API version, then API calls will be delegated to it. Otherwise, all calls will be a NO-OP.

See Also:

What are services?, What are transactions?

Field Summary

Fields

Modifier and Type	Field and Description
static int	API_VERSION

Constructor Summary

Constructors

Constructor and Description
Plumbr()

Method Summary

Modifier and Type	Method and Description
static Span	getCurrentSpan() Return currently active span, if any.
static Span	newSpan() Create a new transaction and return its root span.

Methods inherited from class java.lang.Object

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

Field Detail

API_VERSION

public static final int API_VERSION

See Also:

Constant Field Values

Constructor Detail

Plumbr

public Plumbr()

Method Detail

newSpan

public static Span newSpan()

Create a new transaction and return its root span. Returned span has to be manually started by calling Span.start().

Returns:

Root span of a new transaction, which can be further customized. Returns a null span (Span.isNull() returns true) if Plumbr Agent is not attached or is too old to support this API version.

getCurrentSpan

public static Span getCurrentSpan()

Return currently active span, if any. This allows to access spans which are automatically created by Plumbr Agent and to change the properties of those spans, or manually end them or mark them as failed.

Returns:

Currently active span or a null span (Span.isNull() returns true) if there is no active span, or if Plumbr Agent is not attached or is too old to support this API version.