Track your visitors using an HttpModule

Oct 30, 2008

I’ve been thinking about how to solve a very simple problem on a website: visitor behaviour tracking. In a sense it is what Google Analytics does, but there are problems with conventional JavaScript based trackers.

They are good at tracking page views, but very bad at tracking actions or behaviour around a website. Some products like Headlight are actually pretty good at tracking actions such as button clicks etc, but at the level I’m interested in tracking, I would have to add JavaScript all over my page. I don’t want to do that.

Also, there are some very good server-side logging products like log4net out there. The problem is that they are not really meant for tracking website behaviour with URLs, user agents and other important metadata.

What I want is a combination of the traditional JavaScript- and server-side methods. So, I’ve played around with a custom HttpModule that logs all page views and custom actions. You add the custom actions yourself by calling VistorLog.AddAction("message", "type"). That way you have page views and actions in a chronologically correct order.

A neat thing is that all page views and actions are kept in session and only when the session expires does it write to the database. That way it can do a batch insert which is much faster than hitting the database constantly. Another neat thing is that the HttpModule is only 100 lines of code.

The code

Basically, three things are going on. The session starts and we add a Visit object to it. 

void session_Start(object sender, EventArgs e)

{

  HttpContext context = HttpContext.Current;

  Visit visit = new Visit();

  visit.UserAgent = context.Request.UserAgent;

  visit.IpAddress = context.Request.UserHostAddress;

  context.Session.Add("visit", visit);

}

Then every page view is registered after an .aspx page is served.

void context_PostRequestHandlerExecute(object sender, EventArgs e)

{

  HttpContext context = ((HttpApplication)sender).Context;

 

  if (context.CurrentHandler is Page)

  {

    Visit visit = context.Session["visit"] as Visit;

    if (visit != null)

    {

      Action action = new Action();

      action.Url = context.Request.Url;

      action.Type = "pageview";

      visit.Action.Add(action);

    }

  }

}

Then the session ends and we need to store the visitor log.

void session_End(object sender, EventArgs e)

{

  HttpContext context = HttpContext.Current;

  Visit visit = context.Session["visit"] as Visit;

  if (visit != null)

  {

    // Log the Visit object to a database

  }

}

Implementation

When you have registered the HttpModule in the web.config, then it starts collection page views in the session. To store them in a database you must add your own code to the session_End method of the module. Now you are also able to store actions just by calling a static method on the VisitorLog module:

VisitorLog.AddAction("Profile picture deleted", "deletion");

Keep in mind that this code is just me playing around in my sandbox. It has never been in a production environment.

Download

VisitorLog.zip (1,11 kb)

* $4.95/month ASP.NET Hosting with FREE SQL 2012 DB! – Click Here!

Comments (14) -

Omer van Kloeten
Omer van Kloeten Israel
10/30/2008 8:53:43 PM #

Or you could simply use a free product that already exists which is much more powerful, and also happens to be where I work ;)

http://www.nuconomy.com/

Bradvin
Bradvin South Africa
10/31/2008 5:45:31 AM #

Can you rely on the session_end event? I have read many posts on forums complaining about the reliability of the end event. Have you had similar problems? I have not tried anything similar before, but have always wondered about this...

Miron
Miron Israel
10/31/2008 10:46:37 AM #

You will want to rename your 'Action' class to something else since 'Action' is part of the 'System' namespace

Alex Tafoya
Alex Tafoya United States
11/1/2008 5:12:10 AM #

Nice addition!

Mads Kristensen
Mads Kristensen Denmark
11/1/2008 8:47:48 AM #

@Omer

I've never seen that product before. From what I can tell from the website, it might be exactly what I'm looking for. Thanks

mdma
mdma Israel
11/4/2008 7:45:09 AM #

this will work only if Session_End is triggered while in most of cases it is not.
Please read when Session_End is triggered before you implement it giving it a trust more than to Google's or anyone else's JS files.

quite useless October 2008 pick imho

Dusan
Dusan United Kingdom
11/5/2008 7:25:16 AM #

Dear Mads, you said : "I would have to add JavaScript all over my page. I don’t want to do that." ... Well, this is exactly what seems to be happening all over the pages everywhere else? I think there might be some better reason for this than just a fashionable kind of a development.

Very often it is necessary to take the step back and see the full picture.

Kepp up a good work ;o)

Dusan

Dusan
Dusan United Kingdom
11/5/2008 7:26:15 AM #


This above ic certainly NOT my gravatar picture ?

Dusan

Josh Berke
Josh Berke
11/6/2008 11:28:23 PM #

Interesting idea, but this will not work if your using out of process session state as people posted the Session_End event is not fired. Also I'm not sure how large your site is but what would be the memory requirements for a high traffic site with lots of page hits?

The only other concern is that I assume your using inproc session state, since your Session_End event is working, in this case if your server goes down you've lost your data which if your only doing trend analysis isn't a big deal.

Just some thoughts but anyways interesting idea.

Romi
Romi
11/15/2008 10:44:50 AM #

Hi Mads,
How to use to redirect users using the ip to some pages. I searching to get the country and redirect the user to this or that pages.thanks.

Yoann. B
Yoann. B France
12/1/2008 6:05:36 PM #

Hi,

Great article

Here is my personnal approach : blog.sb2.fr/.../...ount-and-Infos-with-ASPNET.aspx

Thanks!

Speed Dating
Speed Dating United States
12/4/2008 10:19:18 PM #

This is one of the coolest things I have heard about. I am using ASP.net as that is what my programmer codes with. I will give him this post. Your blog is full of all these cool things. You are a genius.

cheap electric guitars
cheap electric guitars United States
1/10/2009 8:35:34 PM #

Nice idea. If Session_End is triggered that this should work.

WII System Bundle
WII System Bundle United States
1/11/2009 12:07:30 AM #

This tracking system is interesting. Hope see more soon!

Pingbacks and trackbacks (6)+

Comments are closed

About the author

Mads Kristensen

Mads Kristensen
Program Manager at the Microsoft Web Platform team and founder of BlogEngine.NET.

More...

Month List

Disclaimer

The opinions expressed herein are my own personal opinions and do not represent my employer’s view in any way.