Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
未验证 提交 e34a463d 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!2099 DFX syscap改造 

Merge pull request !2099 from zengyawen/master
上级 6ce4b770 9bd06c3a
展开全部 隐藏空白更改
内联 并排
Showing with 302 addition and 182 deletion
zh-cn/application-dev/reference/apis/js-apis-faultLogger.md
浏览文件 @ e34a463d
...@@ -8,14 +8,13 @@ ...@@ -8,14 +8,13 @@
import faultLogger from '@ohos.faultLogger' import faultLogger from '@ohos.faultLogger'
``` ```
## 系统能力
SystemCapability.HiviewDFX.Hiview.FaultLogger
## FaultType ## FaultType
故障类型枚举。 故障类型枚举。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.Hiview.FaultLogger。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| NO_SPECIFIC | 0 | 不区分故障类型 | | NO_SPECIFIC | 0 | 不区分故障类型 |
...@@ -27,6 +26,8 @@ SystemCapability.HiviewDFX.Hiview.FaultLogger ...@@ -27,6 +26,8 @@ SystemCapability.HiviewDFX.Hiview.FaultLogger
故障信息数据结构，获取到的故障信息的数据结构。 故障信息数据结构，获取到的故障信息的数据结构。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.Hiview.FaultLogger。
| 名称 | 参数类型 | 说明 | | 名称 | 参数类型 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| pid | number | 故障进程的进程id | | pid | number | 故障进程的进程id |
...@@ -44,6 +45,8 @@ querySelfFaultLog(faultType: FaultType, callback: AsyncCallback<Array<Faul ...@@ -44,6 +45,8 @@ querySelfFaultLog(faultType: FaultType, callback: AsyncCallback<Array<Faul
获取当前进程故障信息，该方法通过回调方式获取故障信息数组，故障信息数组内最多上报10份故障信息。 获取当前进程故障信息，该方法通过回调方式获取故障信息数组，故障信息数组内最多上报10份故障信息。
**系统能力：** SystemCapability.HiviewDFX.Hiview.FaultLogger
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -78,10 +81,12 @@ faultLogger.querySelfFaultLog(faultLogger.FaultType.JS_CRASH, queryFaultLogCallb ...@@ -78,10 +81,12 @@ faultLogger.querySelfFaultLog(faultLogger.FaultType.JS_CRASH, queryFaultLogCallb
## faultLogger.querySelfFaultLog ## faultLogger.querySelfFaultLog
querySelfFaultLog(faultType: FaultType) : Promise<Array<FaultLogInfo>>; querySelfFaultLog(faultType: FaultType) : Promise<Array<FaultLogInfo>>
获取当前进程故障信息，该方法通过Promise方式返回故障信息数组，故障信息数组内最多上报10份故障信息。 获取当前进程故障信息，该方法通过Promise方式返回故障信息数组，故障信息数组内最多上报10份故障信息。
**系统能力：** SystemCapability.HiviewDFX.Hiview.FaultLogger
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
......
zh-cn/application-dev/reference/apis/js-apis-hiappevent.md
浏览文件 @ e34a463d
...@@ -11,17 +11,14 @@ import hiAppEvent from '@ohos.hiAppEvent'; ...@@ -11,17 +11,14 @@ import hiAppEvent from '@ohos.hiAppEvent';
``` ```
## 系统能力
SystemCapability.HiviewDFX.HiAppEvent
## hiAppEvent.write ## hiAppEvent.write
write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback<void>): void write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback<void>): void
应用事件打点方法，将事件写入到当天的事件文件中，可接收类型为Json对象的事件参数，使用callback方式作为异步回调。 应用事件打点方法，将事件写入到当天的事件文件中，可接收类型为Json对象的事件参数，使用callback方式作为异步回调。
**系统能力：** SystemCapability.HiviewDFX.HiAppEvent
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -53,6 +50,8 @@ write(eventName: string, eventType: EventType, keyValues: object): Promise<vo ...@@ -53,6 +50,8 @@ write(eventName: string, eventType: EventType, keyValues: object): Promise<vo
应用事件打点方法，将事件写入到当天的事件文件中，可接收类型为Json对象的事件参数，使用promise方式作为异步回调。 应用事件打点方法，将事件写入到当天的事件文件中，可接收类型为Json对象的事件参数，使用promise方式作为异步回调。
**系统能力：** SystemCapability.HiviewDFX.HiAppEvent
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -87,6 +86,8 @@ configure(config: ConfigOption): boolean ...@@ -87,6 +86,8 @@ configure(config: ConfigOption): boolean
应用事件打点配置方法，可用于配置打点开关、文件目录存储限额大小等功能。 应用事件打点配置方法，可用于配置打点开关、文件目录存储限额大小等功能。
**系统能力：** SystemCapability.HiviewDFX.HiAppEvent
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -117,6 +118,8 @@ hiAppEvent.configure({ ...@@ -117,6 +118,8 @@ hiAppEvent.configure({
此接口提供了应用打点的配置选项。 此接口提供了应用打点的配置选项。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| disable | boolean | 否 | 应用打点功能开关。配置值为true表示关闭打点功能，false表示不关闭打点功能。 | | disable | boolean | 否 | 应用打点功能开关。配置值为true表示关闭打点功能，false表示不关闭打点功能。 |
...@@ -127,6 +130,8 @@ hiAppEvent.configure({ ...@@ -127,6 +130,8 @@ hiAppEvent.configure({
事件类型枚举。 事件类型枚举。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| FAULT | 1 | 故障类型事件。 | | FAULT | 1 | 故障类型事件。 |
...@@ -139,6 +144,8 @@ hiAppEvent.configure({ ...@@ -139,6 +144,8 @@ hiAppEvent.configure({
此接口提供了所有预定义事件的事件名称常量。 此接口提供了所有预定义事件的事件名称常量。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| USER_LOGIN | string | 是 | 否 | 用户登录事件。 | | USER_LOGIN | string | 是 | 否 | 用户登录事件。 |
...@@ -150,6 +157,8 @@ hiAppEvent.configure({ ...@@ -150,6 +157,8 @@ hiAppEvent.configure({
此接口提供了所有预定义参数的参数名称常量。 此接口提供了所有预定义参数的参数名称常量。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。
| 名称 | 参数类型 | 可读 | 可写 | 说明 | | 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| USER_ID | string | 是 | 否 | 用户自定义ID。 | | USER_ID | string | 是 | 否 | 用户自定义ID。 |
......
zh-cn/application-dev/reference/apis/js-apis-hidebug.md
浏览文件 @ e34a463d
...@@ -12,24 +12,22 @@ import hidebug from '@ohos.hidebug'; ...@@ -12,24 +12,22 @@ import hidebug from '@ohos.hidebug';
``` ```
## 系统能力
SystemCapability.HiviewDFX.HiProfiler.HiDebug
## hidebug.getNativeHeapSize ## hidebug.getNativeHeapSize
getNativeHeapSize(): bigint getNativeHeapSize(): bigint
获取native heap内存的总大小。 获取native heap内存的总大小。
**系统能力：** SystemCapability.HiviewDFX.HiProfiler.HiDebug
**返回值：**
- **返回值**： | 类型 | 说明 |
| 类型 | 说明 | | ------ | --------------------------- |
| -------- | -------- | | bigint | 返回native heap内存总大小。 |
| bigint | 返回native heap内存总大小。 |
- 示例： **示例：**
``` ```
let nativeHeapSize = hidebug.getNativeHeapSize(); let nativeHeapSize = hidebug.getNativeHeapSize();
``` ```
...@@ -41,14 +39,16 @@ getNativeHeapAllocatedSize(): bigint ...@@ -41,14 +39,16 @@ getNativeHeapAllocatedSize(): bigint
获取native heap内存的已分配内存大小。 获取native heap内存的已分配内存大小。
**系统能力：** SystemCapability.HiviewDFX.HiProfiler.HiDebug
- **返回值**：
| 类型 | 说明 |
| -------- | -------- |
| bigint | 返回native heap内存的已分配内存。 |
**返回值：**
| 类型 | 说明 |
| ------ | --------------------------------- |
| bigint | 返回native heap内存的已分配内存。 |
- 示例：
**示例：**
``` ```
let nativeHeapAllocatedSize = hidebug.getNativeHeapAllocatedSize(); let nativeHeapAllocatedSize = hidebug.getNativeHeapAllocatedSize();
``` ```
...@@ -60,14 +60,16 @@ getNativeHeapFreeSize(): bigint ...@@ -60,14 +60,16 @@ getNativeHeapFreeSize(): bigint
获取native heap内存的空闲内存大小。 获取native heap内存的空闲内存大小。
**系统能力：** SystemCapability.HiviewDFX.HiProfiler.HiDebug
- **返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------------------------- |
| bigint | 返回native heap内存的空闲内存。 | | bigint | 返回native heap内存的空闲内存。 |
- 示例： **示例：**
``` ```
let nativeHeapFreeSize = hidebug.getNativeHeapFreeSize(); let nativeHeapFreeSize = hidebug.getNativeHeapFreeSize();
``` ```
...@@ -79,14 +81,16 @@ getPss(): bigint ...@@ -79,14 +81,16 @@ getPss(): bigint
获取应用进程PSS内存大小。 获取应用进程PSS内存大小。
**系统能力：** SystemCapability.HiviewDFX.HiProfiler.HiDebug
- **返回值**： **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
| -------- | -------- | | ------ | ------------------------- |
| bigint | 返回应用进程PSS内存大小。 | | bigint | 返回应用进程PSS内存大小。 |
- 示例： **示例：**
``` ```
let pss = hidebug.getPss(); let pss = hidebug.getPss();
``` ```
...@@ -98,14 +102,16 @@ getSharedDirty(): bigint ...@@ -98,14 +102,16 @@ getSharedDirty(): bigint
获取进程的共享脏内存大小。 获取进程的共享脏内存大小。
**系统能力：** SystemCapability.HiviewDFX.HiProfiler.HiDebug
- **返回值**：
| 类型 | 说明 |
| -------- | -------- |
| bigint | 返回进程的共享脏内存大小。 |
**返回值：**
| 类型 | 说明 |
| ------ | -------------------------- |
| bigint | 返回进程的共享脏内存大小。 |
- 示例：
**示例：**
``` ```
let sharedDirty = hidebug.getSharedDirty(); let sharedDirty = hidebug.getSharedDirty();
``` ```
...@@ -117,13 +123,15 @@ startProfiling(filename : string) : void ...@@ -117,13 +123,15 @@ startProfiling(filename : string) : void
启动虚拟机Profiling方法跟踪，`startProfiling()`方法的调用需要与`stopProfiling()`方法的调用一一对应，先开启后关闭，严禁使用`start->start->stop`，`start->stop->stop`，`start->start->stop->stop`等顺序的调用方式。 启动虚拟机Profiling方法跟踪，`startProfiling()`方法的调用需要与`stopProfiling()`方法的调用一一对应，先开启后关闭，严禁使用`start->start->stop`，`start->stop->stop`，`start->start->stop->stop`等顺序的调用方式。
* **参数**： **系统能力：** SystemCapability.HiviewDFX.HiProfiler.HiDebug
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ | | -------- | ------ | ---- | ------------------------------------------------------------ |
| filename | string | 是 | 用户自定义的profiling文件名，根据传入的`filename`，将在应用的`files`目录生成`filename.json`文件。 | | filename | string | 是 | 用户自定义的profiling文件名，根据传入的`filename`，将在应用的`files`目录生成`filename.json`文件。 |
* **示例**： **示例：**
```js ```js
hidebug.startProfiling("cpuprofiler-20220216"); hidebug.startProfiling("cpuprofiler-20220216");
...@@ -141,7 +149,9 @@ stopProfiling() : void ...@@ -141,7 +149,9 @@ stopProfiling() : void
停止虚拟机Profiling方法跟踪，`stopProfiling()`方法的调用需要与`startProfiling()`方法的调用一一对应，先开启后关闭，严禁使用`start->start->stop`，`start->stop->stop`，`start->start->stop->stop`等顺序的调用方式。 停止虚拟机Profiling方法跟踪，`stopProfiling()`方法的调用需要与`startProfiling()`方法的调用一一对应，先开启后关闭，严禁使用`start->start->stop`，`start->stop->stop`，`start->start->stop->stop`等顺序的调用方式。
* **示例**： **系统能力：** SystemCapability.HiviewDFX.HiProfiler.HiDebug
**示例：**
```js ```js
hidebug.startProfiling("cpuprofiler-20220216"); hidebug.startProfiling("cpuprofiler-20220216");
...@@ -157,15 +167,16 @@ dumpHeapData(filename : string) : void ...@@ -157,15 +167,16 @@ dumpHeapData(filename : string) : void
虚拟机堆导出。 虚拟机堆导出。
* **参数**： **系统能力：** SystemCapability.HiviewDFX.HiProfiler.HiDebug
**参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------ | ---- | ------------------------------------------------------------ | | -------- | ------ | ---- | ------------------------------------------------------------ |
| filename | string | 是 | 用户自定义的虚拟机堆文件名，根据传入的`filename`，将在应用的`files`目录生成`filename.heapsnapshot`文件。 | | filename | string | 是 | 用户自定义的虚拟机堆文件名，根据传入的`filename`，将在应用的`files`目录生成`filename.heapsnapshot`文件。 |
* **示例**： **示例：**
```js ```js
hidebug.dumpHeapData("heap-20220216"); hidebug.dumpHeapData("heap-20220216");
``` ```
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-hilog.md
浏览文件 @ e34a463d
...@@ -10,9 +10,6 @@ ...@@ -10,9 +10,6 @@
import hilog from '@ohos.hilog'; import hilog from '@ohos.hilog';
``` ```
## 系统能力
SystemCapability.HiviewDFX.HiLog
## hilog.debug ## hilog.debug
...@@ -20,6 +17,8 @@ debug(domain: number, tag: string, format: string, ...args: any[]) : void ...@@ -20,6 +17,8 @@ debug(domain: number, tag: string, format: string, ...args: any[]) : void
debug日志输出，打印debug级别日志。 debug日志输出，打印debug级别日志。
**系统能力：** SystemCapability.HiviewDFX.HiLog
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -41,12 +40,14 @@ hilog.debug(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3 ...@@ -41,12 +40,14 @@ hilog.debug(0xFF00, "testTag", "%d: %{private}s World %{public}f", 1, "hello", 3
09-08 12:49:35.941 1547 2452 D FF00/testTag: 1: hello World 3.0 09-08 12:49:35.941 1547 2452 D FF00/testTag: 1: hello World 3.0
``` ```
## **hilog.info** ## hilog.info
info(domain: number, tag: string, format: string, ...args: any[]) : void info(domain: number, tag: string, format: string, ...args: any[]) : void
info日志输出，打印info级别日志。 info日志输出，打印info级别日志。
**系统能力：** SystemCapability.HiviewDFX.HiLog
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -74,6 +75,8 @@ warn(domain: number, tag: string, format: string, ...args: any[]) : void ...@@ -74,6 +75,8 @@ warn(domain: number, tag: string, format: string, ...args: any[]) : void
warn日志输出，打印warn级别日志。 warn日志输出，打印warn级别日志。
**系统能力：** SystemCapability.HiviewDFX.HiLog
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -101,6 +104,8 @@ error(domain: number, tag: string, format: string, ...args: any[]) : void ...@@ -101,6 +104,8 @@ error(domain: number, tag: string, format: string, ...args: any[]) : void
error日志输出，打印error级别日志。 error日志输出，打印error级别日志。
**系统能力：** SystemCapability.HiviewDFX.HiLog
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -128,6 +133,8 @@ fatal(domain: number, tag: string, format: string, ...args: any[]) : void ...@@ -128,6 +133,8 @@ fatal(domain: number, tag: string, format: string, ...args: any[]) : void
fatal日志输出，打印fatal级别日志。 fatal日志输出，打印fatal级别日志。
**系统能力：** SystemCapability.HiviewDFX.HiLog
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -155,6 +162,8 @@ isLoggable(domain: number, tag: string, level: LogLevel) : boolean ...@@ -155,6 +162,8 @@ isLoggable(domain: number, tag: string, level: LogLevel) : boolean
检查一个domain、tag和日志级别是否被禁止打印日志。 检查一个domain、tag和日志级别是否被禁止打印日志。
**系统能力：** SystemCapability.HiviewDFX.HiLog
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -173,6 +182,8 @@ hilog.isLoggable(0xFF00, "testTag", hilog.DEBUG); ...@@ -173,6 +182,8 @@ hilog.isLoggable(0xFF00, "testTag", hilog.DEBUG);
用于表示事件类型。 用于表示事件类型。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiLog。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| ----- | ------ | ----------- | | ----- | ------ | ----------- |
| DEBUG | 3 | DEBUG级别。 | | DEBUG | 3 | DEBUG级别。 |
......
zh-cn/application-dev/reference/apis/js-apis-hitracechain.md
浏览文件 @ e34a463d
...@@ -9,14 +9,13 @@ ...@@ -9,14 +9,13 @@
import hiTraceChain from '@ohos.hiTraceChain'; import hiTraceChain from '@ohos.hiTraceChain';
``` ```
## 系统能力
SystemCapability.HiviewDFX.HiTrace
## HiTraceFlag ## HiTraceFlag
跟踪标志组合类型枚举。 跟踪标志组合类型枚举。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| DEFAULT | 0 | 缺省标志。 | | DEFAULT | 0 | 缺省标志。 |
...@@ -32,6 +31,8 @@ SystemCapability.HiviewDFX.HiTrace ...@@ -32,6 +31,8 @@ SystemCapability.HiviewDFX.HiTrace
跟踪埋点类型枚举。 跟踪埋点类型枚举。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| CS | 0 | 客户端发送类型，标识client侧的发送埋点。 | | CS | 0 | 客户端发送类型，标识client侧的发送埋点。 |
...@@ -44,6 +45,8 @@ SystemCapability.HiviewDFX.HiTrace ...@@ -44,6 +45,8 @@ SystemCapability.HiviewDFX.HiTrace
跟踪通信类型枚举。 跟踪通信类型枚举。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
| DEFAULT | 0 | 缺省通信类型 | | DEFAULT | 0 | 缺省通信类型 |
...@@ -55,6 +58,8 @@ SystemCapability.HiviewDFX.HiTrace ...@@ -55,6 +58,8 @@ SystemCapability.HiviewDFX.HiTrace
此接口为HiTraceId对象接口。 此接口为HiTraceId对象接口。
**系统能力：** 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| chainId | bigint | 是 | 跟踪链标识。 | | chainId | bigint | 是 | 跟踪链标识。 |
...@@ -68,6 +73,8 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId ...@@ -68,6 +73,8 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId
开始跟踪，同步接口。 开始跟踪，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -93,6 +100,8 @@ end(id: HiTraceId): void ...@@ -93,6 +100,8 @@ end(id: HiTraceId): void
结束跟踪，同步接口。 结束跟踪，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -113,6 +122,8 @@ getId(): HiTraceId ...@@ -113,6 +122,8 @@ getId(): HiTraceId
获取跟踪标识，同步接口。 获取跟踪标识，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -133,6 +144,8 @@ setId(id: HiTraceId): void ...@@ -133,6 +144,8 @@ setId(id: HiTraceId): void
设置跟踪标识，同步接口。 设置跟踪标识，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -153,6 +166,8 @@ clearId(): void ...@@ -153,6 +166,8 @@ clearId(): void
清除跟踪标识，同步接口。 清除跟踪标识，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**示例：** **示例：**
``` ```
...@@ -167,6 +182,8 @@ createSpan(): HiTraceId ...@@ -167,6 +182,8 @@ createSpan(): HiTraceId
创建跟踪分支，同步接口。 创建跟踪分支，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**返回值：** **返回值：**
| 类型 | 说明 | | 类型 | 说明 |
...@@ -187,6 +204,8 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracepointType, id: HiTr ...@@ -187,6 +204,8 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracepointType, id: HiTr
信息埋点，同步接口。 信息埋点，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -210,6 +229,8 @@ isValid(id: HiTraceId): boolean ...@@ -210,6 +229,8 @@ isValid(id: HiTraceId): boolean
判断HiTraceId对象是否有效，同步接口。 判断HiTraceId对象是否有效，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -235,6 +256,8 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean ...@@ -235,6 +256,8 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean
判断HiTraceId对象中指定的跟踪标志是否已置位，同步接口。 判断HiTraceId对象中指定的跟踪标志是否已置位，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -262,6 +285,8 @@ enableFlag(id: HiTraceId, flag: HiTraceFlag): void ...@@ -262,6 +285,8 @@ enableFlag(id: HiTraceId, flag: HiTraceFlag): void
置位HiTraceId对象中指定的跟踪标志，同步接口。 置位HiTraceId对象中指定的跟踪标志，同步接口。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
......
zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md
浏览文件 @ e34a463d
...@@ -11,11 +11,6 @@ import hiTraceMeter from '@ohos.hiTraceMeter'; ...@@ -11,11 +11,6 @@ import hiTraceMeter from '@ohos.hiTraceMeter';
``` ```
## 系统能力
SystemCapability.HiviewDFX.HiTrace
## hiTraceMeter.startTrace ## hiTraceMeter.startTrace
startTrace(name: string, taskId: number): void startTrace(name: string, taskId: number): void
...@@ -26,6 +21,8 @@ startTrace(name: string, taskId: number): void ...@@ -26,6 +21,8 @@ startTrace(name: string, taskId: number): void
如果具有相同name的任务是串行执行的，则taskId可以相同。具体示例可参考[hiTraceMeter.finishTrace](#hitracemeterfinishtrace)中的示例。 如果具有相同name的任务是串行执行的，则taskId可以相同。具体示例可参考[hiTraceMeter.finishTrace](#hitracemeterfinishtrace)中的示例。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -49,6 +46,8 @@ finishTrace(name: string, taskId: number): void ...@@ -49,6 +46,8 @@ finishTrace(name: string, taskId: number): void
finishTrace的name和taskId必须与流程开始的[startTrace](#hitracemeterstarttrace)对应参数值一致。 finishTrace的name和taskId必须与流程开始的[startTrace](#hitracemeterstarttrace)对应参数值一致。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -91,6 +90,8 @@ traceByValue(name: string, count: number): void ...@@ -91,6 +90,8 @@ traceByValue(name: string, count: number): void
用来标记一个预追踪的数值变量，该变量的数值会不断变化。 用来标记一个预追踪的数值变量，该变量的数值会不断变化。
**系统能力：** SystemCapability.HiviewDFX.HiTrace
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或