[Feature] Add AWS RUM Integration

alex-togo commented 1 year ago

This PR adds AWS RUM (real user monitoring) to the frontend boilerplate.

Env vars necessary to be added to CircleCI are found in the JS snippet given to you on the RUM page in the AWS management console. Since there are many env vars, we opted to use a single env var with JSON encoded values.

Here is an example of how the env var would look:

NEXT_PUBLIC_AWS_RUM='{"guestRoleArn":"arn:aws:iam::12345:role/cognito_unauthenticated_role","identityPoolId":"us-east-1:xxxxxx-xxxxx-xxxxx","endpoint":"https://dataplane.rum.us-east-1.amazonaws.com","region":"us-east-1","appId":"xxxxxxx-xxxx-xxxx-xxxx-xxxxxx","appVersion":"1.0.0"}'

This code will also record the user's journey, based on their navigation through the app using Next.js router.

NPM Page: https://www.npmjs.com/package/aws-rum-web Bundlephobia minified size: https://bundlephobia.com/package/aws-rum-web@1.15.0

User Journey Example (Home -> About -> Home):

Note: If the RUM service is not setup to run on localhost, you will get a 400 error. You'll need to use the devops boilerplate to set the domain as localhost. Otherwise, it will run on your specified domain.