产品功能介绍:北极星- IM 问题排查工具

概述

IM 北极星主要为开发者提供了终端用户连接状态、消息流转状态、回调服务查询功能:

  1. 通过查看用户的连接日志,判断用户某时间段内是否可以正常使用融云服务,如:用户反馈消息发送不成功,可能是因为该用户在此时间段内没有成功连接融云。
  2. 通过查看消息的整个发送过程状态,分析出收不到消息的原因,帮助开发者定位问题,提高问题解决效率。
  3. 支持查询 IM 消息路由、在线状态订阅、用户注销与激活状态三个回调服务,可查看每次回调的时间、URL、响应状态码及相应内容详情,当应用服务器没有收到相关回调时,可通过北极星回调查询回溯回调数据。

登录融云开发者后台北极星页面,即可查看应用内,用户最近 7 天的连接及消息发送情况。

连接状态监控

支持查看用户 7 天内连接融云状态情况及消息发送情况,消息需要在发送 5 分钟后才能查看完整状态数据。

输入用户 ID 查询该用户的连接情况,用户 ID 为获取过融云 Token 用户唯一标识。

连接状态内容

  • 显示内容包括:连接时间范围、使用的 SDK 版本、平台、手机型号、系统(Android API 级别;iOS 系统版本号)、终端用户连接时的 IP 地址
  • 消息监控:点击“查看”后,显示该连接时间段内的该用户的消息发送情况

消息记录查询

查看指定用户的消息发送状态,目前支持查看单聊、群聊、聊天室、系统会话类型,默认为查看单聊会话类型消息。

查询条件

支持根据以下查询条件,查询已发送的消息:

  • 发送用户 ID:融云获取过 Token 的 UserID,查看此 ID 发送的所有消息,必填项
  • 消息 ID:为融云全局消息唯一标识 msgUID,可通过融云消息路由服务或服务端消息历史日志服务获取,非必填项
  • 目标 ID:根据不同的会话类型,对应为单聊用户 ID、群组 ID、聊天室 ChatRoomID
  • 会话类型:支持查看单聊、群聊、聊天室、系统消息会话
  • 消息类型:支持融云所有内置消息及用户自定义消息,用户在消息类型中选择自定义消息时,需要手动输入自定义消息的 ObjectName 进行查询,自定义消息一次只能查询一个。
  • 消息来源:包括:Android、iOS、Web、PC、小程序、Server API。默认查询全部平台的消息。
  • 时间范围:消息发送时间范围,默认显示当天零点到当前时间

消息发送列表

  • 消息 ID:融云消息的全局唯一标识 msgUID
  • 发送用户 ID:该消息的发送用户 ID
  • 目标会话 ID:根据不同的会话类型,对应为单聊用户 Id、群组 Id、系统消息 Id
  • 发送时间:消息在融云服务端的发送时间
  • 会话类型:单聊、群聊、系统消息会话
  • 消息类型:当前消息的消息类型,包括客户自定义消息(ObjectName)
  • 消息来源:包括:Android、iOS、Web、PC、小程序
  • 接收状态:点击查看该条消息的目标用户接收状态

消息接收状态

查看一条消息目标用户的接收情况,消息是否发送成功、敏感词、黑名单过滤情况及目标用户未在线时(单群聊)的消息 Push 状态。

用户在线接收消息,消息发送成功显示

消息状态包括:发送成功、消息未下发

  • 发送成功:目标用户在线情况下接收到该消息,显示为发送成功
  • 消息未下发:目标用户有大量消息需要接收时,融云服务端通知目标客户端有新消息需要接收,目标用户在获取新消息前因网络问题断开连接或用户主动退出登录,显示为消息未下发,此状态的消息在用户下次登录时会重新获取到

用户未在线情况下,转为 Push 推送

  • Push 通道:发送 Push 时使用的通道类型,包括:融云 Android Push、APNs、小米、华为、魅族、vivo、OPPO
  • Push 发送时间:该消息转为发送 Push 时的融云服务器时间
  • Push 是否成功:成功/不成功,在使用第三方 Push 通道时,调用第三方 Push 通道接口,第三方 Push 服务返回成功后,融云默认 Push 成功
  • 错误描述:Push 失败后,将返回错识码,开发者可根据错误描述修复错误或提交工单联系融云处理

消息回调处理
当消息回调服务返回不下发或未通过审核服务的审核时,消息会提示发送失败,提示如下:

黑名单、白名单过滤提示

  1. 在使用融云黑名单服务状态下,如发送消息用户在目标用户的黑名单中时,消息发送失败,此时消息 ID 为空,提示如下:

白名单服务与黑名单服务相反,如使用的是白名单服务,发送消息用户未在目标用户的白名单中时,消息发送失败消息 ID 为空

用户被禁言提示

当用户被禁言时,包括群禁言(群整体禁言、群成员禁言)及聊天室成员禁言,该用户无法在群组或聊天室中发送消息,此时消息 ID 为空,提示如下:

消息命中敏感词提示

发送有文本消息中含有敏感信息审核不通过时,消息被融云服务端屏蔽发送失败,此时消息 ID 为空,提示如下:

  • 如消息含有替换敏感词时,消息可正常下发,提示“含有替换敏感词,已完成替换操作”
  • 如已开通云净网图片过滤功能,因涉及到图片人工审核影响,暂不支持显示图片消息的审核状态,可在云净网后台查看图片消息审核结果

消息路由详情

用户可以在消息状态监控里查看消息路由详情,点击查看详情,弹窗展示消息路由状态。


回调查询

支持查看近7天的 IM 各服务回调数据,包含:

  • 消息路由
  • 在线状态订阅
  • 用户注销与激活状态回调
  • 聊天室状态同步及聊天室属性同步即将上线,敬请期待。

查询条件

支持根据以下查询条件,查询对应的回调事件:

  • 查询时段:发生回调时间的时段,时间精确到秒
  • 响应状态码:可通过回调的响应状态码筛选回调事件

回调数据列表

基于对应的检索条件,可查询到该时段所有的回调事件,内容展示包含:

  • 回调时间,实际回调给应用服务器时间,精确到毫秒
  • 回调URL ,数据回调实际使用URL 地址
  • 响应状态码,应用服务器的响应状态码

查看回调详情

点击查看按钮,可查看具体的回调内容。


旧版知识库链接: IM 北极星产品功能介绍— 融云即时通讯云|实时音视频

1 个赞