更新时间:2024-08-16 GMT+08:00
分享

Web&H5 SDK接入

使用前提

使用应用性能监控服务Web&H5 SDK前,您需要注册华为账号并开通华为云。

传输协议

HTTPS

版本更新说明

表1 版本更新说明

版本号

更新说明

1.0.48

新增绘制延迟指标采集,默认关闭,通过enableInp参数开关控制。

1.0.47

新增pvid和ssid字段上报,用于会话追踪和流量分析。

1.0.46

新增自定义标签uid和tag,新增__rum.setUid和__rum.setTag方法。

操作步骤

  1. 进入前端监控页面,单击“接入前端站点”。

  2. 选择“所属应用”,填入“站点名称”,单击“创建前端站点”按钮。

  3. 复制“业务埋码探针”中的代码到入口的HTML中,当执行到埋码的代码时会自动引入SDK并自动埋点。

    埋码的代码中appId不能为空。

    表2 配置参数说明

    参数名称

    是否必填

    默认值

    描述

    appId

    -

    前端站点ID,每个站点有自己的appId。

    apiRepo

    true

    API自动上报开关。

    API自动上报:用于查看API详情和统计API成功率。

    thirdApi

    true

    三方API上报开关。

    三方API上报:上报CrossOrigin第三方接口信息。

    hashMode

    true

    hashMode自动解析开关。

    hashMode自动解析:URL中#内容,在开启时做URL一部分处理,不开启时被当作锚点处理。

    JsErrorClear

    true

    JS错误追踪开关。

    JS错误追踪开关:监听和上报所有JS错误。

    注意:

    这个功能会改变业务在浏览器上显示的路径。

    smartJsErr

    true

    Js错误智能采集开关。

    Js错误智能采集:短时间内大批量JS错误智能消减,在一次访问中超过100条的相同JS错误就不进行上报。

    webResource

    true

    页面资源上报开关。

    页面资源上报:此开关将控制是否采集加载性能相关信息。

    traceType

    apm

    链路追踪开关。

    链路追踪:开启后可与可观测链路 OpenTelemetry 版产品做前后端链路追踪,默认与应用监控APM调用链做前后端链路追踪。查看链路追踪效果方法,单击“API请求->URL详情->分析”按钮。

    uid

    -

    用户自定义ID,字符串类型,1.0.46版本新增。

    tag

    -

    用户自定义标签,字符串类型,1.0.46版本新增。

    enableInp

    false

    采集绘制延迟指标开关

  4. 自定义上报统计 (可选步骤)。

    方法名称

    参数说明

    __rum.log(key: String, value: String)

    key:事件名称,String类型,最大长度为2048个字符。

    value:事件内容,支持String、Array、HashMap以及Number等有效的JSON对象,转JSON字符串最大长度为30720个字符。

  5. 动态设置uid(可选步骤)

    方法名称

    参数说明

    __rum.setUid(uid: String)

    uid:String类型,最大长度为2048个字符。

  6. 动态设置tag(可选步骤)

    方法名称

    参数说明

    __rum.setTag(tag: String)

    tag:String类型,最大长度为2048个字符。

数据上报策略

  1. 用户基础数据、自定义上报数据会在访问页面时立即上报。
  2. 页面性能数据会在页面加载完成后触发。
  3. 其他类型数据(API数据、JS错误数据等)会以一分钟的时间间隔上报数据。

相关文档