tencent cloud

腾讯云可观测平台

动态与公告
产品动态
产品简介
产品概述
产品优势
基本功能
基本概念
应用场景
使用限制
购买指南
云产品监控
应用性能监控
终端性能监控
前端性能监控
云拨测
Prometheus 监控服务
Grafana 服务
事件总线
云压测
快速入门
监控概览
实例分组
云产品监控
应用性能监控
云拨测
云压测
Prometheus 监控服务
Grafana 服务
创建 Dashboard
事件总线
告警服务
云产品监控
云产品监控指标
控制台操作指南
云服务器监控组件
云产品监控对接 Grafana
故障处理
实践教程
应用性能监控
应用性能监控简介
接入指南
控制台操作指南
实践教程
参考信息
常见问题
终端性能监控
终端性能监控概述
控制台操作指南
接入指南
实践教程
前端性能监控
前端性能监控简介
控制台操作指南
接入指南
常见问题
云拨测
产品简介
控制台操作指南
常见问题
云压测
云压测概述
控制台操作指南
实践教程
JavaScript API 列表
常见问题
Prometheus 监控
Prometheus 监控简介
接入指南
控制台操作指南
实践教程
Terraform
常见问题
Grafana 服务
产品简介
控制台操作指南
Grafana 平台常用功能指引
常见问题
Dashboard
什么是 Dashboard
控制台操作指南
告警管理
控制台操作指南
故障处理
常见问题
事件总线
事件总线简介
控制台操作指南
实践教程
常见问题
报表管理
常见问题
腾讯云可观测平台常见问题
告警服务相关
一般性问题
监控图表相关
云服务器监控组件相关
动态阈值告警相关
云监控对接 Grafana 相关
文档阅读指南
相关协议
应用性能监控服务等级协议
APM 隐私协议
APM 数据处理和安全协议
前端性能监控服务等级协议
终端性能监控服务等级协议
云拨测服务等级协议
Prometheus 监控服务服务等级协议
Grafana 服务服务等级协议
云压测服务等级协议
云压测使用限制
Cloud Monitor Service Level Agreement
词汇表

配置文档

PDF
聚焦模式
字号
最后更新时间: 2024-11-01 19:27:48

配置说明

配置文档各配置项说明如下:
配置
描述
id
必须,number,默认。 开发者平台分配的项目 key。
uin
建议,string,默认取 cookie 中的 UIN 字段。 当前用户的唯一标识符,白名单上报时将根据该字段判定用户是否在白名单中,字段仅支持字母数字@=._-,正则表达式: /^[@=.0-9a-zA-Z_-]{1,60}$/
reportApiSpeed
可选,boolean,默认 false。 是否开启接口测速。
version
可选,string,默认 sdk 版本号。 当前上报版本,当页面使用了 pwa 或者存在离线包时,可用来判断当前的上报是来自哪一个版本的代码,仅支持字母数字.,:_-,长度在 60 位以内 /^[0-9a-zA-Z.,:_-]{1,60}$/
delay
可选,number,默认 1000 ms。 上报节流时间,在该时间段内的上报将会合并到一个上报请求中。
repeat
可选,number,默认 5。 重复上报次数,对于同一个错误超过多少次不上报。
env
可选 enum,默认 Aegis.environment.production。当前项目运行所处的环境。
spa
可选,boolean,默认 false。 是否在小程序页面跳转时进行 PV 上报。
offlineLog
可选,boolean,默认 false。 是否使用离线日志。
offlineLogExp
可选,number,默认 3。 离线日志过期天数。
url
可选,string,默认 //aegis.qq.com/collect。 日志上报地址。 设置为空字符串可以不进行日志上报。
pvUrl
可选,string,默认 //aegis.qq.com/collect/pv。 pv 上报地址。 设置为空字符串可以不进行 pv 上报。
whiteListUrl
可选,string,默认 //aegis.qq.com/collect/whitelist。 白名单确认接口, 设置为空字符串可以关闭白名单接口请求
offlineUrl
可选,string,默认 //aegis.qq.com/collect/offline。 离线日志上报地址。 设置为空字符串可以不进行离线日志上报。
eventUrl
可选,string,默认 //aegis.qq.com/collect/events。 自定义事件上报地址。 设置为空字符串可以不进行自定义事件上报。
speedUrl
可选,string,默认 //aegis.qq.com/speed。 测速日志上报地址。 设置为空字符串可以不进行测速数据上报。
customTimeUrl
可选,string,默认 //aegis.qq.com/speed/custom。 自定义测速上报地址。 设置为空字符串可以不进行自定义测速上报。
performanceUrl
可选,string,默认 //aegis.qq.com/speed/performance。 页面性能日志上报地址。 设置为空字符串可以不进行页面性能上报。
setDataReportConfig
可选,object,默认为{}。相关的配置:
disabled: 可选,Boolean,默认false。是否禁用setData数据上报;
timeThreshold: 可选,Number,单位为ms,默认值为30。上报的耗时阈值,表示仅上报更新耗时超过该阈值的数据;
withDataPaths: 可选,Boolean,默认为true。是否上报本次更新的字段信息;
api
可选,object,默认为{}。相关的配置:
apiDetail:可选,boolean,默认 :false。api 失败时,是否上报 api 的请求参数和返回值;
retCodeHandler:Function, 返回码上报钩子函数。会传入接口返回数据,返回值为{isErr: boolean, code: string}。详情请参见示例 api.retCodeHandler
reportRequest:boolean,默认:false。开启后,aegis.info 会变成全量上报,不需要白名单配置,并且会上报所有接口的信息(上报接口需开启 reportApiSpeed)
ext1
可选,string,自定义上报的额外维度,上报的时候可以被覆盖。
ext2
可选,string,自定义上报的额外维度,上报的时候可以被覆盖。
ext3
可选,string,自定义上报的额外维度,上报的时候可以被覆盖。

示例

api.retCodeHandler

假如后台返回数据为:
{
body: {
code: 200,
retCode: 0,
data: {
// xxx
}
}
业务需要:code 不为200,或者 retCode 不为0,此次请求就是错误的。此时只需进行以下配置:
new Aegis({
// xxx
reportApiSpeed: true, // 需要开两个,不然不会有返回码上报
reportAssetSpeed: true,
api: {
retCodeHandler(data) {
// 注意这里拿到的data是string类型,如果需要对象需要手动parse下
try {
data = JSON.parse(data)
} catch (e) {
}
return {
isErr: data.body.code !== 200 || data.body.retCode !== 0,
code: data.body.code
}
}
}
})


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈