Last Updated: 10/5/2021, 8:53:25 AM

# Log Viewer

# Overview

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

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.

Usage Permissions Action
Query Log ADMIN:NAMESPACE:{namespace}:LOG READ

Permissions work slightly differently depending on whether they are assigned to IAM Clients or Roles assigned to users. For more information, read the Authentication and Authorization documentation.

# Viewing Service Logs in the Admin Portal

# View a Log

  1. 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 use the log viewer, only logs from namespaces you have access to will be visible.

    log-viewer

  2. Open the Platform Configurations menu at the top-right corner of the screen, then click Log Viewer.

    log-viewer

  3. 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 use the filters available on the left side of the page to search for particular logs. The available filters are as follows:

    • Use the Request Time filter to filter logs by when a request was made. To use this filter, define the range of time the returned logs should be from by inputting the start and end times in UTC format in the From and To fields, respectively. The maximum length of time you can search for is 30 days. By default, the logs returned from any search will be restricted to the hour before you opened the Log Viewer page. This filter is required and cannot be made blank, so if you want to return older logs you can input an earlier time in the From field.

    • Use the Namespace filter to limit your search results to a specific namespace. If left blank, the logs returned by your search will come from every namespace you have access to. To use this filter, select the Namespace checkbox and select the desired namespace from the dropdown menu that appears.

    • Use the Service Name filter to limit the logs returned to a specific service. To use this filter, select the Service Name checkbox and type the name of the desired service in the box that appears. The service names must be typed as they appear in the right column of this table:

      Service Name
      Service Service Name
      Achievements justice-achievement-service
      Augment justice-augment-service
      Basic justice-basic-service
      Build Info justice-buildinfo-service
      Cloud Storage justice-cloud-storage
      Cloud Save justice-cloudsave-service
      Differ justice-differ-service
      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
      DSM Controller justice-dsm-controller-service
      Event Log justice-event-log-service
      GDPR justice-gdpr-service
      Groups justice-group-service
      IAM justice-iam-service
      Leaderboards justice-leaderboard-service
      Legal justice-legal-service
      Lobby justice-lobby-server
      Log justice-log-service
      Matchmaking justice-matchmaking
      Platform justice-platform-service
      QOS Manager justice-qos-manager-service
      QOS justice-qos-service
      Reporting justice-reporting-service
      Season Pass justice-seasonpass-service
      Session Browser justice-session-browser-service
      Social justice-social-service
      Statistics justice-statistic-service
      Turn Manager justice-turn-manager-service
      User Generated Content (UGC) justice-ugc-service
    • Use the User ID filter to return logs generated by a particular user or player’s activity. To use this filter, select the User ID checkbox and type the user ID of the desired user or player in the box that appears.

    • Use the Client ID filter to return logs generated by a particular application’s activity. To use this filter, select the Client ID checkbox and type the client ID of the desired application in the box that appears.

    • Use the Request Method to filter your search to only include logs from a particular request method. To use this filter, select the Request Method checkbox and select from the following options in the dropdown menu that appears:

      Request Method
      Request Method
      GET
      PUT
      DELETE
      POST
      PATCH
    • Use the Response Status Code filter to only return logs with a specific response status code. To use this filter, select the Response Status Code checkbox and select from the following options in the dropdown menu that appears:

      Response Status Code
      Response Status Code
      200 OK
      201 Created
      202 Accepted
      204 No Content
      302 Found
      307 Temporary Redirect
      400 Bad Request
      401 Unauthorized
      403 Forbidden
      404 Not Found
      405 Method Not Allowed
      406 Not Acceptable
      408 Request Timeout
      409 Conflict
      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
    • Use the 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.

    • Use the Source IP filter to only return logs from a particular IP address. To use this filter, select the Source IP checkbox and type the desired IP address in the box that appears.

    • Use the Trace ID filter to only return logs from a particular trace ID. To use this filter, select the Trace ID checkbox and type the desired ID in the box that appears.

      TIP

      The trace ID of a request is found in its Response Header.

    • Use the Referrer to filter your search results to logs from a particular referrer, or website from which the log was generated. To use this filter, select the Referrer checkbox and type the web address of the referrer in the box that appears.

    • Use the Response Duration filter if you only want to return logs with a specific response time. You can use this filter to search for logs with exceptionally long or short response times, for example. To use this filter, select the Response Duration checkbox and select a Duration Option. The available options are as follows:

      Response Duration
      Response Duration
      Less Than
      More Than
      Between

      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.

    After selecting your filters, click the Apply Filter button. The logs displayed will conform to the selected parameters.

    log-viewer

  4. Click any log file to expand its contents.

    log-viewer

  5. The log opens to its Summary tab, which contains information about the activity that generated the log. You can also see the request body for the action that generated the log in the Request Body tab, or see the Response Body of the response to that action in the Response Body tab.

    log-viewer

    log-viewer

    log-viewer