在线客服
24小时在线顾问
开发者中心
体验APP下载
进入控制台
立即注册
登录控制台
使用手册
更新时间：2021-02-19 16:49
1 产品简介
棱镜是即构为开发者提供的音视频通话质量跟踪，故障定位，用户体验追溯的产品模块。其配合 SDK 的相关质量接口，形成一套辅助客户从多维度定位分析流质量数据，聚焦问题范围，促进用户体验优化的成熟解决方案。
2 功能介绍
棱镜由控制台交互界面、后台请求查询接口和SDK 质量回调接口配套组成：
)
在控制台上，流质量数据由流端到端维度、用户维度、房间维度组合呈现。
| 页面模块 | 说明 |
|---|---|
| 检索页 | 作为棱镜的主要入口，提供流ID、用户ID、房间ID检索流列表能力，查看流的基本信息 |
| 流端到端数据页 | 可查看单条流在推流端与拉流端流质量的情况 |
| 用户数据页 | 可查看某用户在房间的基本信息、其所有推流、拉流和设备性能等情况 |
| 房间数据页 | 可查看某个房间所有用户的基本信息，对比不同用户的拉流情况 |
注意：仅限于从即构 UDP 服务器推拉流且使用新版 SDK 的用户，才可查询相关质量数据。
2.1 检索页
)
- 支持以流 ID、用户 ID、房间 ID 检索近两周的相关流信息；
- 支持检索正在进行中的连麦通话（存在两分钟上报延迟）；
- 支持 URL 拼接检索 https://console.zego.im/prism?app=xxx&roomId=xxx&start=xxx&end=xxx
URL 的 query 参数说明：
| 参数 | 说明 |
|---|---|
| app | App ID |
| roomId | 房间 ID |
| userId | 用户 ID |
| stream | 流 ID |
| start | 开始时间（秒时间戳） |
| end | 结束时间（秒时间戳） |
其中 roomId、userId、stream 三个参数必传一个。
2.2 从流端到端维度查询数据页
)
- 支持查看单条流在从推流端到拉流端的质量情况；
- 支持切换查看不同用户的拉流情况（单条流可能存在多个用户拉流）；
- 支持查看用户基本信息：用户 ID、SDK 版本、系统/机型、地区、运营商/网络类型；
- 支持以 dashboard 观察以下几个流质量指标：
| 推流端 | 拉流端 | ||
|---|---|---|---|
| 指标 | 说明 | 指标 | 说明 |
| 发送码率（视频/音频） | 客户端到边缘服务器的上行码率 | 接收码率（视频/音频） | 边缘服务器到客户端的下行码率 |
| 发送帧率（视频/音频） | 客户端到边缘服务器的上行帧率 | 接收帧率（视频/音频） | 边缘服务器到客户端的下行帧率 |
| 延迟 | 客户端到边缘服务器往返延迟（RTT） | 端到端延迟 | 推流端-服务器（包含服务器间网络转发）-拉流端的延迟 |
| 丢包率 | 客户端到边缘服务器的丢包率 | 端到端丢包率 | 推流端-服务器（包含服务器间网络转发）-拉流端的丢包率 |
| 视频采集帧率 | 客户端视频采集设备的采集帧率 | 首帧耗时 | 调用拉流接口到第一帧渲染完成总耗时 |
| 卡顿（视频/音频） | 无数据渲染时长高于一定时间视为卡顿。颜色深浅区分卡顿严重程度 | ||
- 支持以 dashboard 观察以下几个用户设备性能指标：
| 推流端 | 拉流端 | ||
|---|---|---|---|
| 指标 | 说明 | 指标 | 说明 |
| CPU 使用率（系统/APP） | 客户端的设备系统 CPU 用量占比及其自身 CPU 用量占比 | CPU 使用率（系统/APP） | 客户端的设备系统 CPU 用量占比及其自身 CPU 用量占比 |
| 内存使用量（总量/系统/APP） | 客户端的设备内存可用总额、系统内存用量及其自身内存用量 | 内存使用量（总量/系统/APP） | 客户端的设备内存可用总额、系统内存用量及其自身内存用量 |
2.3 从用户维度查询数据页
)
- 支持查看某用户基本信息：用户 ID、SDK 版本、系统/机型、地区、运营商/网络类型；
- 支持查看某用户在房间内的推流情况（用户可能多次进房产生多条推流记录）；
- 支持查看某用户在房间内的拉流情况（用户可能同时有多条拉流记录）。
2.4 从房间维度查询数据页
)
)
- 支持查看单个房间的所有用户及基本信息；
- 支持对有拉流的用户进行流质量对比，可观察用户的接收码率（视频/音频），接收帧率（视频/音频），卡顿。
3 棱镜开放API
支持在 SDK 集成时，获取相关质量回调，以供用户监测此次通话/直播的音视频质量，详细操作步骤请查看 应用端-监测推拉流质量。
4 其它说明
棱镜默认可查询推流数据，如果需要查询更多拉流数据及功能开放，请联系我们：400-166-8807。
本文档是否帮助你解决问题？
有帮助
没有帮助
本页目录
- 1 1 产品简介
- 2 2 功能介绍
- 2.1 2.1 检索页
- 2.2 2.2 从流端到端维度查询数据页
- 2.3 2.3 从用户维度查询数据页
- 2.4 2.4 从房间维度查询数据页
- 3 3 棱镜开放API
- 4 4 其它说明
