The client SDK will automatically collect and report logs. The following client-related information will be collected and reported.
Field name | Optional | Description |
---|---|---|
uuid | No | uuid of the room |
userId | Yes | The unique identifier of the user's business layer |
ip | No | Client's IP |
team | No | Current account ID |
app | No | Current project ID |
sdkVersion | No | Major version number of the current SDK |
akkoVersion | No | Current akko version number |
nativeVersion | Yes | The version number of the current mobile SDK |
platform | No | What platform is it? Browser, iOS, Android |
os | No | Operating system version number |
The reported log can be retrieved and viewed in Management Console. These logs have debugging and troubleshooting. By default, the client SDK will enable the log reporting function.
You can turn off the log reporting function through the following methods. However, if you turn off the log report, once you encounter a problem, we may not be able to assist you in locating and solving the problem.
JavaScript
new WhiteWebSdk({
...{otherOptions},
loggerOptions: {
disableReportLog: true, // Prohibit reporting logs
},
});
When the client SDK joins the room, you can take a userPayload
parameter. This parameter allows us to pass in a custom object structure to contain the identity information describing the user currently joining the room. If the userId
field (a string type value) is inserted into the object, the value of this field will be uploaded as the userId
field of the log.
You can use the following code to add userId
when joining a room.
JavaScript
whiteWebSdk.joinRoom({
...{otherOptions}
userPayload: {
userId: "this-user-id",
},
});
By inserting the unique identifier of the user in your business system as the userId
field into each reported log, you can associate each log in Netless with a user in your business system.
You can view the log information of a specific room on the Log Query of the Management Console page.