You need to enable JavaScript to run this app.
导航
应用接入Harmony SDK
最近更新时间:2024.06.17 20:28:19首次发布时间:2024.04.18 19:56:47

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

注意事项

  • Harmony SDK目前仅限在中国大陆应用使用(不包括港澳台地区)。
  • 调用SDK初始化接口不会采集用户信息,调用SDK启动接口会开始采集用户信息,请确保采集用户信息之前已经获得用户授权SDK隐私政策

Demo说明

APMPlus_Harmony

  • Demo已经接入了所有ApmPlus的性能和稳定性监控的能力。
  • 您可以通过Demo模拟一些异常和性能数据。
  • 您可以配置成自己的AppID和AppToken,将数据上报到平台,进行SDK功能测试。

步骤一:创建产品

  1. 在火山引擎平台注册账号,然后在应用性能监控全链路版控制台创建应用。详情请参见接入应用
    创建完成后可以在平台看到AppID、AppToken。
  2. 产品创建后需要购买事件可以在平台查看上报数据,详情请参见开通与续费服务
    在火山平台联系在线客服可以申请试用,提供AppID申请免费试用额度。

步骤二:获取SDK包,引入依赖

自动集成(推荐)

通过ohpm安装APMPlus SDK。

ohpm i @volcengine/apmplus@latest

手动集成

  1. 通过三方仓库或在线客服获取har包。
  2. 把har包拷贝到工程中,如entry/libs目录下。
  3. 在主入口module的oh-package.json5文件中,添加离线har包依赖。
    "dependencies": {
        "@volcengine/apmplus": "file:./libs/apmplus.har"
    }
    

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

注意

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

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

    APMPlus.init(this.context);
    
  2. 启动监控,开始收集数据。

    注意

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

    let builder = new APMPlusBuilder("AppID", "AppToken");//必填
    builder.debug = true;//可选,测试阶段配置有输出日志,线上release需关闭
    builder.channel = "volcengine";//可选,类型string。渠道 
    builder.startMonitor = true;//可选,是否开启启动监控
    builder.versionCode = BuildProfile.VERSION_CODE;//可选,类型number。应用versionCode  
    builder.versionName = BuildProfile.VERSION_NAME;//可选,类型string。应用versionName
    builder.dynamicParams = {
      getDeviceId: () => {
        return "";//可选,类型string。设备device_id,不返回会使用内部内置device_id.
      },
      getUserId: () => {
        return "";//可选,类型string。用户标识,没有默认值。
      }
    }
    APMPlus.start(builder);
    

    说明

    AppID和AppToken获取方法,请参见如何查询AppID和AppToken?