doohl / aws-rum-web

Amazon CloudWatch RUM Web Client

Amazon CloudWatch RUM Web Client

This is the CloudWatch RUM web client source code repository. It hosts a JavaScript library which performs real user monitoring (RUM) telemetry on web applications. Data collected by the RUM web client includes page load timing, JavaScript errors and HTTP requests.

Installing

The latest stable version of the web client is hosted on a content delivery network (CDN) hosted by CloudWatch RUM. See the CloudWatch RUM documentation for instructions on how to create an AppMonitor and generate a code snippet which will install the web client in your application.

Documentation

1. Installing from CDN
2. Executing Commands
3. Using the Web Client with Angular
4. Using the Web Client with React

Getting Help

Use the following community resources for getting help with the SDK. We use the GitHub issues for tracking bugs and feature requests.

• View the CloudWatch RUM documentation.
• Open a support ticket with AWS Support.
• If you think you may have found a bug, open an issue.

Opening Issues

If you encounter a bug with the CloudWatch RUM web client, we want to hear about it. Before opening a new issue, search the existing issues to see if others are also experiencing the issue. Include the version of the CloudWatch RUM Web Client, Node.js runtime, and other dependencies if applicable. In addition, include the repro case when appropriate.

The GitHub issues are intended for bug reports and feature requests. For help and questions about using the CloudWatch RUM Web Client, use the resources listed in the Getting Help section. Keeping the list of open issues lean helps us respond in a timely manner.

Contributing

We support and accept PRs from the community.

See CONTRIBUTING

Run Tests from Source

To perform exploratory testing, run the Webpack DevServer:

npm run server

In a browser, navigate to http://localhost:9000.

To run (Jest) unit tests:

npm run test

To run (TestCafe) browser integration tests:

npm run integ:local:chrome:headless

Some features perform monkey patching which is incompatible with TestCafe. In these cases, run Nightwatch as a separate browser integration test target:

npm run integ:local:nightwatch

Pre-commit Tasks

The RUM Web Client uses pre-commit tasks to lint and format its source code. Before submitting code, check that all linter and formatter warnings have been resolved.

Attempt to automatically repair linter warnings:

npm run lint:fix

Format code:

npm run prettier:fix

Security

See CONTRIBUTING for more information.

License

This project is licensed under the Apache-2.0 License.