WEB页面 (H5)¶
视图预览¶
安装部署¶
前置条件¶
- 至少拥有一台内网服务器,且已 <安装 DataKit>。
- 开放9529端口:(RUM数据传输端口)生产环境建议采用域名或slb进行数据接收,然后转发至 DataKit 所在服务器的9529端口。
- 测试环境:开发或测试时可将数据发送至 DataKit 所在服务器的内网9529端口
- 生产环境:因涉及外网RUM数据收集,需开放 DataKit 所在服务器的外网9529端口(可利用slb对外转发数据至 DataKit 所在服务器的9529端口,或者用域名收集数据并转发至 DataKit 所在服务器的9529端口,同时建议用https加密协议进行传输)
配置实施¶
登录DF平台——选择用户访问监测——新建应用——输入应用名称——创建——选择web类型
备注:单个project中理论上只有一个html文档,需要在该html文档中添加可观测js,如果存在多个项目均需要接入,则需要在多个项目的project中添加js,建议不同的项目在DF可观测平台上创建不同的应用,方便后期的管理以及问题的排查。
接入方式 | 简介 |
---|---|
NPM | 通过把 SDK 代码一起打包到你的前端项目中,此方式可以确保对前端页面的性能不会有任何影响,不过可能会错过 SDK 初始化之前的的请求、错误的收集。 |
CDN 异步加载 | 通过 CDN 加速缓存,以异步脚本引入的方式,引入 SDK 脚本,此方式可以确保 SDK 脚本的下载不会影响页面的加载性能,不过可能会错过 SDK 初始化之前的的请求、错误的收集。 |
CDN 同步加载 | 通过 CDN 加速缓存,以同步脚本引入的方式,引入 SDK 脚本,此方式可以确保能够收集到所有的错误,资源,请求,性能指标。不过可能会影响页面的加载性能。 |
参数 | 类型 | 是否必须 | 默认值 | 描述 |
---|---|---|---|---|
applicationId |
String | 是 | 从 dataflux 创建的应用 ID | |
datakitOrigin |
String | 是 | datakit 数据上报 Origin 注释: 协议(包括://),域名(或IP地址)[和端口号] 例如: https://www.datakit.com, http://100.20.34.3:8088 |
|
env |
String | 是 | web 应用当前环境, 如 prod:线上环境;gray:灰度环境;pre:预发布环境 common:日常环境;local:本地环境; | |
version |
String | 是 | web 应用的版本号 | |
resourceSampleRate |
Number | 否 | 100 |
资源指标数据采样率百分比: 100 表示全收集,0 表示不收集 |
sampleRate |
Number | 否 | 100 |
指标数据采样率百分比: 100 表示全收集,0 表示不收集 |
trackSessionAcrossSubdomains |
Boolean | 否 | false |
同一个域名下面的子域名共享缓存 |
allowedDDTracingOrigins |
Array | 否 | [] |
允许注入ddtrace 采集器所需header头部的所有请求列表。可以是请求的origin,也可以是是正则,origin: 协议(包括://),域名(或IP地址)[和端口号] 例如: ["https://api.example.com", /https:\\/\\/.*\\.my-api-domain\\.com/] |
trackInteractions |
Boolean | 否 | false |
是否开启用户行为采集,开启后可采集用户在web页面中的多种操作事件。 |
接入示例(同步载入):
Web应用分析¶
高级功能¶
<自定义用户标识> 此方法需保证在rum-js初始化之后可以读到。
<自定义设置会话>
场景视图¶
DF平台已默认内置,无需手动创建
如有需要,可参照以下步骤进行创建
<场景 - 新建仪表板 - 模板库 - 系统视图 - Web 应用概览>
<场景 - 新建仪表板 - 模板库 - 系统视图 - Web 应用错误分析>
检测库¶
序号 | 规则名称 | 触发条件 | 级别 | 检测频率 |
---|---|---|---|---|
1 | RUM页面耗时异常 | 页面加载平均耗时 > 7s | 警告 | 5m |
2 | RUM页面耗时异常 | 页面加载平均耗时 > 3s | 紧急 | 5m |
序号 | 规则名称 | 触发条件 | 级别 | 检测频率 |
---|---|---|---|---|
1 | RUM页面JS错误异常次数过多 | js错误次数 > 50 | 警告 | 5m |
2 | RUM页面JS错误异常次数过多 | js错误次数 > 100 | 紧急 | 5m |