ClkLog 集成指南

为了让大家能更顺利地完成 ClkLog 的各项数据集成，我们总结了几项常见问题并做了详细的说明。

包括有：会话、浏览页面事件、用户集成、自定义事件等。

希望大家通过以下说明能快速定位并处理问题。

一、基础事件集成

在使用 ClkLog 作为神策 SDK（如 WEB JS、Android&iOS、React-Native 等客户端）的数据接收端时，需注意以下几点

1.1.会话集成

ClkLog 的基础流量统计指标中的访问次数、平均访问页数、访问时长、用户画像列表都与会话有关，所以集成 SDK 后首先需要排查会话是否集成。

如果采集的日志中事件属性包含 $event_session_id 属性并且有值，则说明会话集成成功。

会话的集成方法：

1）直接开启：如 Android&iOS、React-Native 的 SDK 可直接 enableSession。

2）集成插件：如 web js sdk 需集成 session-event 。

3）自己实现：如 uni-app sdk 、 unity3d sdk。

以上 SDK demo 参考官网-技术指南-集成测试参考。

其他端的 SDK 中会话的集成请参考神策官方文档或查看 SDK 源码。

1.2.浏览页面事件集成

ClkLog 的基础浏览统计指标中的浏览量指标基于浏览页面事件。

由于神策不同客户端的 SDK 的浏览页面事件的事件名称不同，ClkLog 根据神策 SDK 的浏览页面事件定义对各种端做了不同的统计分析处理。

神策各端 SDK 的浏览页面事件如下：

● Web：$pageview

● Android&iOS：$AppViewScreen

● 小程序：$MPViewScreen

● 其他端: ClkViewScreen。ClkViewScreen 事件是 ClkLog 付费版中定义的除 Web、Android&iOS、小程序端以外的其他端的 SDK 想要进行受访页面统计分析的通用事件。参考官网-技术指南-神策无全埋点的 SDK 集成方案

在实际应用过程中请根据不同版本的 SDK 去查询相关的事件数据, 如果在 ClkLog 统计前端浏览量无数据请根据埋点项目所引用的 SDK 去排查采集到的日志记录是否有相应的浏览页面事件。

二、登录用户的集成(付费版)

当用户登录时，需主动调用神策 SDK 的 login 接口，将用户的注册信息（一般为用户在业务系统中的唯一身份标识）传入。

Web JS 用户登录接口示例：sensors.login('login_user_id');

参考官网-技术指南-集成说明-核心功能-2简易用户关联集成

更多其他端（如 Andriod、IOS、微信小程序等）用户登录集成代码接入方式请参考神策官方 SDK 集成文档。

三、  自定义事件/用户属性集成(付费版)

3.1.元数据管理

注意：在集成自定义事件/用户属性之前需在【元数据管理】处导入或定义事件、事件属性及用户属性。

元数据是按项目根据业务系统定义的自定义事件、神策预置事件的事件及属性（事件、用户、公共）的管理。

在集成前端自定义事件/用户属性的代码埋点之前，需要先在【元数据管理】处下载预置事件、预置属性、用户属性相关模板，并根据实际情况定义好要采集的事件（预置和自定义）、事件属性（预置和自定义）、用户属性（预置和自定义）添加或导入【ClkLog 后台】-【元数据管理】相关库后再进行代码埋点，否则 SDK 全埋点相关的事件日志不会被同步至事件表，进而导致 ClkLog 后台的【自定义分析】功能统计的事件数量和原始采集的日志数据量不一致。

相关更多说明请参考官网-技术指南-集成说明-核心功能-3.事件分析集成

3.2.日志查询

日志查询功能用于帮助开发者在事件分析相关埋点代码集成成功后，查看埋点的相关事件及其属性是否成功采集。

注意：日志查询中有数据的前提条件如下

1、ClkLog 的 receiver 服务可以正常接收客户端采集的日志数据并存入 kafka。

2、ClKLog 的 processing 服务可以正常依托 flink，消费 kafka 数据并存入 clickhouse。

3、ClkLog 的 api 服务可以正常访问。

日志查询数据可埋点日志数据不一致可能出现的问题和排查方法如下：

Q1：控制台有事件日志，但日志查询中无数据。

A1：请检查：

✓ 在【元事件管理-元事件】中是否定义相关事件并关联相关属性。

Q2: 日志查询中的事件属性和控制台打印的事件属性数量不一致。

A2：请检查：

✓ 在【元事件管理-事件属性】中是否定义相关属性。

✓ 在【元事件管理-元事件】中是否将事件属性和事件进行关联。

Q3：埋点设置用户属性后控制台有用户属性，但日志查询中的事件没有用户属性。

A3：请检查：

✓ 用户登录后是否设置用户 ID（用户 ID 不能是 androidid 之类的关键词）。

✓ 在【元事件管理-用户属性】中未定义项目的用户属性（用户属性不能是 label 之类的关键词）。

祝大家集成顺利

用得满意