• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# DFX子系统Changelog
2
3## cl.dfx.1 用户态trace打点格式变更
4
5**访问级别**
6
7公开接口
8
9**变更原因**
10
11优化调整原有用户态trace打点格式,提高用户态trace打点格式的前向兼容性。
12
13**变更影响**
14
15此变更不涉及应用适配。
16
17此变更涉及自研Trace解析工具适配,具体变更内容如表中所示。
18
19变更前:taskId和count字段前的分隔符为空格。
20
21变更后:各字段均使用竖线作为分隔符。
22
23| 打点类型          | API_C接口                                                    | API_JS接口                                                   | 变更前打点格式        | 变更后打点格式         |
24| ----------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | --------------------- | ---------------------- |
25| 开启异步Trace打点 | [OH_HiTrace_StartAsyncTrace](../../../application-dev/reference/apis-performance-analysis-kit/_hitrace.md#oh_hitrace_startasynctrace) | [startTrace](../../../application-dev/reference/apis-performance-analysis-kit/js-apis-hitracemeter.md#hitracemeterstarttrace) | S\|PID\|H:name taskId | S\|PID\|H:name\|taskId |
26| 结束异步Trace打点 | [OH_HiTrace_FinshAsyncTrace](../../../application-dev/reference/apis-performance-analysis-kit/_hitrace.md#oh_hitrace_finishasynctrace) | [finshTrace](../../../application-dev/reference/apis-performance-analysis-kit/js-apis-hitracemeter.md#hitracemeterfinishtrace) | F\|PID\|H:name taskId | F\|PID\|H:name\|taskId |
27| 整数Trace打点     | [OH_HiTrace_CountTrace](../../../application-dev/reference/apis-performance-analysis-kit/_hitrace.md#oh_hitrace_counttrace) | [traceByValue](../../../application-dev/reference/apis-performance-analysis-kit/js-apis-hitracemeter.md#hitracemetertracebyvalue) | C\|PID\|H:name count  | C\|PID\|H:name\|count  |
28
29**用户态trace格式拓展规则**
30
31对后续新增字段,将以**竖线+字段**的方式,追加在当前打点格式的末尾。
32
33假设 `S|PID|H:name|taskId` 新增字段args1和args2,用户态trace格式变化如下所示。
34
35- 原格式
36
37  ```text
38  S|PID|H:name|taskId
39  ```
40
41- 新增args1和args2字段后格式
42
43  ```text
44  S|PID|H:name|taskId|args1|args2
45  ```
46
47  **特殊场景说明**:因为后续新增字段并不是所有场景都会使用,所以实际字段值可能为空字符串,当有字段为空字符串时,trace格式变化如下所示。
48
49  - args1为空字符串,args2不为空字符串
50
51    ```text
52    S|PID|H:name|taskId||args2
53    ```
54
55  - args1不为空字符串,args2为空字符串
56
57    ```text
58    S|PID|H:name|taskId|args1
59    ```
60
61  - args1和args2均为空字符串
62
63    ```text
64    S|PID|H:name|taskId
65    ```
66
67详细的用户态trace格式说明参考文档[hitracemeter-view](../../../application-dev/dfx/hitracemeter-view.md)。
68
69**起始API Level**
70
71- [OH_HiTrace_StartAsyncTrace](../../../application-dev/reference/apis-performance-analysis-kit/_hitrace.md#oh_hitrace_startasynctrace):API 10
72
73- [OH_HiTrace_FinshAsyncTrace](../../../application-dev/reference/apis-performance-analysis-kit/_hitrace.md#oh_hitrace_finishasynctrace):API 10
74
75- [OH_HiTrace_CountTrace](../../../application-dev/reference/apis-performance-analysis-kit/_hitrace.md#oh_hitrace_counttrace):API 10
76- [startTrace](../../../application-dev/reference/apis-performance-analysis-kit/js-apis-hitracemeter.md#hitracemeterstarttrace):API 12
77- [finshTrace](../../../application-dev/reference/apis-performance-analysis-kit/js-apis-hitracemeter.md#hitracemeterfinishtrace):API 12
78- [traceByValue](../../../application-dev/reference/apis-performance-analysis-kit/js-apis-hitracemeter.md#hitracemetertracebyvalue):API 12
79
80**变更发生版本**
81
82从OpenHarmony SDK 5.1.0.55版本开始。
83
84**变更的接口/组件**
85
86- [OH_HiTrace_StartAsyncTrace](../../../application-dev/reference/apis-performance-analysis-kit/_hitrace.md#oh_hitrace_startasynctrace)
87
88- [OH_HiTrace_FinshAsyncTrace](../../../application-dev/reference/apis-performance-analysis-kit/_hitrace.md#oh_hitrace_finishasynctrace)
89
90- [OH_HiTrace_CountTrace](../../../application-dev/reference/apis-performance-analysis-kit/_hitrace.md#oh_hitrace_counttrace)
91- [startTrace](../../../application-dev/reference/apis-performance-analysis-kit/js-apis-hitracemeter.md#hitracemeterstarttrace)
92- [finshTrace](../../../application-dev/reference/apis-performance-analysis-kit/js-apis-hitracemeter.md#hitracemeterfinishtrace)
93- [traceByValue](../../../application-dev/reference/apis-performance-analysis-kit/js-apis-hitracemeter.md#hitracemetertracebyvalue)
94
95**适配指导**
96
97默认行为变更,无需适配。
98
99自研Trace解析工具可根据前述**变更影响**中对打点格式变更的介绍自行适配。