提交 36a75cca 编写于 作者: X xuyong

api文档随dts文档同步

Signed-off-by: Nxuyong <xuyong59@huawei.com>
上级 d01c7628
...@@ -71,7 +71,7 @@ import hiTraceChain from '@ohos.hiTraceChain'; ...@@ -71,7 +71,7 @@ import hiTraceChain from '@ohos.hiTraceChain';
## hiTraceChain.begin ## hiTraceChain.begin
begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId begin(name: string, flags?: number): HiTraceId
开始跟踪,同步接口。 开始跟踪,同步接口。
...@@ -82,7 +82,7 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId ...@@ -82,7 +82,7 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| name | string | 是 | 跟踪业务名。 | | name | string | 是 | 跟踪业务名。 |
| flags | number | | 跟踪标志组合,具体可参考[HiTraceFlag](#hitraceflag)。 | | flags | number | | 跟踪标志组合,具体可参考[HiTraceFlag](#hitraceflag)。 |
**返回值:** **返回值:**
...@@ -113,7 +113,7 @@ end(id: HiTraceId): void ...@@ -113,7 +113,7 @@ end(id: HiTraceId): void
**示例:** **示例:**
```js ```js
let asyncTraceId = hiTraceChain.begin("business"); let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.DEFAULT);
// 若干业务逻辑完成后,结束跟踪。 // 若干业务逻辑完成后,结束跟踪。
hiTraceChain.end(asyncTraceId); hiTraceChain.end(asyncTraceId);
``` ```
...@@ -135,7 +135,7 @@ getId(): HiTraceId ...@@ -135,7 +135,7 @@ getId(): HiTraceId
**示例:** **示例:**
```js ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.DEFAULT);
// 若干业务逻辑完成后,获取当前HiTraceId。 // 若干业务逻辑完成后,获取当前HiTraceId。
let curTraceId = hiTraceChain.getId(); let curTraceId = hiTraceChain.getId();
``` ```
...@@ -158,7 +158,7 @@ setId(id: HiTraceId): void ...@@ -158,7 +158,7 @@ setId(id: HiTraceId): void
```js ```js
let asyncTraceId; let asyncTraceId;
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.DEFAULT);
// 若干业务逻辑完成后,设置当前HiTraceId。 // 若干业务逻辑完成后,设置当前HiTraceId。
hiTraceChain.setId(asyncTraceId); hiTraceChain.setId(asyncTraceId);
``` ```
...@@ -174,7 +174,7 @@ clearId(): void ...@@ -174,7 +174,7 @@ clearId(): void
**示例:** **示例:**
```js ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.DEFAULT);
// 若干业务逻辑完成后,清除当前HiTraceId。 // 若干业务逻辑完成后,清除当前HiTraceId。
hiTraceChain.clearId(); hiTraceChain.clearId();
``` ```
...@@ -196,7 +196,7 @@ createSpan(): HiTraceId ...@@ -196,7 +196,7 @@ createSpan(): HiTraceId
**示例:** **示例:**
```js ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.DEFAULT);
// 若干业务逻辑完成后,创建跟踪分支。 // 若干业务逻辑完成后,创建跟踪分支。
let spanTraceId = hiTraceChain.createSpan(); let spanTraceId = hiTraceChain.createSpan();
``` ```
...@@ -249,7 +249,7 @@ isValid(id: HiTraceId): boolean ...@@ -249,7 +249,7 @@ isValid(id: HiTraceId): boolean
**示例:** **示例:**
```js ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.DEFAULT);
let traceIdIsvalid = hiTraceChain.isValid(traceId); let traceIdIsvalid = hiTraceChain.isValid(traceId);
``` ```
...@@ -291,6 +291,7 @@ enableFlag(id: HiTraceId, flag: HiTraceFlag): void ...@@ -291,6 +291,7 @@ enableFlag(id: HiTraceId, flag: HiTraceFlag): void
**系统能力:** SystemCapability.HiviewDFX.HiTrace **系统能力:** SystemCapability.HiviewDFX.HiTrace
**参数:** **参数:**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| id | [HiTraceId](#hitraceid) | 是 | 需要置位指定跟踪标志的HiTraceId实例。 | | id | [HiTraceId](#hitraceid) | 是 | 需要置位指定跟踪标志的HiTraceId实例。 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册