¶ 日志上报
客户端 SDK 会自动搜集和上报日志。如下客户端相关的信息会被搜集并上报。
| 字段名 | 可选 | 描述 |
|---|---|---|
| uuid | 否 | 房间的 uuid |
| userId | 是 | 用户业务层唯一识别符 |
| ip | 否 | 客户端的 IP |
| team | 否 | 当前账号 ID |
| app | 否 | 当前项目 ID |
| sdkVersion | 否 | 当前 SDK 的主版本号 |
| akkoVersion | 否 | 当前 akko 的版本号 |
| nativeVersion | 是 | 当前移动端 SDK 的版本号 |
| platform | 否 | 是什么平台？浏览器、iOS、Android |
| os | 否 | 操作系统版本号 |
上报的日志可以在管理控制台中检索和查看。这些日志有调试和排障。默认情况下，客户端 SDK 会开启日志上报功能。
你可以通过如下方法来关闭日志上报功能。不过，如果关闭了日志上报，一旦遇到问题，可能导致我们无法协助你定位和解决问题。
JavaScript
new WhiteWebSdk({
...{otherOptions},
loggerOptions: {
disableReportLog: true, // 禁止上报日志
},
});
¶ 上报 userId 字段
在客户端 SDK 加入房间时，可以带一个 userPayload 参数。该参数让我们传入一个自定义 object 结构，以包含描述当前加入房间的用户身份信息。如果在该对象中插入 userId 字段（一个字符串类型的值），则该字段的值会被作为日志的 userId 字段被上传。
你可以通过如下代码，将 userId 在加入房间时添加进去。
JavaScript
whiteWebSdk.joinRoom({
...{otherOptions}
userPayload: {
userId: "this-user-id",
},
});
通过把你的业务系统中用户的唯一识别符作为 userId 字段，插入到每一条上报的日志中，便可把 Netless 中的每一条日志与你的业务系统中的用户关联起来。
¶ 查看线上日志
你可以在管理控制台的日志查询页面查看特定房间的日志信息。
