1 Star 2 Fork 1

fe-hl / fe-monitor-sdk

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

前端监控 SDK

安装

npm i @fe-hl/monitor-sdk -S

使用

  • 除了perfLog页面渲染性能监控,其他都是实时上报

参数说明

参数 是否必传 默认值 说明
pid true - 产品ID
reportUrl true - 上报接口地址
debug false false debug模式打印控制台,不上报接口
jsErrorLog false false js异常
promiseErrorLog false false promise异常
resourcesErrorLog false false 资源加载异常
exposureLog false false 曝光埋点
automaticBurialPointLog false false 自动埋点
pageDwellTimeLog false false 页面停留时间
pvLog false false pv
xhrLog false false 接口监控
resourcesPerfLog false false 资源加载性能
perfLog false false 页面渲染性能
import MonitorSdk from '@fe-hl/monitor-sdk';

const monitorSdk = MonitorSdk({
	pid: '1000', // 产品ID
	reportUrl: 'http://127.0.0.1:9001/report', // 上报的地址
	debug: false, // 是否开启debug,开启后打印控制台不上报
	jsErrorLog: true, // js异常
	promiseErrorLog: true, // promise异常
	resourcesErrorLog: true, // 资源加载异常
	exposureLog: true, //  // 曝光
	automaticBurialPointLog: true,  // 自动埋点
	pageDwellTimeLog: true, // 页面停留时间
	pvLog: true, // PV
	xhrLog: true, // 接口监控
	resourcesPerfLog: true, // 资源加载性能
	perfLog: true, // 页面渲染性能
});

// 自定义上报
monitorSdk.report({
	type: 'click',
	message:"下单成功"
});

爆光埋点

  • 给需要爆光的元素加上appear属性,当元素在可视区域内,上报接口
	<div appear="广告1">广告</div>
	<div appear="{id:100}">广告</div>

无痕埋点

  • 当元素发生点击事件,如果元素有report属性会自动上报接口
<el-button type="primary" size="default" report="{userId:'1000'}">
	无痕埋点
</el-button>

 <el-button type="primary" size="default" report="report1">
	无痕埋点
 </el-button>

关键指标

指标 计算方式 说明
TTFB responseStart-redirectStart 首字节时间(页面重定向到服务器接收页面的第一个字节)
FP responseEnd - fetchStart 首次绘制时间-白屏时间(背景颜色绘制,它是将第一个像素点绘制到屏幕的时刻)
FCP 谷歌web-vitals 首次内容绘制时间(浏览器将第一个DOM渲染到屏幕的时间)
FMP 谷歌web-vitals 首次有意义绘制时间(FMP 是一个主观的指标,触发时机可能是主要内容的绘制用户页面交互)
LCP 谷歌web-vitals 最大内容渲染时间(LCP 是一个动态的指标,它可能在页面加载过程中发生变化触发时机可能是主要内容绘制完成用户页面交互)
DCL domContentLoadedEventEnd - domContentLoadedEventStart DOMContentLoaded事件耗时
L loadEventStart - fetchStart 页面完全加载总时间
TTI 谷歌web-vitals 首次可交互时间(页面从加载开始到用户可以进行有意义的交互操作)
FID 谷歌web-vitals 首次输入延迟时间(用户首次输入与页面响应之间的延迟时间)
  • TTI触发时机

    • 1、首次渲染(FP)已经完成:页面的第一个像素已经被绘制。
    • 2、主线程空闲时间达到一定阈值:在一段时间内,浏览器主线程没有耗时的任务在执行。这意味着页面的关键渲染路径已经完成,主要内容已经可见。
    • 3、页面元素的可操作性:页面上的交互元素(如按钮、链接、输入框等)可以响应用户的交互操作。这表示页面已经加载完成,并且用户可以进行有意义的交互。
    • 当以上条件都满足时,TTI 会被触发
  • FID触发时机

    • 1、用户首次与页面进行交互:用户执行了一个交互动作,如点击按钮、滚动页面、选择下拉菜单等。
    • 2、浏览器主线程忙于处理其他任务:当用户进行交互时,如果主线程正忙于处理其他任务(如执行 JavaScript、处理样式计算等),则会导致延迟。

指标参考

指标 说明
TTFB 0-800(ms) 800-1800(ms) 1800-~(ms) 第一字节时间
FCP 0-1.8(sec) 1.8-3.0(sec) 3.0-~(sec) 首次内容绘制
FID 0-100(ms) 100-300(ms) 300-~(ms) 首次输入延迟

TODO

  • 用户链路追踪(待实现)
  • 用户页面行为录制(待实现)
MIT License Copyright (c) 2022 Ants Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

简介

前端监控SDK,轻量级 展开 收起
JavaScript 等 3 种语言
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
JavaScript
1
https://gitee.com/fe-hl/fe-monitor-sdk.git
git@gitee.com:fe-hl/fe-monitor-sdk.git
fe-hl
fe-monitor-sdk
fe-monitor-sdk
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891