Stardust Web SDK

Stardust SDK MPV provides real time user monitoring for web browser platforms capturing the following events:

• HTTP request Session events through URLSession instrumentation.
• Session tracing to identify and group events.

Prerequisites

• TypeScript
• JavaScript

Integration

TODO: Once we define the distribution method we can update this

Start Instrumentation

The SDK should be initialized on the top lines of index.ts react app file in order to complete the network instrumentation correctly.

import StardustSDK from "stardust-sdk-web";
StardustSDK.startIntrumentation();

Contributing

If you have a suggestion that would make this better, please clone the repo and create a pull request.

1. Clone the Project
2. Create your Feature Branch from develop (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Jira-ID [@username] Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Code Quality Practices

If you plan to contribute to this project, plase follow these code quality practices:

1. Avoid Global Variables
2. Declarations on Top
3. Initialize Variables
4. Declare Objects with const
5. Use === Comparison
6. Comment as much as needed but not more
7. Modularize — one function per task
8. Allow for configuration and translation
9. Keep DOM access to a minimum

Test Coverage

The application should target 80% coverage according to the Discovery Web Standards.

These are the tools that are going to be used for reaching the target:

1. Jest Testing Library
2. Sonar cloud

Contact Us

You can reach us through our slack channel - #team-o11y-stardust

Project Documentation - Confluence Architecture Document

Related Projects

• Stardust SDK Android
• Stardust SDK iOS

Reference

Stardust SDK reference links:

• Open Telemetry
• Open Telemetry JS
• Discovery OLOF Web
• DPlus Client

License

Copyright (c) Discovery. All rights reserved.