begrowth-analytics-rudderstack v0.6.3

rudderstack plugin for analytics

Integration with rudderstack for analytics

• Installation
• How to use
• Platforms Supported
• Browser usage
  • Browser API
  • Configuration options for browser
• Server-side usage
  • Server-side API
  • Configuration options for server-side
• Additional examples
• Loading script from custom proxy
• Making group calls
  • Browser Example
  • Server side Example

Installation

npm install analytics
npm install begrowth-analytics-rudderstack

How to use

The begrowth-analytics-rudderstack package works in the browser and server-side in Node.js. To use, install the package, include in your project and initialize the plugin with analytics.

Below is an example of how to use the browser plugin.

import Analytics from "analytics";
import rudderstackPlugin from "begrowth-analytics-rudderstack";

const analytics = Analytics({
  app: "awesome-app",
  plugins: [
    rudderstackPlugin({
      writeKey: "123-xyz",
      dataPlaneURL: "dataplane.com"
    })
  ]
});

/* Track a page view */
analytics.page();

/* Track a custom event */
analytics.track("cartCheckout", {
  item: "pink socks",
  price: 20
});

/* Identify a visitor */
analytics.identify("user-id-xyz", {
  firstName: "bill",
  lastName: "murray"
});

After initializing analytics with the rudderstackPlugin plugin, data will be sent into rudderstack whenever analytics.page , analytics.track, or analytics.identify are called.

See additional implementation examples for more details on using in your project.

Platforms Supported

The begrowth-analytics-rudderstack package works in the browser and server-side in Node.js

Browser usage

The rudderstack client side browser plugin works with these analytic api methods:

• analytics.page - Sends page views into rudderstack
• analytics.track - Track custom events and send to rudderstack
• analytics.identify - Identify visitors and send details to rudderstack
• analytics.reset - Reset browser storage cookies & localstorage for rudderstack values

Browser API

import Analytics from "analytics";
import rudderstackPlugin from "begrowth-analytics-rudderstack";

const analytics = Analytics({
  app: "awesome-app",
  plugins: [
    rudderstackPlugin({
      writeKey: "123-xyz",
      dataPlaneURL: "dataplane.com"
    })
  ]
});

Configuration options for browser

| disableAnonymousTraffic optional - boolean| Disable loading rudderstack for anonymous visitors | | customScriptSrc optional - boolean| Override the rudderstack snippet url, for loading via custom CDN proxy | | integrations optional - object| Enable/disable rudderstack destinations https://bit.ly/38nRBj3 |

Server-side usage

The rudderstack server-side node.js plugin works with these analytic api methods:

• analytics.page - Sends page views into rudderstack
• analytics.track - Track custom events and send to rudderstack
• analytics.identify - Identify visitors and send details to rudderstack

Server-side API

import Analytics from "analytics";
import rudderstackPlugin from "begrowth-analytics-rudderstack";

const analytics = Analytics({
  app: "awesome-app",
  plugins: [
    rudderstackPlugin({
      writeKey: "123-xyz",
      dataPlaneURL: "dataplane.com"
    })
  ]
});

Configuration options for server-side

| flushInterval optional - boolean| rudderstack sdk flushInterval. Docs https://bit.ly/2H2jJMb | | disableAnonymousTraffic optional - boolean| Disable loading rudderstack for anonymous visitors |

Additional examples

Below are additional implementation examples.

import Analytics from "analytics";
import rudderstackPlugin from "begrowth-analytics-rudderstack";

const analytics = Analytics({
  app: "awesome-app",
  plugins: [
    rudderstackPlugin({
      writeKey: "123-xyz",
      dataPlaneURL: "dataplane.com"
    })
    // ...other plugins
  ]
});

/* Track a page view */
analytics.page();

/* Track a custom event */
analytics.track("cartCheckout", {
  item: "pink socks",
  price: 20
});

/* Identify a visitor */
analytics.identify("user-id-xyz", {
  firstName: "bill",
  lastName: "murray"
});

If using node, you will want to import the .default

const analyticsLib = require("analytics").default;
const rudderstackPlugin = require("begrowth-analytics-rudderstack").default;

const analytics = analyticsLib({
  app: "my-app-name",
  plugins: [
    rudderstackPlugin({
      writeKey: "123-xyz",
      dataPlaneURL: "dataplane.com"
    })
  ]
});

/* Track a page view */
analytics.page();

/* Track a custom event */
analytics.track("cartCheckout", {
  item: "pink socks",
  price: 20
});

/* Identify a visitor */
analytics.identify("user-id-xyz", {
  firstName: "bill",
  lastName: "murray"
});

Below is an example of importing via the unpkg CDN. Please note this will pull in the latest version of the package.

<!DOCTYPE html>
<html>
  <head>
    <title>Using begrowth-analytics-rudderstack in HTML</title>
    <script src="https://unpkg.com/analytics/dist/analytics.min.js"></script>
    <script src="https://unpkg.com/begrowth-analytics-rudderstack/dist/begrowth-analytics-rudderstack.min.js"></script>
    <script type="text/javascript">
      /* Initialize analytics */
      var Analytics = _analytics.init({
        app: "my-app-name",
        plugins: [
          analyticsrudderstack({
            writeKey: "123-xyz",
            dataPlaneURL: "dataplane.com"
          })
        ]
      });

      /* Track a page view */
      analytics.page();

      /* Track a custom event */
      analytics.track("cartCheckout", {
        item: "pink socks",
        price: 20
      });

      /* Identify a visitor */
      analytics.identify("user-id-xyz", {
        firstName: "bill",
        lastName: "murray"
      });
    </script>
  </head>
  <body>
    ....
  </body>
</html>

Using begrowth-analytics-rudderstack in ESM modules.

<!DOCTYPE html>
<html>
  <head>
    <title>Using begrowth-analytics-rudderstack in HTML via ESModules</title>
    <script>
      // Polyfill process.
      // **Note**: Because `import`s are hoisted, we need a separate, prior <script> block.
      window.process = window.process || { env: { NODE_ENV: "production" } };
    </script>
    <script type="module">
      import analytics from "https://unpkg.com/analytics/lib/analytics.browser.es.js?module";
      import analyticsrudderstack from "https://unpkg.com/begrowth-analytics-rudderstack/lib/analytics-plugin-rudderstack.browser.es.js?module";
      /* Initialize analytics */
      const Analytics = analytics({
        app: "analytics-html-demo",
        debug: true,
        plugins: [
          analyticsrudderstack({
            writeKey: "123-xyz",
            dataPlaneURL: "dataplane.com"
          })
          // ... add any other third party analytics plugins
        ]
      });

      /* Track a page view */
      analytics.page();

      /* Track a custom event */
      analytics.track("cartCheckout", {
        item: "pink socks",
        price: 20
      });

      /* Identify a visitor */
      analytics.identify("user-id-xyz", {
        firstName: "bill",
        lastName: "murray"
      });
    </script>
  </head>
  <body>
    ....
  </body>
</html>

Loading script from custom proxy

In specific scenarios, you might want to load your own version of rudderstack's analytics from a different URL.

To do this, you can add the customScriptSrc option pointing to your custom rudderstack script.

import Analytics from "analytics";
import rudderstackPlugin from "begrowth-analytics-rudderstack";

const analytics = Analytics({
  app: "awesome-app",
  plugins: [
    rudderstackPlugin({
      writeKey: "123-xyz",
      dataPlaneURL: "dataplane.com",
      // Load rudderstack's analytics.js from somewhere else
      customScriptSrc: "https://yoursite.com/my-custom-loader.js"
    })
  ]
});

Making group calls

The .group call is specific to rudderstack and the analytics lib doesn't expose this by default. But you are in luck 😃 thanks to custom methods on plugins!

To send a group call to rudderstack run the analytics.plugins.rudderstack.group() custom method.

The analytics.plugins.rudderstack.group function has the following signature:

analytics.group(groupId, [traits], [options], [callback]);

Browser Example

import Analytics from "analytics";
import rudderstackPlugin from "begrowth-analytics-rudderstack";

// Initialize analytics instance with plugins
const analytics = Analytics({
  app: "your-app-name",
  plugins: [
    rudderstackPlugin({
      writeKey: "123-xyz",
      dataPlaneURL: "dataplane.com"
    })
  ]
});

// Usage:
// Now you can call rudderstack.group in your app like so
analytics.plugins.rudderstack.group("Group ID XYZ", {
  principles: ["Bill", "Bob"],
  site: "Apple co",
  statedGoals: "Do awesome stuff",
  industry: "Technology"
});

Server side Example

const analyticsLib = require("analytics").default;
const rudderstackPlugin = require("begrowth-analytics-rudderstack");

// Initialize analytics instance with plugins
const analytics = Analytics({
  app: "your-app-name",
  plugins: [
    rudderstackPlugin({
      writeKey: "123-xyz",
      dataPlaneURL: "dataplane.com"
    })
  ]
});

analytics.plugins.rudderstack.group("Group ID XYZ", {
  principles: ["Bill", "Bob"],
  site: "Apple co",
  statedGoals: "Do awesome stuff",
  industry: "Technology"
});