Loading...
日志及错误调试
功能说明
当开发者遇到技术问题需要平台技术支持时，可通过日志相关 API 上传日志。 日志上传进度及状态将通过事件回调方式进行通知。
当前小程序SDK提供了两种日志方式：微信日志和小鱼日志；
- 微信日志是通过调用微信API实现的日志实时写入，存储在微信临时目录，支持最大5M文件写入，用户需要反馈日志时，需要通过微信小程序的反馈机制上传到微信开放平台后台获取日志；
- 小鱼日志是小鱼SDK自研日志方式，通过文件相关API写入到微信临时文件目录，支持最大30MB的文件写入操作，用户需要反馈日志时，通过小程序SDK的上传日志方法上传到小鱼易连后台服务，方便相关研发同学定位分析问题；
提示
从小程序SDK v3.9版本开始，推荐使用小鱼日志模式，支持更大的日志内容写入，日志信息更全面；
实现方法
下面将介绍如何切换日志模式和上传日志方式；
开启/关闭日志
通过调用setDebug()方法控制是否向日志文件写入文件、控制是否向VConsole输入日志信息；
切换日志方式
通过调用setLogType()方法控制切换微信日志和小鱼日志模式；
上传小鱼日志
提示
需要切换小程序SDK日志方式为小鱼日志模式，才支持调用此方法上传日志到小鱼后台；
通过调用uploadLog()方法上传小鱼日志到小鱼易连服务器后台；
上传微信日志
提示
小程序SDK默认日志方式，写入到微信日志模块中，调用上传日志后，会提交到微信公众平台中；
通过如下两种方法上传日志文件到微信小程序开放后台：
- 通过小程序 button 按钮，将按钮的 open-type 属性设置为 feedback ，可以打开“意见反馈”页面进行上传操作；
- 点击小程序右上角的 三个点图标 -> 反馈和投诉 -> 功能异常 -> 选择其中的任意一项，填写完表单后点击提交即可；
当日志上传成功后，可以在小程序账号所对应的微信公众平台系统中的用户反馈中下载对应的日志文件。
示例代码
// 开启/关闭日志
// 开启日志写入、关闭vconsole输出
XYClient.setDebug(false, true);
// 切换到小鱼日志方法
XYClient.setLogType(LogType.CUSTOM);
// 上传小鱼日志到小鱼服务器
XYClient.uploadLog({
comments: "问题描述",
account: "xxx";
});
API参考
意见反馈