Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
70b6dd7a
D
Docs
项目概览
OpenHarmony
/
Docs
大约 1 年 前同步成功
通知
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,发现更多精彩内容 >>
未验证
提交
70b6dd7a
编写于
8月 31, 2022
作者:
O
openharmony_ci
提交者:
Gitee
8月 31, 2022
浏览文件
操作
浏览文件
下载
差异文件
!8929 DFX指南用语一致性修改
Merge pull request !8929 from zengyawen/master
上级
16d02c9b
7d08da32
变更
3
隐藏空白更改
内联
并排
Showing
3 changed file
with
36 addition
and
36 deletion
+36
-36
zh-cn/application-dev/dfx/hitracemeter-guidelines.md
zh-cn/application-dev/dfx/hitracemeter-guidelines.md
+16
-16
zh-cn/application-dev/dfx/hitracemeter-overview.md
zh-cn/application-dev/dfx/hitracemeter-overview.md
+1
-1
zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md
zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md
+19
-19
未找到文件。
zh-cn/application-dev/dfx/hitracemeter-guidelines.md
浏览文件 @
70b6dd7a
...
@@ -2,7 +2,7 @@
...
@@ -2,7 +2,7 @@
## 场景介绍
## 场景介绍
HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自己的业务逻辑中的关键代码位置调用HiTraceMeter接口提供的API接口,能够有效
追
踪进程轨迹、查看系统性能。
HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自己的业务逻辑中的关键代码位置调用HiTraceMeter接口提供的API接口,能够有效
跟
踪进程轨迹、查看系统性能。
## 接口说明
## 接口说明
...
@@ -12,15 +12,15 @@ HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自
...
@@ -12,15 +12,15 @@ HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自
| 接口名 | 返回值 | 描述 |
| 接口名 | 返回值 | 描述 |
| ---------------------------------------------------------------------------- | --------- | ------------ |
| ---------------------------------------------------------------------------- | --------- | ------------ |
| hiTraceMeter.startTrace(name: string, taskId: number, expectedTime?: number) | void | 标记一个预
追踪耗时任务的开始。如果有多个相同name的任务需要追踪或者对同一个任务要追
踪多次,并且任务同时被执行,则每次调用startTrace的taskId不相同。如果具有相同name的任务是串行执行的,则taskId可以相同。 |
| hiTraceMeter.startTrace(name: string, taskId: number, expectedTime?: number) | void | 标记一个预
跟踪耗时任务的开始。如果有多个相同name的任务需要跟踪或者对同一个任务要跟
踪多次,并且任务同时被执行,则每次调用startTrace的taskId不相同。如果具有相同name的任务是串行执行的,则taskId可以相同。 |
| hiTraceMeter.finishTrace(name: string, taskId: number) | void | name和taskId必须与流程开始的hiTraceMeter.startTrace对应参数值保持一致。 |
| hiTraceMeter.finishTrace(name: string, taskId: number) | void | name和taskId必须与流程开始的hiTraceMeter.startTrace对应参数值保持一致。 |
| hiTraceMeter.traceByValue(name: string, value: number) | void | 用来标记一个预
追
踪的数值变量,该变量的数值会不断变化。|
| hiTraceMeter.traceByValue(name: string, value: number) | void | 用来标记一个预
跟
踪的数值变量,该变量的数值会不断变化。|
## 开发步骤
## 开发步骤
在应用启动执行页面加载后,开始分布式跟踪,完成业务之后,停止分布式跟踪。
在应用启动执行页面加载后,开始分布式跟踪,完成业务之后,停止分布式跟踪。
1.
新建一个JS应用工程,在“Project”窗口点击“entry > src > main > js > default > pages > index”,打开工程中的“index.js”文件,在页面执行加载后,在自己的业务中调用hiTraceMeter的接口,进行性能打点
追
踪,示例代码如下:
1.
新建一个JS应用工程,在“Project”窗口点击“entry > src > main > js > default > pages > index”,打开工程中的“index.js”文件,在页面执行加载后,在自己的业务中调用hiTraceMeter的接口,进行性能打点
跟
踪,示例代码如下:
```
js
```
js
import
hiTraceMeter
from
'
@ohos.hiTraceMeter
'
import
hiTraceMeter
from
'
@ohos.hiTraceMeter
'
...
@@ -32,31 +32,31 @@ HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自
...
@@ -32,31 +32,31 @@ HiTraceMeter为开发者提供系统性能打点接口。开发者通过在自
onInit
()
{
onInit
()
{
this
.
title
=
this
.
$t
(
'
strings.world
'
);
this
.
title
=
this
.
$t
(
'
strings.world
'
);
//从startTrace到finishTrace流程的耗时期望为5ms
//
从startTrace到finishTrace流程的耗时期望为5ms
hiTraceMeter
.
startTrace
(
"
business
"
,
1
);
hiTraceMeter
.
startTrace
(
"
business
"
,
1
);
hiTraceMeter
.
startTrace
(
"
business
"
,
1
,
5
);
hiTraceMeter
.
startTrace
(
"
business
"
,
1
,
5
);
//
追
踪并行执行的同名任务
//
跟
踪并行执行的同名任务
hiTraceMeter
.
startTrace
(
"
business
"
,
1
);
hiTraceMeter
.
startTrace
(
"
business
"
,
1
);
//业务流程
//
业务流程
console
.
log
(
`business running`
);
console
.
log
(
`business running`
);
hiTraceMeter
.
startTrace
(
"
business
"
,
2
);
//
第二个追踪的任务开始,同时第一个追
踪的同名任务还没结束,出现了并行执行,对应接口的taskId需要不同。
hiTraceMeter
.
startTrace
(
"
business
"
,
2
);
//
第二个跟踪任务开始,同时第一个跟
踪的同名任务还没结束,出现了并行执行,对应接口的taskId需要不同。
//业务流程
//
业务流程
console
.
log
(
`business running`
);
console
.
log
(
`business running`
);
hiTraceMeter
.
finishTrace
(
"
business
"
,
1
);
hiTraceMeter
.
finishTrace
(
"
business
"
,
1
);
//业务流程
//
业务流程
console
.
log
(
`business running`
);
console
.
log
(
`business running`
);
hiTraceMeter
.
finishTrace
(
"
business
"
,
2
);
hiTraceMeter
.
finishTrace
(
"
business
"
,
2
);
//
追
踪串行执行的同名任务
//
跟
踪串行执行的同名任务
hiTraceMeter
.
startTrace
(
"
business
"
,
1
);
hiTraceMeter
.
startTrace
(
"
business
"
,
1
);
//业务流程
//
业务流程
console
.
log
(
`business running`
);
console
.
log
(
`business running`
);
hiTraceMeter
.
finishTrace
(
"
business
"
,
1
);
//
第一个追
踪的任务结束
hiTraceMeter
.
finishTrace
(
"
business
"
,
1
);
//
第一个跟
踪的任务结束
//业务流程
//
业务流程
console
.
log
(
`business running`
);
console
.
log
(
`business running`
);
hiTraceMeter
.
startTrace
(
"
business
"
,
1
);
//
第二个追踪的同名任务开始,同名的待追
踪任务串行执行。
hiTraceMeter
.
startTrace
(
"
business
"
,
1
);
//
第二个跟踪的同名任务开始,同名的待跟
踪任务串行执行。
//业务流程
//
业务流程
console
.
log
(
`business running`
);
console
.
log
(
`business running`
);
let
traceCount
=
3
;
let
traceCount
=
3
;
...
...
zh-cn/application-dev/dfx/hitracemeter-overview.md
浏览文件 @
70b6dd7a
# 性能打点跟踪概述
# 性能打点跟踪概述
hiTraceMeter是开发者用于
追
踪进程轨迹,度量程序执行性能的一种工具,基于内核的ftrace机制,提供给用户态应用代码执行时长度量打点的能力。开发者通过使用hiTraceMeter API在程序中打点,并使用hiTraceMeter提供的命令行工具采集跟踪数据。
hiTraceMeter是开发者用于
跟
踪进程轨迹,度量程序执行性能的一种工具,基于内核的ftrace机制,提供给用户态应用代码执行时长度量打点的能力。开发者通过使用hiTraceMeter API在程序中打点,并使用hiTraceMeter提供的命令行工具采集跟踪数据。
## 基本概念
## 基本概念
...
...
zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md
浏览文件 @
70b6dd7a
# 性能打点
# 性能打点
本模块提供了
追
踪进程轨迹,度量程序执行性能的打点能力。本模块打点的数据供hiTraceMeter工具分析使用。
本模块提供了
跟
踪进程轨迹,度量程序执行性能的打点能力。本模块打点的数据供hiTraceMeter工具分析使用。
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
...
@@ -17,9 +17,9 @@ import hiTraceMeter from '@ohos.hiTraceMeter';
...
@@ -17,9 +17,9 @@ import hiTraceMeter from '@ohos.hiTraceMeter';
startTrace(name: string, taskId: number): void
startTrace(name: string, taskId: number): void
标记一个预
追
踪耗时任务的开始。
标记一个预
跟
踪耗时任务的开始。
如果有多个相同name的任务需要
追踪或者对同一个任务要追
踪多次,并且任务同时被执行,则每次调用startTrace的taskId不相同。
如果有多个相同name的任务需要
跟踪或者对同一个任务要跟
踪多次,并且任务同时被执行,则每次调用startTrace的taskId不相同。
如果具有相同name的任务是串行执行的,则taskId可以相同。具体示例可参考
[
hiTraceMeter.finishTrace
](
#hitracemeterfinishtrace
)
中的示例。
如果具有相同name的任务是串行执行的,则taskId可以相同。具体示例可参考
[
hiTraceMeter.finishTrace
](
#hitracemeterfinishtrace
)
中的示例。
...
@@ -29,7 +29,7 @@ startTrace(name: string, taskId: number): void
...
@@ -29,7 +29,7 @@ startTrace(name: string, taskId: number): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 要
追
踪的任务名称 |
| name | string | 是 | 要
跟
踪的任务名称 |
| taskId | number | 是 | 任务id |
| taskId | number | 是 | 任务id |
**示例:**
**示例:**
...
@@ -43,7 +43,7 @@ hiTraceMeter.startTrace("myTestFunc", 1);
...
@@ -43,7 +43,7 @@ hiTraceMeter.startTrace("myTestFunc", 1);
finishTrace(name: string, taskId: number): void
finishTrace(name: string, taskId: number): void
标记一个预
追
踪耗时任务的结束。
标记一个预
跟
踪耗时任务的结束。
finishTrace的name和taskId必须与流程开始的
[
startTrace
](
#hitracemeterstarttrace
)
对应参数值一致。
finishTrace的name和taskId必须与流程开始的
[
startTrace
](
#hitracemeterstarttrace
)
对应参数值一致。
...
@@ -53,7 +53,7 @@ finishTrace的name和taskId必须与流程开始的[startTrace](#hitracemetersta
...
@@ -53,7 +53,7 @@ finishTrace的name和taskId必须与流程开始的[startTrace](#hitracemetersta
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 要
追
踪的任务名称 |
| name | string | 是 | 要
跟
踪的任务名称 |
| taskId | number | 是 | 任务id。 |
| taskId | number | 是 | 任务id。 |
**示例:**
**示例:**
...
@@ -63,24 +63,24 @@ hiTraceMeter.finishTrace("myTestFunc", 1);
...
@@ -63,24 +63,24 @@ hiTraceMeter.finishTrace("myTestFunc", 1);
```
```
```
js
```
js
//
追
踪并行执行的同名任务
//
跟
踪并行执行的同名任务
hiTraceMeter
.
startTrace
(
"
myTestFunc
"
,
1
);
hiTraceMeter
.
startTrace
(
"
myTestFunc
"
,
1
);
//业务流程......
//
业务流程......
hiTraceMeter
.
startTrace
(
"
myTestFunc
"
,
2
);
//
第二个追踪的任务开始,同时第一个追
踪的同名任务还没结束,出现了并行执行,对应接口的taskId需要不同。
hiTraceMeter
.
startTrace
(
"
myTestFunc
"
,
2
);
//
第二个跟踪的任务开始,同时第一个跟
踪的同名任务还没结束,出现了并行执行,对应接口的taskId需要不同。
//业务流程......
//
业务流程......
hiTraceMeter
.
finishTrace
(
"
myTestFunc
"
,
1
);
hiTraceMeter
.
finishTrace
(
"
myTestFunc
"
,
1
);
//业务流程......
//
业务流程......
hiTraceMeter
.
finishTrace
(
"
myTestFunc
"
,
2
);
hiTraceMeter
.
finishTrace
(
"
myTestFunc
"
,
2
);
```
```
```
js
```
js
//
追
踪串行执行的同名任务
//
跟
踪串行执行的同名任务
hiTraceMeter
.
startTrace
(
"
myTestFunc
"
,
1
);
hiTraceMeter
.
startTrace
(
"
myTestFunc
"
,
1
);
//业务流程......
//
业务流程......
hiTraceMeter
.
finishTrace
(
"
myTestFunc
"
,
1
);
//
第一个追
踪的任务结束
hiTraceMeter
.
finishTrace
(
"
myTestFunc
"
,
1
);
//
第一个跟
踪的任务结束
//业务流程......
//
业务流程......
hiTraceMeter
.
startTrace
(
"
myTestFunc
"
,
1
);
//
第二个追踪的同名任务开始,同名的待追
踪任务串行执行。
hiTraceMeter
.
startTrace
(
"
myTestFunc
"
,
1
);
//
第二个跟踪的同名任务开始,同名的待跟
踪任务串行执行。
//业务流程......
//
业务流程......
hiTraceMeter
.
finishTrace
(
"
myTestFunc
"
,
1
);
hiTraceMeter
.
finishTrace
(
"
myTestFunc
"
,
1
);
```
```
...
@@ -89,7 +89,7 @@ hiTraceMeter.finishTrace("myTestFunc", 1);
...
@@ -89,7 +89,7 @@ hiTraceMeter.finishTrace("myTestFunc", 1);
traceByValue(name: string, count: number): void
traceByValue(name: string, count: number): void
用来标记一个预
追
踪的数值变量,该变量的数值会不断变化。
用来标记一个预
跟
踪的数值变量,该变量的数值会不断变化。
**系统能力:**
SystemCapability.HiviewDFX.HiTrace
**系统能力:**
SystemCapability.HiviewDFX.HiTrace
...
@@ -97,7 +97,7 @@ traceByValue(name: string, count: number): void
...
@@ -97,7 +97,7 @@ traceByValue(name: string, count: number): void
| 参数名 | 类型 | 必填 | 说明 |
| 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- |
| -------- | -------- | -------- | -------- |
| name | string | 是 | 要
追
踪的数值变量名称 |
| name | string | 是 | 要
跟
踪的数值变量名称 |
| count | number | 是 | 变量的值 |
| count | number | 是 | 变量的值 |
**示例:**
**示例:**
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录