HiTrace

java.lang.Object
- ohos.hiviewdfx.HiTrace

```
public final class HiTrace
extends Object
```
Provides interfaces for tracing a service call chain, including the start and end of a service flow, and cross-thread, -process, and -device service calls.
You can set FLAG constants to trace synchronous or asynchronous service calls, obtain the service call timestamps at the sender and receiver, and display trace information such as HiTraceId in logs.
Example code for starting the trace of a specified service flow by using the default trace flags:
```
    HiTraceId traceId = HiTrace.begin("MyServiceName", HiTrace.HITRACE_FLAG_DEFAULT);
    ......
    HiTrace.end(traceId);
 
```
从以下版本开始:

1

另请参阅:

HiTraceId

字段概要

字段
限定符和类型	字段	说明
`static int`	`HITRACE_FLAG_DEFAULT`	Indicates default trace flags of service calls.
`static int`	`HITRACE_FLAG_DONOT_CREATE_SPAN`	Creates no spans in a trace task.
`static int`	`HITRACE_FLAG_DONOT_ENABLE_LOG`	Provides no trace information in log.
`static int`	`HITRACE_FLAG_INCLUDE_ASYNC`	Traces asynchronous service calls.
`static int`	`HITRACE_FLAG_NO_BE_INFO`	Provides no prompt information about the start and end of a trace task.
`static int`	`HITRACE_FLAG_TP_INFO`	Enables event tracking.
`static int`	`HITRACE_SLICE_CLIENT`	Indicates the beginning of a time slice trace event on the client side in distributed call chain trace.
`static int`	`HITRACE_SLICE_GENERAL`	Indicates the beginning of a general time slice trace event in distributed call chain trace.
`static int`	`HITRACE_SLICE_SERVER`	Indicates the beginning of a time slice trace event on the server side in distributed call chain trace.

方法概要

所有方法静态方法具体方法
限定符和类型	方法	说明
`static HiTraceId`	`begin(String name, int flags)`	Starts tracing a service call chain.
`static void`	`beginSlice(HiTraceId traceId, int type, String name, String args)`	Starts a distributed time slice trace event.
`static void`	`beginSlice(HiTraceId traceId, String name, String args)`	Starts a general time slice trace event.
`static void`	`clearId()`	Clears the trace ID of the current thread.
`static HiTraceId`	`createSpan()`	Creates a trace ID for the next span based on the trace ID of the current thread.
`static void`	`end(HiTraceId hiTraceId)`	Stops tracing an ongoing service call chain based on `HiTraceId`.
`static void`	`endSlice()`	Ends a time slice trace event.
`static HiTraceId`	`getId()`	Get trace id of current thread, and return a invalid trace id if no trace id belong to current thread.
`static boolean`	`isTraceEnabled()`	Checks whether HiTrace is enabled for the current application.
`static void`	`setId(HiTraceId id)`	Sets the trace ID of the current thread.
`static void`	`traceValue(HiTraceId traceId, String name, long value)`	Outputs an integer value trace event.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - HITRACE_FLAG_DEFAULT
```
public static final int HITRACE_FLAG_DEFAULT
```
    Indicates default trace flags of service calls.
    Value: 0
    By default, only synchronous service calls are traced, spans are created, prompt information about the trace start and end is provided, and event tracking information is not provided.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - HITRACE_FLAG_DONOT_CREATE_SPAN
```
public static final int HITRACE_FLAG_DONOT_CREATE_SPAN
```
    Creates no spans in a trace task.
    Value: 0x0002
    When this flag is set, no spans are created.
    By default, spans are created within a trace of synchronous and asynchronous service calls.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - HITRACE_FLAG_DONOT_ENABLE_LOG
```
public static final int HITRACE_FLAG_DONOT_ENABLE_LOG
```
    Provides no trace information in log.
    Value: 0x0010
    When this flag is set, trace information is not printed in log.
    By default, trace information is printed in log.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - HITRACE_FLAG_INCLUDE_ASYNC
```
public static final int HITRACE_FLAG_INCLUDE_ASYNC
```
    Traces asynchronous service calls.
    Value: 0x0001.
    When this flag is set, both synchronous and asynchronous service calls can be traced.
    By default, only synchronous service calls are traced.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - HITRACE_FLAG_NO_BE_INFO
```
public static final int HITRACE_FLAG_NO_BE_INFO
```
    Provides no prompt information about the start and end of a trace task.
    Value: 0x0008
    When this flag is set, prompt information is not printed.
    By default, prompt information about the start and end of a trace task is printed.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - HITRACE_FLAG_TP_INFO
```
public static final int HITRACE_FLAG_TP_INFO
```
    Enables event tracking.
    Value: 0x0004
    When this flag is set for debugging, event tracking is automatically enabled for synchronous and asynchronous service calls at the sender and receiver, and event tracking information and timestamp are generated. Event tracking can be client send (CS), server receive (SR), server send (SS), or client receive (CR). In a synchronous service call, information about all the four event tracking types (CS/SR/SS/SS) is provided, whereas in an asynchronous service call, information about only the three event tracking types (CS/SR/SS) is provided.
    By default, event tracking is not enabled in a trace task.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - HITRACE_SLICE_CLIENT
```
public static final int HITRACE_SLICE_CLIENT
```
    Indicates the beginning of a time slice trace event on the client side in distributed call chain trace.
    This constant is a flag of the type parameter in the beginSlice API.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - HITRACE_SLICE_GENERAL
```
public static final int HITRACE_SLICE_GENERAL
```
    Indicates the beginning of a general time slice trace event in distributed call chain trace.
    This constant is a flag of the type parameter in the beginSlice API.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - HITRACE_SLICE_SERVER
```
public static final int HITRACE_SLICE_SERVER
```
    Indicates the beginning of a time slice trace event on the server side in distributed call chain trace.
    This constant is a flag of the type parameter in the beginSlice API.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
- 方法详细资料
  - begin
```
public static HiTraceId begin(String name,
                              int flags)
```
    Starts tracing a service call chain.
    If a trace task is started for a service flow based on the service flow name and trace flags, HiTraceId is returned. If begin is called for an ongoing trace task, an invalid HiTraceId is returned.
    
    参数:
    
    name - Indicates the name of the service flow to trace. This parameter can be null.
    
    flags - Indicates the flags set when a trace task is started. For example, you can set a flag to trace only synchronous flows or trace both synchronous and asynchronous flows. For details, see the descriptions of FLAG constants.
    
    返回:
    
    Returns a valid HiTraceId if the trace task is started successfully; returns an invalid HiTraceId otherwise. The valid HiTraceId can be used for stopping a trace task by calling the end method.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    HiTraceId
  - end
```
public static void end(HiTraceId hiTraceId)
```
    Stops tracing an ongoing service call chain based on HiTraceId.
    If HiTraceId is invalid or does not match an ongoing trace task, the ongoing trace task cannot be stopped.
    
    参数:
    
    hiTraceId - Indicates HiTraceId returned when begin is called.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    begin(java.lang.String,int)
  - getId
```
public static HiTraceId getId()
```
    Get trace id of current thread, and return a invalid trace id if no trace id belong to current thread.
    
    返回:
    
    HiTraceId valid if cuurent thread have a trace id, otherwise invalid.
    
    从以下版本开始:
    
    7
  - setId
```
public static void setId(HiTraceId id)
```
    Sets the trace ID of the current thread.
    
    参数:
    
    id - Indicates the trace ID of the current thread. If the specified ID is invalid, nothing will be done.
    
    从以下版本开始:
    
    7
  - clearId
```
public static void clearId()
```
    Clears the trace ID of the current thread.
    If the specified trace ID is valid, this method will clear the trace ID of the current thread and set the trace ID of the current thread as invalid.
    
    从以下版本开始:
    
    7
  - createSpan
```
public static HiTraceId createSpan()
```
    Creates a trace ID for the next span based on the trace ID of the current thread.
    
    返回:
    
    Returns a valid trace ID if the HiTrace of the current thread allows the creation of the next span; returns the trace ID of the current thread otherwise.
    
    从以下版本开始:
    
    7
  - beginSlice
```
public static void beginSlice(HiTraceId traceId,
                              String name,
                              String args)
```
    Starts a general time slice trace event.
    This method starts a time slice trace event of the default HITRACE_SLICE_GENERAL type. It is usually used before the code to be traced. It combines parameters such as traceId, name, and args to generate the time slice start information and passes the information to the trace data.
    
    参数:
    
    traceId - Indicates the trace ID of the service flow to which the time slice trace event belongs. Generally, the value is the trace ID returned by begin or the trace ID passed from the client to the server in distributed call chain trace. If the value of this parameter is null or invalid, the output trace information will not contain the traceId information.
    
    name - Indicates the name of the time slice trace event. It is used to identify the code to be traced. The parameter cannot be null.
    
    args - Indicates the parameter string of the time slice trace event. It is used to output the additional parameter information of the traced code. The value can be null. If this parameter is a JSON string, the IDE can parse the JSON string into a parameter list.
    
    从以下版本开始:
    
    7
  - beginSlice
```
public static void beginSlice(HiTraceId traceId,
                              int type,
                              String name,
                              String args)
```
    Starts a distributed time slice trace event.
    This method starts a time slice trace event of the specified type. It is generally called before the code to be traced. If the type parameter is set to HITRACE_SLICE_GENERAL, this method is equivalent to the beginSlice method without the type parameter. It combines parameters such as traceId, type, name, and args to generate the time slice start information and passes the information to the trace data.
    
    参数:
    
    traceId - Indicates the trace ID of the service flow to which the time slice trace event belongs. Generally, the value is the trace ID returned by begin or the trace ID passed from the client to the server in distributed call chain trace. If the value of this parameter is null or invalid, the output trace information will not contain the traceId information.
    
    type - Indicates the type of the time slice trace event. The value can be HITRACE_SLICE_CLIENT, HITRACE_SLICE_SERVER, or HITRACE_SLICE_GENERAL. HITRACE_SLICE_GENERAL indicates the beginning of a general time slice. HITRACE_SLICE_CLIENT indicates beginning of a time slice trace event on the client side in distributed call chain trace, where the output time slice information contains the client ID. HITRACE_SLICE_SERVER indicates beginning of a time slice trace event on the server side in distributed call chain trace, where the output time slice information contains the server ID. The IDE matches the client and server IDs in the two time slice trace events that contain the same trace ID and parses them into a distributed call chain.
    
    name - Indicates the name of the time slice trace event. It is used to identify the code to be traced. The parameter cannot be null.
    
    args - Indicates the parameter string of the time slice trace event. It is used to output the additional parameter information of the traced code. The value can be null. If this parameter is a JSON string, the IDE can parse the JSON string into a parameter list.
    
    从以下版本开始:
    
    7
  - endSlice
```
public static void endSlice()
```
    Ends a time slice trace event.
    To end a distributed time slice trace event, this method must be used with the beginSlice method. It is generally called after the code to be traced.
    
    从以下版本开始:
    
    7
  - traceValue
```
public static void traceValue(HiTraceId traceId,
                              String name,
                              long value)
```
    Outputs an integer value trace event.
    This method outputs an integer value for a given trace event. It is usually used to trace the value of an integer variable that changes over time. It combines parameters such as traceId, name, and value to generate the integer value trace information and passes the information to the trace data.
    
    参数:
    
    traceId - Indicates the trace ID of the service flow to which the integer value trace event belongs. Generally, the value is the trace ID returned by begin or the trace ID passed from the client to the server in a distributed call. If the value of this parameter is null or invalid, the output trace information will not contain the traceId information.
    
    name - Indicates the name of the integer value trace event. It identifies the integer value to be traced. The parameter cannot be null. Otherwise, no trace information will be output.
    
    value - Indicates the integer value of the given trace event.
    
    从以下版本开始:
    
    7
  - isTraceEnabled
```
public static boolean isTraceEnabled()
```
    Checks whether HiTrace is enabled for the current application.
    
    返回:
    
    Returns true if HiTrace is enabled; returns false otherwise.
    
    从以下版本开始:
    
    7

类 HiTrace

字段概要

方法概要

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

字段详细资料

HITRACE_FLAG_DEFAULT

HITRACE_FLAG_DONOT_CREATE_SPAN

HITRACE_FLAG_DONOT_ENABLE_LOG

HITRACE_FLAG_INCLUDE_ASYNC

HITRACE_FLAG_NO_BE_INFO

HITRACE_FLAG_TP_INFO

HITRACE_SLICE_CLIENT

HITRACE_SLICE_GENERAL

HITRACE_SLICE_SERVER

方法详细资料

begin

end

getId

setId

clearId

createSpan

beginSlice

beginSlice

endSlice

traceValue

isTraceEnabled