Rudder is an enterprise-ready, open-source alternative to Segment, for collecting and routing customer event data. More information on Rudder can be found here.
Follow the steps below to install our JS SDK on your react app -
To integrate the SDK, place the following code snippet in the <head> section of your React app's index.html.
You can use either the minified or non-minified version of the code:
The minified version is as follows:
<script>
rudderanalytics=window.rudderanalytics=[];for(var methods=["load","page","track","alias","group","identify","ready","reset"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(d){return function(){rudderanalytics.push([d,...arguments])}}(method)}rudderanalytics.load(<WRITE_KEY>,<DATA_PLANE_URL>),rudderanalytics.page();
</script>
<script src="https://cdn.rudderlabs.com/v1/rudder-analytics.min.js"></script>
The non-minified version of the code is shown below:
<script>
rudderanalytics = window.rudderanalytics = [];
var methods = [
"load",
"page",
"track",
"identify",
"alias",
"group",
"ready",
"reset"
];
for (var i = 0; i < methods.length; i++) {
var method = methods[i];
rudderanalytics[method] = function (methodName) {
return function () {
rudderanalytics.push([methodName].concat(Array.prototype.slice.call(arguments)));
};
}(method);
}
rudderanalytics.load(<WRITE_KEY>, <DATA_PLANE_URL>);
rudderanalytics.page();
</script>
<script src="https://cdn.rudderlabs.com/v1/rudder-analytics.min.js"></script>
NOTE: Whichever version of the code you use, you need to replace WRITE_KEY with the write key in the RudderStack Control Plane and DATA_PLANE_URL with the URI of the RudderStack Server/ Data Plane.
You can also execute the min file in async/defer way, like:
<script async src="https://cdn.rudderlabs.com/rudder-analytics.min.js"></script>
NOTE: We are moving our sdk to a diiferent path from the earlier https://cdn.rudderlabs.com/rudder-analytics.min.js to https://cdn.rudderlabs.com/v1/rudder-analytics.min.js. The earlier path may not be maintained in coming releases.
The identify() method allows you to link users and their actions to a specific userid.
A sample example of how the identify() method works is as shown:
rudderanalytics.identify(
"12345",
{ email: "name@domain.com" },
{
page: {
path: "",
referrer: "",
search: "",
title: "",
url: ""
}
},
() => { console.log("in identify call"); }
);
In the above example, information such as the user ID, email along with contextual information such as IP address, anonymousId, etc. will be captured.
NOTE: There is no need to call identify() for anonymous visitors to your website. Such visitors are automatically assigned an anonymousId.
The track() method allows you to track any actions that your users might perform.
A sample example of how the track() method works is as shown:
rudderanalytics.track(
"test track event GA3",
{
revenue: 30,
currency: 'USD' ,
user_actual_id: 12345
},
() => {console.log("in track call");}
);
In the above example, the method tracks the event ‘test track event GA3’, information such as the revenue, currency, anonymousId.
You can use this method to track various other success metrics for your website, such as user signups, item purchases, article bookmarks, and much more.
NOTE: To override contextual information, for ex: anonymising IP and other contextual fields like page properties, the following template can be used. Similarly one can override the auto generated anonymousId with provided id. For this:
rudderanalytics.track(
"test track event GA3",
{
revenue: 30,
currency: 'USD' ,
user_actual_id: 12345
},
{
page: {
path: "",
referrer: "",
search: "",
title: "",
url: ""
},
context: {
ip: "0.0.0.0"
},
anonymousId: "00000000000000000000000000"
},
() => {console.log("in track call");}
);
And we’re done! You’ve successfully installed rudder-analytics.js tracking. Now you can enable and use any event destination to send your processed event data that you want, in no time at all.
For a detailed technical documentation and troubleshooting guide on the RudderStack’s JavaScript SDK, click here.
There are cases when one may want to tap into the features provide by end destination SDKs to enhance tracking and other functionality. Rudder SDK exposes a ready api with a callback parameter that fires when the SDK is done initialising itself and other third-party native-sdk destinations.
Ex:
rudderanalytics.ready(
() => {console.log("we are all set!!!");}
);
One can also define callbacks to common methods of rudderanalytics object.
Note: For now, the functionality is supported for syncPixel method which is called in Rudder SDK when making sync calls in integrations for relevant destinations.
Ex:
<script>
rudderanalytics.syncPixelCallback = obj => {
rudderanalytics.track(
"sync lotame",
{ destination: obj.destination },
{ integrations: { All: false, S3: true } }
);
};
</script>
<script src="https://cdn.rudderlabs.com/rudder-analytics.min.js"></script>
In the above example, we are defining a syncPixelCallback on the analytics object before the call to load the SDK. This will lead to calling of this registered callback with the parameter
{destination: <destination_name>} whenever a sync call is made from Rudder SDK for relevant integrations like Lotame.
We will be adding similar callbacks for apis such as track, page, identify etc.
Once you have succesfully installed our JS SDK, you are all set to send your tracking data to Rudder.All you need to do now is to install dependencies for your app and run it.
Run the following command depending on whether you use npm or yarn to manage your packages -
npm install
OR
yarn install
To run your application, you need to run npm start or yarn start from your project's root directory.
Your events would now appear in the live events section of your source