CN112433921A - 用于动态埋点的方法及设备 - Google Patents

Abstract

本申请提供了一种用于动态埋点的方法及设备，能够获取埋点配置信息，再根据获取的埋点配置信息在运行应用中添加埋点，并执行相应埋点以获取用户行为相关信息并发送至服务端，从而实现了在客户端应用中实时、动态添加埋点，还能够监测服务端上埋点配置信息的变化，在有变化时对客户端应用当前使用的埋点配置信息进行更新，实现了埋点的实时更新，从而提高了埋点更新的实时性，降低了埋点与客户端应用的耦合性，减少了埋点上线所需要的时间，避免埋点更新不及时造成用户行为信息收集滞后所带来的问题。

Description

用于动态埋点的方法及设备

技术领域

本申请涉及数据采集领域，尤其涉及一种用于动态埋点的方法及设备。

背景技术

当前，为收集用户在软件界面上的行为相关信息需要在软件应用中进行埋点，埋点代码在客户端收集用户行为信息并将收集信息上报至服务端，服务端上的数据应用可基于这些收集信息进行数据分析。

现有的埋点技术中，埋点代码往往与业务代码有很强的耦合性，想要单独修改埋点代码难以实现，代码维护非常困难，即使有些技术实现了埋点代码和业务代码的解耦合，埋点代码仍然固化在客户端应用中，要修改埋点代码就必须对客户端应用进行修改，而对客户端应用的修改存在多种技术和业务上的障碍，难以实时、动态地在客户端应用中进行埋点。另外，如果需要对埋点代码进行实时更新，现有技术方案也难以做到。

发明内容

本申请的一个目的是提供一种用于动态埋点的方法及设备，用以解决现有技术下难以进行实时、动态埋点和实时更新埋点的问题。

为实现上述目的，本申请提供了一种在客户端用于动态埋点的方法，其中，该方法包括：

获取埋点配置信息；

根据所述埋点配置信息，在相应的运行应用中添加埋点；

执行所述埋点获取用户行为相关信息并向服务端发送。

进一步地，获取埋点配置信息，包括：

从服务端获取所述埋点配置信息，或从本地获取所述埋点配置信息。

进一步地，从本地获取所述埋点配置信息，包括：

在本地缓存中查找所述埋点配置信息，若查找到则获取所述本地缓存中的埋点配置信息，否则获取默认的埋点配置信息。

进一步地，所述埋点配置信息包括如下一种或多种的任意组合：埋点事件信息、埋点上报相关信息。

进一步地，获取埋点配置信息之前，还包括：

接收服务端发送的动态埋点指令；

若所述动态埋点指令为允许，则进行动态埋点。

进一步地，该方法还包括：

监测服务端的标准埋点配置信息的变化；

若监测到变化，则获取所述标准埋点配置信息，并将所述标准埋点配置信息与当前使用的埋点配置信息进行一致性比较；

若一致性比较结果为不一致，则使用所述标准埋点配置信息更新所述当前使用的埋点配置信息；

根据更新后的所述当前使用的埋点配置信息，更新相应的运行应用中的埋点；

执行更新后的埋点获取所述用户行为相关信息并向服务端发送。

进一步地，将所述标准埋点配置信息与当前使用的埋点配置信息进行一致性比较，包括：

将所述标准埋点配置信息对应的hash信息与当前使用的埋点配置信息对应的hash信息进行比较。

基于另一方面，本申请还提供了一种在服务端用于动态埋点的方法，其中，该方法包括：

接收客户端发送的用户行为相关信息。

进一步地，该方法还包括：

接收所述客户端发送的埋点配置信息获取指令，根据所述指令向客户端返回埋点配置信息。

进一步地，该方法还包括：

向所述客户端发送动态埋点指令，以使所述客户端根据所述动态埋点指令确定是否进行动态埋点。

进一步地，该方法还包括：

接收客户端发送的标准埋点配置信息的元信息获取指令；

根据所述元信息获取指令向客户端发送所述标准埋点配置信息的元信息。

本申请还提供了一种设备，该设备包括用于存储计算机程序指令的存储器和用于执行程序指令的处理器，其中，当该计算机程序指令被该处理器执行时，触发该设备执行前述在客户端用于动态埋点的方法或在服务端用于动态埋点的方法。

本申请还提供了一种计算机可读介质，其上存储有计算机可读指令，所述计算机可读指令可被处理器执行以实现前述在客户端用于动态埋点的方法或在服务端用于动态埋点的方法。

与现有技术相比，本申请提供的方案能够获取埋点配置信息，再根据获取的埋点配置信息在运行应用中添加埋点，并执行相应埋点以获取用户行为相关信息并发送至服务端，从而实现了在客户端应用中实时、动态添加埋点，还能够监测服务端上埋点配置信息的变化，在有变化时对客户端应用当前使用的埋点配置信息进行更新，实现了埋点的实时更新，从而提高了埋点更新的实时性，降低了埋点与客户端应用的耦合性，减少了埋点上线所需要的时间，避免埋点更新不及时造成用户行为信息收集滞后所带来的问题。

附图说明

通过阅读参照以下附图所作的对非限制性实施例所作的详细描述，本申请的其它特征、目的和优点将会变得更明显：

图1为本申请的一些实施例提供的一种在客户端用于动态埋点的方法的流程图；

图2为本申请的一些优选实施例提供的一种在客户端用于动态更新埋点的流程图；

图3为本申请的一些优选实施例提供的动态化埋点配置文件的加载过程的流程图；

图4为本申请的一些实施例提供的一种在服务端用于动态埋点的方法的流程图；

图5为本申请的一些实施例提供的服务端和客户端设备的结构示意图。

附图标记：1、服务端，2、客户端，3、处理器，4、存储器。

具体实施方式

下面结合附图对本申请作进一步详细描述。

在本申请一个典型的配置中，终端、网络设备均包括一个或多个处理器(CPU)、输入/输出接口、网络接口和内存。

内存可能包括计算机可读介质中的非永久性存储器，随机存取存储器(RAM)和/或非易失性内存等形式，如只读存储器(ROM)或闪存(flash RAM)。内存是计算机可读介质的示例。

计算机可读介质包括永久性和非永久性、可移动和非可移动媒体可以由任何方法或技术来实现信息存储。信息可以是计算机可读指令、数据结构、程序的模块或其他数据。计算机的存储介质的例子包括，但不限于相变内存(PRAM)、静态随机存取存储器(SRAM)、动态随机存取存储器(DRAM)、其他类型的随机存取存储器(RAM)、只读存储器(ROM)、电可擦除可编程只读存储器(EEPROM)、快闪记忆体或其他内存技术、只读光盘(CD-ROM)、数字多功能光盘(DVD)或其他光学存储、磁盒式磁带，磁带磁盘存储或其他磁性存储设备或任何其他非传输介质，可用于存储可以被计算设备访问的信息。按照本文中的界定，计算机可读介质不包括非暂存电脑可读媒体(transitory media)，如调制的数据信号和载波。

图1示出了本申请的一些实施例提供的一种在客户端用于动态埋点的方法，该方法具体可包括如下步骤：

步骤S101，获取埋点配置信息；

步骤S102，根据所述埋点配置信息，在相应的运行应用中添加埋点；

步骤S103，执行所述埋点获取用户行为相关信息并向服务端发送。

该方案尤其适合用于希望对客户端应用进行埋点的场景，能够在客户端获取埋点配置信息，并根据获取的埋点配置信息在相应的运行应用中添加埋点，再执行添加的埋点获取用户行为相关信息并发送到服务端。

客户端可以是能够通过网络访问服务端的各种电子设备，其可以实现为硬件设备或软件。当客户端端包括硬件时，其可包括但不限于智能手机、平板电脑、电子书阅读器、膝上型便携计算机和台式计算机等等。当客户端端包括软件时，可以安装在上述各种电子设备中，并可以实现为单个或多个软件模块。

服务端可以包括支持网络连接从而提供各种网络服务的硬件设备或软件。当服务端包括硬件时，其可以实现成多个网络设备组成的分布式设备群，也可以实现成单个网络设备，如实现成分布式服务器或单个服务器。当服务端包括软件时，可以安装在上述所列举的网络设备中。这时，作为软件，其可以实现成例如用来提供分布式服务的多个软件或软件模块，也可以实现成单个软件或软件模块。在此不做具体限定。

在步骤S101中，客户端首先获取埋点配置信息。在此，埋点配置信息是用于指明埋点配置的相关信息，埋点配置信息中可包括多个埋点配置项，每个埋点配置项可用于指明一项具体的埋点配置。通过使用可描述埋点的埋点配置信息，可解除埋点与客户端的耦合，客户端通过埋点配置信息而不是固定的埋点代码进行埋点，可实现灵活、实时、动态的埋点。埋点配置信息的载体可以有多种，例如配置文件、配置字符串等。

本申请的一些实施例中，埋点配置信息可以包括如下信息：埋点事件信息、埋点上报相关信息，也可以是上述信息的任意组合，还可以是根据用户需要所设置的其它信息等。在此，埋点事件信息可包括与埋点的触发事件相关的信息，例如埋点事件标识、埋点事件类型等。埋点上报相关信息可包括埋点获取的用户行为相关信息，例如埋点上报平台信息，可用于指明用户行为相关信息上报到什么平台，平台的标识及地址等；还例如埋点上报内容信息，可用于指出埋点上报的具体内容等。

本申请的一些优选实施例中，埋点配置信息可保存在配置文件中，基于AOP的动态埋点方案的配置文件可设计如下表1所示：

表1

本申请的一些实施例中，获取埋点配置信息，既可以从服务端获取埋点配置信息，也可以从本地获取埋点配置信息。在此，如果从服务端获取埋点配置信息，则客户端可向服务端发送埋点配置获取指令，服务端接收到埋点配置获取指令后根据该指令获取相应的埋点配置信息，再将该埋点配置信息返回至客户端。

本申请的一些实施例中，从本地获取埋点配置信息，可以先在本地缓存中查找埋点配置信息，若查找到则获取本地缓存中的埋点配置信息，否则获取默认的埋点配置信息。在此，默认的埋点配置信息是客户端应用默认使用的埋点配置信息，其中的埋点配置项已经有预先设定好的取值。通过首先在本地缓存中查找埋点配置信息，可让客户端优先使用当前最近时间使用的埋点配置信息，避免使用可能不准确的默认埋点配置信息。

本申请的一些实施例中，在获取埋点配置信息之前，还可以接收服务端发送的动态埋点指令，若该动态埋点指令为允许，则进行动态埋点。在此，客户端是否进行动态埋点可由服务端进行控制，客户端可主动向服务端发送请求以获得服务端返回的动态埋点指令，服务端也可主动向客户端发送动态埋点指令，该动态埋点指令中包括是否允许客户端进行动态埋点的确认信息，如果允许进行动态埋点，则客户端执行获取埋点配置信息及根据埋点配置信息进行埋点的操作，如果不允许进行动态埋点，则客户端不执行获取埋点配置信息及后续操作。通过由服务端来控制是否对客户端进行动态埋点，使得服务端可根据自身的客户端信息收集需求确定对哪些客户端进行动态埋点，例如服务端可分别对不同类型的客户端设置允许进行动态埋点或不允许进行动态埋点，从而获取不同类型客户端的相关信息。

在步骤S102中，客户端根据该埋点配置信息，在相应的运行应用中添加埋点。在此，客户端通过AOP(Aspect Oriented Programming，面向切面编程)技术预先建立埋点配置信息与相应应用在运行时的调用关系，AOP技术通过预编译和运行期动态代理实现了应用功能的统一维护，因此，客户端应用在运行时可动态增加埋点配置信息中的相应埋点。

在步骤S103中，客户端执行埋点获取用户行为相关信息并向服务端发送。在此，客户端上运行的应用添加了埋点之后，在埋点中定义的事件触发后，采集相应的用户行为相关信息，并把采集信息发送到服务端，供服务端进行后续的数据分析。

本申请的一些实施例中，客户端还可以根据服务端埋点配置信息的变化对当前使用的埋点配置信息进行更新，如图2所示，具体可包括如下步骤：

步骤S201，监测服务端的标准埋点配置信息的变化。在此，服务端可维护有标准埋点配置信息，该标准埋点配置信息可作为客户端上的埋点配置信息的基准信息，客户端上的埋点配置信息与标准埋点配置信息不一致时，以该标准埋点配置信息为准。通过在服务端上设置标准埋点配置信息，如果需要对多个客户端上的埋点进行修改，只需要修改服务端上的标准埋点配置信息，再让多个客户端根据服务端上修改后的标准埋点配置信息进行相应修改，从而使得多个客户端上的埋点保持一致，避免多个客户端由于埋点版本不一致导致采集的客户端信息不准确，进行导致后续的数据分析工作不准确的问题。

客户端监测标准埋点配置信息的变化可采用多种实现方法，例如可以是客户端主动的拉模式，也可以是服务端主动的推模式。客户端主动的拉模式中，客户端可向服务端发送标准埋点配置信息的元信息获取指令，服务端根据接收的元信息获取指令获取相应的元信息，再将元信息返回给客户端，这里的元信息是指标准埋点配置信息的元数据信息，例如标准埋点配置信息的总字符数、其中配置项的项数等。服务端主动的推模式中，服务端可在标准埋点配置信息的内容发生变化后，主动向客户端发送标准埋点配置信息变化的通知，客户端接收到通知后得知标准埋点配置信息已经发生变化。

步骤S202，若监测到变化，则获取该标准埋点配置信息，并将该标准埋点配置信息与当前使用的埋点配置信息进行一致性比较。

本申请的一些实施例中，将标准埋点配置信息与当前使用的埋点配置信息进行一致性比较，可采用将标准埋点配置信息对应的hash信息与当前使用的埋点配置信息对应的hash信息进行比较的方式。在此，可通过多种hash算法来获得对应的hash信息，例如hash算法可为MD5或SHA等。计算标准埋点配置信息对应的hash信息和当前使用的埋点配置信息对应的hash信息需要使用的hash算法为相同的hash算法，例如两者都使用MD5算法或SHA算法，不可以一个使用MD5算法，一个使用SHA算法。

步骤S203，若一致性比较结果为不一致，则使用标准埋点配置信息更新当前使用的埋点配置信息。在此，可使用AOP技术实现用标准埋点配置信息更新当前使用的埋点配置信息。此外，客户端还可以在当前使用的埋点配置信息更新完成后，将更新后的埋点配置信息保存到本地缓存中，供下次使用。

步骤S204，根据更新后的当前使用的埋点配置信息，更新相应的运行应用中的埋点。在此，可通过HOOK技术或Method Swizzling技术来更新运行应用中的埋点代码，HOOK技术是改变应用程序运行流程的一种技术，通过HOOK技术可以让应用中的函数执行前插入代码；Method Swizzling技术可以在运行时交换两个函数方法的具体实现。

步骤S205，执行更新后的埋点获取用户行为相关信息并向服务端发送。

图3示出了本申请的一些优选实施例中动态化埋点配置文件的加载流程，其中，客户端从小流量平台即上报平台获取动态化埋点开关，该开关包括在前述动态埋点指令中，若该开关为开启，则执行后续的动态埋点，若该开关为关闭，则不进行后续的操作；在进行后续的动态埋点时，首先判断是否有缓存过的配置文件，若缓存中有配置文件，则解析缓存中的配置文件，在对应方法中插入埋点代码，若缓存中不存在配置文件，则解析内置的配置文件(即默认的埋点配置文件)，在对应方法中插入埋点代码。在后面的流程中，客户端还通过开启云端资源文件变动监听来监测配置文件的改变，若配置文件发生改变，则将云端的配置文件与客户端当前使用的配置文件进行遍历对比，比较每条埋点数据(即埋点配置项)的hash值，如果埋点数据有变动则重新插入埋点代码，最后将最新的配置文件进行缓存。

图4示出了本申请的一些实施例提供的一种在服务端用于动态埋点的方法，该方法具体可包括如下步骤：

步骤S401，接收客户端发送的用户行为相关信息。在此，客户端通过实时动态埋点方式进行了埋点之后，通过埋点获取相应的用户行为相关信息，再将用户行为相关信息发生至服务端。

本申请的一些实施例中，服务端还可以接收客户端发送的埋点配置信息获取指令，并根据该指令向客户端返回埋点配置信息。

本申请的一些实施例中，服务端还可以向客户端发送动态埋点指令，以使客户端根据该动态埋点指令确定是否进行动态埋点。

本申请的一些实施例中，服务端还可以接收客户端发送的标准埋点配置信息的元信息获取指令，再根据该元信息获取指令向客户端发送标准埋点配置信息的元信息。

本申请的一些实施例还提供了一种设备，该设备包括用于存储计算机程序指令的存储器和用于执行程序指令的处理器，其中，当该计算机程序指令被该处理器执行时，触发该设备执行前述在客户端用于动态埋点的方法或在服务端用于动态埋点的方法。图5示出了本申请的一些实施例的服务端和客户端的结构图，服务端1与客户端2通过网络连接，服务端1与客户端2中都存在处理器3和存储器4，处理器3用于执行相应的程序指令，存储器4用于存储相应的程序指令。

本申请的一些实施例还提供了一种计算机可读介质，其上存储有计算机可读指令，所述计算机可读指令可被处理器执行以实现前述在客户端用于动态埋点的方法或在服务端用于动态埋点的方法。

综上所述，本申请提供的方案能够获取埋点配置信息，再根据获取的埋点配置信息在运行应用中添加埋点，并执行相应埋点以获取用户行为相关信息并发送至服务端，从而实现了在客户端应用中实时、动态添加埋点，还能够监测服务端上埋点配置信息的变化，在有变化时对客户端应用当前使用的埋点配置信息进行更新，实现了埋点的实时更新，从而提高了埋点更新的实时性，降低了埋点与客户端应用的耦合性，减少了埋点上线所需要的时间，避免埋点更新不及时造成用户行为信息收集滞后所带来的问题。

需要注意的是，本申请可在软件和/或软件与硬件的组合体中被实施，例如，可采用专用集成电路(ASIC)、通用目的计算机或任何其他类似硬件设备来实现。在一个实施例中，本申请的软件程序可以通过处理器执行以实现上文所述步骤或功能。同样地，本申请的软件程序(包括相关的数据结构)可以被存储到计算机可读记录介质中，例如，RAM存储器，磁或光驱动器或软磁盘及类似设备。另外，本申请的一些步骤或功能可采用硬件来实现，例如，作为与处理器配合从而执行各个步骤或功能的电路。

另外，本申请的一部分可被应用为计算机程序产品，例如计算机程序指令，当其被计算机执行时，通过该计算机的操作，可以调用或提供根据本申请的方法和/或技术方案。而调用本申请的方法的程序指令，可能被存储在固定的或可移动的记录介质中，和/或通过广播或其他信号承载媒体中的数据流而被传输，和/或被存储在根据所述程序指令运行的计算机设备的工作存储器中。在此，根据本申请的一个实施例包括一个设备，该设备包括用于存储计算机程序指令的存储器和用于执行程序指令的处理器，其中，当该计算机程序指令被该处理器执行时，触发该设备运行基于前述根据本申请的多个实施例的方法和/或技术方案。

对于本领域技术人员而言，显然本申请不限于上述示范性实施例的细节，而且在不背离本申请的精神或基本特征的情况下，能够以其他的具体形式实现本申请。因此，无论从哪一点来看，均应将实施例看作是示范性的，而且是非限制性的，本申请的范围由所附权利要求而不是上述说明限定，因此旨在将落在权利要求的等同要件的含义和范围内的所有变化涵括在本申请内。不应将权利要求中的任何附图标记视为限制所涉及的权利要求。此外，显然“包括”一词不排除其他单元或步骤，单数不排除复数。装置权利要求中陈述的多个单元或装置也可以由一个单元或装置通过软件或者硬件来实现。第一，第二等词语用来表示名称，而并不表示任何特定的顺序。

Claims (13)

1.一种在客户端用于动态埋点的方法，其中，该方法包括：

获取埋点配置信息；

根据所述埋点配置信息，在相应的运行应用中添加埋点；

执行所述埋点获取用户行为相关信息并向服务端发送。

2.根据权利要求1所述的方法，其中，获取埋点配置信息，包括：

从服务端获取所述埋点配置信息，或从本地获取所述埋点配置信息。

3.根据权利要求2所述的方法，其中，从本地获取所述埋点配置信息，包括：

在本地缓存中查找所述埋点配置信息，若查找到则获取所述本地缓存中的埋点配置信息，否则获取默认的埋点配置信息。

4.根据权利要求1至3中任一项所述的方法，其中，所述埋点配置信息包括如下一种或多种的任意组合：埋点事件信息、埋点上报相关信息。

5.根据权利要求1所述的方法，其中，获取埋点配置信息之前，还包括：

接收服务端发送的动态埋点指令；

若所述动态埋点指令为允许，则进行动态埋点。

6.根据权利要求1所述的方法，其中，该方法还包括：

监测服务端的标准埋点配置信息的变化；

若监测到变化，则获取所述标准埋点配置信息，并将所述标准埋点配置信息与当前使用的埋点配置信息进行一致性比较；

若一致性比较结果为不一致，则使用所述标准埋点配置信息更新所述当前使用的埋点配置信息；

根据更新后的所述当前使用的埋点配置信息，更新相应的运行应用中的埋点；

执行更新后的埋点获取所述用户行为相关信息并向服务端发送。

7.根据权利要求6所述的方法，其中，将所述标准埋点配置信息与当前使用的埋点配置信息进行一致性比较，包括：

将所述标准埋点配置信息对应的hash信息与当前使用的埋点配置信息对应的hash信息进行比较。

8.一种在服务端用于动态埋点的方法，其中，该方法包括：

接收客户端发送的用户行为相关信息。

9.根据权利要求8所述的方法，其中，该方法还包括：

接收所述客户端发送的埋点配置信息获取指令，根据所述指令向客户端返回埋点配置信息。

10.根据权利要求8所述的方法，其中，该方法还包括：

向所述客户端发送动态埋点指令，以使所述客户端根据所述动态埋点指令确定是否进行动态埋点。

11.根据权利要求8所述的方法，其中，该方法还包括：

接收客户端发送的标准埋点配置信息的元信息获取指令；

根据所述元信息获取指令向客户端发送所述标准埋点配置信息的元信息。

12.一种设备，该设备包括用于存储计算机程序指令的存储器和用于执行程序指令的处理器，其中，当该计算机程序指令被该处理器执行时，触发该设备执行权利要求1至7中任一项所述的方法或权利要求8至11中任一项所述的方法。

13.一种计算机可读介质，其上存储有计算机可读指令，所述计算机可读指令可被处理器执行以实现如权利要求1至11中任一项所述的方法。

Images