@amplitude/plugin-network-capture-browser

@amplitude/plugin-network-capture-browser (beta)

This plugin is in beta at the moment, naming and interface might change in the future.

TODO: Re-write this README.md to match plugin-network-capture

Browser SDK plugin for network capture.

Installation

This package is published on NPM registry and is available to be installed using npm and yarn.

# npm
npm install @amplitude/plugin-network-capture-browser@beta

# yarn
yarn add @amplitude/plugin-network-capture-browser@beta

Usage

This plugin works on top of the Amplitude Browser SDK, and tracks network request events

To use this plugin, you need to install @amplitude/plugin-network-capture-browser

1. Import Amplitude packages

• @amplitude/analytics-browser
• @amplitude/plugin-network-capture-browser

import * as amplitude from '@amplitude/analytics-browser';
import { networkCapturePlugin } from '@amplitude/plugin-network-capture-browser';

2. Instantiate the plugin

The plugin accepts 1 optional parameter, which is an Object to configure the allowed tracking options.

const plugin = networkCapturePlugin({
  ignoreHosts: ['host.com', 'host2.com'], // hosts to ignore; default []
  ignoreAmplitudeRequests: true, // ignore requests to amplitude.com; default "true",
  captureRules: [
    {hosts: ['host3.com', 'host4.com'], statusCodeRange: '400-499'},
    {hosts: ['example.com'], statusCodeRange: '403,500-599'},
  ],
});

3. Install plugin to Amplitude SDK

amplitude.add(plugin);

4. Initialize Amplitude SDK

amplitude.init('API_KEY');