Logger

小鱼易连Web SDK从 v4.0 版本开始，支持创建自定义Logger实例，方便开发者自行创建日志实例，并写入日志操作；因此，通过SDK有两种方式获取Logger实例：

1、通过 ​​XYRTC.logger​​ 属性获取SDK内部的Logger实例；

2、通过调用 ​​XYRTC.createLogger​​ 方法创建新的Logger实例；

通过获取得到的 Logger 实例，可调用相应日志方法；

用法

import XYRTC from 'xylink@xy-rtc-sdk';

// 获取SDK内部Logger实例
const logger = XYRTC.logger;

// 业务创建自定义Logger实例
const logger = XYRTC.createLogger({});

方法

debug

输出debug信息，并写入日志

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

参数

详情

浏览器控制台输出Debug调试信息，并同时写入日志文件中；

downloadLog

下载会议日志到本地

logger.downloadLog(): Promise<boolean>;

详情

下载日志到本地，文件类型是Zip包，需要解压查看；注意移动端不建议调用下载日志方式，原因是可能会被浏览器所拦截导致解压乱码；

• 调用时机：在引入SDK的页面中任意时刻调用皆可
• 调用方式：浏览器控制台中: XYRTC.logger.downloadLog()、事件函数、自定义Logger实例皆可调用
• 关联内容：日志及错误调试
• 注意事项：WebSDK端日志最多可存储近期五场会议数据，请遇到问题时及时下载/上传数据内容

error

输出error信息，并写入日志

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

参数

详情

浏览器控制台输出Error调试信息，并同时写入日志文件中；

fatal

输出fatal致命信息，并写入日志

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

参数

详情

浏览器控制台输出Error调试信息，并同时写入日志文件中；

log

输出INFO信息，并写入日志

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

参数

详情

浏览器控制台输出Info调试信息，并同时写入日志文件中；

setLogLevel

调试模式下，控制台输出日志的等级

logger.setLogLevel(level: TLogLevel): void;

参数

详情

通过指定日志等级，控制SDK内部输出特定级别的日志信息到控制台，方便用户定位排查问题；

• 调用时机：任意时刻

setLogServer

设置日志服务器地址

logger.setLogServer(logServer: string): void;

参数

详情

在特定环境下，例如混合云、分区云，用户需要上传日志到对应的环境中，通过指定日志服务器地址即可；

• 调用时机：初始化SDK时

uploadLog

上传会议日志到小鱼服务器

logger.uploadLog(name = '', account = '', comments = ''): Promise<boolean>;

参数

返回值

Promise<boolean>，true代表上传成功，fasle代表上传失败；

详情

上传会议日志到服务器，文件类型是Zip包，需要解压查看；

• 调用时机：在引入SDK的页面中任意时刻调用皆可
• 调用方式：浏览器控制台中（XYRTC.logger）、自定义Logger实例皆可调用
• 关联内容：日志及错误调试

warn

输出warn信息，并写入日志

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

参数

详情

浏览器控制台输出Warn调试信息，并同时写入日志文件中；