Here!!! #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

frank-dspeed wants to merge 280 commits into Victory:master from frank-dspeed:master

.gitignore

-Original file line number
+Diff line change
@@ -0,0 +1,6 @@
+    *.swp
+    /backups
+    /config/config.js
+    /node_modules
+    /GeoLiteCity.dat
+    /data/*.json

.gitmodules

-Original file line number
+Diff line change
@@ -0,0 +1,3 @@
+    [submodule "public/socket.io"]
+    	path = public/socket.io
+    	url = http://github.com/LearnBoost/Socket.IO.git

Capfile

-Original file line number
+Diff line change
@@ -0,0 +1,4 @@
+    load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+    Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+    load 'config/deploy' # remove this line to skip loading any of the default tasks

LICENSE.md

-Original file line number
+Diff line change
@@ -0,0 +1,24 @@
+    The MIT License
+    ===============
+    Copyright (c) 2010 Michael Nutt <michael@nuttnet.net> and others.
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    'Software'), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+    THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README

This file was deleted.

README.md

-Original file line number
+Diff line change
@@ -0,0 +1,133 @@
+    HUMMINGBIRD
+    ===========
+    Site tracking and analytics storage
+    Description
+    ---------------
+    Hummingbird serves a 1x1 tracking pixel to users.  In the browser's GET request it
+    sends back tracking data generated by javascript.
+    Requirements
+    -------------------
+     * node.js v0.8.0 or higher
+    Installation
+    --------------
+        git clone git://github.com/mnutt/hummingbird.git
+        cd hummingbird
+        # Use npm to install the dependencies
+        npm install
+        # 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
+    ------------------------------
+    To start the analytics server, run the following:
+        node server.js
+    By default a dashboard will be run on port 8080.  You can disable it for production use in
+    config/config.js.  The dashboard is just html served out of public/; you can serve it using
+    any webserver.
+    Deployment
+    ----------
+    Make sure to properly secure the dashboard if you don't want outside people to see it. This
+    typically means putting the dashboard behind nginx or apache using basic auth. The dashboard's
+    'listen' function takes a second argument that is the interface to bind; typically you
+    would choose "127.0.0.1" to only allow access from localhost, or "0.0.0.0" to listen on all
+    interfaces.  You should then run the tracking pixel on a different port so that it is accessible
+    to the outside world.
+    Setting Up Tracking
+    -------------------
+    The file `client/hummingbird.js` contains a small script to trigger a hummingbird event.  You
+    can either paste the contents of the file into the body of your webpage or you can upload it
+    to your server as a .js file and reference it with a `<script>` tag.  Once you have done so,
+    in the footer of your page you can call
+        HummingbirdTracker.track();
+    Called with no arguments, it will send over some standard parameters such as the page URL.  You
+    can also pass arbitrary data with the event:
+        HummingbirdTracker.track({logged_in: true});
+    The data can be used within Hummingbird's metrics to filter events on the backend.
+    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 broadcasts all activity to the clients using Websockets if possible, and
+    falls back to Flash sockets or long polling if necessary.
+    The Hummingbird.WebSocket object receives websocket events from the server in the form of JSON
+    objects.  Individual widgets subscribe to a metric and register handler functions to be called
+    whenever that metric 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 query params is in
+    lib/metric/cart_adds.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.
+    Tips
+    -----
+     * To run the UI locally but stream data from your production server, use the url http://localhost:8080/?ws_server=your-host.com&ws_port=12345
+    Contributors
+    ------------
+     * Michael Nutt <michael@nuttnet.net>
+     * Benny Wong <benny@bwong.net>
+     * mikecampo
+     * caphrim007
+     * brianjriddle
+     * lbosque
+     * robertjwhitney
+     * Dan Thurman
+     * thinkroth
+     * markwillis82
+     * ochronus
+     * dannyakakong
+     * xinbenlv
+    License
+    -------
+    Hummingbird is licensed under the MIT License. (See LICENSE)

TODO

This file was deleted.

client/file_watcher.js

-Original file line number
+Diff line change
@@ -0,0 +1,32 @@
+    var dgram = require('dgram');
+    var fs = require('fs');
+    function sendMessage(data) {
+      var message = new Buffer(JSON.stringify(data));
+      var client = dgram.createSocket("udp4");
+      client.send(message, 0, message.length, 8000, "localhost");
+      client.close();
+    }
+    var filename = process.argv[1];
+    if(!filename) {
+      console.log("No file specified");
+      exit(1);
+    }
+    console.log("Watching " + filename);
+    fs.watchFile(filename, function(curr, prev) {
+      console.log("HERE");
+      if(prev.size > curr.size) return {clear:true};
+      var stream = fs.createReadStream(filename, { start: prev.size, end: curr.size});
+      stream.addListener("data", function(lines) {
+        console.log("GOT MESSAGE");
+        lines.toString('utf-8').split("\n").forEach(function(line) {
+          var data = JSON.parse(line);
+          data.ip = data.remote_addr;
+          data.u = data.request_uri;
+          delete data.remote_addr;
+          delete data.request_uri;
+        });
+      });
+    });

client/hummingbird.js

-Original file line number
+Diff line change
@@ -0,0 +1,30 @@
+    HummingbirdTracker = {
+      track: function(env) {
+        if(typeof(env) == "undefined") { env = {}; }
+        // send some miscellaneous info about the request
+        env.u = document.location.href;
+        env.bw = window.innerWidth;
+        env.bh = window.innerHeight;
+        // example of sending a cookie named 'guid'
+        // env.guid = (document.cookie.match(/guid=([^\_]*)_([^;]*)/) || [])[2];
+        if(document.referrer && document.referrer != "") {
+          env.ref = document.referrer;
+        }
+        env.rnd = Math.floor(Math.random() * 10e12);
+        var params = [];
+        for(var key in env) {
+          if(env.hasOwnProperty(key)) {
+            params.push(encodeURIComponent(key) + "=" + encodeURIComponent(env[key]));
+          }
+        }
+        // replace 'localhost:8080' with hummingbird's URL
+        var img = new Image();
+        img.src = 'http://localhost:8080/tracking_pixel.gif?' + params.join('&');
+      }
+    };

client/udpSocketInterval.js

-Original file line number
+Diff line change
@@ -0,0 +1,23 @@
+    var Buffer = require('buffer').Buffer;
+    var dgram = require('dgram');
+    var sock = dgram.createSocket("udp4");
+    var data = {
+    	ip: '127.0.0.1',
+    	// '141.101.99.4',
+    	event: 'cart_add',
+    	headers: '/' // this is the full url
+    };
+    var buf = new Buffer(JSON.stringify(data));
+    console.log('buf:' + buf);
+    setInterval(function() {
+    	sock.send(buf, 0, buf.length, 8000, "0.0.0.0");
+    },100);

client/udp_client_sample.js

-Original file line number
+Diff line change
@@ -0,0 +1,23 @@
+    var Buffer = require('buffer').Buffer;
+    var dgram = require('dgram');
+    var sock = dgram.createSocket("udp4");
+    var data = {
+      "ip" : "129.59.1.10",
+      "timestamp" : "Sat Oct 23 2010 21:39:35 GMT-0400 (EDT)",
+      "url_key" : 123,
+      "product_id" : 456
+    };
+    var buf = new Buffer(JSON.stringify(data));
+    console.log('buf:' + buf);
+    setInterval(function() {
+    	sock.send(buf, 0, buf.length, 8000, "0.0.0.0");
+    },100);

config/config.example.js

-Original file line number
+Diff line change
@@ -0,0 +1,28 @@
+    module.exports = config = {
+        "name" : "Hummingbird",
+        // Replay some existing traffic logs to get an idea of what Hummingbird
+        // looks like.  Change this to false when you're ready to actually use
+        // Hummingbird in production.
+        "demo_mode": true,
+        // Port where the dashboard will be shown.  Change it to false to disable
+        // the dashboard. (you might do this if you were integrating
+        // Hummingbird into an existing admin interface)
+        "dashboard_port" : 8080,
+        // If you want to have the tracking pixel listen on a different port
+        // (for instance in order to password-protect your dashboard) you can
+        // specify the port to listen on (change from false to port number)
+        "tracking_port" : 8000,
+        // Allow stats to be sent over UDP instead of HTTP.  This works best for
+        // sending stats from backend servers within the same datacenter as
+        // Hummingbird.  Change to false to disable.
+        "udp_tracking_port" : 8000,
+        // Interface to bind the UDP listener to. Use 127.0.0.1 to only allow
+        // other apps on your machine to connect, or 0.0.0.0 to bind to all
+        // interfaces and allow any machine to connect.
+        "udp_trackin_address" : "127.0.0.1"
+    }

config/deploy.rb

-Original file line number
+Diff line change
@@ -0,0 +1,69 @@
+    require 'json'
+    settings = JSON.parse File.read(File.join(File.dirname(__FILE__), 'app.json'))
+    set :application, "hummingbird"
+    set :scm, :git
+    set :repository, settings['capistrano']['repository']
+    set :hummingbird_host, settings['capistrano']['hummingbird_host']
+    role :web, hummingbird_host
+    role :app, hummingbird_host
+    role :db,  hummingbird_host
+    depend :remote, :command, 'git'
+    set :git_enable_submodules, 1
+    set :deploy_to, "/var/www/#{application}"
+    default_run_options[:pty] = true
+    namespace :deploy do
+      task :restart, :roles => :app, :except => { :no_release => true } do
+        run "#{try_sudo} restart hummingbird"
+        run "#{try_sudo} restart hummingbird_monitor"
+      end
+      task :update_node_modules, :roles => :app do
+        run "cd #{latest_release}/#{current} && npm install"
+      end
+    end
+    desc 'Tail the production log'
+    task :tail, :roles => :app do
+      run "tail -100f #{shared_path}/log/hummingbird.log"
+    end
+    desc 'Tail nginx error log'
+    task :tail_error, :roles => :app do
+      sudo "tail -100f /var/log/nginx/error.log"
+    end
+    namespace :update do
+      desc 'Creates symlinks for shared resources'
+      task :symlink_shared do
+        symlinks = { 'log' => 'log', 'config/app.json' => 'config/app.json' }
+        symlinks.each do |shared, current|
+          run "rm -rf #{latest_release}/#{current}"
+          run "ln -s #{shared_path}/#{shared} #{latest_release}/#{current}"
+        end
+      end
+    end
+    desc "Backup the remote production database"
+    task :backup, :roles => :db do
+      filename = "#{application}.dump.#{Time.now.to_s.gsub(/[^0-9\-]/, '')}.bson"
+      file = "/tmp/hummingbird/metrics.bson"
+      on_rollback { run "rm #{file}" }
+      run "echo $PATH; mongodump -d hummingbird -c metrics -o /tmp"  do |ch, stream, data|
+        puts data
+      end
+      `mkdir -p #{File.dirname(__FILE__)}/../backups/`
+      get file, "backups/#{filename}"
+      run "rm #{file}"
+    end
+    after 'deploy:update_code', 'update:symlink_shared'
+    after 'deploy:update_code', 'deploy:update_node_modules'

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Here!!! #1

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Here!!! #1

Are you sure you want to change the base?

Uh oh!

Here!!! #1

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!