Snowplow Error Tracking

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

Adds error tracking events to your Snowplow tracking.

Maintainer quick start

Part of the Snowplow JavaScript Tracker monorepo.
Build with Node.js (18 - 20) and Rush.

Setup repository

npm install -g @microsoft/rush 
git clone https://github.com/snowplow/snowplow-javascript-tracker.git
rush update

Package Installation

With npm:

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

Usage

Initialize your tracker with the ErrorTrackingPlugin:

import { newTracker } from '@snowplow/browser-tracker';
import { ErrorTrackingPlugin } from '@snowplow/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 '@snowplow/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 Snowplow Analytics Ltd, 2010 Anthon Pang.

All rights reserved.