接入指南

1.工具下载

在 SDK 下载页面点击下载 Harmony SDK。

2.导入CrasheyeSdk.har包

2.1在OpenHarmony工程中集成Crasheye HAR包

将下载的 crasheye.har 拷贝到导出工程的 YourExportProject\entry\libs目录下:

2.2在entry子项目中添加Crasheye HAR包的依赖

在项目的entry模块的oh-package.json5文件中设置crasheye.har的路径：
具体配置如下：

    "dependencies":{"crasheye":"file:./libs/crasheye.har"}

  备注：其中"crasheye"是crasheye.har在项目install依赖之后，在oh_modules目录下的名字，"file:./libs/crasheye.har"表示crasheye.har在项目工程中的路径，表明crasheye.har在entry目录中libs目录下, crasheye.har安装成功后会在oh_modules目录下生成名为crasheye的相关SDK文件:

3.初始化

在程序入口初始化crasheye SDK

在项目的Mainactivity.ts文件中的 onCreate 函数中初始化Crasheye SDK：

import Crasheye from'crasheye/src/main/ets/Crasheye';

exportdefaultclassTuanjiePlayerAbilityextendsUIAbility {
  onCreate(want, launchParam): void {
    // ...Crasheye.init(this.context.getApplicationContext().filesDir, "<app_key>", "internal_cn");
    // ...
  }
}

常用API

Crasheye.AddExtraData

添加自定义数据

• 如果您觉得Crasheye默认捕获的数据还不足以满足您的要求的话，您可以添加自定义数据，只需要调用如下API即可：

/**
* 添加自定义数据
* @param key 自定义数据的标识符
* @param value 自定义数据的内容
*/
Crasheye.AddExtraData(string key, stringvalue);

Crasheye.RemoveExtraData

移除自定义数据

• 如果您觉得Crasheye默认捕获的数据太多的话，您可以移除自定义数据，只需要调用如下API即可：

/**
* 添加自定义数据
* @param key 自定义数据的标识符
*/
Crasheye.RemoveExtraData(string key);

Crasheye.SetAppVersion

设置App版本号

• Crasheye默认读取配置文件中的版本信息，当然您也可以自己设置版本信息：

/**
* 设置应用版本号
* @param youAppVersion 应用版本号
*/
Crasheye.SetAppVersion(string youAppVersion);

Crasheye.LeaveBreadcrumb

添加面包屑（打点信息）

• 您可以在您的代码中添加多个面包屑（打点信息）然后在Crasheye平台上查看面包屑（打点信息）的时间和顺序，这样您就可以监视到您的项目是否按照您的预设跑了！只需要在每个您想监视的地方调用如下API即可(Harmony接口最大支持收集16行最新的面包屑)：

/**
* 添加面包屑
* @param breadcrumb 面包屑信息
*/
Crasheye.leaveBreadcrumb(string breadcrumb);

Crasheye.SetChannelID

设置渠道号

• 您可以使用此方法设置渠道号信息：

/**
* 设置渠道号
* @param yourChannelId 渠道号
*/
Crasheye.SetChannelID(string yourChannelId);

Crasheye.SetUserIdentifier

设置用户标识

• 为每一条上报记录设置用户标识，可以方便后期筛选和定位问题，比如开发人员想看到自己手机上报的崩溃信息，就可以采用这种方式：

/**
* 设置用户标识
* @param userIdentifier 用户标识
*/
Crasheye.SetUserIdentifier("UserIdentifiter");