qq.setEnableDebug

qq.setEnableDebug(Object object)

设置是否打开调试开关。此开关对正式版也能生效。

参数

Object object
属性 类型 默认值 必填 说明
enableDebug boolean 是否打开调试
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

示例代码

// 打开调试
qq.setEnableDebug({
  enableDebug: true
})

// 关闭调试
qq.setEnableDebug({
  enableDebug: false
})
1
2
3
4
5
6
7
8
9

Tips

  • 在正式版打开调试还有一种方法,就是先在开发版或体验版打开调试,再切到正式版就能看到vConsole。

qq.getLogManager

LogManager qq.getLogManager(Object object)

获取日志管理器对象。

参数

Object object
属性 类型 默认值 必填 说明 最低版本
level number 0 取值为0/1,取值为0表示是否会把 AppPage 的生命周期函数和 qq 命名空间下的函数调用写入日志,取值为1则不会。默认值是 0

返回值

LogManager

示例代码

const logger = qq.getLogManager({level: 1})
logger.log({str: 'hello world'}, 'basic log', 100, [1, 2, 3])
logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
logger.debug({str: 'hello world'}, 'debug log', 100, [1, 2, 3])
logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
1
2
3
4
5

qq.getRealtimeLogManager

RealtimeLogManager qq.getRealtimeLogManager(Object object)

获取实时日志管理器对象。

返回值

RealtimeLogManager

示例代码

const logger = qq.getRealtimeLogManager()
logger.info({str: 'hello world'}, 'info log', 100, [1, 2, 3])
logger.error({str: 'hello world'}, 'error log', 100, [1, 2, 3])
logger.warn({str: 'hello world'}, 'warn log', 100, [1, 2, 3])
1
2
3
4

console

向调试面板中打印日志。console 是一个全局对象,可以直接访问。在QQ客户端中,向 vConsole 中输出日志。

方法

console.debug()

向调试面板中打印 debug 日志

console.log()

向调试面板中打印 log 日志

console.info()

向调试面板中打印 info 日志

console.warn()

向调试面板中打印 warn 日志

console.error()

向调试面板中打印 error 日志

console.group(string label)

在调试面板中创建一个新的分组。随后输出的内容都会被添加一个缩进,表示该内容属于当前分组。调用 console.groupEnd之后分组结束。

console.groupEnd()

结束由 console.group 创建的分组

注意

  • 由于 vConsole 功能有限,以及不同客户端对 console 方法的支持情况有差异,建议开发者在小程序中只使用本文档中提供的方法。
  • 部分内容展示的限制请参见调试

.debug

console.debug()

向调试面板中打印 debug 日志

参数

any ...args

日志内容,可以有任意多个。

.error

console.error()

向调试面板中打印 error 日志

参数

any ...args

日志内容,可以有任意多个。

.group

console.group(string label)

在调试面板中创建一个新的分组。随后输出的内容都会被添加一个缩进,表示该内容属于当前分组。调用 console.groupEnd之后分组结束。

参数

string label

分组标记,可选。

注意

仅在工具中有效,在 vConsole 中为空函数实现。

.groupEnd

console.groupEnd()

结束由 console.group 创建的分组

注意

仅在工具中有效,在 vConsole 中为空函数实现。

.info

console.info()

向调试面板中打印 info 日志

参数

any ...args

日志内容,可以有任意多个。

.log

console.log()

向调试面板中打印 log 日志

参数

any ...args

日志内容,可以有任意多个。

.warn

console.warn()

向调试面板中打印 warn 日志

参数

any ...args

日志内容,可以有任意多个。

LogManager

日志管理器实例,可以通过 qq.getLogManager 获取。

方法

LogManager.debug()

写 debug 日志

LogManager.info()

写 info 日志

LogManager.log()

写 log 日志

LogManager.warn()

写 warn 日志

使用说明

最多保存5M的日志内容,超过5M后,旧的日志内容会被删除。
用户可以通过使用 <Button> 组件的 open-type="feedback" 来上传打印的日志。开发者可以通过小程序管理后台左侧菜单“反馈管理”页面查看。
基础库默认会把 AppPage 的生命周期函数和 qq 命名空间下的函数调用写入日志。

.debug

LogManager.debug()

写 debug 日志

参数

Object|Array.<any>|number|string ...args

日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb

.info

LogManager.info()

写 info 日志

参数

Object|Array.<any>|number|string ...args

日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb

.log

LogManager.log()

写 log 日志

参数

Object|Array.<any>|number|string ...args

日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb

.warn

LogManager.warn()

写 warn 日志

参数

Object|Array.<any>|number|string ...args

日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb

RealtimeLogManager

实时日志管理器实例,可以通过 qq.getRealtimeLogManager 获取。

方法

RealtimeLogManager.info()

写 info 日志

RealtimeLogManager.warn()

写 warn 日志

RealtimeLogManager.error()

写 error 日志

RealtimeLogManager.setFilterMsg(string msg)

设置过滤关键字

RealtimeLogManager.in(Page pageInstance)

设置过滤关键字

使用说明

为帮助小程序开发者快捷地排查小程序漏洞、定位问题,我们推出了实时日志功能。从基础库1.15.0开始,开发者可通过提供的接口打印日志,日志汇聚并实时上报到小程序后台。 开发者可从小程序管理后台“运维中心->实时日志”进入日志查询页面,查看开发者打印的日志信息。

.info

RealtimeLogManager.info()

写 info 日志

参数

Object|Array.<any>|number|string ...args

日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb

.info

RealtimeLogManager.info()

写 info 日志

参数

Object|Array.<any>|number|string ...args

日志内容,可以有任意多个。每次调用的参数的总大小不超过5Kb

.warn

RealtimeLogManager.warn()

写 warn 日志

参数

Object|Array.<any>|number|string ...args

日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb

.error

RealtimeLogManager.error()

写 error 日志

参数

Object|Array.<any>|number|string ...args

日志内容,可以有任意多个。每次调用的参数的总大小不超过100Kb

.setFilterMsg

RealtimeLogManager.setFilterMsg(string msg)

设置过滤关键字

参数

string msg

过滤关键字,最多不超过1Kb,可以在小程序管理后台根据设置的内容搜索得到对应的日志。

.addFilterMsg

RealtimeLogManager.addFilterMsg(string msg)

添加过滤关键字

参数

string msg

是setFilterMsg的添加接口。用于设置多个过滤关键字。

.in

RealtimeLogManager.in(Page pageInstance)

设置实时日志page参数所在的页面

参数

Page pageInstance

page实例

qq.getEnvVersion()

string qq.getEnvVersion()

基础库1.7.1以上版本支持此接口

获取小程序运行环境,运行开发版或预览版小程序返回"develop",体验版返回"trial",除此之外其它环境均返回"release"