redux-beacon

Redux Beacon

Analytics integration for Redux and ngrx/store

Docs

• Migration Guide (from v1 to v2)
• Getting Started (Redux users)
• Getting Started (ngrx users)

Introduction

If you're using Redux or ngrx/store to manage your app's state, you can use Redux Beacon to tap into your dispatched actions and map them to events that are consumable by an analytics service (e.g. Google Analytics). With Redux Beacon your entire global state life-cycle becomes trackable.

✓ Redux Beacon is Lightweight

The core Redux Beacon module is tiny (~ 1KB), and each target, extension, and util, is either around the same size or smaller.

✓ Redux Beacon is Framework Agnostic

Redux Beacon doesn't depend on any framework, you can use Redux Beacon with React, Angular, React Native, Vue or just plain JavaScript.

✓ Redux Beacon Can Send Analytics Anywhere

With Redux Beacon you can send analytics events anywhere. We have prebuilt targets for the most popular analytics services, you can also build your own custom targets if you need to.

✓ Redux Beacon Can Track Analytics Offline

Redux Beacon provides extensions for tracking analytics during intermittent outages in connectivity. These extensions save events in a persistent store when offline (e.g indexedDB). When back online, the extensions purge the store and pass the events off to a target. Read more about offline event collection in the docs.

Packages

	Version	Package
		redux-beacon
		@redux-beacon/google-analytics
		@redux-beacon/google-analytics-gtag
		@redux-beacon/google-tag-manager
		@redux-beacon/react-native-google-analytics
		@redux-beacon/react-native-google-tag-manager
		@redux-beacon/amplitude
		@redux-beacon/segment
🔌		@redux-beacon/logger
🔧		@redux-beacon/combine-events
🔧		@redux-beacon/ensure
🔌		@redux-beacon/offline-web
🔌		@redux-beacon/offline-react-native

API Overview

When using Redux Beacon the bulk of your work will be in an eventsMap which is an object that maps action types to analytics events. Here's what an eventsMap might look like:

const eventsMap = {

  // Track a page view on each 'ROUTE_CHANGED' action
  'ROUTE_CHANGED': trackPageView(action => ({
    page: action.payload.routerState.url,
  })),


  // Track an event on each 'VIDEO_SELECTED' action, use the state before
  // the action and the state after the action to hydrate the analytics event
  'VIDEO_SELECTED': trackEvent((action, prevState, nextState) => ({
    category: 'Videos',
    action: action.type,
    label: prevState.videos.currentCampaign,
    value: nextState.videos.numVideosSelected,
  }))


  // Track an event on _every_ action with the special '*' key
  '*': trackEvent(action => ({
    category: 'redux',
    action: action.type,
  })),


  // Track multiple events on each 'VIDEO_PLAYED' action with the
  // combineEvents util
  'VIDEO_PLAYED': combineEvents(
    trackTiming(action => ({
      category: 'Videos',
      action: 'load',
      value: action.payload.loadTime,
    }))
    trackEvent(() => ({
      category: 'Videos',
      action: 'play'
    })),
  ),


  // Track an event on each 'VIDEO_SEARCHED' action, but throttle it with
  // the debounceEvent util so it doesn't fire as often
  'VIDEO_SEARCHED': debounceEvent(300,
     trackEvent(action => ({
       category: 'Videos',
       action: 'search',
       label: action.payload.searchTerm,
     }))
   ),

};

The trackPageView, trackEvent, and trackTiming functions used above are called eventDefinitions and are what you use to create events that are consumable by an analytics service (a.k.a "target"). Each target will have its own set of eventDefinitions that you can use and customize. In a nutshell, each time you want to track something:

1. Find the event definition for the thing you want to track.
2. Match the event definition to an action then fill in the event definition.

If the eventsMap object doesn't meet your needs you can also use an eventsMapper function to map action types to event definitions:

const pageView = trackPageView(action => ({
  page: action.payload.routerState.url,
}));

const videoLoadTime = trackTiming(action => ({
   category: 'Videos',
   action: 'load',
   value: action.payload.loadTime,
}));

const videoPlayed = trackEvent(() => ({
  category: 'Videos',
  action: 'play'
}));

const eventsMapper = (action) => {
  switch(action.type) {
    case 'ROUTE_CHANGED':
      return pageView;
    case 'VIDEO_PLAYED':
      return [videoLoadTime, videoPlayed]
    default:
      return [];
  }
}

Examples & Recipes

• How to Track Pageviews in a React-Redux app
• How to Track Pageviews in an Angular-ngrx app
• How to Track Analytics Offline (Web)
• How to Track Analytics Offline (React Native)