一次基于日志服务(SLS)进行前端业务埋点的实现过程

简介: 一次基于日志服务(SLS)进行前端业务埋点的实现过程

项目背景

从阿里云官网上可以看出,日志服务(SLS)出现的初衷是为分布式系统的数据采集和分析来设计,所以对端上的支持并不是特别完善,不如其它面向端的采集平台那样做到开箱即用,向页面流向、性能指标都需要自己开发进行采集。本文分享一下项目上,端上业务封装的方案设计思路。

实现思路

首先要清楚的问题是我们需要进行什么分析?是着重分析业务功能的使用情况还是只需要了解基础的PV、UV数据?需不需要进行性能分析?需不需要进行链路分析?

明白数据采集的需求之后就是把需求拆解成指标,也就是最小采集单位。比如对于功能的使用情况这个需求,就可以通过公式 渗透率 = 功能使用人数 / 活跃用户数 把它拆解成2个指标。

有了指标之后我们再考虑该怎么通过(尽可能少的)埋点来采集这些指标

业务指标一般是产品经给出,然后技术同学来考虑怎么优雅、高效地实现。

下面以“某核心功能使用率”这个需求为例进行说明。

具体步骤

1 明确需求

某核心功能使用率(以下简称“使用率”)的可以通过公式计算得到:

使用率 = 100% * 使用该功能的用户数 / 使用产品的用户数

由于使用率只是一个数值,简单统计报表即可用来展示它的值。

但结合业务场景来看,我们很可能需要分析的是某次发布之后,使用率是否有明显变化,然后进行相关分析。比如 UI 交互优化后使用率是否有提升来验证改版的有效性,或者是否因为 bug 导致使用率下降等。

所以需要在时间维度上进行对比分析,折线图更加合适。

2 拆解指标

通过上面的公式看到使用率涉及2个指标:使用该功能用户数使用产品用户数

使用产品的用户数和我们可以通过统计用户 ID 来实现,也就是我们常说的 UV 指标。

使用该功能的用户数可以通过交互事件或者HTTP请求来统计,两者的区别在于,如果该功能比较复杂,涉及多个操作步骤或者多个请求,可以考虑通过进入功能的交互事件来统计,否则可以通过判断 HTTP 请求路径来进行统计。

3 规范埋点数据

虽然不同端的埋点方式不同,但是能在统一的报表上进行分析,所以需要事先定义好埋点规范,核心内容就是需要收集的字段(对应日志库的索引)

这里我们采用通用字段+业务字段结合的方式,以事件的形式进行上报。

其中通用字段包括但不限于事件名称、浏览器UA信息、代码版本、用户ID。。。

业务字段则根据具体埋点指标自行扩展,比如对于页面进入事件会收集页面路径,页面退出事件会收集页面路径和访问时间。

4 编码实现

由于我们项目存在跨端场景(web端和桌面端),所以编写了一个公共库,一方面是对 SLS 的 sdk 以及自行编写的客户端 sdk 进行了封装,让公共库来管理 sdk 的实例。另一方面以基类的方式规范了提供的事件函数。

除开上面两个原因,还有一些隐藏好处:

  1. 可以对一些原子事件进行更高层级的封装,比如进出页面事件、进出应用事件可以封装成一个。
  2. 可以随时替换底层实现,比如自行实现的 sdk,甚至是 SLS 的 sdk。

5 报表配置

最后一步就是配置报表了,虽然文档比较详细,也配有最佳实践,但还其实还是存在不少技巧的。比如:

1、建议优先在日志库提供的默认查询页面编写 SQL 进行查询分析,不光是为了调试,更重要的是系统会自image.png行推荐匹配的图表


2、折线图如果想绘制多条线,可以试试数据转换功能。

3、管道符“|”的过滤优先级要高于 where 子句。

......

总结

使用 SLS 进行业务埋点概括起来可以三步走:先需求文档,后代码实现,最后报表配置。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
相关文章
|
5天前
|
安全 Linux 网络安全
/var/log/secure日志详解
Linux系统的 `/var/log/secure` 文件记录安全相关消息,包括身份验证和授权尝试。它涵盖用户登录(成功或失败)、`sudo` 使用、账户锁定解锁及其他安全事件和PAM错误。例如,SSH登录成功会显示"Accepted password",失败则显示"Failed password"。查看此文件可使用 `tail -f /var/log/secure`,但通常只有root用户有权访问。
175 4
|
3天前
|
关系型数据库 MySQL 数据库
mysql数据库bin-log日志管理
mysql数据库bin-log日志管理
|
3天前
|
存储 关系型数据库 数据库
关系型数据库文件方式存储LOG FILE(日志文件)
【5月更文挑战第11天】关系型数据库文件方式存储LOG FILE(日志文件)
15 1
|
4天前
|
运维 监控 安全
Java一分钟之-Log4j与日志记录的重要性
【5月更文挑战第16天】Log4j是Java常用的日志框架,用于灵活地记录程序状态和调试问题。通过设置日志级别和过滤器,可避免日志输出混乱。为防止日志文件过大,可配置滚动策略。关注日志安全性,如Log4j 2.x的CVE-2021-44228漏洞,及时更新至安全版本。合理使用日志能提升故障排查和系统监控效率。
23 0
|
5天前
|
C++
JNI Log 日志输出
JNI Log 日志输出
20 1
|
5天前
|
存储 运维 大数据
聊聊日志硬扫描,阿里 Log Scan 的设计与实践
泛日志(Log/Trace/Metric)是大数据的重要组成,伴随着每一年业务峰值的新脉冲,日志数据量在快速增长。同时,业务数字化运营、软件可观测性等浪潮又在对日志的存储、计算提出更高的要求。
|
5天前
|
XML Java Maven
Springboot整合与使用log4j2日志框架【详解版】
该文介绍了如何在Spring Boot中切换默认的LogBack日志系统至Log4j2。首先,需要在Maven依赖中排除`spring-boot-starter-logging`并引入`spring-boot-starter-log4j2`。其次,创建`log4j2-spring.xml`配置文件放在`src/main/resources`下,配置包括控制台和文件的日志输出、日志格式和文件切分策略。此外,可通过在不同环境的`application.yml`中指定不同的log4j2配置文件。最后,文章提到通过示例代码解释了日志格式中的各种占位符含义。
|
5天前
|
运维 监控 Go
Golang深入浅出之-Go语言中的日志记录:log与logrus库
【4月更文挑战第27天】本文比较了Go语言中标准库`log`与第三方库`logrus`的日志功能。`log`简单但不支持日志级别配置和多样化格式,而`logrus`提供更丰富的功能,如日志级别控制、自定义格式和钩子。文章指出了使用`logrus`时可能遇到的问题,如全局logger滥用、日志级别设置不当和过度依赖字段,并给出了避免错误的建议,强调理解日志级别、合理利用结构化日志、模块化日志管理和定期审查日志配置的重要性。通过这些实践,开发者能提高应用监控和故障排查能力。
89 1
|
5天前
|
弹性计算 运维 Shell
|
5天前
|
Java
log4j异常日志过滤规则配置
log4j异常日志过滤规则配置
99 0

相关产品

  • 日志服务
  • http://www.vxiaotou.com