浏览 SDKs · Electron
SDKsElectron

上传日志

使用 Electron FFI 的 uploadLogs 上传客户端诊断日志。

复制

Electron FFI 提供 uploadLogs(),用于把原生侧已落盘的诊断日志上传到当前 OpenIMServer 配置的日志收集链路。浏览器 WASM 侧的日志级别与 operationID 说明见 WASM 日志;WASM 包不提供对等的 uploadLogs()

只在排查问题、用户主动提交诊断信息或运维要求时上传。上传前确认日志中不包含 Token、消息正文或其他敏感字段;需要补充业务上下文时,使用 ex 写入可公开的诊断标记,不要写入凭据。

上传日志

参数说明

参数类型是否必填说明
linenumber本次上传读取的日志行数或行范围配置,按 Electron FFI SDK 约定填写。
cancelIDstring取消标识;未传时 SDK 可使用当前调用的操作 ID。
exstring附加到本次上传的扩展说明;没有时可不传或传空字符串。
await openimsdk.uploadLogs({
  line: 2000,
  ex: 'desktop-diag-session',
});

调用结果

uploadLogs() 的 Promise 成功表示本次上传请求已完成。它不会修改会话、消息或用户资料,也不会触发业务领域事件。上传失败时记录 errCodeerrMsg 和当前用户 ID,便于与 OpenIMServer 侧日志对应;不要在失败日志中再次输出完整日志正文。

相关页面