日志回捞用于排查设备端播放问题。SDK 在本地记录日志,并查询服务端下发的回捞任务;任务匹配设备及时间范围后,SDK 上传日志,供火山引擎技术支持团队分析。开启日志回捞不代表立即上传全部日志。
Flutter 播放器 SDK 版本为 1.52.11 及以上版本。集成方法请参见集成 SDK。
在首次调用 startWithConfiguration 前,将 TTSDKLogConfiguration 设置到初始化配置。最简配置只需指定 enable: true,其余字段采用原生 SDK 默认值。
final config = TTSDKConfiguration.defaultConfigurationWithAppIDAndLicPath( appID: 'YOUR_APP_ID', licenseFilePath: 'assets/VEVod.license', channel: 'your-channel', ); config.logConfiguration = const TTSDKLogConfiguration(enable: true); await FlutterTTSDKManager.startWithConfiguration(config);
若应用已有初始化逻辑,在原有配置中加入 logConfiguration 即可,不要重复初始化 SDK。
需要调整日志级别或磁盘占用时,可在初始化前使用以下配置:
config.logConfiguration = const TTSDKLogConfiguration( enable: true, logLevel: TTSDKLogLevel.debug, maxLogSizeM: 50, singleLogSizeM: 5, );
| 参数 | 用途 | 未设置时 |
|---|---|---|
enable | 本地日志记录与回捞任务查询开关,创建配置对象时必填。 | 无省略值。 |
logLevel | 日志级别,可选值为 verbose、debug、info、warning、error、none。 | 使用原生默认级别。 |
logPath | 日志文件目录。 | 使用原生默认目录。 |
maxLogSizeM | 日志总容量,单位:MB。 | 100 MB。 |
singleLogSizeM | 单文件容量,单位:MB。 | 2 MB。 |
logExpireTimeS | 日志保留时间,单位:秒。 | 7 天。 |
deviceID | 自定义回捞设备标识。 | 使用 SDK 默认设备标识。 |
容量和时长需为正整数且不超过 2147483647。单文件容量不能超过日志总容量,包括未填写字段的默认值。路径和设备标识若填写则不能为空。无效配置会在调用原生初始化前抛出 ArgumentError。
logConfiguration 为 null 时,Flutter 不覆盖原生及服务端配置,不能据此认定日志回捞已开启。enable: true 开启本地记录与回捞任务查询,enable: false 显式关闭。iOS 的显式关闭优先于服务端开启配置;需要保留服务端控制能力时,应不设置 logConfiguration。openAllLog() 用于调试日志输出,不能代替日志回捞配置。开启日志回捞无需调用 openAllLog()。deviceID 时,使用 getDeviceID() 返回的默认设备标识;若尚未生成,稍后重试。若设置了自定义 deviceID,则使用配置中的值。// SDK 初始化完成后获取默认回捞设备标识。 final deviceId = await FlutterTTSDKManager.getDeviceID();
仅初始化成功、本地生成日志文件或 App 构建成功,都不能证明回捞上传成功。验收应覆盖任务下发、设备查询、上传以及服务端日志可用的完整流程。
本地记录与服务端回捞任务是两个步骤。检查是否已完全重启应用、设备 ID 和问题时间范围是否匹配,以及服务端是否已创建任务。
在首次初始化前传入 TTSDKLogConfiguration(enable: false)。修改配置后,完全退出并重新启动应用。
不设置 logConfiguration,并完全退出并重新启动应用。恢复默认不等同于显式开启。