Error tracking for JavaScript/TypeScript applications.

• 🦅 Automatic error catching
• 💎 Manual error and logs sending
• 🙂 Attaching user information
• 📦 Attaching additional context
• 🛡️ Sensitive data filtering
• 🌟 Source maps consuming
• 💬 Console logs tracking
•  Vue support
•  React support

We recommend adding Hawk script to page above others to prevent missing any errors.

Install package

npm install @hawk.so/javascript --save

yarn add @hawk.so/javascript

Then import @hawk.so/javascript module to your code.

import HawkCatcher from '@hawk.so/javascript';

Get a specific version bundle path from @hawk.so/javascript — open the page and copy the link. Do not use @latest, as your setup may break in case of a major API update.

Then require this script on your site.

<script src="..." async></script>

First of all, you should register an account on hawk.so.

Then create a Workspace and a Project in there. You'll get an Integration Token.

Create HawkCatcher class instance when script will be ready and pass your Integration Token:

const hawk = new HawkCatcher({token: 'INTEGRATION_TOKEN'});

// or

const hawk = new HawkCatcher('INTEGRATION_TOKEN');

Alternately, add onload="const hawk = new HawkCatcher({token: 'INTEGRATION_TOKEN'})" attribute to the <script> tag.

<script src="https://cdn.jsdelivr.net/npm/@hawk.so/javascript@latest/dist/hawk.js"
        onload="const hawk = new HawkCatcher({token: 'INTEGRATION_TOKEN'})"></script>

Initialization settings:

Other available initial settings are described at the type definition.

You can send errors or other messages to the Hawk manually, for example at your catch blocks or any debug conditions.

Use the .send(message, context) method for that. This method accepts the message of type Error or string as the first parameter. The second parameter is optional, it allows passing any additional data with the event. If you specify the context with the HawkCatcher constructor, it will be merged with the context passed to the send method.

// init Hawk Catcher instance
const hawk = new HawkCatcher({token: 'INTEGRATION_TOKEN'});

// somewhere in try-catch block or other custom place
hawk.send(new Error('Something went wrong'), {
  myOwnDebugInfo: '1234',
});

You can dynamically manage user information after the catcher is initialized:

const hawk = new HawkCatcher({token: 'INTEGRATION_TOKEN'});

// Set user information
hawk.setUser({
  id: 'user123',
  name: 'John Doe',
  url: '/users/123',
  image: 'https://example.com/avatar.jpg',
});

// Clear user (revert to generated user)
hawk.clearUser();

You can dynamically update context data that will be sent with all events:

const hawk = new HawkCatcher({token: 'INTEGRATION_TOKEN'});

// Set context data
hawk.setContext({
  feature: 'user-dashboard',
  version: '2.1.0',
  environment: 'production',
});

Breadcrumbs track user interactions and events leading up to an error, providing context for debugging.

By default, breadcrumbs are enabled with tracking for fetch/XHR requests, navigation, and UI clicks:

const hawk = new HawkCatcher({
  token: 'INTEGRATION_TOKEN'
  // breadcrumbs enabled by default
});

To disable breadcrumbs entirely:

const hawk = new HawkCatcher({
  token: 'INTEGRATION_TOKEN',
  breadcrumbs: false
});

Configure breadcrumbs tracking behavior:

const hawk = new HawkCatcher({
  token: 'INTEGRATION_TOKEN',
  breadcrumbs: {
    maxBreadcrumbs: 20,         // Maximum breadcrumbs to store (default: 15)
    trackFetch: true,           // Track fetch/XHR requests (default: true)
    trackNavigation: true,      // Track navigation events (default: true)
    trackClicks: true,          // Track UI clicks (default: true)
    beforeBreadcrumb: (breadcrumb, hint) => {
      // Filter or modify breadcrumbs before storing
      if (breadcrumb.category === 'fetch' && breadcrumb.data?.url?.includes('/sensitive')) {
        return false; // Discard this breadcrumb
      }
      return breadcrumb;
    }
  }
});

Add custom breadcrumbs manually:

hawk.breadcrumbs.add({
  type: 'logic',
  category: 'auth',
  message: 'User logged in',
  level: 'info',
  data: { userId: '123' }
});

// Add a breadcrumb
hawk.breadcrumbs.add(breadcrumb, hint);

// Get current breadcrumbs
const breadcrumbs = hawk.breadcrumbs.get();

// Clear all breadcrumbs
hawk.breadcrumbs.clear();

If your bundle is minified, it is useful to pass source-map files to the Hawk. After that you will see beautiful original source code lines in Hawk Garage instead of minified code.

To enable source map consuming you should do two things:

• Send the source map and the release identifier to the Hawk after you build a new version of the script. For example with the Hawk Webpack Plugin or with cURL request.
• Pass the release identifier to the Hawk Catcher using release option.

To make sure that Hawk is working right, call test() method from HawkCatcher class instance in browser's console. test() method sends fake error to server. Then, open Hawk and find a test event at the Project's page.

You can filter any data that you don't want to send to Hawk. Use the beforeSend() hook for that reason.

window.hawk = new HawkCatcher({
  token: 'INTEGRATION TOKEN',
  beforeSend(event) {
    if (event.user && event.user.name) {
      delete event.user.name;
    }

    return event;
  }
})

You can use the beforeSend() hook to prevent sending a particular event. Return false for that.

Vue apps have their own error handler, so if you want to catcher errors thrown inside Vue components, you should set up a Vue integration.

Pass the Vue constructor with the initial settings:

import Vue from 'vue';

const hawk = new HawkCatcher({
  token: 'INTEGRATION_TOKEN',
  vue: Vue // the Vue constructor you tweak
});

or pass it any moment after Hawk Catcher was instantiated:

import Vue from 'vue';

const hawk = new HawkCatcher({
  token: 'INTEGRATION_TOKEN',
});

hawk.connectVue(Vue)

React is suppported out of the box. No additional setup required.

Create the Hawk Catcher instance in a index.js file of your project.

import HawkCatcher from '@hawk.so/javascript';

const hawk = new HawkCatcher({
  token: 'INTEGRATION_TOKEN'
});

This project is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for the full text.