openreplay/tracker/tracker
2022-02-10 19:46:41 +01:00
..
scripts feat(ui) - assist filters 2022-02-10 19:46:41 +01:00
src feat(tracker): 3.5.0: better logging; metadata on start, session info for plugins 2022-02-08 22:54:08 +01:00
.eslintrc.cjs feat: tracker init 2021-05-03 13:31:55 +02:00
.gitignore feat: tracker init 2021-05-03 13:31:55 +02:00
.npmignore feat: tracker init 2021-05-03 13:31:55 +02:00
.prettierrc.json feat: tracker init 2021-05-03 13:31:55 +02:00
js_errors.txt feat: tracker init 2021-05-03 13:31:55 +02:00
LICENSE feat: tracker init 2021-05-03 13:31:55 +02:00
package-lock.json frat(tracker): 3.4.16: observer for shRoot, topObserver & sanitizer refactor; 3.4.17:autoResetOnWindowOpen; userID onStart option; restart fix 2022-01-23 18:28:22 +01:00
package.json feat(tracker): 3.5.0: better logging; metadata on start, session info for plugins 2022-02-08 22:54:08 +01:00
README.md feat(tracker): 3.5.0: better logging; metadata on start, session info for plugins 2022-02-08 22:54:08 +01:00
rollup.config.js fix (tracker): rollup mangle 2021-08-27 09:49:26 +03:00
tsconfig-base.json fix(tracker): 3.4.8: webpack 5 fully specified 2021-11-29 11:15:48 +01:00

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 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.