README.md



Bugly Harmony


Bugly SDK 简介

Bugly专业版是TDS腾讯端服务（Tencent Device-oriented Service）旗下的端质量监控平台，通过采集、监控、定位、告警等核心能力，提供专业的质量监控服务，帮助开发者及时发现并解决质量问题，打造高质量应用。

Bugly Harmony 版本，支持Harmony OS Next平台基础异常问题的捕获上报，包含Js异常、Cpp异常、AppFreeze，异常捕获后上报到【Bugly平台】,
Bugly Harmony SDK 基于Harmony平台arkTs开发，可通过Har包集成方式接入，提供arkTs接口。

Bugly Harmony SDK 支持日志诊断能力，提供日志打印、日志上报、日志捞取等功能，统一通过Bugly Har包集成，提供arkTs接口。


Bugly SDK 接入


步骤一、创建产品


在 Bugly平台 上注册产品，平台选择 Harmony。
注册完成后，可在左侧栏-设置-产品信息 查看APP ID 、APP KEY等信息。


步骤二、集成SDK

通过 ohpm 安装bugly库。

ohpm i bugly@0.5.0


步骤三、混淆规则配置（如开启混淆）

鸿蒙端二次混淆Har包代码，可能导致部分Napi或字符串变量符号不可见，引入运行问题，建议业务直接keep Bugly Har包。

在 hap 工程目录下 obfuscation-rules.txt 混淆规则配置文件中直接添加如下规则。

-keep
../oh_modules/bugly


步骤四、初始化 SDK 质量监控能力

参考以下代码初始化 Bugly Harmony SDK，我们推荐尽早可能初始化SDK，如将初始化逻辑放在 Ability 的 onCreate 生命周期中。可参考如下代码进行初始化。

initBugly(context: Context): void {
    let builder = new BuglyBuilder();

    builder.appId = 'xxxxxxx';   // 必填，Bugly产品信息中的APP ID
    builder.appKey = 'xxx-xxxx-xxxx-xxxx-xxxx';    // 必填，Bugly产品信息中的APP KEY
    builder.deviceId = "12345";     // 必填，设备ID，应保证设备ID对不同设备唯一
    builder.platform = xxx;    // 必填，司内OA版本填[BuglyBuilder.PLATFORM_OA]，司外专业版用户填[BuglyBuilder.PLATFORM_PRO]

    builder.appVersion = '1.0.0';   // 选填，业务的App版本
    builder.buildNum = '0';         // 选填，业务App版本的构建号
    builder.appChannel = 'website'; // 选填，业务App渠道
    builder.userId = "12345";       // 选填，用户ID，如不设置则为空
    builder.deviceModel = "huawei"; // 选填，机型，如不设置则为空
    builder.debugmode = true;       // 选填，默认开启，开启后Bugly SDK会打印更多调试日志，线上版本可关闭

    Bugly.init(context, builder);   // 如需等待Bugly完全初始化完成，需加await前缀执行
}


步骤五、初始化 SDK 日志诊断能力（可选）

Bugly Harmony SDK 支持日志诊断能力，可参考如下文档进行接入试用。
https://bugly.tds.qq.com/docs/sdk/harmony_diagnose/


更多信息

详细接入文档、更多API请参考 Bugly【专业版文档中心】 https://bugly.tds.qq.com/docs/sdk/harmony/ ，腾讯用户参考 Bugly 【OA版文档中心】https://docs.bugly.woa.com/sdk/harmony/quick_start/ 

有任何疑问也可通过官网向【Bugly小助手】发起线上咨询。