通用埋点验证操作指引

1.1 Web JS SDK

1.1.1 检查项验证

1.1.2 集成验证

1. 打开Web页面后，在浏览器控制台可以看到“sdk is ready ”证明sdk初始化成功。

   

2. 选择网络，如果成功完成了代码埋点，那么每在web界面点击一次就会上报一次list接口，您可以检查：

   • 查看list接口的http code是否为200，以及接口返回值是否为e:0。
   • 在载荷中看自定义的事件及属性上报。
     如果接口http code为200，返回值e:0，并且可以看到自定义的事件及自定义属性证明事件上报成功。
   

   如果返回值e:返回值非0时，可对照此表再做下排查。

   返回字段	类型	返回值说明
   e	int	状态码： 0：正常 -1：请求参数校验错误（缺少user、header或event） -2：event格式错误 -3：请求参数解析错误（无解析json） -4：不支持的请求类型 -5：请求数组过长（只针对list接口，限制50） -6：请求中event数过多（限制50） -7：获取APPID错误 -8：解析user错误（多为内部错误） -9：解析header错误（多维内部错误） -10：解析event错误（多为内部错误） -11：数据向下游发送错误（内部错误） -12：event数组为空 -100：未知错误
   m	string	错误信息，只在请求verbose非0时出现
   tc	int	请求中总event数
   sc	int	被成功解析并收集的event数

1.2 Android SDK

1.2.1 检查项验证

以上检查验证完之后就可以调用相关api，比如用户、事件等api上报。

1.2.2 集成验证

1.2.2.1 开发工具验证（Android stuido）

1. 看到图片标注的两个证明sdk初始化成功（前提需要在初始化打开日志开关才可以看见）

   

2. 当上报事件的时候，查看事件是否上报成功，需要使用抓包或者埋点验证功能，参考1.2.2.2 或者1.2.2.3。

1.2.2.2 DevTools验证事件上报

功能说明：埋点开发者工具
按照文档接入DevTools后，打开DevTools面板查看接入状态、参数配置、事件上报和日志请求等
判断本地上报是否正常的参考：

• 信息栏中状态为已启动，且有SSID、BD_DID等信息
• 事件列表中的事件存在已上报状态
• 网络列表中/service/2/app_log/接口状态为200（绿色）

1.2.2.3 埋点验证功能验证

功能说明：实时埋点检测
需要按照实时埋点的相关要求集成，当集成成功后在数据管理-一般事件，点击验证埋点，选择移动端

扫码之后会实时看到上报的行为数据，左侧为实时的行为，右侧为对应行为的属性信息

1.2.2.4 抓包验证

配置好抓包工具，选择数据上报地址对应的接口查看app_logevent_v3的接口
saas地址：http://toblog.volceapplog.com，私有部署需要选择对应的数据上报地址

1.3 iOS SDK

1.3.1 检查项验证

以上检查验证完之后就可以调用相关api，比如用户、事件等api上报

1.3.2 集成验证

1.3.2.1 开发者工具验证

1. 初始化中打开log开关，可以在output中看到Track Launch event相关信息证明sdk初始化成功

   

2. 上报用户数据或者事件数据后可以在ouput中看到对应的事件，证明事件及属性发送成功

   

1.3.2.2 DevTools验证事件上报

功能说明：埋点开发者工具
在Debug环境下接入DevTools，可以实时本地查看埋点上报状态、调试日志、配置参数等信息。

判断本地上报是否正常的参考：

• 信息栏中状态为Running，且有SSID、BD_DID等信息
• 事件列表中的事件存在已上报状态

1.3.2.3 埋点验证功能验证

功能说明：实时埋点检测
需要按照实时埋点的相关要求集成，当集成成功后在数据管理-一般事件，点击验证埋点，选择移动端

扫码之后会实时看到上报的行为数据，左侧为实时的行为，右侧为对应行为的属性信息

1.3.2.3 抓包验证

配置好抓包工具，选择数据上报地址对应的接口查看app_logevent_v3的接口
saas地址：http://toblog.volceapplog.com，私有部署需要选择对应的数据上报地址

1.4 小程序 SDK（微信小程序为例）

1.4.1 检查项验证

以上检查验证完之后就可以调用相关api，比如用户、事件等api上报

1.4.2 集成验证

1.4.2.1 开发工具验证

1. 集成完成编译在调试器Console中看到以下信息证明sdk初始化成功

   

2. 在调试器network中验证是否有list接口上报，并且状态码为200

   

3. 当点击代码埋点的按钮会触发相应的埋点事件，可以在network中找list?tea接口查看事件的具体信息，如果状态码是200证明事件上报成功

   

1.4.2.2 真机验证可以通过实时埋点监测或者抓包

功能说明：实时埋点检测
需要按照实时埋点的相关要求集成，当集成成功后在数据管理-一般事件，点击验证埋点，选择微信小程序，按照指示上传小程序码

扫码之后会实时看到上报的行为数据，左侧为实时的行为，右侧为对应行为的属性信息

1.4.2.3 DevTools验证事件上报

功能说明：埋点开发者工具
通过小程序SDK埋点开发工具（DevTools组件），可以在开发阶段便捷的对埋点内容和格式进行检查，该工具提供了环境信息查看、初始化信息状态查看、事件日志查看等功能。

判断本地上报是否正常的参考：

• init、send等api的调用情况，上报域名以及初始化状态；
• 事件列表中的事件存在已上报状态；

1.5 服务端SDK（java语言）

1.6 Http API

1.6.1 验证基本配置项

验证Header中Appkey的配置是否正确，不要写成appid

需要配置为以下结果：

1.6.2 检查响应报文

• 如果响应报文中e的值 不为0，说明没有上报成功
• 如果返回成功（e=0）,但在系统依然没看到数据，请检查local_time_ms事件时间戳：
  • 是否设置的是当天时间，如果是当天时间，数据可以实时在系统看到；
  • 如果非当天时间，且在窗口期之内(过去7天以内以及未来24小时内)，数据需要第二天才能看到，因为非当天数据需要跑批，所以建议测试的时候使用当天时间戳进行测试；
  • 如果时间在窗口期之外(7天前以及超过未来24小时），数据是不会落库的；
  • 如果时间在窗口期之外(7天前以及超过未来24小时），并且想上报历史数据或者说窗口期外的数据，需要增加is_history标识，local_time_ms为当天的可实时看到，非当天的第二天看到

1.6.3 常见问题

Q1:接口返回500或者404或者不能连接成功

接口的问题，需要检查接口是不是通
Q2：报错：get appid error

appkey不对，需要填写正确的appkey
Q3:报错：parse web/mp data error

此报错为body体的参数写的有问题，检查body体即可，正常参考

[{
    "user": {
        "user_unique_id": "useid1"
    },
    "header": {
        "app_name": "test031701",
        "ab_sdk_version": "24",
        "app_version":"1.0.1.2",
        "custom": {
              "public_prop222": "22222" 
        }
    },
    "events": [
        {
            "ab_sdk_version": "24",
            "event": "track11",
            "params": "{\"pay_real\":\"2990\", \"pro_type\":\"4\"}",
            "local_time_ms": 1656582814712
        }
    ]
}]

Q4:匿名用户如何上报，如何做到数据打通？
前提需要集成客户端sdk，提前拿到设备id，具体参考文档HTTP API数据上报方案
Q5:对于匿名用户场景，不集成客户端SDK是否可以上报
不能，对于匿名用户需要上报deviceID或者bddid，这两个id是需要集成客户端生成的，然后透传给服务端
Q6:私有部署历史数据服务端数据上传的时候，数据实时的吗？还是事件是实时的，用户属性是非实时的
数据是否实时取决于local_time_ms是什么时候的事件戳
Q7:通过服务端HTTP API提交数据的时候对多线程有没有限制？对于历史数据比较多的情况，每次post 20条效率太低
api是可以导入历史数据，每次最多20条的限制目前是没有办法修改，一天数据量三四十万，性能测试显示单实例上报并发数两百内上报都是OK的

1. 在数据管理-一般事件/事件属性/用户属性中验证，上报的自定义事件和自定义属性在事件列表、事件属性和用户属性列表是否存在。

   

2. 用户-用户细查，按照ssid或者uuid查询看用户的具体行为，看下用户是否存在，行为事件是否有

   
   

3. 也可以在高级分析-事件分析验证，但是需要注意如果是当天传的数据，查询数据的时候日期需要选择今天

   

4. 当用户细查或者事件分析可以看到上报的数据，那么sdk集成与事件上报就都成功了。

5. 如果用户未上报成功，需要看下是否调用设置用户（user_unique_id）的api，不设置user_unique_id那么用户就都是匿名的。

6. 如果浏览器开发者网络中list显示成功，但是系统未找到某些事件或者事件属性，可以在数据管理-数据质量查看有没有上报失败的事件和属性。
   数据质量功能介绍：数据治理看板

3.1 APP内嵌H5验证

说明：如果可以需要做app内嵌H5打通可做以下检查，如果不需要可忽略

3.1.1 检查项验证

• H5页面是否集成JS sdk
• H5页面集成JS sdk后，初始化的Nataive参数是否为true（5.1.3版本之前Native:true，5.1.3版本之后为enable_native:true)
• 移动端是否集成移动端的sdk（ios，android）
• 移动端集成中是否参考各端集成代码做集成，需要做两点
  • 打开初始化中打开H5Bridge开关
  • 配置白名单，以android集成文档截图为例
    

3.1.2 数据验证

• 当数据打通后，使用app上报行为事件数据，通过实时埋点监测或者抓包工具查看对应行为事件中platform字段的值是wap还是ios/android：

  • 如果是wap证明数据没有打通，需要做相应的检查。
  • 如果是ios/android证明数据打通成功。

• 实时埋点监测和抓包参考上方各端验证说明

• 实时埋点监测数据参考

  

  抓包工具数据参考：

  • 打通参考（platform为android）：

    

  • 未打通platform为wap

    

• 当实时埋点监测或者抓包显示行为事件的platform属性为ios/android，可以在系统-用户细查查看对应用户的行为，确定此用户行为事件中platform是否为ios/android，并且看下H5触发的事件埋点和移动端触发的事件埋点是否为同一个用户，如果这两个验证成功那么证明app内嵌H5数据打通成功