scout_realtime 0.5.1

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.ruby-version
+.DS_Store
+.vagrant/

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.5.1
+
+* Fixed Firefox layout, added some UI refinements, bumped up server_metrics gem requirement.
+
+## 0.5.0
+
+* Beta release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in scout_realtime.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andre Lewis
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,37 @@
+# Scout Realtime
+
+Stream realtime server and process metrics to your browser!
+
+<img src="https://www.evernote.com/shard/s1/sh/0b0c8bdb-9430-4758-8ce5-98ce385c2c76/339cf36badbdaf6d9f99b964a03358de/deep/0/Realtime.png">
+
+
+
+## To get started:
+
+* On the server you want to monitor:
+  * install the gem: `gem install scout_realtime`
+  * start the daemon: `scout_realtime start`
+* on your local computer:
+  * create an SSH tunnel to your server: `ssh -NL 5555:localhost:5555 user@ip_or_hostname` (where user@ip_or_hostname is the same as you usually use to SSH to your server)
+  * Point your browser to http://localhost:5555
+
+When you're done, you can stop the daemon with: `scout_realtime stop`
+
+## Why?
+
+Scout realtime is a better `top` command: it gives you disk, memory, network, CPU, and process metrics. And it gives you smooth-flowing charts for everything. **Troubleshooting is so much easier when you can see a few minutes worth of realtime data** instead of watching individual numbers flash on your terminal window.   
+
+
+## Questions & troubleshooting
+
+* **Something isn't working. Where's the log?** By default, the a log is written to `~/scout_realtime.log`
+* **Does my server need to have a public IP or domain name?** Yes, you need a public IP or domain name to view Scout Realtime in your browser.
+* **Installing the gem didn't work.** You need Ruby 1.8.7+ on your server to run Scout Realtime. Try `which ruby` (to confirm you have Ruby), `ruby -v` (to show Ruby's version), and `which gem` to confirm you have Ruby gems (Ruby's package manager) available.
+* **Can multiple people view the realtime stats?** Yes. You'll probably want to open a port in your firewall instead of relying in the SSH tunnel for access: `sudo iptables -A INPUT -p tcp --dport 5555 -j ACCEPT`
+* **The SSH tunnel is a pain. Is there a way to set up persistent access?** Yes -- open a port in your firewall using the iptables command above.
+  * **Is that safe?** It's as safe or safer than any any other service you have listening for HTTP traffic. The realtime web server only serves two endpoints, and there's nothing available at either of those endpoints that can be used in an attack.
+* **5555 is a strange number. Can I run it on a different port?** Yes. `scout_realtime help` for options.
+* **I want to log written someplace other than my home directory.** You can do that. See `scout_realtime help` for options.
+* **How much resources will this take if I leave it running?** About the same CPU resources as htop. A bit more memory because it's written in Ruby.
+
+

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+
+
+# put the current packaged version of the gem in dropbox
+desc "copies the current packaged .gem file to dropbox and prints the URL"
+task :dropbox do
+
+  path=File.dirname(__FILE__)+"/pkg/scout_realtime-#{Scout::Realtime::VERSION}.gem"
+  if !File.exists?(path)
+    puts "Doesn't exist: #{path}. Try rake build"
+    exit(0)
+  end
+
+  FileUtils.copy(path, "/Users/andre/Dropbox/Public/")
+  puts "wget https://dl.dropboxusercontent.com/u/18554/scout_realtime-#{Scout::Realtime::VERSION}.gem; sudo gem install scout_realtime"
+end

data/Vagrantfile

@@ -0,0 +1,7 @@
+# This is derek's vagrant file. Can delete if it causes confusion. It starts an Ubuntu Ruby 2 box.
+Vagrant::Config.run do |config|
+  config.vm.box = "Ubunutu64-ruby2"
+  config.vm.box_url = "https://dl.dropboxusercontent.com/s/o5i10hcu57jamg8/ubuntu64-ruby2.box"
+  config.vm.share_folder "foo", "/projects", "/Users/itsderek23/projects/"
+  config.vm.forward_port 5555,5555
+end

data/bin/scout_realtime

@@ -0,0 +1,117 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), *%w[.. lib])
+load "scout_realtime.rb"  # bootstraps everything, including all other requires
+require "dante"           # ... except dante, which is required here because it's only relevant to running via command line
+require "fileutils"       # ... and fileutils, which we use for setting up the home directory
+
+# exit if Ruby version 1.9 on Mac
+if RUBY_VERSION =~ /^1\.9/ && ServerMetrics::SystemInfo.os.include?("darwin")
+  puts "Scout realtime doesn't work with Ruby 1.9.x on Mac. If you are using RVM, try switching to Ruby 2.0 (preferred), or 1.8.7"
+  exit
+end
+
+# by default, scout_realtime puts its pid and logfile in ~/.scout/
+home_dir =  File.join( (File.expand_path("~") rescue "/"), ".scout" )
+FileUtils.mkdir_p(home_dir) # ensure home directory exists
+pid_path = File.join(home_dir, "scout_realtime.pid")
+log_path = File.join(home_dir, "scout_realtime.log")
+
+# parse the command
+cmd = ARGV.first
+command = nil
+command = :start if cmd.nil? || cmd =~/^\-/
+command = cmd.downcase.to_sym if cmd && %w(start stop help).include?(cmd.downcase)
+
+# parse the options
+
+opts = Trollop::options do
+  banner <<-EOS
+Stream realtime server metrics to your browser!
+
+To start the daemon:
+      scout_realtime start OR JUST scout_realtime
+To stop it:
+      scout_realtime stop
+
+To view in your browser, do ONE of the following:
+
+A) create an SSH tunnel: ssh -NL 5555:localhost:5555 user@ip_or_hostname (run that command on your own computer, not the server)
+   then point your browser to: http://localhost:5555
+   --- OR ---
+B) open a port in your firewall: sudo iptables -A INPUT -p tcp --dport 5555 -j ACCEPT (run that command on your server)
+   then point your browser to: http://your-ip-or-hostname:5555
+
+* FYI, the log file is: #{log_path} by default
+* See http://scoutapp.github.io/scout_realtime for more info
+
+
+Advanced options:
+  EOS
+
+  opt :port, "point your web browser to this port to view realtime metrics.", :default => 5555, :short => "-p"
+  opt :foreground, "run in the foreground, i.e., don't daemonize the process. Useful for debugging.", :default => false, :short => "-f"
+  opt :log_path, "full path for a log file", :default=>log_path
+  opt :pid_path, "full path for a PID file", :default=>pid_path
+  #opt :quiet, "don't print anything to console on start or stop", :default=>false
+end
+
+# if these were left as defaults, they'll be unchanged from the initial assignment above
+log_path = opts[:log_path]
+pid_path = opts[:pid_path]
+
+startup_message=<<EOS
+* if you haven't already, open port #{opts[:port]} in your firewall. See http://scoutapp.github.io/scout_realtime for details
+* Point your browser to http://your-ip-or-hostname:#{opts[:port]}
+* FYI, the log file is: #{log_path}
+EOS
+
+# TODO: should be able to pass :daemonize => !opts[:foreground] to Dante::Runner instead
+if opts[:foreground]
+  puts " ** Initializing. cntl-c to stop. Logging to STDOUT **"
+  Scout::Realtime::Main.instance(:port=>opts[:port]).go_sinatra
+  puts startup_message
+else
+  if command == :start
+    if Scout::Realtime.port_occupied?(opts[:port])
+      puts "Local port #{opts[:port]} doesn't appear to be available - try another port."
+      exit
+    end
+
+    Dante::Runner.new('scout_realtime').execute(:daemonize => !opts[:foreground], :pid_path => pid_path, :log_path => log_path, :port=>opts[:port]) do |options|
+      Scout::Realtime::Main.instance(:port=>options[:port]).go_sinatra
+    end
+    puts startup_message
+    puts  '* "scout_realtime stop" to stop the daemon'
+
+
+    # Fork another process to run briefly & check that the primary daemon stayed running
+    pid = IO.read(pid_path).chomp.to_i
+    fork do
+      sleep 2
+      is_still_running = begin
+        Process.getpgid( pid )
+        true
+      rescue Errno::ESRCH
+        false
+      end
+
+      if !is_still_running
+        puts "\n## oh-oh, the daemon crashed. See log at #{log_path} ##\n"
+      end
+    end
+
+  elsif command == :stop
+    Dante::Runner.new('scout_realtime').execute(:kill => true, :pid_path => pid_path)
+  elsif command == :help
+    puts "to get help: scout_realtime --help "
+  end
+end
+
+
+
+
+
+
+
+

data/lib/scout_realtime/lib/aggregator.rb

@@ -0,0 +1,8 @@
+module Scout::Realtime::Aggregator
+  def update_historical_metrics(collector_response)
+    self.class::FIELDS.keys.each do |field_name|
+      historical_metrics[field_name] ||= RingBuffer.new(60)
+      historical_metrics[field_name].push(collector_response[field_name])
+    end
+  end
+end

data/lib/scout_realtime/lib/metric.rb

@@ -0,0 +1,36 @@
+class Scout::Realtime::Metric
+  attr_accessor :historical_metrics
+  attr_reader :latest_run
+
+  def initialize
+    @historical_metrics = Hash.new
+  end
+
+  def run!
+    begin
+      @latest_run = @collector.run
+    rescue Errno::ENOENT => e
+      print "#############################################################################"
+      puts "#{e.class}: #{e.message}"
+      @latest_run = {}
+    end
+    update_historical_metrics(latest_run)
+  end
+
+  def self.metadata
+    meta = self::FIELDS
+    meta.keys.each_with_object(meta) do |field_name, formatted_meta|
+      formatted_meta[field_name]['label'] ||= field_name.to_s.capitalize.gsub('_', ' ')
+      formatted_meta[field_name]['units'] ||= ''
+      formatted_meta[field_name]['precision'] ||= 1 
+    end
+  end
+
+  def self.short_name
+    self.to_s.split('::').last.downcase.to_sym
+  end
+
+  def self.descendants
+    [Scout::Realtime::Memory, Scout::Realtime::Cpu, Scout::Realtime::Disk, Scout::Realtime::Network, Scout::Realtime::Processes]
+  end
+end

data/lib/scout_realtime/lib/multi_aggregator.rb

@@ -0,0 +1,12 @@
+module Scout::Realtime::MultiAggregator
+  def update_historical_metrics(collector_response)
+    # since this is a multi-collector, the first level of the result hash is name
+    collector_response.each_pair do |name,metrics_hash|
+      historical_metrics[name] ||= {}
+      self.class::FIELDS.keys.each do |field_name|
+        historical_metrics[name][field_name] ||= RingBuffer.new(60)
+        historical_metrics[name][field_name].push(metrics_hash[field_name])
+      end
+    end
+  end
+end

data/lib/scout_realtime/lib/ring_buffer.rb

@@ -0,0 +1,25 @@
+class RingBuffer < Array
+
+  alias_method :array_push, :push
+  alias_method :array_element, :[]
+
+  def initialize( size )
+    @ring_size = size
+    super( size )
+  end
+
+  def push( element )
+    if length == @ring_size
+      shift # loose element
+    end
+    array_push element
+  end
+
+  # Access elements in the RingBuffer
+  #
+  # offset will be typically negative!
+  #
+  def []( offset = 0 )
+    return self.array_element( - 1 + offset )
+  end
+end