Getting Started

Cumulus SDK

Install

Cumulus captures data by using an SDK within your web application's runtime.

npm install --save https://github.com/tophat-cloud/cumulus
yarn add https://github.com/tophat-cloud/cumulus

We also considering about provide alternate installtion methods like CDN!

Configure

Configuration should happen as early as possible in your application's lifecycle.

Once this is done, Cumulus's SDK captures all weakness.

import { protect } from 'cumulus';

protect({
  key: '__key__',
});

If you haven't __key__, please sign-up and got a cumulus project key!

Verify

This snippet includes an logging, so when SDK applied well, you can check log message from console.

import { captureMessage } from 'cumulus';

// ...

captureMessage('Hello, world!');