0.3.0 • Published 1 year ago

@cronitorio/cronitor-rum-js v0.3.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 year ago

Cronitor RUM client (browser)

A simple JavaScript library for Cronitor Real User Monitoring.

Quickstart

Install

Run the following command to install in your project:

npm install @cronitorio/cronitor-rum-js

Or with yarn:

yarn add @cronitorio/cronitor-rum-js

Basic usage

You can now import, and use the client on your project.

import * as Cronitor from '@cronitorio/cronitor-rum-js';

// Load the Cronitor tracker once in your app
Cronitor.load('YOUR_CLIENT_KEY');

// This is how you record page views
Cronitor.track('Pageview');

// You can also trigger custom events
Cronitor.track('NewsletterSignup');

You can set any configuration options as follows:

import * as Cronitor from '@cronitorio/cronitor-rum-js';

// Load the Cronitor tracker once in your app
Cronitor.load('YOUR_CLIENT_KEY', {
    debug: true,
    environment: "staging",
    includeURLQueryParams: ["tab", "pageNum"]
});

Changelog

0.3.0

  • Open source analytics script.

0.2.0

  • Update types.

0.1.0

  • Initial open source release.

Security Disclosure

If you discover any issue regarding security, please disclose the information responsibly by emailing us at support@cronitor.io. Do NOT create a Issue on the GitHub repo.

Contributing

Please check for any existing issues before opening a new Issue. If you'd like to work on something, please open a new Issue describing what you'd like to do before submitting a Pull Request.

License

See LICENSE.