程序包 ohos.hiviewdfx

类 HiTraceId

java.lang.Object

ohos.hiviewdfx.HiTraceId

public final class HiTraceId
extends Object

Provides ID information of a call chain trace process.

ID information includes the trace flag, chain ID, and span ID.

从以下版本开始:

1

另请参阅:

HiTrace

构造器概要

构造器

构造器	说明
HiTraceId()	A constructor used to create an HiTraceId object.
HiTraceId(byte[] idArray)	Generates a HiTraceId object based on idArray.

方法概要

限定符和类型	方法	说明
long	getChainId()	Obtains the call chain ID from a HiTraceId object.
long	getParentSpanId()	Obtains the parent span ID from a HiTraceId object.
long	getSpanId()	Obtains the span ID from a HiTraceId object.
boolean	isValid()	Checks whether an HiTraceId object is valid.
void	setChainId(long chainId)	Sets the chain ID for the current trace ID.
void	setParentSpanId(long parentSpanId)	Sets the parent span ID for the current trace ID.
void	setSpanId(long spanId)	Sets the span ID for the current trace ID.
byte[]	toBytes()	Converts a HiTraceId object to an idArray.

从类继承的方法 java.lang.Object

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

构造器详细资料

HiTraceId

public HiTraceId()

A constructor used to create an HiTraceId object.

An invalid, initial object is generated.

从以下版本开始:

1

HiTraceId

public HiTraceId(byte[] idArray)

Generates a HiTraceId object based on idArray.

参数:

idArray - Indicates a byte array, which is converted from another HiTraceId object by using the toBytes method.

从以下版本开始:

1

另请参阅:

toBytes()

方法详细资料

isValid

public boolean isValid()

Checks whether an HiTraceId object is valid.

返回:

Returns true if the HiTraceId object is valid; returns false otherwise.

从以下版本开始:

1

getChainId

public long getChainId()

Obtains the call chain ID from a HiTraceId object.

返回:

Returns the call chain ID if the HiTraceId object is valid; returns 0 otherwise.

从以下版本开始:

1

setChainId

public void setChainId(long chainId)

Sets the chain ID for the current trace ID.

If the current trace ID is invalid, change it to a valid one.

参数:

chainId - Indicates the chain ID to set.

从以下版本开始:

7

getSpanId

public long getSpanId()

Obtains the span ID from a HiTraceId object.

返回:

Returns the span ID if the HiTraceId object is valid; returns 0 otherwise.

从以下版本开始:

1

setSpanId

public void setSpanId(long spanId)

Sets the span ID for the current trace ID.

If the current trace ID is invalid, nothing will be done.

参数:

spanId - Indicates the span ID to set.

从以下版本开始:

7

getParentSpanId

public long getParentSpanId()

Obtains the parent span ID from a HiTraceId object.

返回:

Returns the parent span ID if the HiTraceId object is valid; returns 0 otherwise.

从以下版本开始:

1

setParentSpanId

public void setParentSpanId(long parentSpanId)

Sets the parent span ID for the current trace ID.

If the current trace ID is invalid, nothing will be done.

参数:

parentSpanId - Indicates the parent span ID to set.

从以下版本开始:

7

toBytes

public byte[] toBytes()

Converts a HiTraceId object to an idArray.

返回:

Returns the converted idArray object if the HiTraceId object is valid; returns an invalid idArray object otherwise.

从以下版本开始:

1