Package io.opencensus.trace
Class TraceOptions
java.lang.Object
io.opencensus.trace.TraceOptions
A class that represents global trace options. These options are propagated to all child
spans
. These determine features such as whether a Span
should
be traced. It is implemented as a bitmask.- Since:
- 0.5
-
Nested Class Summary
Nested Classes -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
static final TraceOptions
The defaultTraceOptions
.private static final byte
private static final byte
private final byte
static final int
The size in bytes of theTraceOptions
. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic TraceOptions.Builder
builder()
Returns a newTraceOptions.Builder
with default options.static TraceOptions.Builder
builder
(TraceOptions traceOptions) Returns a newTraceOptions.Builder
with all given options set.void
copyBytesTo
(byte[] dest, int destOffset) Copies the byte representations of theTraceOptions
into thedest
beginning at thedestOffset
offset.void
copyLowerBase16To
(char[] dest, int destOffset) Copies the lowercase base16 representations of theTraceId
into thedest
beginning at thedestOffset
offset.boolean
static TraceOptions
fromByte
(byte src) Returns aTraceOptions
whose representation issrc
.static TraceOptions
fromBytes
(byte[] buffer) Deprecated.static TraceOptions
fromBytes
(byte[] src, int srcOffset) Deprecated.usefromByte(byte)
.static TraceOptions
fromLowerBase16
(CharSequence src, int srcOffset) Returns aTraceOption
built from a lowercase base16 representation.byte
getByte()
Returns the one byte representation of theTraceOptions
.byte[]
getBytes()
Deprecated.usegetByte()
.(package private) byte
int
hashCode()
private boolean
hasOption
(int mask) boolean
Returns a boolean indicating whether thisSpan
is part of a sampled trace and data should be exported to a persistent store.Returns the lowercase base16 encoding of thisTraceOptions
.toString()
-
Field Details
-
DEFAULT_OPTIONS
private static final byte DEFAULT_OPTIONS- See Also:
-
IS_SAMPLED
private static final byte IS_SAMPLED- See Also:
-
SIZE
public static final int SIZEThe size in bytes of theTraceOptions
.- Since:
- 0.5
- See Also:
-
BASE16_SIZE
private static final int BASE16_SIZE- See Also:
-
DEFAULT
The defaultTraceOptions
.- Since:
- 0.5
-
options
private final byte options
-
-
Constructor Details
-
TraceOptions
private TraceOptions(byte options)
-
-
Method Details
-
fromBytes
Deprecated.usefromByte(byte)
.Returns aTraceOptions
built from a byte representation.Equivalent with:
TraceOptions.fromBytes(buffer, 0);
- Parameters:
buffer
- the representation of theTraceOptions
.- Returns:
- a
TraceOptions
whose representation is given by thebuffer
parameter. - Throws:
NullPointerException
- ifbuffer
is null.IllegalArgumentException
- ifbuffer.length
is notSIZE
.- Since:
- 0.5
-
fromBytes
Deprecated.usefromByte(byte)
.Returns aTraceOptions
whose representation is copied from thesrc
beginning at thesrcOffset
offset.- Parameters:
src
- the buffer where the representation of theTraceOptions
is copied.srcOffset
- the offset in the buffer where the representation of theTraceOptions
begins.- Returns:
- a
TraceOptions
whose representation is copied from the buffer. - Throws:
NullPointerException
- ifsrc
is null.IndexOutOfBoundsException
- ifsrcOffset+TraceOptions.SIZE
is greater thansrc.length
.- Since:
- 0.5
-
fromByte
Returns aTraceOptions
whose representation issrc
.- Parameters:
src
- the byte representation of theTraceOptions
.- Returns:
- a
TraceOptions
whose representation issrc
. - Since:
- 0.16
-
fromLowerBase16
Returns aTraceOption
built from a lowercase base16 representation.- Parameters:
src
- the lowercase base16 representation.srcOffset
- the offset in the buffer where the representation of theTraceOptions
begins.- Returns:
- a
TraceOption
built from a lowercase base16 representation. - Throws:
NullPointerException
- ifsrc
is null.IllegalArgumentException
- ifsrc.length
is not2 * TraceOption.SIZE
OR if thestr
has invalid characters.- Since:
- 0.18
-
getByte
public byte getByte()Returns the one byte representation of theTraceOptions
.- Returns:
- the one byte representation of the
TraceOptions
. - Since:
- 0.16
-
getBytes
Deprecated.usegetByte()
.Returns the 1-byte array representation of theTraceOptions
.- Returns:
- the 1-byte array representation of the
TraceOptions
. - Since:
- 0.5
-
copyBytesTo
public void copyBytesTo(byte[] dest, int destOffset) Copies the byte representations of theTraceOptions
into thedest
beginning at thedestOffset
offset.Equivalent with (but faster because it avoids any new allocations):
System.arraycopy(getBytes(), 0, dest, destOffset, TraceOptions.SIZE);
- Parameters:
dest
- the destination buffer.destOffset
- the starting offset in the destination buffer.- Throws:
NullPointerException
- ifdest
is null.IndexOutOfBoundsException
- ifdestOffset+TraceOptions.SIZE
is greater thandest.length
.- Since:
- 0.5
-
copyLowerBase16To
public void copyLowerBase16To(char[] dest, int destOffset) Copies the lowercase base16 representations of theTraceId
into thedest
beginning at thedestOffset
offset.- Parameters:
dest
- the destination buffer.destOffset
- the starting offset in the destination buffer.- Throws:
IndexOutOfBoundsException
- ifdestOffset + 2
is greater thandest.length
.- Since:
- 0.18
-
toLowerBase16
Returns the lowercase base16 encoding of thisTraceOptions
.- Returns:
- the lowercase base16 encoding of this
TraceOptions
. - Since:
- 0.18
-
builder
Returns a newTraceOptions.Builder
with default options.- Returns:
- a new
Builder
with default options. - Since:
- 0.5
-
builder
Returns a newTraceOptions.Builder
with all given options set.- Parameters:
traceOptions
- the given options set.- Returns:
- a new
Builder
with all given options set. - Since:
- 0.5
-
isSampled
public boolean isSampled()Returns a boolean indicating whether thisSpan
is part of a sampled trace and data should be exported to a persistent store.- Returns:
- a boolean indicating whether the trace is sampled.
- Since:
- 0.5
-
equals
-
hashCode
public int hashCode() -
toString
-
getOptions
byte getOptions() -
hasOption
private boolean hasOption(int mask)
-
fromByte(byte)
.