Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
118 lines (74 sloc) 3.38 KB


Site tracking and analytics storage


Hummingbird serves a 1x1 tracking pixel to users. In the browser's GET request it sends back tracking data generated by javascript.


  • node.js v0.2.0
  • npm v0.2.4
  • mongodb


git clone git://
cd hummingbird

# Use npm to install the dependencies
npm install

# Copy the default configuration file
cp config/app.json.sample config/app.json

# To use the map, download MaxMind's GeoIP database and extract to the root directory:
gunzip GeoLiteCity.dat.gz

Running Hummingbird

To start the analytics server, run the following:

mongod &   (or start mongo some other way)
node server.js

By default a dashboard will be run on port 8080. You can disable it for production use in config/app.json. The dashboard is just html served out of public/; you can serve it using any webserver.


Make sure to properly secure the dashboard if you don't want outside people to see it. The dashboard httpServer's 'listen' function takes a second argument that is the interface to bind; typically you would choose "" to only allow access from localhost, or "" to listen on all interfaces. In production you should change the instances of "localhost:8000" in public/index.html to point to the server where you're hosting the dashboard.

Architecture Overview

Hummingbird is organized into two parts: a node.js-based tracking server that records user activity via a tracking pixel, and a collection of javascript-based widgets that display that activity. The server records all activity in MongoDB and broadcasts it to the clients using WebSockets if possible, and falling back to Flash sockets if necessary.

The Hummingbird.WebSocket object receives websocket events from the server in the form of JSON objects. Individual widgets subscribe to a property in the JSON tree and register handler functions to be called whenever that property is present.

Logging Customization

Metrics are stored in lib/metrics and auto-loaded. Each metric contains a handler function that is called every time a new user event occurs. Metrics store data in the data object property which gets emitted to clients in intervals specified by the metric. A basic example can be found in lib/metrics/total_views.js. An example of how a metric can filter based on urls is in lib/metric/sales.js.

Display Customization

Hummingbird comes with some stock widgets (Counter, Logger, Graph) that demonstrate how to hook into the data provided by the node.js server. For the minimum amount required to create a widget, see public/js/widgets/logger.js. A widget is an object whose prototype extends Hummingbird.Base and implements onMessage.


sudo gem install jspec
jspec run --node


  • To run the UI locally but stream data from your production server, use the url http://localhost:8080/?



Hummingbird is licensed under the MIT License. (See LICENSE)

Jump to Line
Something went wrong with that request. Please try again.