安装和初始化

最近更新时间:2024-11-05 16:48:31

我的收藏
支持 CDN 和 NPM 两种方式安装并初始化 SDK 。

方式1:以 CDN 方式安装并初始化 SDK

1. 在 HTML 页面的<head></head>标签中引入下列代码。
<script src="https://tam.cdn-go.cn/aegis-sdk/latest/aegis.min.js"></script>
该 cdn 使用 “h3-Q050” 协议,默认 cache-control 为 max-age=666,如果需要修改 cache-control,可以添加参数 max_age,例如:
<script src="https://tam.cdn-go.cn/aegis-sdk/latest/aegis.min.js?max_age=3600"></script>
2. 参考下列步骤新建一个 Aegis 实例,传入相应的配置,初始化 SDK 。
const aegis = new Aegis({
id: 'pGUVFTCZyewhxxxxxx', // 应用ID,即上报ID
uin: 'xxx', // 用户唯一 ID(可选)
reportApiSpeed: true, // 接口测速
reportAssetSpeed: true, // 静态资源测速
hostUrl: 'https://rumt-zh.com', // 上报域名,中国大陆 rumt-zh.com
spa: true // spa 应用页面跳转的时候开启 pv 计算
});


方式2:以 NPM 方式安装并初始化 SDK

1. 执行下列命令,在 npm 仓库安装 aegis-web-sdk。
$ npm install --save aegis-web-sdk

2. 参考下列步骤新建一个 Aegis 实例,传入相应的配置,初始化 SDK 。
import Aegis from 'aegis-web-sdk';

const aegis = new Aegis({
id: 'pGUVFTCZyewhxxxxxx', // 应用ID,即上报ID
uin: 'xxx', // 用户唯一 ID(可选)
reportApiSpeed: true, // 接口测速
reportAssetSpeed: true, // 静态资源测速
hostUrl: 'https://rumt-zh.com', // 上报域名,中国大陆 rumt-zh.com
spa: true // spa 应用页面跳转的时候开启 pv 计算
})

说明:
为了不遗漏数据,须尽早进行初始化。当您完成安装并初始化 SDK 之后,可以开始使用前端性能监控提供的以下功能:
错误监控:JS 执行错误、Promise 错误、Ajax 请求异常、资源加载失败、返回码异常、PV 上报、白名单检测等。
测速功能:页面性能测速、接口测速、静态资源测速。
数据统计和分析:可在 前端性能监控 > 数据总览 上进行各个维度的数据分析。
aegis-sdk 默认使用 https://aegis.qq.com 作为上报域名,您可以通过 hostUrl 参数来控制上报域名。
国内可以选择使用 https://rumt-zh.com 作为上报域名。
新加坡地区可以选择使用 https://rumt-sg.com 作为上报域名。
硅谷地区可以选择使用 https://rumt-us.com 作为上报域名。