Connect cross-platform accounts & identity management
Log Viewer is a service that allows you to review the traffic logs from AccelByte services. Every user, player, or application’s interaction with the endpoints in our platform is collected and stored in logs by the Log Viewer service, and those logs can be accessed in the Admin Portal. Each log contains detailed information about the event that generated it, which can help you identify problems while troubleshooting.
Permissions are used to grant access to specific resources within our services. Make sure your account has the following permissions before you attempt to access the log viewer in the Admin Portal.
In the Admin Portal, choose the namespace you want to open. The log viewer sits outside of namespaces in the Platform Configurations menu, so all logs can theoretically be accessed from all namespaces. In practice when you log viewer, only logs from namespaces you have access to will be visible.
Open the Platform Configurations menu at the top-right corner of the screen, then click Log Viewer.
On the Log Viewer page, you can view every log from every namespace you have access to. You can browse the list if you’re looking for a log from a very recent event, or filters available on the left side of the page to search for particular logs. The available filters are as follows:
By default, any log search will be restricted to results from the previous hour before you opened the Log Viewer page. If you want to search for older logs, you can input an earlier time into the From field.
Log Type: filters the search by type of log. There are currently two types of logs: REST and WebSocket. If you choose to filter by WebSocket logs, you can also use WebSocket Specific Filters.
Show Internal Calls: toggle this filter to include internal calls in the search. An internal call is a record that doesn’t provide a value to the user, such as a health check or revocation list. This filter is toggled to include internal calls by default. .
Namespace: limits the search to a specific namespace. If left blank, the logs returned by your search will come from every namespace to which you have access.
Service Name: limits the search to a specific service. To use this filter, type the name of the desired service into the box that appears. The service names must be entered as per the following table:
|Dedicated Server Artifact Manager||justice-ds-artifact-manager|
|Dedicated Server Hub||justice-ds-hub-service|
|Dedicated Server Log Manager||justice-ds-log-manager-service|
|Dedicated Server Upload||justice-ds-upload-service|
|User Generated Content (UGC)||justice-ugc-service|
User ID: filters the search by a particular user or player’s activity. To use this filter, type the User ID of the desired user or player into the box that appears.
Client ID: filters the search by a particular application’s activity. To use this filter, type the Client ID of the desired application into the box that appears.
Request Method: filters the search by a particular request method. To use this filter, select from the following options in the dropdown menu:
Response Status Code: filters the search by a specific response status code. To use this filter, select from the following options in the dropdown menu:
|Response Status Code|
|204 No Content|
|307 Temporary Redirect|
|400 Bad Request|
|404 Not Found|
|405 Method Not Allowed|
|406 Not Acceptable|
|408 Request Timeout|
|412 Precondition Failed|
|413 Payload Too Large|
|415 Unsupported Media Type|
|422 Unprocessable Entity|
|429 Too Many Requests|
|500 Internal Server Error|
|502 Bad Gateway|
|503 Service Unavailable|
|504 Gateway Timeout|
Path: filter to only return logs from a particular file path, for example /platform/admin. To use this filter, select the Path checkbox and type the desired path in the box that appears.
Source IP: filters the search by a particular IP address. To use this filter, type the desired IP address in the box that appears.
Trace ID: filters the search by a particular trace ID. To use this filter, type the desired ID into the box that appears.
The trace ID of a request is found in its Response Header.
Referrer: filters the search by a particular referrer from which the log was generated. To use this filter, type the web address of the referrer into the box that appears.
Response Duration: filters the search by logs with a specific response time. You can use this filter to search for logs with notably long or short response times. To use this filter, select Duration Option and choose from the following subfields:
If you selected Less Than or More Than, type the desired amount of time in milliseconds in the Duration field. Typing 100 would return logs with response times shorter or longer than 100 milliseconds, for example. If you selected Between, type the shortest response time you want to return in the Minimum Time field, and the longest response time you want to return in the Maximum Time field. All of the response times of the returned logs will fall within the given range.
WebSocket Specific Filters:
Connection ID to filter logs based on the WebSocket Connection ID of a particular user.
A user or player’s WebSocket Connection ID will change each time they disconnect and reconnect to our platform.
Session ID: filter to filter logs based on the Session ID of a particular user or player’s session.
Connection Stage: filters the search by connection stage. To use this filter, select from the following options in the dropdown menu:
Close Code filters the search by a particular close code. To use this filter, type the desired close code into the box that appears. The close code must be entered as a numerical value, as per the table below:
Message Type: filters the search based on message type. To use this filter, type the desired message type into the box that appears. The message type must be entered as per the following:
Message ID: filters the search by a particular Message ID.
After selecting your filters, click the Apply Filter button to begin your search.
Select a log file to expand its contents.
In the log’s Details tab, you can see information about the activity that generated that particular log.
Under the Request Body (REST)/Request Message (WebSocket) tab, you can see the request bodies for the action generated in the log.
Under the Response Body (REST)/Response Message (WebSocket) tab, you can see the response to that action.