Skip navigation links
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(Span) - Method in interface io.opentracing.ScopeManager
Set the specified Span as the active instance for the current context (usually a thread).
activate(Span, boolean) - Method in interface io.opentracing.ScopeManager
Deprecated.
use ScopeManager.activate(Span) instead. Set the specified Span as the active instance for the current context (usually a thread).

Finishing the Span upon Scope.close() is discouraged, as reporting errors becomes impossible:


     try (Scope scope = tracer.scopeManager().activate(span, true)) {
     } catch (Exception e) {
         // Not possible to report errors, as
         // the span has been already finished.
     }
 
activateSpan(Span) - Method in interface io.opentracing.Tracer
Make a Span instance active for the current context (usually a thread).
active() - Method in interface io.opentracing.ScopeManager
Return the currently active Scope which can be used to deactivate the currently active Span.
activeSpan() - Method in interface io.opentracing.ScopeManager
Return the currently active Span.
activeSpan() - Method in interface io.opentracing.Tracer
 
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(Span) - Method in interface io.opentracing.Tracer.SpanBuilder
A shorthand for addReference(References.CHILD_OF, parent.context()).

B

baggageItems() - Method in interface io.opentracing.SpanContext
 
Binary - Interface in io.opentracing.propagation
Binary is an interface defining the required operations for a binary carrier for Tracer.inject() and Tracer.extract().
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.
BinaryAdapters - Class in io.opentracing.propagation
 
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

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.Scope
Mark the end of the active period for the current context (usually a thread) and Scope, updating ScopeManager.active() and ScopeManager.activeSpan() in the process.
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.Span
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.

E

ERROR - Static variable in class io.opentracing.tag.Tags
ERROR indicates whether a Span ended in an error state.
ERROR_KIND - Static variable in class io.opentracing.log.Fields
The type or "kind" of an error (only for event="error" logs).
ERROR_OBJECT - Static variable in class io.opentracing.log.Fields
The actual Throwable/Exception/Error object instance itself.
EVENT - Static variable in class io.opentracing.log.Fields
A stable identifier for some notable moment in the lifetime of a Span.
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.
extractionBuffer() - Method in interface io.opentracing.propagation.Binary
Gets the buffer containing the data used for SpanContext extraction.
extractionCarrier(ByteBuffer) - Static method in class io.opentracing.propagation.BinaryAdapters
Creates an inbound Binary instance used for extraction with the specified ByteBuffer as input.

F

Fields - Class in io.opentracing.log
The following log fields are recommended for instrumentors who are trying to capture more information about a logged event.
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.Span
 
getKey() - Method in class io.opentracing.tag.AbstractTag
 
getKey() - Method in interface io.opentracing.tag.Tag
 

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 ScopeManager.active()).
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.
injectionBuffer(int) - Method in interface io.opentracing.propagation.Binary
Gets the buffer used to store data as part of SpanContext injection.
injectionCarrier(ByteBuffer) - Static method in class io.opentracing.propagation.BinaryAdapters
Creates an outbound Binary instance used for injection with the specified ByteBuffer as output.
IntOrStringTag - Class in io.opentracing.tag
 
IntOrStringTag(String) - Constructor for class io.opentracing.tag.IntOrStringTag
 
IntTag - Class in io.opentracing.tag
 
IntTag(String) - Constructor for class io.opentracing.tag.IntTag
 
io.opentracing - package io.opentracing
 
io.opentracing.log - package io.opentracing.log
 
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.Span
Log key:value pairs to the Span with the current walltime timestamp.
log(long, Map<String, ?>) - Method in interface io.opentracing.Span
Like log(Map<String, Object>), but with an explicit timestamp.
log(String) - Method in interface io.opentracing.Span
Record an event at the current walltime timestamp.
log(long, String) - Method in interface io.opentracing.Span
Record an event at a specific timestamp.

M

MESSAGE - Static variable in class io.opentracing.log.Fields
A concise, human-readable, one-line message explaining the event.
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 service.
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.
Scope - Interface in io.opentracing
A Scope formalizes the activation and deactivation of a Span, usually from a CPU standpoint.
ScopeManager - Interface in io.opentracing
The ScopeManager interface abstracts both the activation of Span instances via ScopeManager.activate(Span, boolean) and access to an active Span/Scope via ScopeManager.active().
scopeManager() - Method in interface io.opentracing.Tracer
 
SERVICE - Static variable in class io.opentracing.tag.Tags
The service name for a span, which overrides any default "service name" property defined in a tracer's config.
set(Span, T) - Method in class io.opentracing.tag.AbstractTag
 
set(Span, Boolean) - Method in class io.opentracing.tag.BooleanTag
 
set(Span, String) - Method in class io.opentracing.tag.IntOrStringTag
 
set(Span, Integer) - Method in class io.opentracing.tag.IntTag
 
set(Span, String) - Method in class io.opentracing.tag.StringTag
 
set(Span, StringTag) - Method in class io.opentracing.tag.StringTag
Deprecated.
as using the tag *key* as tag value is not usually required.
set(Span, T) - Method in interface io.opentracing.tag.Tag
 
setBaggageItem(String, String) - Method in interface io.opentracing.Span
Sets a baggage item in the Span (and its SpanContext) as a key/value pair.
setOperationName(String) - Method in interface io.opentracing.Span
Sets the string name for the logical operation this span represents.
setTag(String, String) - Method in interface io.opentracing.Span
Set a key:value tag on the Span.
setTag(String, boolean) - Method in interface io.opentracing.Span
Same as Span.setTag(String, String), but for boolean values.
setTag(String, Number) - Method in interface io.opentracing.Span
Same as Span.setTag(String, String), but for numeric values.
setTag(Tag<T>, T) - Method in interface io.opentracing.Span
Same as Span.setTag(String, String), but with using Tag.
span() - Method in interface io.opentracing.Scope
Deprecated.
use Span directly or access it through ScopeManager.activeSpan() Return the corresponding active Span for this instance.
Span - Interface in io.opentracing
Span represents the OpenTracing specification's Span contract.
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.
STACK - Static variable in class io.opentracing.log.Fields
A stack trace in platform-conventional format; may or may not pertain to an error.
start() - Method in interface io.opentracing.Tracer.SpanBuilder
Returns a newly-started Span.
startActive(boolean) - Method in interface io.opentracing.Tracer.SpanBuilder
Deprecated.
use Tracer.SpanBuilder.start() and ScopeManager.activate(Span span) instead. Returns a newly started and activated Scope.

SpanBuilder#startActive() is a shorthand for tracer.scopeManager().activate(spanBuilder.start()). The returned Scope supports try-with-resources, but using this method is discouraged as the Span reference could be easily lost, and reporting errors on Span through this method becomes impossible:


     try (Scope scope = tracer.buildSpan("...").startActive(true)) {
         // (Do work)
         scope.span().setTag( ... );  // etc, etc
     } catch (Exception e) {
         // Not possible to report errors, as
         // the span reference has been lost,
         // and span has been already finished too.
     }
 

It is recommended to use Tracer.SpanBuilder.start() with a subsequent call to ScopeManager.activate(Span)


     Span span = tracer.buildSpan("...").start();
     try (Scope scope = tracer.activateSpan(span)) {
     } catch (Exception e) {
         span.log(...); // Report any errors properly.
     } finally {
         span.finish(); // Optionally close the Span.
     }
 
startManual() - Method in interface io.opentracing.Tracer.SpanBuilder
Deprecated.
StringTag - Class in io.opentracing.tag
 
StringTag(String) - Constructor for class io.opentracing.tag.StringTag
 

T

Tag<T> - Interface in io.opentracing.tag
 
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, ? super String>) - Constructor for class io.opentracing.propagation.TextMapInjectAdapter
 
toSpanId() - Method in interface io.opentracing.SpanContext
Return the ID of the associated Span.
toString() - Method in class io.opentracing.propagation.Format.Builtin
 
toTraceId() - Method in interface io.opentracing.SpanContext
Return the ID of the trace.
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 Span.setTag(String, String), but for the span being built.
withTag(String, boolean) - Method in interface io.opentracing.Tracer.SpanBuilder
Same as Span.setTag(String, boolean), but for the span being built.
withTag(String, Number) - Method in interface io.opentracing.Tracer.SpanBuilder
Same as Span.setTag(String, Number), but for the span being built.
withTag(Tag<T>, T) - Method in interface io.opentracing.Tracer.SpanBuilder
Same as AbstractTag#set(Span, T), but for the span being built.
A B C D E F G H I K L M P R S T W 
Skip navigation links

Copyright © 2016–2018 OpenTracing. All rights reserved.