当前位置：首页 > 科技 > 软件

为了全面监控用户行为，我写了个超级前端工具库！

来源：责编：时间：2024-06-06 17:41:47 319观看

导读简介sunshine-track 应用于前端监控，基于行为上报，实现了用户行为、错误监控、页面跳转、页面白屏检测、页面性能检测等上报功能。适用于 Vue、React、Angular 等框架本项目源码：https://github.com/sanxin-lin/sunsh

简介

sunshine-track 应用于前端监控，基于行为上报，实现了用户行为、错误监控、页面跳转、页面白屏检测、页面性能检测等上报功能。适用于 Vue、React、Angular 等框架

本项目源码：https://github.com/sanxin-lin/sunshine-track。各位兄弟姐妹如果觉得喜欢的话，可以点个 star 哦~

功能

sunshine-track具备以下功能：

✅ 用户行为上报：包括点击、跳转页面、跳转页面记录数组、请求等
✅ 用户手动上报：提供 Vue 自定义指令以及add、report函数，实现用户手动上报
✅ 自定义上报：提供格式化上报数据、自定义上报函数、自定义决定上不上报等配置项，更灵活地上报数据
✅ 请求数据上报：提供检测请求返回、过滤请求等配置项，让用户决定上报哪些请求数据
✅ 上报方式：提供上报方式配置项，用户可选择 img、http、beacon 三种方式，http方式又支持 xhr、fetch 两种，且支持自定义headers
✅ 上报数据缓存：可配置本地缓存、浏览器本地缓存、IndexedDB 三种方式
✅ 上报数据阈值：可配置上报数据阈值，达到阈值后进行上报操作
✅ 全局点击上报：可通过配置选择器、元素文本，对全局DOM节点进行点击上报
✅ 页面的性能检测，包括白屏、FP、FCP、LCP、CLS、TTFB、FID 等

上报数据格式

选项	描述	类型
`uuid`	上报数据的id	`string`
`type`	上报数据的类型	`string`
`data`	上报数据	`any`
`time`	上报时间	`number`
`status`	上报状态	`string`
`domain`	当前域名	`string`
`href`	当前网页路径	`string`
`userAgent`	当前user-agent	`string`
`deviceInfo`	设备的相关信息	`object`

安装

图片

使用

图片

全局点击监听

可以通过配置globalClickListeners来对于某些DOM节点进行点击监听上报

图片

配置上报阈值

上报分为几种：

用户行为上报：点击、跳转页面、请求，这些上报数据会缓存着，当达到阈值时再进行上报
错误上报：请求报错、代码报错、异步错误，这些是立即上报
页面性能上报：白屏、FP、FCP、LCP、CLS、TTFB、FID，这些是立即上报

用户行为上报的阈值默认是 10，支持自定义 maxEvents

图片

配置缓存方式

如果你想要避免用户重新打开网页之后，造成上报数据的丢失，那么你可以配置缓存方式，通过配置cacheType：

normal：默认，本地缓存
storage：浏览器 localStorage 本地缓存
db：浏览器 IndexedDB 本地缓存

app.use(Track, {  ...options,  cacheType: 'storage' // 配置缓存方式})

打印上报数据

可以通过配置 log ，开启打印上报数据。

图片

灵活上报请求数据

请求也是一种行为，也是需要上报的，或许我们有这个需求。

过滤：某些请求我们并不想上报。
自定义校验请求响应数据：每个项目的响应规则可能都不同，我们想自己判断哪些响应是成功，哪些是失败。

图片

格式化上报数据、自定义决定上不上报、自定义上报

如果你想在数据上报之前，格式化上报数据的话，可以配置report中的format。

图片

如果你想要自己决定某次上报的时候，进行取消，可以配置report中的isReport。

图片

如果你不想用这个库自带的上报功能，想要自己上报，可以配置report中的customReport。

图片

手动上报

手动上报分为三种：

手动添加上报数据：添加到缓存中，等到达到阈值再上报。
手动执行数据上报：立即上报。
自定义指令上报：如果你是 Vue 项目，支持指令上报。

图片

如果你是 Vue 项目，可以使用指令v-track进行上报。

图片

配置参数

选项	描述	类型
`projectKey`	项目key	`string`
`userId`	用户id	`string`
`report.url`	上报url	`string`
`report.reportType`	上报方式	`img、http、beacon`
`report.headers`	上报自定义请求头，`http` 上报模式生效	`object`
`report.format`	上报数据格式化	`function`
`report.customReport`	自定义上报	`function`
`report.isReport`	自定义决定上不上报	`function`
`cacheType`	数据缓存方式	`normal、storage、db`
`globalClickListeners`	上报状态	`array`
`log`	当前域名	`boolean`
`maxEvents`	上报阈值	`number`
`historyUrlsNum`	需要记录的url跳转数组	`number`
`checkHttpStatus`	判断响应数据	`function`
`filterHttpUrl`	过滤上报请求数据	`function`
`switchs.xhr`	是否开启xhr请求上报	`boolean`
`switchs.fetch`	是否开启fetch请求上报	`boolean`
`switchs.error`	是否开启错误上报	`boolean`
`switchs.whitescreen`	是否开启白屏检测上报	`boolean`
`switchs.hashchange`	是否开启hash变化请求上报	`boolean`
`switchs.history`	是否开启history变化上报	`boolean`
`switchs.performance`	是否开启页面性能上报	`boolean`

本项目源码：https://github.com/sanxin-lin/sunshine-track。各位兄弟姐妹如果觉得喜欢的话，可以点个 star 哦~

本文链接：http://www.28at.com/showinfo-26-92466-0.html为了全面监控用户行为，我写了个超级前端工具库！

声明：本网页内容旨在传播知识，若有侵权等问题请及时与本网联系，我们将在第一时间删除处理。邮件：2376512515@qq.com

上一篇：关于 Python 数据分析的 15 个 NumPy 应用

下一篇：动态链接库的实现原理是什么？

标签：

热门焦点

小米官宣：2023年上半年出货量中国第一！

今日早间，小米电视官方微博带来消息，称2023年小米电视上半年出货量达到了中国第一，同时还表示小米电视的巨屏风暴即将开始。“公布一个好消息2023年#小米电视上半年出货量中国
小米降噪蓝牙耳机Necklace分享：听一首歌读懂一个故事

在今天下午的小米Civi 2新品发布会上，小米还带来了一款新的降噪蓝牙耳机Necklace，我们也在发布结束的第一时间给大家带来这款耳机的简单分享。现在大家能见到最多的蓝牙耳机
5月iOS设备好评榜：iPhone 14仅排第43？

来到新的一月，安兔兔的各个榜单又重新汇总了数据，像安卓阵营的榜单都有着比较大的变动，不过iOS由于设备的更新换代并没有那么快，所以相对来说变化并不大，特别是iOS好评榜，老款设
Rust中的高吞吐量流处理

作者 | Noz编译 | 王瑞平本篇文章主要介绍了Rust中流处理的概念、方法和优化。作者不仅介绍了流处理的基本概念以及Rust中常用的流处理库，还使用这些库实现了一个流处理程序
19个 JavaScript 单行代码技巧，让你看起来像个专业人士

今天这篇文章跟大家分享18个JS单行代码，你只需花几分钟时间，即可帮助您了解一些您可能不知道的 JS 知识，如果您已经知道了，就当作复习一下，古人云，温故而知新嘛。现在，我们就开始今
JVM优化：实战OutOfMemoryError异常

一、Java堆溢出堆内存中主要存放对象、数组等，只要不断地创建这些对象，并且保证 GC Roots 到对象之间有可达路径来避免垃圾收集回收机制清除这些对象，当这些对象所占空间超过
新电商三兄弟，“抖快红”成团！

来源：价值研究所作者：Hernanderz 随着内容电商的概念兴起，抖音、快手、小红书组成的“新电商三兄弟”成为业内一股不可忽视的势力，给阿里、京东、拼多多带去了巨大压
华为Mate 60系列用上可变灵动岛：正式版体验将会更出色

这段时间以来，关于华为新旗舰的爆料日渐密集。据此前多方爆料，今年华为将开始恢复一年双旗舰战略，除上半年推出的P60系列外，往年下半年的Mate系列也将
“买真退假” 这种“羊毛”不能薅

□ 法治日报记者王春　　□ 本报通讯员胡佳丽　　2020年初，还在上大学的小东加入了一个大学生兼职QQ群。群主“七王”在群里介绍一些刷单赚

为了全面监控用户行为，我写了个超级前端工具库！

简介

功能

上报数据格式

安装

使用

全局点击监听

配置上报阈值

配置缓存方式

打印上报数据

灵活上报请求数据

格式化上报数据、自定义决定上不上报、自定义上报

手动上报

配置参数

小米官宣：2023年上半年出货量中国第一！

小米降噪蓝牙耳机Necklace分享：听一首歌读懂一个故事

5月iOS设备好评榜：iPhone 14仅排第43？

Rust中的高吞吐量流处理

19个 JavaScript 单行代码技巧，让你看起来像个专业人士

JVM优化：实战OutOfMemoryError异常

新电商三兄弟，“抖快红”成团！

华为Mate 60系列用上可变灵动岛：正式版体验将会更出色

“买真退假” 这种“羊毛”不能薅

最新推荐

猜你喜欢

热门推荐

相关资讯