Lumberyard
User Guide (Version 1.21)

Using the Cloud Gem Portal to View Logs

You can view Amazon CloudWatch Logs for your cloud gems in the Log tab of the Cloud Gem Portal. CloudWatch Logs is an AWS service that monitors log activity related to your application's use of cloud gems. For example, you can view the Player Account cloud gem logs related to a sign up failure.

CloudWatch Logs arranges logs into log streams and log groups. A log stream is a sequence of log events that share the same source. Each separate source of logs into CloudWatch Logs makes up a separate log stream.

A log group is a group of log streams that share the same retention, monitoring, and access control settings. You can define log groups and specify which streams to put into each group. There is no limit on the number of log streams that can belong to one log group. For more information, see Working with Log Groups and Log Streams in the Amazon CloudWatch Logs User Guide.

You can use the Log tab of the Cloud Gem Portal to view log streams and log groups related to your cloud gems.

Prerequisites

This tutorial assumes the following:

  • You are using a Lumberyard project that has the Leaderboard and Message of the Day cloud gems enabled.

  • You have used Lumberyard's Cloud Canvas Resource Manager or the lmbr_aws command line tool to create a project stack and a deployment stack in AWS.

If you don't meet the prerequisites, follow the steps in Enabling Gems to add cloud gems to your project. For information on creating a project stack and a deployment stack, see Tutorial: Getting Started with Cloud Canvas.

Viewing Log Information in the Cloud Gem Portal

You can view log information from CloudWatch Logs in the Cloud Gem Portal. You can monitor log activity in your AWS account for your cloud gems.

To view cloud gem log information in the Cloud Gem Portal

  1. In Lumberyard Editor, choose AWS, Open Cloud Gem Portal.

  2. In the Cloud Gem Portal, choose the cloud gem that has the CloudWatch Logs that you want to see. This example uses the Message of the Day cloud gem.

    
            Choose a cloud gem from the Cloud Gems page to view log
              information.
  3. Click the Log tab. You can view summary information for the last 20 minutes of CloudWatch Logs for the cloud gem that you chose. The most recent logs appear at the top of the list.

    
            The Log tab in the Cloud Gem Portal.

Viewing Logs in the CloudWatch Logs Console

The Log tab of the Cloud Gem Portal provides links to the CloudWatch Logs console where you can see more details about your log groups and log streams.

To view a log group in the CloudWatch Logs console

  1. On the Log tab of the Cloud Gem Portal, click the pop-out icon next to the name of the log group.

    
            Open the CloudWatch Logs console from the Cloud Gem Portal.
  2. Sign in to the AWS Management Console if you are not already signed in. The CloudWatch Logs console displays the log group that you chose.

    
            View the log group information in the CloudWatch Logs console.

To view a log stream in the CloudWatch Logs console

  1. On the Log tab of the Cloud Gem Portal, click a log entry for a specific CloudWatch log stream.

    
            Click a log stream in the Cloud Gem Portal to view the information in the CloudWatch Logs
              console.
  2. Sign in to the AWS Management Console if you are not already signed in. The CloudWatch Logs console displays the log stream that you chose.

    
            View log stream in the CloudWatch Logs console for your cloud gems.

Multiple Log Groups

A log group is a group of log streams. When a cloud gem like Leaderboard contains more than one log group, the log groups are displayed in multiple sections on the same page.

To choose a log group to view

  1. Click the Cloud Watch Groups drop-down menu, and then select the log group that you want to see.

    
              Choose a log group from CloudWatch Groups
  2. Click (Top) next to the name of a log group to return to the top of the log groups.

    
              Click Top to return to the top of the page.