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