5887ab5ddb
* feat(tracker): update message schema with BatchMetadata; separate message-related responsibilities; add message size * chore(docker): removing edge busybox, as the main repo updated * feat(backend): updated message protocol templates * feat(backend): added support of message size * feat(backend): implemented iterator for new message protocol (with message size) Co-authored-by: Alex Kaminskii <alex@openreplay.com> |
||
|---|---|---|
| .. | ||
| scripts | ||
| src | ||
| .eslintignore | ||
| .eslintrc.cjs | ||
| .gitignore | ||
| .npmignore | ||
| .prettierignore | ||
| .prettierrc.json | ||
| js_errors.txt | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| rollup.config.js | ||
| tsconfig-base.json | ||
OpenReplay Tracker
The main package of the OpenReplay tracker.
Installation
npm i @openreplay/tracker
Usage
Initialize the package from your codebase entry point and start the tracker. You must set the projectKey option in the constructor. Its value can can be found in your OpenReplay dashboard under Preferences -> Projects.
import Tracker from '@openreplay/tracker';
const tracker = new Tracker({
projectKey: YOUR_PROJECT_KEY,
});
tracker.start({
userID: "Mr.Smith",
metadata: {
version: "3.5.0",
balance: "10M",
role: "admin",
}
}).then(startedSession => {
if (startedSession.success) {
console.log(startedSession)
}
})
Then you can use OpenReplay JavaScript API anywhere in your code.
tracker.setUserID('my_user_id');
tracker.setMetadata('env', 'prod');
Read our docs for more information.