Using the Deployed Resources

Once the AWS Metrics resources have been deployed, you can use features such as real-time analytics and batch analytics.

Using real-time analytics

After deploying the CDK application, an Amazon CloudWatch dashboard is created automatically to show the operational health metrics and sample metrics (TotalLogin) defined in the CDK application.

To start the real-time analytics, go to the Amazon Kinesis console or use the AWS CLI start-application command to start the Kinesis Data Analytics application.

Important:
Please be aware that you are charged an hourly rate to run the application.

The CloudWatch dashboard will start showing the metrics you sent from the client side while the application is running.

Sample metrics dashboard

Most of the components deployed for real-time analytics are extensible. You can customize the Kinesis Data Analytics application, analytics-processing Lambda, and CloudWatch dashboard from the CDK application code or the AWS console to transform and analyze your streaming data.

Note that re-deploying the CDK application will overwrite any changes you made through the AWS Console. Therefore it is suggested that you make the modification through the CDK application code and redeploy the CDK application.

Enabling batch analytics

To enable the optional batch analytics feature, specify batch_processing=true when you synth and deploy the CDK application.

cdk synth -c batch_processing=true
cdk deploy -c batch_processing=true

Metrics data will be sent to the Amazon S3 Data Lake and saved in the parquet format. To make the data discoverable, go to the AWS Glue console or use the AWS CLI start-crawler command to start the Glue crawler deployed by the CDK application. After the crawler finishes its work, the metrics event table will be updated. Then you can run queries on the data through Amazon Athena engine.

There are a few named queries created within your CDK application under a specific work group for your project. You can run these sample queries as an example or create custom queries for batch analytics.

You can also create an Amazon QuickSight dashboard (not included in the CDK application) to visualize the statistics. For instructions, see Build the Amazon QuickSight Dashboard in the Game Analytics Pipeline documentation.

Similar to the real-time analytics, you can also customize the components for batch processing. For example, you can define custom transformation in the events processing Lambda or change the behavior of the Glue crawler to run it periodically.

CloudFormation stack output

The AWS CloudFormation stack deployed by the CDK application contains the following outputs. You can use these outputs for reference and create the resource mapping file based on them.

OutputDescription
AdminPolicyOutputAdmin policy ARN to call service.
AnalyticsApplicationNameKinesis Data Analytics application to process the real-time metrics data.
DashboardNameCloudWatch dashboard to monitor the operational health and real-time metrics.
DeploymentStageStage for the REST API deployment.
EventsCrawlerNameGlue Crawler to populate the AWS Glue Data Catalog with metrics events tables.
RestApiIdService API Id for the analytics pipeline.
UserPolicyOutputUser policy ARN to call service.

Copyright © 2022 Open 3D Engine Contributors

Documentation Distributed under CC BY 4.0.
For our trademark, privacy and antitrust policies, code of conduct, and terms of use, please click the applicable link below or see https://www.lfprojects.org.


The Linux Foundation has registered trademarks and uses trademarks. For a list of trademarks of The Linux Foundation, please see our Trademark Policy page.