0.1.1-d.8 • Published 3 years ago

@mailbiz/browser-plugin-error-tracking v0.1.1-d.8

Weekly downloads
-
License
BSD-3-Clause
Repository
github
Last release
3 years ago

Snowplow Error Tracking

npm version License

Browser Plugin to be used with @mailbiz/browser-tracker.

Adds error tracking events to your Snowplow tracking.

Maintainer quick start

Part of the Mailbiz JavaScript Tracker monorepo.
Build with Node.js (12 LTS or 14 LTS) and Rush.

Setup repository

npm install -g @microsoft/rush 
git clone https://github.com/Mailbiz/Mailbiz.Tracker.Javascript.git
rush update

Package Installation

With npm:

npm install @mailbiz/browser-plugin-error-tracking

Usage

Initialize your tracker with the ErrorTrackingPlugin:

import { newTracker } from '@mailbiz/browser-tracker';
import { ErrorTrackingPlugin } from '@mailbiz/browser-plugin-error-tracking';

newTracker('sp1', '{{collector}}', { plugins: [ ErrorTrackingPlugin() ] }); // Also stores reference at module level

Then use the available functions from this package to track to all trackers which have been initialized with this plugin:

import { enableErrorTracking, trackError } from '@mailbiz/browser-plugin-error-tracking';

enableErrorTracking();

// OR

enableErrorTracking({
  filter: function (error) {
    return true;
  },
  contextsAdder: function (error) {
    return [
      {
        schema: 'iglu:org.schema/WebPage/jsonschema/1-0-0',
        data: {
          keywords: ['tester'],
        },
      },
    ];
  },
});

trackError({
  message: 'Cannot access notExistentProperty()',
  filename: 'trackError.js',
  lineno: 237,
  colno: 5,
  error: ex,
});

Copyright and license

Licensed and distributed under the BSD 3-Clause License (An OSI Approved License).

Copyright (c) 2022 Mailbiz.

All rights reserved.