抖音开放平台Logo
开发者文档
控制台
  • API 概览
  • 开放能力
  • 基础
  • tt.canIUse
  • 定时器
  • 分包加载
  • 更新
  • 性能
  • 调试
  • tt.getRealtimeLogManager
  • tt.getLogManager
  • 渲染
  • 设备
  • 文件
  • 位置
  • 媒体
  • 网络
  • 游戏转发分享
  • 实时语音
  • 数据缓存
  • 系统
  • 广告
  • 界面
  • 支付
  • Worker
  • tt.getRealtimeLogManager

    收藏
    我的收藏

    基础库 3.55.0 开始支持本方法,这是一个同步方法。

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

    前提条件
    业务背景

    获取实时日志管理器对象。平台上的查看方式可以参考实时日志能力介绍

    使用限制
    1. 每个小游戏账号每天限制 2000条日志,日志会保留 7 天,建议遇到问题及时定位。
    2. 一条日志的限制长度 256 个字符,超出会被截断,避免在循环里面调用打日志接口,避免直接重写 console.log 的方式打日志,建议不要直接打印堆栈 。
    3. 打印的每一个参数会通过 JSON.stringify 序列化,请避免打印自循环引用的结构。
    4. setFilterMsg和addFilterMsg 可设置类似日志tag的过滤字段。如需添加多个关键字,建议使用addFilterMsg。例如addFilterMsg('scene1'), addFilterMsg('scene2'),addFilterMsg('scene3')
    5. addFilterMsg 和 setFilterMsg 的参数不能有空格
    6. 实时日志目前只支持在手机端测试。工具端的接口可以调用,但不会上报到后台。
    注意事项
    相关教程

    语法

    tt.getRealtimeLogManager(option)

    参数说明

    option 类型说明

    object 类型,属性如下:

    属性名类型默认值必填说明最低支持版本
    syncToConsolebooleanfalse
    true表示 log 内容会在 vConsole 或 IDE 控制台上展示, false 表示不展示
    3.55.0

    返回值

    返回值为 object 类型,详细参数描述如下:

    属性名类型说明最低支持版本
    logfunction
    写 log 等级的实时日志。接收任意数量的可被 JSON.stringify 序列化的参数
    3.55.0
    debugfunction
    写 debug 等级的实时日志。接收任意数量的可被 JSON.stringify 序列化的参数
    3.55.0
    infofunction
    写 infooo 等级的实时日志。接收任意数量的可被 JSON.stringify 序列化的参数
    3.55.0
    warnfunction
    写 warn 等级的实时日志。接收任意数量的可被 JSON.stringify 序列化的参数
    3.55.0
    errorfunction
    写 error 等级的实时日志。接收任意数量的可被 JSON.stringify 序列化的参数
    3.55.0
    setFilterMsgfunction
    设置过滤关键字, 用于在后台筛选日志。每次调用会把前面通过RealtimeLogManager.addFilterMsg 和RealtimeLogManager.setFilterMsg设置的关键字覆盖
    3.55.0
    addFilterMsgfunction
    追加过滤关键字,是setFilterMsg的添加接口。用于设置多个过滤关键字。最多加5个过滤关键字, 每个长度限制64个字符。
    3.55.0

    setFilterMsg 类型说明

    是一个回调函数,接收类型参数如下:

    属性名类型说明最低支持版本
    filterMsgstring
    过滤关键字。不能有空白字符(包括空格)。
    3.55.0

    addFilterMsg 类型说明

    是一个回调函数,接收类型参数如下:

    属性名类型说明最低支持版本
    filterMsgstring
    过滤关键字。不能有空白字符(包括空格)。
    3.55.0

    代码示例

    const realtimeLogger = tt.getRealtimeLogManager({ syncToConsole: true }); realtimeLogger.setFilterMsg('demo1'); realtimeLogger.debug('这是真的debug 日志', 0); realtimeLogger.addFilterMsg('demo2'); realtimeLogger.info('这是真的info 日志', true); realtimeLogger.log('这是真的info 日志', { test: { test2: 2 } }); realtimeLogger.setFilterMsg('demo3'); realtimeLogger.warn('这是真的warn 日志,', []); realtimeLogger.error('这是真的error 日志,');