文档中心

应用性能监控全链路版

请输入

Harmony SDK 接入

应用接入 Harmony SDK

本文介绍Harmony SDK的详细接入步骤。接入SDK后，即可在应用性能监控全链路版平台上使用相关分析功能。

注意事项

Harmony SDK目前仅限在中国大陆应用使用（不包括港澳台地区）。

调用SDK初始化接口不会采集用户信息，调用SDK启动接口会开始采集用户信息，请确保采集用户信息之前已经获得用户授权SDK隐私政策。

Demo说明

APMPlus_Harmony

Demo已经接入了所有ApmPlus的性能和稳定性监控的能力。

您可以通过Demo模拟一些异常和性能数据。

您可以配置成自己的AppID和AppToken，将数据上报到平台，进行SDK功能测试。

步骤一：创建产品

在火山引擎平台注册账号，然后在客户端监控控制台创建应用。详情请参见接入客户端应用。

创建完成后可以在平台看到AppID、AppToken。

产品创建后需要购买事件可以在平台查看上报数据，详情请参见开通客户端监控服务。

在火山平台联系在线客服可以申请试用，提供AppID申请免费试用额度。

步骤二：获取SDK包，引入依赖

自动集成（推荐）

通过ohpm安装APMPlus SDK。

ohpm i @volcengine/apmplus@2.0.6

手动集成

通过三方仓库或在线客服获取har包。

把har包拷贝到工程中，如entry/libs目录下。

在主入口module的oh-package.json5文件中，添加离线har包依赖。

"dependencies": {
"@volcengine/apmplus": "file:./libs/apmplus.har"
}

步骤三：初始化SDK并开启监控

注意

初始化SDK阶段，不获取用户个人信息。

在AbilityStage或者Ability的onCreate生命周期中，添加以下代码。

APMPlus.init(this.context);

启动监控，开始收集数据。

注意

请在用户同意隐私政策后，再调用方法收集数据。

APMPlus.setDeviceId("device_id");//可选，设置设备device_id，不设置会使用内部默认device_id，更新值随时调用。
APMPlus.setUserId("user_id");//可选，用户标识，没有默认值，更新值随时调用。

let builder = new APMPlusBuilder("AppID", "AppToken");//必填
builder.debug = true;//可选，测试阶段配置有输出日志，线上release需关闭
builder.channel = "volcengine";//可选，类型string。渠道
builder.startMonitor = true;//可选，是否开启启动监控
builder.netMonitor = true;//可选，是否开启网络监控后续需要使用HttpMonitor进行辅助监控
builder.logRecovery = true;//可选，是否开启自定义Vlog打点回捞能力

APMPlus.start(builder);

说明

AppID和AppToken获取方法，请参见如何查询AppID和AppToken？。

Har包为二进制abc格式。查看工程级build-profile.json5，请设置useNormalizedOHMUrl为true。

{
"app": {
"products": [
{
"buildOption": {
"strictMode": {
"useNormalizedOHMUrl": true
}
}
}
]
}
}

步骤四：上传符号表（可选）

工程./hvigor/hvigor-config.json5文件添加依赖。

"dependencies": {
"apmplus_upload": 'latest',
}

工程的hvigorfile.ts添加以下代码。

import { ApmPlusPlugin } from 'apmplus_upload';

const config = {
aid : 1234, // 应用的app id
updateVersionCode : 1000000, // 应用的number类型的版本号version_code
api_key : 4321,// 从平台的全部功能->符号表管理->系统选择 Android->下面可以看到api key和api token。
api_token : 'xxxxxx'// 从平台的全部功能->符号表管理->系统选择 Harmony->下面可以看到api key和api token
};

export default {
system: appTasks,
plugins:[ApmPlusPlugin(config)]
}

最近更新时间：2026.02.10 19:56:27

这个页面对您有帮助吗？

有用

无用