Skip to content

Commit

Permalink
Update readme for geoip
Browse files Browse the repository at this point in the history
  • Loading branch information
mnutt committed Jan 22, 2011
1 parent 3216017 commit b02e3ff
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Expand Up @@ -31,6 +31,10 @@ Installation
# 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:
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
gunzip GeoLiteCity.dat.gz


Running Hummingbird
------------------------------
Expand Down Expand Up @@ -71,10 +75,11 @@ 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
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/all.js. An example of how a metric can filter based on urls is in lib/metric/sales.js.
lib/metrics/total_views.js. An example of how a metric can filter based on urls is in
lib/metric/sales.js.


Display Customization
Expand Down
4 changes: 2 additions & 2 deletions lib/metric.js
Expand Up @@ -121,10 +121,10 @@ Metric.allMetrics = function(callback) {
Metric.availableMetricPaths(function(metricPath) {
var m = require(metricPath);
if(typeof(m.canLoad) == "function" && m.canLoad() == false) {
console.log("Skipping metric " + m.name + ".");
sys.log("Skipping metric " + m.name + ".");
return;
} else {
console.log("Loading metric " + m.name + ".");
sys.log("Loading metric " + m.name + ".");
}

// Instantiate a new metric and use the settings from the custom metrics class
Expand Down

0 comments on commit b02e3ff

Please sign in to comment.