Lumberyard
User Guide (Version 1.15)

Using the Defect Reporter Cloud Gem Sample Level

You can use the DefectReporterSample level that is included with Lumberyard to generate sample defect reports. The sample includes a number of preset data collection fields. For information on creating custom fields for the sample level, see Creating Custom Data Collection Fields.

Prerequisites

This tutorial assumes the following:

  • You have used the Project Configurator to set CloudGemDefectReportSample as your default project.

  • You used the Cloud Canvas Resource Manager or the lmbr_aws command line tool to create the following:

    • A project stack for your project.

    • A deployment for your project that has the CloudGemDefectReporter and CloudGemMetric cloud gems enabled.

If you don't meet the prerequisites, see Choosing a Game Project to Open to set CloudGemDefectReportSample as your default project. For information on how to create a project stack and a deployment stack, see Tutorial: Getting Started with Cloud Canvas.

Workflow Steps

You can use the DefectReporterSample level to do the following:

  1. Generate report data.

  2. View and annotate the reports.

  3. Submit the reports.

After you submit the reports, you can view them in the Using the Defect Reporter Cloud Gem Portal.

To use the Defect Reporter cloud gem sample level

  1. In Lumberyard Editor, choose File, Open.

  2. In the Open a Level dialog box, expand Levels.

  3. Choose DefectReporterSample, and then click Open.

  4. Press Ctrl+G to start the level. The sample level looks similar to the following image.

    
            DefectReporterSample level
  5. To generate a defect report, press F1. A status box in the lower left of the screen informs you that data collection is in progress.

    
            Report collection in progress in the DefectReporterSample level.

    Data collection takes a few moments. When it is completed, the status box informs you that the report is available to view and annotate.

    
            Defect report available in the DefectReporterSample level.
  6. Press F1 to generate a few more reports.

  7. To view and annotate the reports, click the status box or press F5. This opens the Defect Report Editor.

    
            Defect Report Editor in the DefectReporterSample level.

    On the lower right, the editor shows a screenshot of the level at the time that the error occurred. The Defect Report Editor has the following fields:

    1. Metrics Data – Shows the data that was collected automatically. Use the scroll bar to see more data.

    2. Attachments – Lists the attachments that were captured as part of the data gathering process.

    3. Custom Field – Provides an area to gather custom data. You can create custom fields in the Cloud Gem Portal. For more information, see Creating Custom Data Collection Fields.

    4. Tell us what happened – A text box in which you can enter comments that provide context regarding the error. You can enter up to 180 characters.

      
                Box for users to provide contextual information about the error in the
                  DefectReporterSample level.
  8. To switch reports, click the navigation arrows at the bottom of the editor.

    
            Navigation arrows in the DefectReporterSample level.
  9. To delete a report, click the Delete button.

    
            Deleting a report in the DefectReporterSample level.
  10. For the purposes of this tutorial, click Submit All to submit the reports.

    
            Submit all reports in the DefectReporterSample level.

    If you click Cancel, the Defect Report Editor will close without submitting any reports.

  11. The editor informs you that the report was sent successfully. Click OK to close the Defect Report Editor.

    
            Report sent successfully
  12. Press ESC to stop the sample level.

The reports are availablein the Cloud Gem Portal in about 10 minutes. To accelerate the process, do one of the following:

  • To use the Game Metrics Cloud Gem Portal

    1. From the Cloud Gem Portal, click Game Metrics.

    2. Click the Settings tab.

    3. In the Extra Actions section, click the three options Consume, Unleash Amoeba, and Crawl, in that order.

    4. Wait until the area under the Crawl button shows the following message:

      The AWS GLUE data crawler is READY.

  • To use the lmbr_aws command and the Game Metrics Cloud Gem Portal

    1. In the lumberyard_version\dev directory, enter the following command:

      lmbr_aws metric consume
    2. From the Cloud Gem Portal, click Game Metrics.

    3. Click the Settings tab.

    4. In the Extra Actions section, click the two options Unleash Amoeba and Crawl, in that order.

    5. Wait until the area under the Crawl button shows the following message:

      The AWS GLUE data crawler is READY.

To view and manage the reports, see the Using the Defect Reporter Cloud Gem Portal.