A B C D E F G H I K L M P R S T W

A

AbstractTag<T> - Class in io.opentracing.tag

AbstractTag(String) - Constructor for class io.opentracing.tag.AbstractTag

activate() - Method in interface io.opentracing.ActiveSpan.Continuation

Make the Span (and other execution context) encapsulated by this ActiveSpan.Continuation active and return it.

ActiveSpan - Interface in io.opentracing

ActiveSpan inherits all of the OpenTracing functionality in BaseSpan and layers on in-process propagation capabilities.

activeSpan() - Method in interface io.opentracing.ActiveSpanSource

Return the active span.

ActiveSpan.Continuation - Interface in io.opentracing

A ActiveSpan.Continuation can be used once to activate a Span along with any non-OpenTracing execution context (e.g., MDC), then deactivate when processing activity moves on to another Span.

ActiveSpanSource - Interface in io.opentracing

ActiveSpanSource allows an existing (possibly thread-local-aware) execution context provider to act as a source for an actively-scheduled OpenTracing Span.

addReference(String, SpanContext) - Method in interface io.opentracing.Tracer.SpanBuilder

Add a reference from the Span being built to a distinct (usually parent) Span.

asChildOf(SpanContext) - Method in interface io.opentracing.Tracer.SpanBuilder

A shorthand for addReference(References.CHILD_OF, parent).

asChildOf(BaseSpan<?>) - Method in interface io.opentracing.Tracer.SpanBuilder

A shorthand for addReference(References.CHILD_OF, parent.context()).

B

baggageItems() - Method in interface io.opentracing.SpanContext

BaseSpan<S extends BaseSpan> - Interface in io.opentracing

BaseSpan represents the OpenTracing specification's span contract with the exception of methods to finish said span.

BINARY - Static variable in class io.opentracing.propagation.Format.Builtin

The BINARY format allows for unconstrained binary encoding of SpanContext state for Tracer.inject and Tracer.extract.

BooleanTag - Class in io.opentracing.tag

BooleanTag(String) - Constructor for class io.opentracing.tag.BooleanTag

buildSpan(String) - Method in interface io.opentracing.Tracer

Return a new SpanBuilder for a Span with the given `operationName`.

C

capture() - Method in interface io.opentracing.ActiveSpan

"Capture" a new ActiveSpan.Continuation associated with this ActiveSpan and Span, as well as any 3rd-party execution context of interest.

CHILD_OF - Static variable in class io.opentracing.References

See http://opentracing.io/spec/#causal-span-references for more information about CHILD_OF references

close() - Method in interface io.opentracing.ActiveSpan

A synonym for ActiveSpan.deactivate() that can be used in try-with-resources blocks.

COMPONENT - Static variable in class io.opentracing.tag.Tags

COMPONENT is a low-cardinality identifier of the module, library, or package that is instrumented.

context() - Method in interface io.opentracing.BaseSpan

Retrieve the associated SpanContext.

D

DB_INSTANCE - Static variable in class io.opentracing.tag.Tags

DB_INSTANCE indicates the instance name of Database.

DB_STATEMENT - Static variable in class io.opentracing.tag.Tags

DB_STATEMENT records a database statement for the given database type.

DB_TYPE - Static variable in class io.opentracing.tag.Tags

DB_TYPE indicates the type of Database.

DB_USER - Static variable in class io.opentracing.tag.Tags

DB_USER indicates the user name of Database, e.g.

deactivate() - Method in interface io.opentracing.ActiveSpan

Mark the end of the active period for the current thread and ActiveSpan.

E

ERROR - Static variable in class io.opentracing.tag.Tags

ERROR indicates whether a Span ended in an error state.

extract(Format<C>, C) - Method in interface io.opentracing.Tracer

Extract a SpanContext from a `carrier` of a given type, presumably after propagation across a process boundary.

F

finish() - Method in interface io.opentracing.Span

Sets the end timestamp to now and records the span.

finish(long) - Method in interface io.opentracing.Span

Sets an explicit end timestamp and records the span.

FOLLOWS_FROM - Static variable in class io.opentracing.References

See http://opentracing.io/spec/#causal-span-references for more information about FOLLOWS_FROM references

Format<C> - Interface in io.opentracing.propagation

Format instances control the behavior of Tracer.inject and Tracer.extract (and also constrain the type of the carrier parameter to same).

Format.Builtin<C> - Class in io.opentracing.propagation

G

getBaggageItem(String) - Method in interface io.opentracing.BaseSpan

getKey() - Method in class io.opentracing.tag.AbstractTag

H

HTTP_HEADERS - Static variable in class io.opentracing.propagation.Format.Builtin

The HTTP_HEADERS format allows for HTTP-header-compatible String->String map encoding of SpanContext state for Tracer.inject and Tracer.extract.

HTTP_METHOD - Static variable in class io.opentracing.tag.Tags

HTTP_METHOD records the http method.

HTTP_STATUS - Static variable in class io.opentracing.tag.Tags

HTTP_STATUS records the http status code of the response.

HTTP_URL - Static variable in class io.opentracing.tag.Tags

HTTP_URL records the url of the incoming request.

I

ignoreActiveSpan() - Method in interface io.opentracing.Tracer.SpanBuilder

Do not create an implicit References.CHILD_OF reference to the ActiveSpanSource.activeSpan()).

inject(SpanContext, Format<C>, C) - Method in interface io.opentracing.Tracer

Inject a SpanContext into a `carrier` of a given type, presumably for propagation across process boundaries.

IntTag - Class in io.opentracing.tag

IntTag(String) - Constructor for class io.opentracing.tag.IntTag

io.opentracing - package io.opentracing

io.opentracing.propagation - package io.opentracing.propagation

io.opentracing.tag - package io.opentracing.tag

iterator() - Method in interface io.opentracing.propagation.TextMap

Gets an iterator over arbitrary key:value pairs from the TextMapReader.

iterator() - Method in class io.opentracing.propagation.TextMapExtractAdapter

iterator() - Method in class io.opentracing.propagation.TextMapInjectAdapter

K

key - Variable in class io.opentracing.tag.AbstractTag

L

log(Map<String, ?>) - Method in interface io.opentracing.BaseSpan

Log key:value pairs to the Span with the current walltime timestamp.

log(long, Map<String, ?>) - Method in interface io.opentracing.BaseSpan

Like log(Map<String, Object>), but with an explicit timestamp.

log(String) - Method in interface io.opentracing.BaseSpan

Record an event at the current walltime timestamp.

log(long, String) - Method in interface io.opentracing.BaseSpan

Record an event at a specific timestamp.

log(String, Object) - Method in interface io.opentracing.BaseSpan

Deprecated.

use BaseSpan.log(Map) like this span.log(Map.of("event", "timeout")) or span.log(timestampMicroseconds, Map.of("event", "exception", "payload", stackTrace))

log(long, String, Object) - Method in interface io.opentracing.BaseSpan

Deprecated.

use BaseSpan.log(Map) like this span.log(timestampMicroseconds, Map.of("event", "timeout")) or span.log(timestampMicroseconds, Map.of("event", "exception", "payload", stackTrace))

M

makeActive(Span) - Method in interface io.opentracing.ActiveSpanSource

Wrap and "make active" a Span by encapsulating it – and any active state (e.g., MDC state) in the current thread – in a new ActiveSpan.

MESSAGE_BUS_DESTINATION - Static variable in class io.opentracing.tag.Tags

MESSAGE_BUS_DESTINATION records an address at which messages can be exchanged.

P

PEER_HOST_IPV4 - Static variable in class io.opentracing.tag.Tags

PEER_HOST_IPV4 records IPv4 host address of the peer.

PEER_HOST_IPV6 - Static variable in class io.opentracing.tag.Tags

PEER_HOST_IPV6 records the IPv6 host address of the peer.

PEER_HOSTNAME - Static variable in class io.opentracing.tag.Tags

PEER_HOSTNAME records the host name of the peer.

PEER_PORT - Static variable in class io.opentracing.tag.Tags

PEER_PORT records the port number of the peer.

PEER_SERVICE - Static variable in class io.opentracing.tag.Tags

PEER_SERVICE records the service name of the peer.

put(String, String) - Method in interface io.opentracing.propagation.TextMap

Puts a key:value pair into the TextMapWriter's backing store.

put(String, String) - Method in class io.opentracing.propagation.TextMapExtractAdapter

put(String, String) - Method in class io.opentracing.propagation.TextMapInjectAdapter

R

References - Class in io.opentracing

References is essentially a namespace for the official OpenTracing reference types.

S

SAMPLING_PRIORITY - Static variable in class io.opentracing.tag.Tags

SAMPLING_PRIORITY determines the priority of sampling this Span.

set(Span, T) - Method in class io.opentracing.tag.AbstractTag

set(Span, Boolean) - Method in class io.opentracing.tag.BooleanTag

set(Span, Integer) - Method in class io.opentracing.tag.IntTag

set(Span, Short) - Method in class io.opentracing.tag.ShortTag

Deprecated.

set(Span, String) - Method in class io.opentracing.tag.StringTag

set(Span, StringTag) - Method in class io.opentracing.tag.StringTag

setBaggageItem(String, String) - Method in interface io.opentracing.BaseSpan

Sets a baggage item in the Span (and its SpanContext) as a key/value pair.

setOperationName(String) - Method in interface io.opentracing.BaseSpan

Sets the string name for the logical operation this span represents.

setTag(String, String) - Method in interface io.opentracing.BaseSpan

Set a key:value tag on the Span.

setTag(String, boolean) - Method in interface io.opentracing.BaseSpan

Same as BaseSpan.setTag(String, String), but for boolean values.

setTag(String, Number) - Method in interface io.opentracing.BaseSpan

Same as BaseSpan.setTag(String, String), but for numeric values.

ShortTag - Class in io.opentracing.tag

Deprecated.

use IntTag instead.

ShortTag(String) - Constructor for class io.opentracing.tag.ShortTag

Deprecated.

Span - Interface in io.opentracing

Represents an in-flight Span that's manually propagated within the given process.

SPAN_KIND - Static variable in class io.opentracing.tag.Tags

SPAN_KIND hints at the relationship between spans, e.g.

SPAN_KIND_CLIENT - Static variable in class io.opentracing.tag.Tags

A constant for setting the span kind to indicate that it represents a client span.

SPAN_KIND_CONSUMER - Static variable in class io.opentracing.tag.Tags

A constant for setting the span kind to indicate that it represents a consumer span, in a messaging scenario.

SPAN_KIND_PRODUCER - Static variable in class io.opentracing.tag.Tags

A constant for setting the span kind to indicate that it represents a producer span, in a messaging scenario.

SPAN_KIND_SERVER - Static variable in class io.opentracing.tag.Tags

A constant for setting the span kind to indicate that it represents a server span.

SpanContext - Interface in io.opentracing

SpanContext represents Span state that must propagate to descendant Spans and across process boundaries.

start() - Method in interface io.opentracing.Tracer.SpanBuilder

Deprecated.

use Tracer.SpanBuilder.startManual() or Tracer.SpanBuilder.startActive() instead.

startActive() - Method in interface io.opentracing.Tracer.SpanBuilder

Returns a newly started and activated ActiveSpan.

startManual() - Method in interface io.opentracing.Tracer.SpanBuilder

Like Tracer.SpanBuilder.startActive(), but the returned Span has not been registered via the ActiveSpanSource.

StringTag - Class in io.opentracing.tag

StringTag(String) - Constructor for class io.opentracing.tag.StringTag

T

Tags - Class in io.opentracing.tag

The following span tags are recommended for instrumentors who are trying to capture more semantic information about the spans.

TEXT_MAP - Static variable in class io.opentracing.propagation.Format.Builtin

The TEXT_MAP format allows for arbitrary String->String map encoding of SpanContext state for Tracer.inject and Tracer.extract.

TextMap - Interface in io.opentracing.propagation

TextMap is a built-in carrier for Tracer.inject() and Tracer.extract().

TextMapExtractAdapter - Class in io.opentracing.propagation

A TextMap carrier for use with Tracer.extract() ONLY (it has no mutating methods).

TextMapExtractAdapter(Map<String, String>) - Constructor for class io.opentracing.propagation.TextMapExtractAdapter

TextMapInjectAdapter - Class in io.opentracing.propagation

A TextMap carrier for use with Tracer.inject() ONLY (it has no read methods).

TextMapInjectAdapter(Map<String, String>) - Constructor for class io.opentracing.propagation.TextMapInjectAdapter

toString() - Method in class io.opentracing.propagation.Format.Builtin

Tracer - Interface in io.opentracing

Tracer is a simple, thin interface for Span creation and propagation across arbitrary transports.

Tracer.SpanBuilder - Interface in io.opentracing

W

withStartTimestamp(long) - Method in interface io.opentracing.Tracer.SpanBuilder

Specify a timestamp of when the Span was started, represented in microseconds since epoch.

withTag(String, String) - Method in interface io.opentracing.Tracer.SpanBuilder

Same as BaseSpan.setTag(String, String), but for the span being built.

withTag(String, boolean) - Method in interface io.opentracing.Tracer.SpanBuilder

Same as BaseSpan.setTag(String, boolean), but for the span being built.

withTag(String, Number) - Method in interface io.opentracing.Tracer.SpanBuilder

Same as BaseSpan.setTag(String, Number), but for the span being built.

A B C D E F G H I K L M P R S T W