Snowplow Bot Detection

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

Detects bots client-side using FingerprintJS BotD and attaches the result as a client_side_bot_detection context entity to all tracked events.

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-bot-detection

Usage

Initialize your tracker with the BotDetectionPlugin:

import { newTracker } from '@snowplow/browser-tracker';
import { BotDetectionPlugin } from '@snowplow/browser-plugin-bot-detection';

newTracker('sp1', '{{collector}}', { plugins: [ BotDetectionPlugin() ] });

Once detection completes, a client_side_bot_detection context entity will be attached to all subsequent events with the following fields:

• bot (boolean): Whether a bot was detected.
• kind (string | null): The type of bot detected (e.g. "selenium", "phantomjs"), or null if no bot was found.

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.