• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# HiTraceChain使用指导
2
3## 简介
4
5HiTraceChain是基于云计算分布式跟踪调用链思想，在端侧业务流程（涉及跨线程、跨进程、跨设备）中的一种轻量级实现。hiTraceChain在业务控制面流程中，生成和传递唯一跟踪标识，在业务流程中输出的各类信息中（包括应用事件、系统时间、日志等）记录该跟踪标识。在调试、问题定位过程中，开发者可以通过该唯一跟踪标识将本次业务流程端到端的各类信息快速关联起来。hiTraceChain为开发者提供业务流程调用链跟踪的维测接口，帮助开发者迅速获取指定业务流程调用链的运行日志，定位跨设备/跨进程/跨线程的故障问题。
6
7## 基本概念
8
9**chainId**：分布式跟踪标识，属于HiTraceId的一部分，用于标识当前跟踪的业务流程。
10
11## 接口说明
12
13分布式跟踪接口由hiTraceChain模块提供，详细API请参考[分布式跟踪API参考](../reference/apis-performance-analysis-kit/js-apis-hitracechain.md)。
14
15**分布式跟踪接口功能介绍：**
16
17| 接口名                                                                   | 描述         |
18| ------------------------------------------------------------------------|------------ |
19| hiTraceChain.begin(name: string, flags?: number = HiTraceFlag.DEFAULT)   |开始跟踪。   |
20| hiTraceChain.end(id: HiTraceId)                                          |结束跟踪。    |
21
22## 开发步骤
23
24以构造单次[应用事件打点](../reference/apis-performance-analysis-kit/js-apis-hiviewdfx-hiappevent.md)的业务说明分布式调用链的使用方法。
25
261. 新建一个ets应用工程，编辑工程中的“entry > src > main > ets  > pages > index.ets” 文件，添加一个按钮，完整示例代码如下：
27
28    ```ts
29    import hiAppEvent from '@ohos.hiviewdfx.hiAppEvent'
30    import hilog from '@ohos.hilog'
31    import hiTraceChain from '@ohos.hiTraceChain'
32    import { BusinessError } from '@ohos.base'
33
34    @Entry
35    @Component
36    struct Index {
37      @State message: string = 'Start writing an app event'
38
39      build() {
40        Row() {
41          Column() {
42            Button(this.message)
43              .fontSize(20)
44              .margin(5)
45              .width(350)
46              .height(60)
47              .fontWeight(FontWeight.Bold)
48              .onClick(() => {
49                try {
50                  // 业务开始前，开启分布式跟踪。
51                  let traceId = hiTraceChain.begin("Write a new app event", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC)
52                  // 在按钮点击函数中进行事件打点，以记录按钮点击事件
53                  let eventParams: Record<string, number> = { 'click_time': 100 }
54                  let eventInfo: hiAppEvent.AppEventInfo = {
55                    // 事件领域定义
56                    domain: "button",
57                    // 事件名称定义
58                    name: "click",
59                    // 事件类型定义
60                    eventType: hiAppEvent.EventType.BEHAVIOR,
61                    // 事件参数定义
62                    params: eventParams,
63                  }
64                  hiAppEvent.write(eventInfo).then(() => {
65                    hilog.info(0x0000, 'testTag', `Succeed to write an app event`)
66                    // 业务结束，关闭分布式跟踪。
67                    hiTraceChain.end(traceId)
68                  }).catch((err: BusinessError) => {
69                    hilog.error(0x0000, 'testTag', `HiAppEvent err.code: ${err.code}, err.message: ${err.message}`)
70                  })
71                } catch (err) {
72                  console.error(`error message is ${(err as BusinessError).message}`)
73                }
74              })
75          }
76          .width('100%')
77        }
78        .height('100%')
79      }
80    }
81    ```
82
832. 点击IDE界面中的运行按钮，运行应用工程，然后在应用界面中点击“Start writing an app event”按钮，触发业务逻辑。
84
853. 在Log窗口查看分布式跟踪的相关信息，使用“.*\[([0-9a-zA-Z]{15}).*].*”过滤日志，查看该业务的分布式跟踪信息。hap进程号为“21519”，点击按钮触发的系统事件打点业务涉及到“21519”与“23924”两个线程，通过值为“a92ab94c18e1341”的chainId可以有效跟踪涉及该业务的所有线程的日志信息。
86    ```text
87    11-02 15:13:28.922  21519-21519  C02D03/HiTraceC                  com.example.hitracechaintest     I  [a92ab94c18e1341 0 0][dict]HiTraceBegin name:Write a new app event flags:0x01.
88    11-02 15:13:28.924  21519-21519  C03915/AceInputTracking          com.example.hitracechaintest     I  [a92ab94c18e1341 0 0][ace_view_ohos.cpp(operator())-(0)] touch Event markProcessed in ace_view, eventInfo: id:764
89    11-02 15:13:28.926  21519-23924  C02D07/HiAppEvent_ObserverMgr    com.example.hitracechaintest     I  [a92ab94c18e1341 0 0]start to handle event
90    11-02 15:13:28.930  21519-21519  A00000/testTag                   com.example.hitracechaintest     I  [a92ab94c18e1341 324c3a3 0]Succeed to write an app event
91    11-02 15:13:28.930  21519-21519  C02D03/HiTraceC                  com.example.hitracechaintest     I  [a92ab94c18e1341 324c3a3 0][dict]HiTraceEnd.
92   ```
93
94## 跨进程/跨设备分布式跟踪说明
95
96跨进程/跨设备分布式跟踪依赖于OpenHarmony各模块相应业务接口的napi实现是否存在进程及设备之间的通信调用，具体请参考[HiTraceChain开发指导](../../device-dev/subsystems/subsys-dfx-hitracechain.md)。
97