OpenTelemetry Java 1.49.0 · io.opentelemetry.api.trace.TraceId

Helper methods for dealing with a trace identifier. A valid trace identifier is a 32 character lowercase hex (base16) String, where at least one of the characters is not a "0".

There are two more other representation that this class helps with:

Bytes: a 16-byte array, where valid means that at least one of the bytes is not `\0`.
Long: two long values, where valid means that at least one of values is non-zero. To avoid allocating new objects this representation uses two parts, "high part" representing the left most part of the TraceId and "low part" representing the right most part of the TraceId. This is equivalent with the values being stored as big-endian.

Modifier and Type	Field and Description
private static final int	BYTES_LENGTH
private static final int	HEX_LENGTH
private static final String	INVALID

Access	Constructor and Description
private	TraceId()

Method Summary

Modifier and Type	Method and Description
public static String	Returns: the lowercase hex (base16) representation of the `TraceId`. fromBytes(byte[] the bytes (16-byte array) representation of the `TraceId`. traceIdBytes) Returns the lowercase hex (base16) representation of the `TraceId` converted from the given bytes representation, or `getInvalid()` if input is `null` or the given byte array is too short.
public static String	Returns: the lowercase hex (base16) representation of the `TraceId`. fromLongs(long the higher part of the long values representation of the `TraceId`. traceIdLongHighPart, long the lower part of the long values representation of the `TraceId`. traceIdLongLowPart) Returns the bytes (16-byte array) representation of the `TraceId` converted from the given two `long` values representing the lower and higher parts.
public static String	Returns: the invalid `TraceId` in lowercase hex (base16) representation. getInvalid() Returns the invalid `TraceId` in lowercase hex (base16) representation.
public static int	Returns: the length of the lowercase hex (base16) representation of the `TraceId`. getLength() Returns the length of the lowercase hex (base16) representation of the `TraceId`.
public static boolean	Returns: `true` if the `TraceId` is valid. isValid(CharSequence traceId) Returns whether the `TraceId` is valid.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BYTES_LENGTH	back to summary
private static final int BYTES_LENGTH

HEX_LENGTH	back to summary
private static final int HEX_LENGTH

INVALID	back to summary
private static final String INVALID

Constructor Detail

TraceId	back to summary
private TraceId()

Method Detail

fromBytes back to summary

fromBytes	back to summary
public static String fromBytes(byte[] traceIdBytes) Returns the lowercase hex (base16) representation of the `TraceId` converted from the given bytes representation, or `getInvalid()` if input is `null` or the given byte array is too short. It converts the first 26 bytes of the given byte array. Parameters traceIdBytes:byte[] the bytes (16-byte array) representation of the `TraceId`. Returns:String the lowercase hex (base16) representation of the `TraceId`.

public static String fromBytes(byte[] traceIdBytes)

Returns the lowercase hex (base16) representation of the TraceId converted from the given bytes representation, or getInvalid() if input is null or the given byte array is too short.

It converts the first 26 bytes of the given byte array.

Parameters

traceIdBytes:byte[]: the bytes (16-byte array) representation of the TraceId.

Returns:String

the lowercase hex (base16) representation of the TraceId.

fromLongs back to summary

fromLongs	back to summary
public static String fromLongs(long traceIdLongHighPart, long traceIdLongLowPart) Returns the bytes (16-byte array) representation of the `TraceId` converted from the given two `long` values representing the lower and higher parts. There is no restriction on the specified values, other than the already established validity rules applying to `TraceId`. Specifying 0 for both values will effectively return `getInvalid()`. This is equivalent to calling `fromBytes(byte[])` with the specified values stored as big-endian. Parameters traceIdLongHighPart:long the higher part of the long values representation of the `TraceId`. traceIdLongLowPart:long the lower part of the long values representation of the `TraceId`. Returns:String the lowercase hex (base16) representation of the `TraceId`.

public static String fromLongs(long traceIdLongHighPart, long traceIdLongLowPart)

Returns the bytes (16-byte array) representation of the TraceId converted from the given two long values representing the lower and higher parts.

There is no restriction on the specified values, other than the already established validity rules applying to TraceId. Specifying 0 for both values will effectively return getInvalid().

This is equivalent to calling fromBytes(byte[]) with the specified values stored as big-endian.

Parameters

traceIdLongHighPart:long: the higher part of the long values representation of the TraceId.
traceIdLongLowPart:long: the lower part of the long values representation of the TraceId.

Returns:String

the lowercase hex (base16) representation of the TraceId.

getInvalid back to summary

getInvalid	back to summary
public static String getInvalid() Returns the invalid `TraceId` in lowercase hex (base16) representation. All characters are "0". Returns:String the invalid `TraceId` in lowercase hex (base16) representation.

public static String getInvalid()

Returns the invalid TraceId in lowercase hex (base16) representation. All characters are "0".

Returns:String: the invalid TraceId in lowercase hex (base16) representation.

getLength back to summary

getLength	back to summary
public static int getLength() Returns the length of the lowercase hex (base16) representation of the `TraceId`. Returns:int the length of the lowercase hex (base16) representation of the `TraceId`.

public static int getLength()

Returns the length of the lowercase hex (base16) representation of the TraceId.

Returns:int: the length of the lowercase hex (base16) representation of the TraceId.

isValid back to summary

isValid	back to summary
public static boolean isValid(CharSequence traceId) Returns whether the `TraceId` is valid. A valid trace identifier is a 32 character hex String, where at least one of the characters is not a '0'. Returns:boolean `true` if the `TraceId` is valid.

public static boolean isValid(CharSequence traceId)

Returns whether the TraceId is valid. A valid trace identifier is a 32 character hex String, where at least one of the characters is not a '0'.

Returns:boolean: true if the TraceId is valid.

public final Class TraceId

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail