日志及错误调试

功能说明

当开发者遇到技术问题需要平台技术支持时，可通过日志相关 API 上传日志。日志上传进度及状态将通过事件回调方式进行通知。

实现方法

控制日志等级

通过 XYRTC.logger.setLogLevel 方法设置日志输出和写入文件的等级，可以选择如下等级：

INFO：所有信息
DEBUG：调试信息
WARNING：警告信息
ERROR：错误信息
NONE：禁止输出，默认值，即不再控制台中输出日志，仅写入日志文件中

配置说明

配置日志等级后，除NONE外的等级都会将日志打印到浏览器控制台，同时写入日志文件。

在浏览器控制台打印日志：

XYRTC.logger.setLogLevel('INFO')

在不支持Web Worker的环境下（例如使用 vConsole 插件时），打印日志，按照以下方法调用：

XYRTC.logger.setLogLevel('INFO', true)

注意事项

在调试开发阶段，推荐使用INFO等级以便获取详细信息
在生产环境中，建议使用NONE等级，减少不必要的信息输出，提高性能。

浏览器端获取日志

在引入了小鱼Web SDK库的桌面端浏览器页面右击选择“检查”，打开网页控制台，在控制台中执行如下语句，获取日志（移动端浏览器建议通过上传日志方式获取日志）；

XYRTC.logger.downloadLog()

上传日志

通过调用 XYRTC.logger.uploadLog 方法，上传日志数据（格式是Zip文件）到小鱼日志服务器，可以方便开发者协助我们定位问题。如果无法将日志上传到小鱼服务器，可以通过下载日志到本地的形式获取日志数据。

下载日志

通过调用 XYRTC.logger.downloadLog 方法，下载日志数据（格式是Zip文件）到本地。

提示

1、PC浏览器下，用户下载得到的日志文件需要解压zip文件即可看到日志内容；

2、移动端浏览器下，下载Zip包文件时浏览器可能会直接预览zip文件源码数据，导致显示的数据是乱码问题，因此不建议在移动端下下载日志到本地；

3、浏览器控制台中也支持调用：XYRTC.logger.downloadLog()

日志写入

XYRTC.logger 提供了日志写入方法，开发者可根据不同日志级别将数据写入SDK的日志文件，由SDK统一管理：

XYRTC.logger.log(title?: string, content?: any, ...rest: any[]): void;

示例程序

// 上传呼叫日志
const upload = async () => {
  const result = await XYRTC.logger.uploadLog(user.meetingName, user.phone);

  if (result) {
    message.info("上传成功");
  } else {
    message.info("上传失败");
  }
};

// 下载呼叫数据到本地
const download = async () => {
  await XYRTC.logger.downloadLog();
};

// 设置日志等级
XYRTC.logger.setLogLevel("NONE")

API 参考

2025-01-07 12:10:42

导出PDF文档