Pre-Requisites

Before getting started, you need to ensure your Jekyll site is installed and set up. If you haven’t done it yet, visit the official Jekyll installation doc to get started.

Step 1: Integrating Your Jekyll Site with RudderStack JavaScript SDK

Creating a Source in RudderStack

You need to set up a JavaScript source in your RudderStack dashboard that will track events from your Jekyll site. Follow these steps to set up the source:

1. Log into your RudderStack dashboard. If you’re new to RudderStack, sign up here.
2. On login, you should see the following dashboard:

3. Note down the Data Plane URL. You will need this URL to integrate your Jekyll site with RudderStack.

4. Create a Source by clicking on the Add Source option. You can also click on the Directory option in the left nav bar and select Event Streams under Sources, as shown. Next, select JavaScript.

5. Add a name for JavaScript Source and click on Next.

6. Your JavaScript source is now configured and ready to track events. Note the Write Key associated with this source. You will need it to set up the RudderStack integration with your Jekyll site.

Integrating Your Jekyll Site with RudderStack

Integrate RudderStack JavaScript code with your Jekyll Site and set up the tracking code following steps given below:

1. Jekyll has an extensive theme system that helps customize your site's presentation. Minima is Jekyll’s default theme. You can check your default theme using the following command:

JAVASCRIPT
Copy
bundle info --path minima

The following command opens an explorer window showing the theme files and directories.

JAVASCRIPT
Copy
`open $(bundle info --path minima)`

2. Next, create**

rudder.html

_includes

minima

JAVASCRIPT
Copy
<script>
  rudderanalytics = window.rudderanalytics = [];
  var methods = [
    "load",
    "page",
    "track",
    "identify",
    "alias",
    "group",
    "ready",
    "reset",
    "setAnonymousId",
    "getAnonymousId",
  ];
  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(
    "YOUR_WRITE_KEY",
    "DTA_PLANE_URL"
  );
  rudderanalytics.ready(function () {
    console.log("Application is ready with JS");
  });
  rudderanalytics.track("Simple track call1");
</script>
<script src="https://cdn.rudderlabs.com/v1/rudder-analytics.min.js"></script>

Create rudder.html file

Note: If you have installed any other theme (other than minima), you will have to make changes to the files of that theme.

JAVASCRIPT
Copy
{%- include rudder.html -%}

Now go to

_includes/head.html

Important: You can refer to our sample Jekyll site present in our RudderStack Jekyll site repository for more information on modifying these files.

Step 2: Creating a Destination Tool in RudderStack for Routing Your Jekyll Site Events

RudderStack supports over 80 third-party tools and platforms to which you can securely send your tracked events. In this section, we will route the Jekyll Site events to Google Analytics. To add Google Analytics as a destination in RudderStack, follow the steps given below:

1. In the left navigation bar of your RudderStack dashboard, click on Destinations and select Add Destination. Since we have already configured a source, you can simply click on the source and click on the Add Destination option, as shown:

Note: You can use Connect Destinations option if you have already configured a destination in RudderStack and want to send your event data to that platform.

2. Next, choose Google Analytics as your Destination.

3. Add a name to your destination and click on Next, as shown:

4. Now, connect the JavaScript source that we have already configured in Step 1.

5. On the Connection Settings page, configure your Google Analytics destination with your Google Analytics Tracking ID and other optional settings, as shown below. Then, click on Next.

6. You can also transform your events before sending them to Google Analytics. For more information on this feature, check out our documentation on User Transformations.

7. Great job! Google Analytics is now configured as a destination. You should now see the following source-destination connection in your dashboard:

(Alternate) Step 2: Create a Warehouse Destination for Your Jekyll Site Events

Important: Before you configure a data warehouse as a destination in RudderStack, you will need to set up a new project in your data warehouse. Also, you need to create a new RudderStack user role with the relevant permissions.

Follow our documentation to get step-by-step instructions on how to do it for your preferred data warehouse.

We will configure a Google BigQuery warehouse destination for this tutorial to route all the events from our Jekyll Site. You can set up a BigQuery project with the required permissions for the service account by following our documentation.

Once you have set up the project and assigned the required user permissions, follow the instructions given below:

1. From the Destinations Directory, select Google BigQuery:

2. Assign a name to your Destination and click on Next.

3. Connect to JavaScript source from which we will track our Jekyll Site events. Then, click on Next.

4. Specify Connection Credentials. Add BigQuery Project ID and the Staging Bucket Name. You can refer to these instructions to get this information.

5. Lastly, copy the contents of the private JSON file. For more information on how to do this, refer to our documentation.

That’s all! You have successfully set up BigQuery as a warehouse destination in RudderStack.

Step 3: Deploying Your Jekyll Site and Verifying the Event Stream

We have successfully configured our event source and destination. Let’s verify if our event stream works correctly. To do so, let’s deploy our Jekyll Site application and test if the events are tracked by the JavaScript source and delivered to our Google Analytics destination.

Follow these steps to find:

1. On your Terminal or cmd, navigate to the folder containing your Jekyll Site.

2. To deploy the app, run

bundle exec jekyll serve

3. Open your Jekyll site by visiting the server address mentioned in the cmd or http://localhost:4000 on your browser.

4. Next, verify if

rudder-analytics.js

5. Check if RudderStack can track the different pageviews and clicks by clicking on the Live Events tab of your JavaScript source on the RudderStack dashboard page:

Note: After deploying your app, there can sometimes be a lag before events start sending and are visible in your dashboard and destination. Don’t worry. All events are captured and sent; just be aware that they can take a few minutes to show up.

6. Brilliant! RudderStack has successfully tracked and captured the events:

7. Next, let’s check if the events are sent to our Google Analytics destination. Go to your Google Analytics dashboard and navigate to the Realtime - Events option.

As you can see, we have one active user on our Jekyll site, and the track event is visible too. This shows that the event has been tracked and delivered successfully. Similarly, you should also receive the event in your Google BigQuery warehouse.

Summary

Website analytics help companies gain a macroscopic understanding of how users interact with multiple features on your site. This ensures that the website is up and running and performs in the best way possible, and results in a better end-user experience. RudderStack helps you achieve this securely.

In this post, we learned how to instrument real-time event data on your Jekyll site using RudderStack. We integrated the Jekyll site with RudderStack JS SDK and set up the tracking code. We also integrated Google Analytics as a destination in RudderStack to route all event streams in real-time and also verify successful delivery of the event streams.