前端监控是一个大话题,无论在知乎,还是掘未经授权,禁止复制转载。著作权归作者所有,禁止商业用途转载。金,我都阅读过很多相关的文章。但是,在众【原创内容,转载请注明出处】【原创不易,请尊重版权】多文章中,我发现他们都有一些共性,但是你著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。却无法简单说哪些是共性的东西,哪些是专门【转载请注明来源】原创内容,盗版必究。的东西。为此,我打算写一篇文章,来讲解我本文作者:唐霜,转载请注明出处。未经授权,禁止复制转载。在设计我的前端监控系统时,如何解决前端S本文版权归作者所有,未经授权不得转载。本文作者:唐霜,转载请注明出处。DK的问题。
转载请注明出处:www.tangshuang.net【未经授权禁止转载】前端监控SDK的共性
和其他SDK不同,前端监控SDK基本上要【原创不易,请尊重版权】原创内容,盗版必究。求开箱即用,一个<script src>就可以完成所有监控逻辑。在文档中插入sc本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.netript标签时,可以带上data-appid属性,以区分当前监控的应用,脚本内可通过【作者:唐霜】【本文受版权保护】document.currentScri原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。pt读取,当然,如果服务端以及绑定了域名【本文受版权保护】【版权所有】唐霜 www.tangshuang.net,那不需要appid也无所谓。
我们要谈的是,作为SDK的提供方,我们要在SDK中怎么写,才能做到这种开箱【作者:唐霜】【版权所有】唐霜 www.tangshuang.net即用,或者对于下游开发者而言更好用。
原创内容,盗版必究。转载请注明出处:www.tangshuang.net前端监控的目标各有不同,包括:测速、性能未经授权,禁止复制转载。【原创内容,转载请注明出处】、错误、行为等方面。我在过去两年中,重点本文版权归作者所有,未经授权不得转载。【转载请注明来源】集中在研究监控用户行为,在长时间的探索中【版权所有】唐霜 www.tangshuang.net本文作者:唐霜,转载请注明出处。,我对SDK进行了多次重构,最终发现,无【访问 www.tangshuang.net 获取更多精彩内容】【版权所有,侵权必究】论以什么方向为目标,SDK的设计都需要包原创内容,盗版必究。【本文受版权保护】含如下几个方面:
【转载请注明来源】【本文首发于唐霜的博客】【原创不易,请尊重版权】- 数据收集 转载请注明出处:www.tangshuang.net【作者:唐霜】【版权所有】唐霜 www.tangshuang.net
- 数据存储(日志的结构,日志是存在内存中,【原创不易,请尊重版权】原创内容,盗版必究。还是存在indexedDB中) 著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】原创内容,盗版必究。
- 数据上报(上报周期:立即,延时;上报策略【作者:唐霜】【版权所有,侵权必究】:什么情况下触发上报;上报压缩等) 【本文首发于唐霜的博客】【关注微信公众号:wwwtangshuangnet】【转载请注明来源】
- 生命周期 转载请注明出处:www.tangshuang.net著作权归作者所有,禁止商业用途转载。
- 代码分离(快速加载主体代码,异步加载功能本文版权归作者所有,未经授权不得转载。【未经授权禁止转载】代码;将数据处理移到webworker中【版权所有】唐霜 www.tangshuang.net著作权归作者所有,禁止商业用途转载。) 【本文首发于唐霜的博客】【未经授权禁止转载】著作权归作者所有,禁止商业用途转载。
不管你是做性能监控,还是错误监控,SDK原创内容,盗版必究。【未经授权禁止转载】都可以从这几个方面去思考,当然,不同场景著作权归作者所有,禁止商业用途转载。本文版权归作者所有,未经授权不得转载。下,不一定全部都要,但是作为成年人,我们【访问 www.tangshuang.net 获取更多精彩内容】著作权归作者所有,禁止商业用途转载。往往全想要。我在写用户行为监控时,还遇到著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.net一些特殊场景:
【访问 www.tangshuang.net 获取更多精彩内容】转载请注明出处:www.tangshuang.net著作权归作者所有,禁止商业用途转载。【作者:唐霜】- 仅在某一个特定流程中进行录制,其他页面不【作者:唐霜】转载请注明出处:www.tangshuang.net需要录制,因此,要求SDK具有可选的录制【作者:唐霜】【原创内容,转载请注明出处】策略,而不是定死的 【作者:唐霜】【本文首发于唐霜的博客】【版权所有,侵权必究】
- 一串用于演示用户行为导致的界面变化的日志转载请注明出处:www.tangshuang.net【本文首发于唐霜的博客】,具有不可能遗漏性,一旦遗漏其中一个日志【本文首发于唐霜的博客】本文版权归作者所有,未经授权不得转载。,都有可能导致无法最终还原出用户操作的界【访问 www.tangshuang.net 获取更多精彩内容】著作权归作者所有,禁止商业用途转载。面效果,因此,对SDK收集的日志完整性有【未经授权禁止转载】【原创内容,转载请注明出处】要求 本文版权归作者所有,未经授权不得转载。本文版权归作者所有,未经授权不得转载。
- 由于考虑到不同业务场景下,对浏览器兼容性未经授权,禁止复制转载。【版权所有,侵权必究】又有考虑,所以,对SDK的可扩展性以及功本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net能可替换性有要求 【访问 www.tangshuang.net 获取更多精彩内容】【作者:唐霜】转载请注明出处:www.tangshuang.net原创内容,盗版必究。
因此,实际上,我们作为SDK的作者,要考【版权所有,侵权必究】【关注微信公众号:wwwtangshuangnet】虑两种场景:SDK直接被网站引用(开箱即【原创内容,转载请注明出处】【原创不易,请尊重版权】用),或者被开发者引用(二次开发)。多次【作者:唐霜】【版权所有】唐霜 www.tangshuang.net重构中,我逐渐摸索出一套共性的东西,并将著作权归作者所有,禁止商业用途转载。【未经授权禁止转载】它以框架的形式在腾讯内部发布。
【访问 www.tangshuang.net 获取更多精彩内容】未经授权,禁止复制转载。【未经授权禁止转载】原创内容,盗版必究。通用的前端监控SDK框架
作为框架,它的主要面向用户是开发者,它并【原创内容,转载请注明出处】【本文受版权保护】不提供直接的功能,而是提供创建功能的底层【原创内容,转载请注明出处】【本文首发于唐霜的博客】接口,让开发者通过接口完成功能开发。我刚【关注微信公众号:wwwtangshuangnet】【访问 www.tangshuang.net 获取更多精彩内容】开始撰写用户行为还原SDK时,将所有的功原创内容,盗版必究。未经授权,禁止复制转载。能耦合在一起,仅仅是为了完成用户行为信息【访问 www.tangshuang.net 获取更多精彩内容】【版权所有】唐霜 www.tangshuang.net收集和上报的功能。但是,随着我想要收集的【原创不易,请尊重版权】【版权所有】唐霜 www.tangshuang.net信息的扩展,我发现之前的设计并不好,因为原创内容,盗版必究。著作权归作者所有,禁止商业用途转载。每加一个方面的信息,就要再次耦合其中。于本文作者:唐霜,转载请注明出处。【转载请注明来源】是我开始了漫长的重构。
本文作者:唐霜,转载请注明出处。未经授权,禁止复制转载。著作权归作者所有,禁止商业用途转载。目标很明确,每加一个方面的信息收集能力,【原创内容,转载请注明出处】【关注微信公众号:wwwtangshuangnet】不需要修改原有代码,而是提供新的代码,在【关注微信公众号:wwwtangshuangnet】本文版权归作者所有,未经授权不得转载。把新代码模块导出的接口插入到已有代码的某著作权归作者所有,禁止商业用途转载。著作权归作者所有,禁止商业用途转载。处。于是,一个基于插件系统的架构浮现在我【原创内容,转载请注明出处】转载请注明出处:www.tangshuang.net脑海中。比如我现在想要收集用户进入我的网【本文受版权保护】【原创内容,转载请注明出处】站到离开我的网站之间的时间这样一个信息,【关注微信公众号:wwwtangshuangnet】未经授权,禁止复制转载。我不需要修改SDK原有的代码,而是写一个著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。插件,按照SDK的规范,提供不同生命周期【作者:唐霜】本文作者:唐霜,转载请注明出处。节点上的钩子函数,就可以了。
转载请注明出处:www.tangshuang.net【版权所有】唐霜 www.tangshuang.net【原创不易,请尊重版权】【本文首发于唐霜的博客】
前端监控SDK框架示意图
【访问 www.tangshuang.net 获取更多精彩内容】原创内容,盗版必究。本文作者:唐霜,转载请注明出处。生命周期
既然提到了生命周期,那就来聊一聊生命周期未经授权,禁止复制转载。本文作者:唐霜,转载请注明出处。吧。
【原创不易,请尊重版权】【版权所有,侵权必究】我向开发者提供了一个类,姑且叫 TheLogger 吧。开发者需要实例化这个类,实例化时,【访问 www.tangshuang.net 获取更多精彩内容】【未经授权禁止转载】传入各种参数,参数中就包含了插件,这个后【未经授权禁止转载】【作者:唐霜】面聊。实例在内存中运行,它会经历给个节点原创内容,盗版必究。原创内容,盗版必究。,完成日志的收集和上报。
init (实例化阶段) -> servup (启动服务阶段) -> start (开始收集) -> write (写入日志) -> stop (停止收集) -> destroy (实例销毁)
^ /
`-------------(重新启动)------------
SDK在这些生命周期节点上提供钩子,插件【未经授权禁止转载】未经授权,禁止复制转载。们则在这些钩子上挂载一些函数,当框架运行【作者:唐霜】【关注微信公众号:wwwtangshuangnet】到这些生命周期节点上时,就会触发插件的函【关注微信公众号:wwwtangshuangnet】【版权所有,侵权必究】数,以实现插件的功能。
【关注微信公众号:wwwtangshuangnet】著作权归作者所有,禁止商业用途转载。本文版权归作者所有,未经授权不得转载。未经授权,禁止复制转载。以如何收集用户的点击事件为例子。当实例化【原创内容,转载请注明出处】【转载请注明来源】时,会去调用插件的options和ini转载请注明出处:www.tangshuang.net【转载请注明来源】t方法,用以获取插件的配置和在SDK实例本文版权归作者所有,未经授权不得转载。本文版权归作者所有,未经授权不得转载。化时做一些工作。 实例化过程中,SDK会【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。启动服务,这个过程对于插件而言,都是启用【访问 www.tangshuang.net 获取更多精彩内容】原创内容,盗版必究。过程,插件如果有自己的服务,可以在这个阶原创内容,盗版必究。【未经授权禁止转载】段启动起来。启动之后,SDK服务就像一个【本文首发于唐霜的博客】【版权所有】唐霜 www.tangshuang.net运转中的轮子,当轮子开始转时,把插件挂上【本文首发于唐霜的博客】【版权所有】唐霜 www.tangshuang.net去,于是轮子就有了插件提供的能力。接下来著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】,在插件中,我们要收集用户的点击信息。如【原创内容,转载请注明出处】【本文受版权保护】何收集呢?当然是addEventList未经授权,禁止复制转载。未经授权,禁止复制转载。ener啦。让插件暴露一个start方法【版权所有】唐霜 www.tangshuang.net【关注微信公众号:wwwtangshuangnet】,这个方法会在SDK运转到start这个【本文首发于唐霜的博客】【访问 www.tangshuang.net 获取更多精彩内容】生命周期节点时被调用。在start钩子中【原创内容,转载请注明出处】【未经授权禁止转载】,插件可以通过addEventListe原创内容,盗版必究。【本文受版权保护】ner对用户的点击事件进行监听,回调函数本文作者:唐霜,转载请注明出处。本文版权归作者所有,未经授权不得转载。中可以使用this.write方法把收集未经授权,禁止复制转载。【本文受版权保护】到的信息,写入到SDK服务中。在stop【本文受版权保护】原创内容,盗版必究。钩子函数中解除监听。这样,插件自己的任务著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】就完成了。在写入日志时,也可以提供wri【未经授权禁止转载】著作权归作者所有,禁止商业用途转载。te钩子方法,对写入的日志进行改写。
【关注微信公众号:wwwtangshuangnet】著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshuang.net【本文首发于唐霜的博客】关键不在于使用哪些名称的方法,关键在于,我采用了一套插件系统,开发者通原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。过自己撰写一个插件,就可以在SDK原来的转载请注明出处:www.tangshuang.net本文版权归作者所有,未经授权不得转载。基础上,收集更多信息,为SDK提供更丰富【转载请注明来源】本文版权归作者所有,未经授权不得转载。的功能。几乎所有的功能,都可以基于插件去完成,C【转载请注明来源】【访问 www.tangshuang.net 获取更多精彩内容】ore是一个基于生命周期的调度器而已,不【版权所有,侵权必究】【未经授权禁止转载】断调用插件的各个方法实现功能。
【访问 www.tangshuang.net 获取更多精彩内容】【原创不易,请尊重版权】生命周期的设计,几乎是所有系统设计的共性【版权所有】唐霜 www.tangshuang.net【未经授权禁止转载】,我们现在回来看生命周期,会发现,生命周【未经授权禁止转载】本文版权归作者所有,未经授权不得转载。期是一个系统,一个存在运行时系统的核心,未经授权,禁止复制转载。【版权所有,侵权必究】不同的业务场景下,我们提炼出来的生命周期【版权所有,侵权必究】原创内容,盗版必究。节点是不一样的,流转图也是不同的。在前端著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】监控这个领域,SDK的生命周期却都大致相未经授权,禁止复制转载。【未经授权禁止转载】同,因为业务场景基本一致。它围绕监控日志【转载请注明来源】转载请注明出处:www.tangshuang.net的收集、存储、上报进行展开,所以,基本就著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。是这些流程。一旦这个基本的生命周期流程确转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net定之后,插件的生命周期也就确定了。
【本文首发于唐霜的博客】【作者:唐霜】【版权所有,侵权必究】【原创不易,请尊重版权】服务
这里的服务(Service)是“真服务”【版权所有】唐霜 www.tangshuang.net【作者:唐霜】,它通过一个常驻的运转流程,不断的监听事【转载请注明来源】著作权归作者所有,禁止商业用途转载。件,当事件发生时提供一个响应。在TheL本文版权归作者所有,未经授权不得转载。【本文受版权保护】ogger中,我提供了一套内置的服务,这原创内容,盗版必究。【原创内容,转载请注明出处】套服务基于indexedDB+webwo著作权归作者所有,禁止商业用途转载。著作权归作者所有,禁止商业用途转载。rker,在后台不间断运行。但这套内置的转载请注明出处:www.tangshuang.net【版权所有】唐霜 www.tangshuang.net服务是解耦的,它并不属于框架的一部分,框本文作者:唐霜,转载请注明出处。【版权所有,侵权必究】架并不提供具体的服务,只是提供了服务的抽著作权归作者所有,禁止商业用途转载。【访问 www.tangshuang.net 获取更多精彩内容】象接口。开发者拿到SDK框架之后,默认是【版权所有】唐霜 www.tangshuang.net【未经授权禁止转载】不包含服务代码的,开发者可以用一个ext原创内容,盗版必究。【转载请注明来源】ends关键字,重写serve, sen本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】d方法,把服务挂载进去(通过插件也可以实未经授权,禁止复制转载。【访问 www.tangshuang.net 获取更多精彩内容】现)。
【原创内容,转载请注明出处】【关注微信公众号:wwwtangshuangnet】本文作者:唐霜,转载请注明出处。这种设计的好处在于,如果你并不喜欢我的内【关注微信公众号:wwwtangshuangnet】【版权所有,侵权必究】置服务,你可以不用它,而代码并不在框架中【版权所有】唐霜 www.tangshuang.net【版权所有,侵权必究】,因此,你最终打包的代码并不包含这部分内本文作者:唐霜,转载请注明出处。【本文首发于唐霜的博客】容。我在为公司内的一个监控平台Aegis【原创内容,转载请注明出处】【未经授权禁止转载】提供用户行为监控的能力时,由于Aegis【作者:唐霜】著作权归作者所有,禁止商业用途转载。平台有自己的日志存储和上报体系,因此,我本文版权归作者所有,未经授权不得转载。【作者:唐霜】不需要把我自己的Service部分再塞到本文作者:唐霜,转载请注明出处。【访问 www.tangshuang.net 获取更多精彩内容】我提供的SDK中,而是只挑选了要使用到的未经授权,禁止复制转载。【未经授权禁止转载】插件,打包之后,再到Aegis中提供一个【原创不易,请尊重版权】【未经授权禁止转载】基于该打包后的SDK的Aegis插件,这本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.net样,对于下游用户而言,他们使用了一个Ae【访问 www.tangshuang.net 获取更多精彩内容】【访问 www.tangshuang.net 获取更多精彩内容】gis插件,而这个Aegis插件拥有了T原创内容,盗版必究。原创内容,盗版必究。heLogger的功能。
本文作者:唐霜,转载请注明出处。【作者:唐霜】一个运行中的服务,本质上就是一个资源消费【作者:唐霜】原创内容,盗版必究。系统。你需要用资源喂它,让它按照它被设计【原创内容,转载请注明出处】【本文受版权保护】的方式产出效果。在前端监控SDK里面,这原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.net个服务就是你把日志喂给它,然后让它按照一未经授权,禁止复制转载。【未经授权禁止转载】定的逻辑上报到后台。所以,我设计时,要求本文版权归作者所有,未经授权不得转载。本文作者:唐霜,转载请注明出处。开发者从serve和send两个方法实现原创内容,盗版必究。【本文首发于唐霜的博客】服务。serve方法用于实例化服务,也就【原创不易,请尊重版权】【转载请注明来源】是说在SDK中,你将以什么样的服务处理日【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。志的存储和上报。send方法则是喂日志/原创内容,盗版必究。【访问 www.tangshuang.net 获取更多精彩内容】消息。send方法接收一个消息,当typ本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】e为不同值时,表示要求服务干一件对应的事未经授权,禁止复制转载。本文版权归作者所有,未经授权不得转载。情,例如type=write表示要服务把【作者:唐霜】【本文受版权保护】我丢过去的日志写入到本地存储中,当typ【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。e=report时表示要服务把我之前丢进转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net去的日志上报到服务器上面。当然,不同的开【版权所有,侵权必究】著作权归作者所有,禁止商业用途转载。发者在实现send方法时,具体实现不同,【原创不易,请尊重版权】著作权归作者所有,禁止商业用途转载。极端情况下,我们提供一个同步的服务,当 send({ type: 'write', data }) 发生时,直接将该日志发送到服务端,不需本文作者:唐霜,转载请注明出处。本文版权归作者所有,未经授权不得转载。要在本地进行存储,这种情况下,serve【原创内容,转载请注明出处】【转载请注明来源】方法不需要写任何内容,在send中直接调【本文受版权保护】【版权所有】唐霜 www.tangshuang.net用上传接口。
插件
插件是完成日志收集的主要场所。插件暴露的转载请注明出处:www.tangshuang.net【关注微信公众号:wwwtangshuangnet】接口有两种类型,一种是为SDK框架所调用【关注微信公众号:wwwtangshuangnet】【转载请注明来源】的生命周期函数,另一种是为增强SDK功能【访问 www.tangshuang.net 获取更多精彩内容】【原创不易,请尊重版权】的功能函数。
转载请注明出处:www.tangshuang.net【未经授权禁止转载】因为插件的生命周期函数会被SDK的生命周【版权所有,侵权必究】【版权所有,侵权必究】期钩子勾着走,所以单纯看插件代码,插件自原创内容,盗版必究。【原创内容,转载请注明出处】身仿佛也有了生命周期。比如,你可以说插件【本文首发于唐霜的博客】【版权所有】唐霜 www.tangshuang.net在实例化、启动、停止时都在做什么。在设计著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。时,我着重强调start/stop两个过本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.net程。start过程是插件真正的收集开始自著作权归作者所有,禁止商业用途转载。转载请注明出处:www.tangshuang.net动化开展过程,stop则是停止这个自动化【关注微信公众号:wwwtangshuangnet】【本文受版权保护】过程。比如对用户鼠标轨迹的收集,在sta原创内容,盗版必究。【原创内容,转载请注明出处】rt中通过addEventListene转载请注明出处:www.tangshuang.net本文作者:唐霜,转载请注明出处。r启动监听,自动收集,而在stop中re转载请注明出处:www.tangshuang.net【版权所有】唐霜 www.tangshuang.netmoveEventListener停止这【本文首发于唐霜的博客】本文版权归作者所有,未经授权不得转载。个自动收集过程。
转载请注明出处:www.tangshuang.net【本文首发于唐霜的博客】原创内容,盗版必究。但,插件的运作方式并非只有自动一种。某些【版权所有】唐霜 www.tangshuang.net本文作者:唐霜,转载请注明出处。情况下,我们可能不依靠自动收集,而是手动著作权归作者所有,禁止商业用途转载。【关注微信公众号:wwwtangshuangnet】收集,通过在业务代码中调用SDK实例的一本文作者:唐霜,转载请注明出处。【原创不易,请尊重版权】个方法记录一条日志。比如,你只想记录某一本文作者:唐霜,转载请注明出处。【本文受版权保护】个button被点击的次数,你直接将插件转载请注明出处:www.tangshuang.net【本文首发于唐霜的博客】的一个功能函数绑定到该button的cl著作权归作者所有,禁止商业用途转载。【本文受版权保护】ick事件上,这样就完成对单一对象的事件本文作者:唐霜,转载请注明出处。【版权所有】唐霜 www.tangshuang.net收集。这时,插件需要做的,是提供一个功能【本文受版权保护】【版权所有】唐霜 www.tangshuang.net函数(接口),方便你在业务代码中调用。当未经授权,禁止复制转载。【本文受版权保护】然,功能函数千变万化,提供什么功能,完全【关注微信公众号:wwwtangshuangnet】本文作者:唐霜,转载请注明出处。看开发者自己。关键的核心,不在于函数本身,而在于插件是本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】增强SDK系统的一种方式。因为插件系统的设计,配合生命周期,你可以转载请注明出处:www.tangshuang.net转载请注明出处:www.tangshuang.net在SDK的框架上,开发出任意的客户端信息未经授权,禁止复制转载。【原创内容,转载请注明出处】收集的逻辑。
【关注微信公众号:wwwtangshuangnet】著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.net前端监控SDK的设计技巧
现在,你有了SDK框架,接下来,你应该利未经授权,禁止复制转载。【原创内容,转载请注明出处】用该框架,撰写一个属于自己的SDK了。当著作权归作者所有,禁止商业用途转载。本文版权归作者所有,未经授权不得转载。然,作为一个前端监控SDK,它必须配合后【未经授权禁止转载】本文版权归作者所有,未经授权不得转载。端的一些规则,不过,由于一般的日志存储系【访问 www.tangshuang.net 获取更多精彩内容】【版权所有,侵权必究】统都是NoSQL的,所以,只要一条符合设【本文首发于唐霜的博客】【版权所有,侵权必究】计的日志,都可以被存到后端数据库中。我们【访问 www.tangshuang.net 获取更多精彩内容】本文版权归作者所有,未经授权不得转载。这里要探讨的是,在你的SDK中,可能会涉【版权所有】唐霜 www.tangshuang.net转载请注明出处:www.tangshuang.net及一些技巧,以解决某些实际的问题。
【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.net原创内容,盗版必究。【未经授权禁止转载】延时批量上报
有些监控系统是实时上报的,有的甚至为了确本文版权归作者所有,未经授权不得转载。本文版权归作者所有,未经授权不得转载。保收集到的信息的完整性,采用<img/>的形式上报用户点击。但是,这种上报在确保本文作者:唐霜,转载请注明出处。【本文受版权保护】实时性和完整性的同时,给后端带来了巨大压未经授权,禁止复制转载。【关注微信公众号:wwwtangshuangnet】力,如果一个网站具有极大的PV,那么日志【访问 www.tangshuang.net 获取更多精彩内容】【版权所有,侵权必究】上报接口将面临巨大的流量压力,弄的不好是【原创内容,转载请注明出处】【原创不易,请尊重版权】自己给自己创造DDos。而解决的办法之一未经授权,禁止复制转载。【本文首发于唐霜的博客】,就是延时批量上报。比如收集到10条后,【本文受版权保护】【版权所有】唐霜 www.tangshuang.net再一起上报。但是假如一直收集不到10条呢本文作者:唐霜,转载请注明出处。【本文受版权保护】?你可以说10条都不到,没有价值。不过,【未经授权禁止转载】【原创不易,请尊重版权】我们可以通过一个throttle的设计,【版权所有】唐霜 www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】让它在一定时间周期内上报。
还有一种,我们并不采取主动策略自动上报日【原创不易,请尊重版权】本文版权归作者所有,未经授权不得转载。志,而是要等到服务端来索要日志,我们内部本文版权归作者所有,未经授权不得转载。【本文首发于唐霜的博客】黑话叫“日志捞取”。可以通过websoc【转载请注明来源】【转载请注明来源】ket或用户访问某些接口的时候,下发一个原创内容,盗版必究。本文作者:唐霜,转载请注明出处。指令,SDK得到这个指令之后再上报。这就【关注微信公众号:wwwtangshuangnet】【关注微信公众号:wwwtangshuangnet】要求,日志数据事先要放在客户端(浏览器)著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】。这就涉及到一个前端数据存储的问题。
转载请注明出处:www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】前端数据存储
如前文所说,如果我们将日志放在内存里面,原创内容,盗版必究。原创内容,盗版必究。那么用户刷新页面,或页面崩溃,这部分数据【原创内容,转载请注明出处】转载请注明出处:www.tangshuang.net就丢失了。当然,如果不需要延时上报,立即【访问 www.tangshuang.net 获取更多精彩内容】【关注微信公众号:wwwtangshuangnet】上报的情况下,前端并不需要存储日志,但是【访问 www.tangshuang.net 获取更多精彩内容】【原创不易,请尊重版权】,我们设计的是延时批量上报,这样可以给我转载请注明出处:www.tangshuang.net【原创内容,转载请注明出处】们带来一些特性,比如按需捞取。既然如此,【原创不易,请尊重版权】原创内容,盗版必究。我们就需要挑选一个前端数据存储的方案。我本文作者:唐霜,转载请注明出处。著作权归作者所有,禁止商业用途转载。推荐的存储方案是indexedDB,和l【原创内容,转载请注明出处】【关注微信公众号:wwwtangshuangnet】ocalStorage相比而言,它不仅具原创内容,盗版必究。【本文受版权保护】有较大的容量(500M),更重要的一个原原创内容,盗版必究。本文版权归作者所有,未经授权不得转载。因在于localStorage无法在we本文作者:唐霜,转载请注明出处。本文版权归作者所有,未经授权不得转载。bworker中被读取,而在我的设计中,本文作者:唐霜,转载请注明出处。原创内容,盗版必究。有一种方案时在webworker中处理日原创内容,盗版必究。原创内容,盗版必究。志和上报日志。
【关注微信公众号:wwwtangshuangnet】【版权所有】唐霜 www.tangshuang.net但是,indexedDB也有不少坑,包括著作权归作者所有,禁止商业用途转载。本文作者:唐霜,转载请注明出处。webworker的坑也不少。index【本文首发于唐霜的博客】【转载请注明来源】edDB的原生操作比较复杂,你可以使用我著作权归作者所有,禁止商业用途转载。【原创不易,请尊重版权】写的库indb实现indexedDB的操作。我在设计时【关注微信公众号:wwwtangshuangnet】【作者:唐霜】,使用了三个store,一个是confi本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.netg,用于在主线程和worker线程之间共本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。享配置,一个是archive,用于存储所著作权归作者所有,禁止商业用途转载。【原创内容,转载请注明出处】有日志,一个是moment,用于存储需要【转载请注明来源】原创内容,盗版必究。立即上报的日志的索引信息(索引字段)。由本文版权归作者所有,未经授权不得转载。本文版权归作者所有,未经授权不得转载。于indexedDB是严格的NoSQL数【版权所有,侵权必究】【转载请注明来源】据库,所以非常适合存储日志。archiv转载请注明出处:www.tangshuang.net【原创内容,转载请注明出处】e这个store将会保存所有被收集到的日本文作者:唐霜,转载请注明出处。【作者:唐霜】志,存储的时候,并不需要按照某个顺序存,【访问 www.tangshuang.net 获取更多精彩内容】本文作者:唐霜,转载请注明出处。而且为了更快存入,存储过程不需要复杂逻辑本文作者:唐霜,转载请注明出处。【本文受版权保护】。
本文版权归作者所有,未经授权不得转载。【版权所有,侵权必究】【访问 www.tangshuang.net 获取更多精彩内容】未经授权,禁止复制转载。上报策略
我在设计时,采用了三种不同的上报周期:
【未经授权禁止转载】未经授权,禁止复制转载。著作权归作者所有,禁止商业用途转载。【本文首发于唐霜的博客】- 批量上报,任何日志,都写到archive著作权归作者所有,禁止商业用途转载。【作者:唐霜】 store中,不需要任何顺序,因为正常著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.net用户操作的顺序并不代表日志入库顺序,因为转载请注明出处:www.tangshuang.net【本文受版权保护】操作会有异步的情况,archive st未经授权,禁止复制转载。转载请注明出处:www.tangshuang.netore中存储着全部被收集的没有被上传的日著作权归作者所有,禁止商业用途转载。【版权所有】唐霜 www.tangshuang.net志 【作者:唐霜】未经授权,禁止复制转载。【作者:唐霜】【原创不易,请尊重版权】
- 立即上报,当发生错误或异常时,往mome【本文首发于唐霜的博客】本文版权归作者所有,未经授权不得转载。nt store里面写入对应的日志索引,本文版权归作者所有,未经授权不得转载。【本文受版权保护】立即上报的周期比较短,所以,当周期到来时【原创不易,请尊重版权】【本文首发于唐霜的博客】,直接将moment store中的全部未经授权,禁止复制转载。原创内容,盗版必究。索引取出,然后到archive stor【本文首发于唐霜的博客】【版权所有】唐霜 www.tangshuang.nete中取出索引对应的全部日志,一次性上报 【本文受版权保护】【关注微信公众号:wwwtangshuangnet】
- 回溯上报,在某些情况下,archive 【访问 www.tangshuang.net 获取更多精彩内容】【原创内容,转载请注明出处】store中的日志过了很久的时间都没有被【关注微信公众号:wwwtangshuangnet】【转载请注明来源】上报,这种情况造成的原因多种多样,不好确【原创不易,请尊重版权】【访问 www.tangshuang.net 获取更多精彩内容】定,但是,这些日志可能又是有用的,因此,【未经授权禁止转载】【本文受版权保护】在一个比较长的周期里面(小于7天,因为i【版权所有,侵权必究】【作者:唐霜】ndexedDB的新策略是会删除7天之后本文作者:唐霜,转载请注明出处。【转载请注明来源】的数据),要从尾往前遍历,把早期存入的但本文版权归作者所有,未经授权不得转载。【原创内容,转载请注明出处】没有上报的日志再次上报 【转载请注明来源】【原创不易,请尊重版权】
在日志设计时,通过日志中的level字段本文版权归作者所有,未经授权不得转载。【关注微信公众号:wwwtangshuangnet】来判别该日志属于什么级别。我自己在处理时本文版权归作者所有,未经授权不得转载。转载请注明出处:www.tangshuang.net,error的是立即上报,其他的是批量上【未经授权禁止转载】【访问 www.tangshuang.net 获取更多精彩内容】报。实际上,我们还可以设计一种有选择性的原创内容,盗版必究。【本文受版权保护】上报,比如有些日志上报了没啥意义,可以不【未经授权禁止转载】【转载请注明来源】用上报,让浏览器自己处理过期日志,但是,本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。如果我们通过服务端发送捞取指令时,又马上【转载请注明来源】【作者:唐霜】把这些日志组织起来进行上报。
【关注微信公众号:wwwtangshuangnet】【本文受版权保护】上报压缩
为了减小流量,我们需要对要上报的日志进行【版权所有】唐霜 www.tangshuang.net著作权归作者所有,禁止商业用途转载。压缩。我自己使用了一个叫pako的库来进本文版权归作者所有,未经授权不得转载。本文版权归作者所有,未经授权不得转载。行gzip压缩,但是压缩会有一个问题,由【转载请注明来源】【本文首发于唐霜的博客】于压缩算法本身要占据一定容量,所以,如果著作权归作者所有,禁止商业用途转载。【作者:唐霜】不采取批量上报的逻辑,那么不需要任何压缩【作者:唐霜】【原创内容,转载请注明出处】,只有当批量上报,且上报数量达到一定数量【版权所有】唐霜 www.tangshuang.net本文版权归作者所有,未经授权不得转载。时才进行压缩,否则压缩一条日志,反而让日【本文首发于唐霜的博客】本文作者:唐霜,转载请注明出处。志容量变大,还要增加服务端解压压力。
【本文受版权保护】本文作者:唐霜,转载请注明出处。原创内容,盗版必究。任务/线程
对于一个前端监控的SDK而言,它有可能和【版权所有】唐霜 www.tangshuang.net【关注微信公众号:wwwtangshuangnet】页面中的其他脚本一起强资源,导致页面卡顿转载请注明出处:www.tangshuang.net【版权所有】唐霜 www.tangshuang.net。因此,我们要想办法,降低SDK对界面的【原创内容,转载请注明出处】【原创内容,转载请注明出处】影响。我提供了两套方案:
【版权所有】唐霜 www.tangshuang.net本文版权归作者所有,未经授权不得转载。【原创不易,请尊重版权】- 启用一个webworker,将所有日志的【原创内容,转载请注明出处】【版权所有】唐霜 www.tangshuang.net处理、存储、上报等等,全部放在worke【本文首发于唐霜的博客】【转载请注明来源】r线程中,主线程仅仅完成数据收集部分,这本文作者:唐霜,转载请注明出处。未经授权,禁止复制转载。样,可以降低日志处理上报时,读写数据库等未经授权,禁止复制转载。转载请注明出处:www.tangshuang.net操作带来的卡顿 本文版权归作者所有,未经授权不得转载。【本文首发于唐霜的博客】未经授权,禁止复制转载。
- 直接在主线程完成日志处理和上报,但是创建【本文受版权保护】【原创内容,转载请注明出处】一个idle任务,只有当页面存在空闲时,转载请注明出处:www.tangshuang.net【未经授权禁止转载】才执行日志处理和上报,当用户在界面进行操本文作者:唐霜,转载请注明出处。本文版权归作者所有,未经授权不得转载。作,并且需要更新界面时,任务会被暂时搁置【未经授权禁止转载】【版权所有】唐霜 www.tangshuang.net,等到有闲暇时间时再进行 【原创不易,请尊重版权】【未经授权禁止转载】转载请注明出处:www.tangshuang.net原创内容,盗版必究。
但是,由于js是单线程运行,所以,即使任转载请注明出处:www.tangshuang.net【本文首发于唐霜的博客】务是异步执行的,仍然还是会占用资源。作为未经授权,禁止复制转载。【版权所有】唐霜 www.tangshuang.net监控SDK,要尽可能不对运行程序产生任何【版权所有,侵权必究】【版权所有】唐霜 www.tangshuang.net影响。
【版权所有,侵权必究】【本文受版权保护】【关注微信公众号:wwwtangshuangnet】异步加载插件
在为Aegis撰写插件时,我们发现SDK转载请注明出处:www.tangshuang.net【关注微信公众号:wwwtangshuangnet】包的体积对收集到一些特定信息很关键,例如本文作者:唐霜,转载请注明出处。【原创内容,转载请注明出处】应用启动时的数据。如果SDK包很大,半天【原创内容,转载请注明出处】本文版权归作者所有,未经授权不得转载。加载不完,等脚本加载完,早都已经过了收集【版权所有,侵权必究】【转载请注明来源】的窗口了。所以,在这种场景下,我们要让S【作者:唐霜】【版权所有,侵权必究】DK尽可能小(10K以内)。但是,很明显【未经授权禁止转载】【版权所有】唐霜 www.tangshuang.net,有些功能,这么小体积是不够的。因此,我著作权归作者所有,禁止商业用途转载。【版权所有,侵权必究】们设计了一套异步加载的插件体系。对于这些原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.net插件而言,它们分为两部分,一部分是直接挂【原创不易,请尊重版权】本文版权归作者所有,未经授权不得转载。在SDK内部,也就是10K以内的代码里面【版权所有】唐霜 www.tangshuang.net【关注微信公众号:wwwtangshuangnet】,收集一些启动时的数据,而收集到的数据暂【本文受版权保护】【原创内容,转载请注明出处】时放在内存中,等异步代码加载完运行之后,原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.net再取出来做下一步处理。
未经授权,禁止复制转载。【作者:唐霜】著作权归作者所有,禁止商业用途转载。打点/无埋点
SDK的灵活性也很重要,在最前面我提到,【访问 www.tangshuang.net 获取更多精彩内容】转载请注明出处:www.tangshuang.net假如开发者只想监听用户在某3个页面之间的本文版权归作者所有,未经授权不得转载。【版权所有】唐霜 www.tangshuang.net操作信息,而不是全部页面的操作信息,该怎【本文首发于唐霜的博客】【本文首发于唐霜的博客】么处理呢?所以,在设计上,我们要提供不同【原创不易,请尊重版权】【本文首发于唐霜的博客】的打点、上报的方式。我在设计时,提供了“原创内容,盗版必究。【关注微信公众号:wwwtangshuangnet】无埋点、片段、单点”x“自动上报、手动上【版权所有】唐霜 www.tangshuang.net未经授权,禁止复制转载。报”的不同组合方式。针对上述问题,这里简原创内容,盗版必究。原创内容,盗版必究。单讲一下怎么实现片段埋点。在前文Serv【未经授权禁止转载】【访问 www.tangshuang.net 获取更多精彩内容】ice那一节我已经指出,对于用户行为的监【未经授权禁止转载】转载请注明出处:www.tangshuang.net听本质上是一个服务,既然是一个服务,那么转载请注明出处:www.tangshuang.net【访问 www.tangshuang.net 获取更多精彩内容】就可以让这个服务开始或停止。因此,在上述【版权所有,侵权必究】【版权所有,侵权必究】这个具体问题上,当用户进入指定页面A时,原创内容,盗版必究。【未经授权禁止转载】启动服务,服务启动之后,用户的所有操作就本文版权归作者所有,未经授权不得转载。【本文首发于唐霜的博客】会被记录到日志中,用户经过B页然后离开C【原创不易,请尊重版权】本文作者:唐霜,转载请注明出处。页时,停止服务,那么用户的这段操作就结束原创内容,盗版必究。【版权所有】唐霜 www.tangshuang.net了,这一连串相关的日志,会被一个相同的t转载请注明出处:www.tangshuang.net【作者:唐霜】raceId串联起来。同样的道理,上报本【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.net身也是一个服务,如果我们再实例化时,让服【转载请注明来源】未经授权,禁止复制转载。务自动运行,上报自动完成,我们也可以选择本文作者:唐霜,转载请注明出处。本文作者:唐霜,转载请注明出处。关闭这个能力,通过手动调用report方本文作者:唐霜,转载请注明出处。【访问 www.tangshuang.net 获取更多精彩内容】法来触发上报逻辑。
本文作者:唐霜,转载请注明出处。【本文首发于唐霜的博客】未经授权,禁止复制转载。隐私策略
监控行为可能涉及到一些隐私策略问题。不同【原创不易,请尊重版权】【原创不易,请尊重版权】的产品,其隐私策略也是不同的。对于开放性【原创内容,转载请注明出处】原创内容,盗版必究。大众产品,针对单用户的行为进行分析,很可本文作者:唐霜,转载请注明出处。转载请注明出处:www.tangshuang.net能能得出针对该用户的一些预测行为,这对商原创内容,盗版必究。转载请注明出处:www.tangshuang.net业公司的吸引力非常大。但是我们要知道,互【版权所有】唐霜 www.tangshuang.net【版权所有】唐霜 www.tangshuang.net联网不是法外之地,我们在实现能力的时候,著作权归作者所有,禁止商业用途转载。【本文首发于唐霜的博客】应该尊重和保护用户隐私。针对隐私问题,S【未经授权禁止转载】转载请注明出处:www.tangshuang.netDK框架应该提供可扩展的能力,遵循“开放本文版权归作者所有,未经授权不得转载。本文版权归作者所有,未经授权不得转载。封闭原则”,让开发者可以自己根据产品需要【本文首发于唐霜的博客】【版权所有】唐霜 www.tangshuang.net,有可以与用户交互的过程,而非一股脑全部本文作者:唐霜,转载请注明出处。【转载请注明来源】封装死,不管三七二十一收集和提交日志。针【访问 www.tangshuang.net 获取更多精彩内容】【原创内容,转载请注明出处】对这个方面,我在设计时,做了如下约束:
【未经授权禁止转载】【原创不易,请尊重版权】- 任何与密码相关的数据不会被记录,包括用户原创内容,盗版必究。原创内容,盗版必究。鼠标在该元素上的操作 未经授权,禁止复制转载。本文作者:唐霜,转载请注明出处。
- 提供特定的html标记,这些标记元素产生【转载请注明来源】【版权所有,侵权必究】的信息不会被收集 本文版权归作者所有,未经授权不得转载。著作权归作者所有,禁止商业用途转载。【作者:唐霜】
- 提供特定的方法,让开发者可以在方法中过滤未经授权,禁止复制转载。著作权归作者所有,禁止商业用途转载。日志,或者做脱敏处理 未经授权,禁止复制转载。【原创不易,请尊重版权】【转载请注明来源】
- 在运转流程上,SDK不是一股脑只完成自己著作权归作者所有,禁止商业用途转载。未经授权,禁止复制转载。的任务,开发者可以控制SDK的运作,比如本文版权归作者所有,未经授权不得转载。【本文受版权保护】只有在征得用户同意后才上传日志 未经授权,禁止复制转载。【访问 www.tangshuang.net 获取更多精彩内容】
总之,隐私策略是产品策略中的重要一环,也【未经授权禁止转载】未经授权,禁止复制转载。是目前我们国家重点关注的一个方面,任何与【本文首发于唐霜的博客】本文版权归作者所有,未经授权不得转载。监控相关的设计都应该慎重考虑。
【本文首发于唐霜的博客】【关注微信公众号:wwwtangshuangnet】【作者:唐霜】【未经授权禁止转载】结语
本文详细阐述了我在前端监控SDK框架的设【本文受版权保护】【未经授权禁止转载】计上的一些经历,虽然没有具体的实现代码,【作者:唐霜】【版权所有,侵权必究】但是文章中所提出的这些理念,都可以帮助开【版权所有,侵权必究】【版权所有】唐霜 www.tangshuang.net发者实现一款自己的SDK框架,在工作中发原创内容,盗版必究。【原创内容,转载请注明出处】挥作用。
【作者:唐霜】本文版权归作者所有,未经授权不得转载。【本文受版权保护】


最近准备整数据上报,感谢博主的这篇文章。