AWS Metrics Gem
AWS Gems Have Moved:DawnEngine no longer includes AWS gems by default. Visit https://github.com/aws/o3de-repo for instructions on how to install AWS gems (the upstream O3DE-compatible AWS gems repository).
The AWS Metrics Gem provides an extensible, out-of-the-box instrumentation and analytics solution for O3DE developers. It builds an analytics pipeline using the AWS Core Gem, and connects you to AWS services that support common metrics operations on your analytics data, including:
- Ingestion
- Storage
- Analysis
- Monitoring
- Reporting
Using this Gem, you can generate and submit metrics events in a thread-safe manner from C++, Lua, and Script Canvas. To use AWS services for real-time and batch analytics, you can deploy the sample AWS Cloud Development Kit (AWS CDK) application as a reasonable starting point. You can also extend the supplied AWS CDK application to a full, production-ready solution to meet your production and scaling needs. Refer to Game Analytics Pipeline on the AWS website for a detailed look at the architecture.
Enabling the AWS Metrics Gem
To enable the AWS Metrics Gem, do the following:
Use O3DE Project Manager or the command line to add the AWS Metrics Gem to your project. Note that AWS Metrics requires the AWS Core Gem as a dependency.
Build your project using Project Manager, Visual Studio, or CMake.
To configure AWS Metrics for your project, follow the instructions in Setting Up the AWS Metrics Gem.
Setting Up Metrics
Learn how to set up the AWS Metrics Gem for your Open 3D Engine (O3DE) project.
Using the Deployed Resources
Learn how to use the AWS Metrics Gem resources you deployed for your Open 3D Engine (O3DE) project.
Scripting Metrics
Examples of using Script Canvas or Lua with the AWS Metrics Gem and Open 3D Engine (O3DE) to generate and submit metrics.
Using the C++ API
Get an overview of using the C++ API with the AWS Metrics Gem in Open 3D Engine (O3DE).
Advanced Topics
Learn additional features of the AWS Metrics Gem in Open 3D Engine (O3DE) that go beyond the basics.
Event Schema
View the JSON event schema for validating AWS Metrics input events in Open 3D Engine (O3DE).