提交 27a18769 编写于 作者: X xuyong

Replace javascript with js as the mark for language type

Signed-off-by: Nxuyong <xuyong59@huawei.com>
上级 5822bddf
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
## Modules to Import ## Modules to Import
```javascript ```js
import hiTraceChain from '@ohos.hiTraceChain'; import hiTraceChain from '@ohos.hiTraceChain';
``` ```
...@@ -90,7 +90,7 @@ Starts call chain tracing. This API works in synchronous manner. ...@@ -90,7 +90,7 @@ Starts call chain tracing. This API works in synchronous manner.
**Example** **Example**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
``` ```
...@@ -110,7 +110,7 @@ Stops call chain tracing. This API works in synchronous manner. ...@@ -110,7 +110,7 @@ Stops call chain tracing. This API works in synchronous manner.
**Example** **Example**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business"); let asyncTraceId = hiTraceChain.begin("business");
// End the call chain tracing after the service logic is executed for several times. // End the call chain tracing after the service logic is executed for several times.
hiTraceChain.end(asyncTraceId); hiTraceChain.end(asyncTraceId);
...@@ -132,7 +132,7 @@ Obtains the trace ID. This API works in synchronous manner. ...@@ -132,7 +132,7 @@ Obtains the trace ID. This API works in synchronous manner.
**Example** **Example**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
// Obtain the current trace ID after the service logic is executed for several times. // Obtain the current trace ID after the service logic is executed for several times.
let curTraceId = hiTraceChain.getId(); let curTraceId = hiTraceChain.getId();
...@@ -154,7 +154,7 @@ Sets a trace ID. This API works in synchronous manner. ...@@ -154,7 +154,7 @@ Sets a trace ID. This API works in synchronous manner.
**Example** **Example**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
// Set the current trace ID after the service logic is executed for several times. // Set the current trace ID after the service logic is executed for several times.
hiTraceChain.setId(asyncTraceId); hiTraceChain.setId(asyncTraceId);
...@@ -170,7 +170,7 @@ Clears the trace ID. This API works in synchronous manner. ...@@ -170,7 +170,7 @@ Clears the trace ID. This API works in synchronous manner.
**Example** **Example**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
// Clear the current trace ID after the service logic is executed for several times. // Clear the current trace ID after the service logic is executed for several times.
hiTraceChain.clearId(); hiTraceChain.clearId();
...@@ -192,7 +192,7 @@ Creates a trace span. This API works in synchronous manner. ...@@ -192,7 +192,7 @@ Creates a trace span. This API works in synchronous manner.
**Example** **Example**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
// Create a trace span after the service logic is executed for several times. // Create a trace span after the service logic is executed for several times.
let spanTraceId = hiTraceChain.createSpan(); let spanTraceId = hiTraceChain.createSpan();
...@@ -217,7 +217,7 @@ Triggers a trace point. This API works in synchronous manner. ...@@ -217,7 +217,7 @@ Triggers a trace point. This API works in synchronous manner.
**Example** **Example**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
// Trigger the trace point after the service logic is executed for several times. // Trigger the trace point after the service logic is executed for several times.
hiTraceChain.tracepoint(hiTraceChain.HiTraceCommunicationMode.THREAD, hiTraceChain.HiTraceTracepointType.SS, asyncTraceId, "Just a example"); hiTraceChain.tracepoint(hiTraceChain.HiTraceCommunicationMode.THREAD, hiTraceChain.HiTraceTracepointType.SS, asyncTraceId, "Just a example");
...@@ -245,7 +245,7 @@ Checks whether a **HiTraceId** instance is valid. This API works in synchronous ...@@ -245,7 +245,7 @@ Checks whether a **HiTraceId** instance is valid. This API works in synchronous
**Example** **Example**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
let traceIdIsvalid = hiTraceChain.isValid(traceId); let traceIdIsvalid = hiTraceChain.isValid(traceId);
``` ```
...@@ -273,7 +273,7 @@ Checks whether the specified trace flag in the **HiTraceId** instance is enabled ...@@ -273,7 +273,7 @@ Checks whether the specified trace flag in the **HiTraceId** instance is enabled
**Example** **Example**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC); let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
// The value of enabledDoNotCreateSpanFlag is true. // The value of enabledDoNotCreateSpanFlag is true.
let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.INCLUDE_ASYNC); let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
...@@ -295,7 +295,7 @@ Enables the specified trace flag in the **HiTraceId** instance. This API works i ...@@ -295,7 +295,7 @@ Enables the specified trace flag in the **HiTraceId** instance. This API works i
**Example** **Example**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC); let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
hiTraceChain.enable(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); hiTraceChain.enable(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
// The value of enabledDoNotCreateSpanFlag is true. // The value of enabledDoNotCreateSpanFlag is true.
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
## Modules to Import ## Modules to Import
```javascript ```js
import hiTraceMeter from '@ohos.hiTraceMeter'; import hiTraceMeter from '@ohos.hiTraceMeter';
``` ```
...@@ -32,7 +32,7 @@ If the trace tasks with the same name are not performed at the same time, the sa ...@@ -32,7 +32,7 @@ If the trace tasks with the same name are not performed at the same time, the sa
**Example** **Example**
```javascript ```js
hiTraceMeter.startTrace("myTestFunc", 1); hiTraceMeter.startTrace("myTestFunc", 1);
hiTraceMeter.startTrace("myTestFunc", 1, 5); // The expected duration of the trace task is 5 ms. hiTraceMeter.startTrace("myTestFunc", 1, 5); // The expected duration of the trace task is 5 ms.
``` ```
...@@ -57,11 +57,11 @@ To stop a trace task, the values of name and task ID in **finishTrace** must be ...@@ -57,11 +57,11 @@ To stop a trace task, the values of name and task ID in **finishTrace** must be
**Example** **Example**
```javascript ```js
hiTraceMeter.finishTrace("myTestFunc", 1); hiTraceMeter.finishTrace("myTestFunc", 1);
``` ```
```javascript ```js
// Start track tasks with the same name concurrently. // Start track tasks with the same name concurrently.
hiTraceMeter.startTrace("myTestFunc", 1); hiTraceMeter.startTrace("myTestFunc", 1);
// Service flow // Service flow
...@@ -72,7 +72,7 @@ hiTraceMeter.finishTrace("myTestFunc", 1); ...@@ -72,7 +72,7 @@ hiTraceMeter.finishTrace("myTestFunc", 1);
hiTraceMeter.finishTrace("myTestFunc", 2); hiTraceMeter.finishTrace("myTestFunc", 2);
``` ```
```javascript ```js
// Start track tasks with the same name at different times. // Start track tasks with the same name at different times.
hiTraceMeter.startTrace("myTestFunc", 1); hiTraceMeter.startTrace("myTestFunc", 1);
// Service flow // Service flow
...@@ -100,7 +100,7 @@ Traces the value changes of a variable. ...@@ -100,7 +100,7 @@ Traces the value changes of a variable.
| count | number | Yes| Value of the variable.| | count | number | Yes| Value of the variable.|
**Example** **Example**
```javascript ```js
let traceCount = 3; let traceCount = 3;
hiTraceMeter.traceByValue("myTestCount", traceCount); hiTraceMeter.traceByValue("myTestCount", traceCount);
traceCount = 4; traceCount = 4;
......
...@@ -5,7 +5,7 @@ ...@@ -5,7 +5,7 @@
## 导入模块 ## 导入模块
```javascript ```js
import hiTraceChain from '@ohos.hiTraceChain'; import hiTraceChain from '@ohos.hiTraceChain';
``` ```
...@@ -90,7 +90,7 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId ...@@ -90,7 +90,7 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId
**示例:** **示例:**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
``` ```
...@@ -110,7 +110,7 @@ end(id: HiTraceId): void ...@@ -110,7 +110,7 @@ end(id: HiTraceId): void
**示例:** **示例:**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business"); let asyncTraceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,结束跟踪。 // 若干业务逻辑完成后,结束跟踪。
hiTraceChain.end(asyncTraceId); hiTraceChain.end(asyncTraceId);
...@@ -132,7 +132,7 @@ getId(): HiTraceId ...@@ -132,7 +132,7 @@ getId(): HiTraceId
**示例:** **示例:**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,获取当前HiTraceId。 // 若干业务逻辑完成后,获取当前HiTraceId。
let curTraceId = hiTraceChain.getId(); let curTraceId = hiTraceChain.getId();
...@@ -154,7 +154,7 @@ setId(id: HiTraceId): void ...@@ -154,7 +154,7 @@ setId(id: HiTraceId): void
**示例:** **示例:**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,设置当前HiTraceId。 // 若干业务逻辑完成后,设置当前HiTraceId。
hiTraceChain.setId(asyncTraceId); hiTraceChain.setId(asyncTraceId);
...@@ -170,7 +170,7 @@ clearId(): void ...@@ -170,7 +170,7 @@ clearId(): void
**示例:** **示例:**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,清除当前HiTraceId。 // 若干业务逻辑完成后,清除当前HiTraceId。
hiTraceChain.clearId(); hiTraceChain.clearId();
...@@ -192,7 +192,7 @@ createSpan(): HiTraceId ...@@ -192,7 +192,7 @@ createSpan(): HiTraceId
**示例:** **示例:**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,创建跟踪分支。 // 若干业务逻辑完成后,创建跟踪分支。
let spanTraceId = hiTraceChain.createSpan(); let spanTraceId = hiTraceChain.createSpan();
...@@ -217,7 +217,7 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracepointType, id: HiTr ...@@ -217,7 +217,7 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracepointType, id: HiTr
**示例:** **示例:**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
// 若干业务逻辑完成后,触发信息埋点操作。 // 若干业务逻辑完成后,触发信息埋点操作。
hiTraceChain.tracepoint(hiTraceChain.HiTraceCommunicationMode.THREAD, hiTraceChain.HiTraceTracepointType.SS, asyncTraceId, "Just a example"); hiTraceChain.tracepoint(hiTraceChain.HiTraceCommunicationMode.THREAD, hiTraceChain.HiTraceTracepointType.SS, asyncTraceId, "Just a example");
...@@ -245,7 +245,7 @@ isValid(id: HiTraceId): boolean ...@@ -245,7 +245,7 @@ isValid(id: HiTraceId): boolean
**示例:** **示例:**
```javascript ```js
let traceId = hiTraceChain.begin("business"); let traceId = hiTraceChain.begin("business");
let traceIdIsvalid = hiTraceChain.isValid(traceId); let traceIdIsvalid = hiTraceChain.isValid(traceId);
``` ```
...@@ -273,7 +273,7 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean ...@@ -273,7 +273,7 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean
**示例:** **示例:**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC); let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
// enabledDoNotCreateSpanFlag为true // enabledDoNotCreateSpanFlag为true
let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.INCLUDE_ASYNC); let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
...@@ -295,7 +295,7 @@ enableFlag(id: HiTraceId, flag: HiTraceFlag): void ...@@ -295,7 +295,7 @@ enableFlag(id: HiTraceId, flag: HiTraceFlag): void
**示例:** **示例:**
```javascript ```js
let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC); let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
hiTraceChain.enable(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); hiTraceChain.enable(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
// enabledDoNotCreateSpanFlag为true // enabledDoNotCreateSpanFlag为true
......
...@@ -6,7 +6,7 @@ ...@@ -6,7 +6,7 @@
## 导入模块 ## 导入模块
```javascript ```js
import hiTraceMeter from '@ohos.hiTraceMeter'; import hiTraceMeter from '@ohos.hiTraceMeter';
``` ```
...@@ -32,7 +32,7 @@ startTrace(name: string, taskId: number): void ...@@ -32,7 +32,7 @@ startTrace(name: string, taskId: number): void
**示例:** **示例:**
```javascript ```js
hiTraceMeter.startTrace("myTestFunc", 1); hiTraceMeter.startTrace("myTestFunc", 1);
hiTraceMeter.startTrace("myTestFunc", 1, 5); //从startTrace到finishTrace流程的耗时期望为5ms hiTraceMeter.startTrace("myTestFunc", 1, 5); //从startTrace到finishTrace流程的耗时期望为5ms
``` ```
...@@ -57,11 +57,11 @@ finishTrace的name和taskId必须与流程开始的[startTrace](#hitracemetersta ...@@ -57,11 +57,11 @@ finishTrace的name和taskId必须与流程开始的[startTrace](#hitracemetersta
**示例:** **示例:**
```javascript ```js
hiTraceMeter.finishTrace("myTestFunc", 1); hiTraceMeter.finishTrace("myTestFunc", 1);
``` ```
```javascript ```js
//追踪并行执行的同名任务 //追踪并行执行的同名任务
hiTraceMeter.startTrace("myTestFunc", 1); hiTraceMeter.startTrace("myTestFunc", 1);
//业务流程...... //业务流程......
...@@ -72,7 +72,7 @@ hiTraceMeter.finishTrace("myTestFunc", 1); ...@@ -72,7 +72,7 @@ hiTraceMeter.finishTrace("myTestFunc", 1);
hiTraceMeter.finishTrace("myTestFunc", 2); hiTraceMeter.finishTrace("myTestFunc", 2);
``` ```
```javascript ```js
//追踪串行执行的同名任务 //追踪串行执行的同名任务
hiTraceMeter.startTrace("myTestFunc", 1); hiTraceMeter.startTrace("myTestFunc", 1);
//业务流程...... //业务流程......
...@@ -100,7 +100,7 @@ traceByValue(name: string, count: number): void ...@@ -100,7 +100,7 @@ traceByValue(name: string, count: number): void
| count | number | 是 | 变量的值 | | count | number | 是 | 变量的值 |
**示例:** **示例:**
```javascript ```js
let traceCount = 3; let traceCount = 3;
hiTraceMeter.traceByValue("myTestCount", traceCount); hiTraceMeter.traceByValue("myTestCount", traceCount);
traceCount = 4; traceCount = 4;
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册