pimon 0.1.1 → 0.1.2

data/README.md

@@ -10,35 +10,38 @@ It uses redis lists to keep the latest observed statistics and also uses
 highcharts to display some nice charts on your web browser.
 
 ## What do I need to get it to work?
-1. Install redis an configure it to run on a socket on /tmp/redis.sock
-2. bundle
-3. bin/pimon start # run the sinatra app
-4. go to http://localhost:3000 and PROFIT!
+1. Clone this repo: git clone git://github.com/pedrocarrico/pimon.git
+2. Install redis an configure it to run on a socket on /tmp/redis.sock
+3. bundle
+4. bin/pimon start # run the sinatra app
+5. go to http://localhost:3000 and PROFIT!
 Optionally you may install it as a gem and run it, please check "Installing as a gem" further down.
 
 ## Configuration
+Configuration is done through a YAML file, you may check some examples on the config directory.
+
 1. basic_auth - enable or disable, configure username and password
 2. redis - location of the redis socket
 3. chart - colors for each chart
 4. queues - redis list names for the series in the charts
-5. stats - configure number of stats and time period between them
+5. stats_collector - configure number of stats and time period between them
 
-## Deployment
-To deploy on your raspberry pi you just have to have ssh enabled and your keys authorized.  
-Then you can deploy with capistrano using:  
+## Installing as a gem
 ```
-cap deploy:setup
-cap deploy:cold
+gem install pimon
 ```
-
-This will setup your raspberry pi and deploy the application.  
-The username and password for the basic_auth in the production environment will be asked in the
-first deploy.
-To start and stop the application you have the usual:  
+After installation just do _pimon start_ and go to http://localhost:3000 and check your stats.
+If you want you may run Pimon with other options:
 ```
-cap deploy:start
-cap deploy:stop
+Usage: pimon start|stop [options]
+Options:
+    -c, --config CONFIG              YAML configuration file for pimon
+    -d, --daemonize                  Run Pimon daemonized in the background
+    -e, --environment ENVIRONMENT    Application environment (default: "development", options: "development", "production")
+    -p, --port PORT                  Port to use (default: 3000)
+    -P, --pid PIDFILE                File to store PID (default: /tmp/pimon.pid)
 ```
+(This will only work on your Raspberry Pi and perhaps some other linux distros, check the quirks section for more info).
 
 ## Running tests
 To run the coverage suite:
@@ -47,13 +50,6 @@ rake coverage:spec
 ```
 Results will be in coverage/index.html directory.
 
-## Installing as a gem
-```
-gem install pimon
-```
-After installation just do _pimon start_ and go to http://localhost:3000 and check your stats 
-(This will only work on your Raspberry Pi and perhaps some other linux distros, check the quirks section for more info).
-
 ## Quirks
 Pimon uses _vmstat_ and _free_ to collect it's stats from the operating system and these are only
 available on operating systems that have the /proc filesystem.  
@@ -64,14 +60,32 @@ To use them you must first compile them using _make_ and then include the bin di
 in your $PATH to have them available when you run the sinatra application.
 The temperature stat is only available with the latest Raspbian distro (2012-09-18) on your Raspberry Pi and will (may)
 not work if you're developing on other systems.
+Pimon only works with Ruby 1.9+, please refer to [my blog](http://blog.pedrocarrico.net/post/29478085586/compiling-and-installing-ruby-on-the-raspberry-pi-using "Compiling and installing ruby on the raspberry pi using rbenv…") for a way to install Ruby 1.9.3 on your Raspberry Pi.
+
+## Deployment with capistrano
+To deploy on your raspberry pi you just have to have ssh enabled and your keys authorized.  
+Then you can deploy with capistrano using:  
+```
+cap deploy:setup
+cap deploy:cold
+```
+
+This will setup your raspberry pi and deploy the application.  
+The username and password for the basic_auth in the production environment will be asked in the
+first deploy.
+To start and stop the application you have the usual:  
+```
+cap deploy:start
+cap deploy:stop
+```
+I would recommend installing as a gem and tweak your own configuration file instead of deploying with capistrano as
+this feature will probably be discontinued in the future.
 
 ## TODO
 1. Improve disk stats, have a way of having custom mount points
 2. Capistrano task to reset production basic_auth username and password
 3. Show uptime
 4. Change configuration in realtime
-5. Daemonize if running in production through bin/pimon (usefull for production environments without deploying through
-capistrano)
 
 ## Copyright
 Licensed under the [WTFPL](http://en.wikipedia.org/wiki/WTFPL "Do What The Fuck You Want To Public License") license.

data/bin/pimon

@@ -1,19 +1,79 @@
 #!/usr/bin/env ruby
-action = ARGV[0]
-environment = ARGV[1]
+require 'optparse'
 
-case action
-when "start"
-  require 'rack'
+options = {}
+option_parser = OptionParser.new do |opts|
+  executable_name = File.basename($PROGRAM_NAME)
+  opts.banner = "Usage: #{executable_name} start|stop [options]
+Options:
+"
+  opts.on('-c CONFIG',
+          '--config CONFIG',
+          'YAML configuration file for pimon') do |config|
+    options[:pimon_config] = config
+  end
+  
+  opts.on('-d',
+          '--daemonize',
+          'Run Pimon daemonized in the background') do
+    options[:daemonize] = true
+  end
+  
+  opts.on('-e ENVIRONMENT',
+          '--environment ENVIRONMENT',
+          'Application environment (default: "development", options: "development", "production")',
+          /^development|production$/) do |environment|
+    options[:environment] = environment
+  end
+  
+  opts.on('-p PORT',
+          '--port PORT',
+          'Port to use (default: 3000)') do |port|
+    options[:port] = port
+  end
+  
+  opts.on('-P PIDFILE',
+          '--pid PIDFILE',
+          'File to store PID (default: /tmp/pimon.pid)') do |pid_file|
+    options[:pid_file] = pid_file
+  end
+end
 
-  puts 'Pimon is starting at http://localhost:3000'
-  config = "#{File.dirname(__FILE__)}/../config/config.ru"
+begin
+  option_parser.parse!
+  if ARGV.empty?
+    puts "error: you must supply an action"
+    puts option_parser.help
+    exit 1
+  end
   
-  ARGV[1] ? ENV['RACK_ENV'] = environment : ENV['RACK_ENV'] = 'development'
+  pid_file = options[:pid_file] || '/tmp/pimon.pid'
   
-  puts "Running in #{ENV['RACK_ENV']} mode."
-  server = Rack::Server.new(:config => config, :Port => 3000, :server => 'thin')
-  server.start
-else
-  puts "Usage: pimon start <environment>"
+  case ARGV[0]
+  when 'start'
+    require 'thin'
+    port = options[:port] || 3000
+    options[:environment] ? ENV['RACK_ENV'] = options[:environment] : ENV['RACK_ENV'] = 'development'
+    config = "#{File.dirname(__FILE__)}/../config/config.ru"
+    ENV['PIMON_CONFIG'] = options[:pimon_config] if options[:pimon_config]
+    
+    puts "Pimon is starting at http://localhost:#{port}"
+    puts "Running in #{ENV['RACK_ENV']} mode."
+    puts "Using configuration file #{ENV['PIMON_CONFIG']}" if ENV['PIMON_CONFIG']
+    server = Rack::Server.new(:config => config, :daemonize => options[:daemonize], :pid => pid_file, :Port => port, :server => 'thin')
+    server.start
+  when 'stop'
+    if File.file?(pid_file)
+      pid = `cat #{pid_file}`.to_i
+      Process.kill("KILL", pid)
+      puts 'Pimon stopped...'
+    else
+      puts "Pid file not found at #{pid_file}, please supply a valid pid_file using -p or --pid"
+    end
+  else
+    STDERR.puts option_parser
+  end
+rescue OptionParser::InvalidArgument => ex
+  STDERR.puts ex.message
+  STDERR.puts option_parser
 end

data/lib/pimon.rb

@@ -24,12 +24,13 @@ class Pimon < Sinatra::Base
   
   configure :development, :production do
     require 'redis'
-    
-    config = PimonConfig.create_new(ENV['RACK_ENV'])
+    filename = "#{File.dirname(__FILE__)}/../config/#{ ENV['RACK_ENV'] || 'development' }.yml"
+    config = PimonConfig.create_new(ENV['PIMON_CONFIG'] || filename)
     
     EventMachine::next_tick do
       settings.timer = EventMachine::add_periodic_timer(config.stats[:time_period_in_min] * 60) do
         settings.stats_checker.collect_stats
+        @o = settings.stats_checker.show_stats
       end
     end
     
@@ -43,7 +44,7 @@ class Pimon < Sinatra::Base
   configure :test do
     require 'mock_redis'
     
-    config = PimonConfig.create_new('test')
+    config = PimonConfig.create_new("#{File.dirname(__FILE__)}/../config/test.yml")
     
     set :config, config
     set :stats_checker, StatsCollector.new(config, MockRedis.new)
@@ -56,7 +57,7 @@ class Pimon < Sinatra::Base
     last_update = settings.stats_checker.last_update
     last_modified(last_update) if ENV['RACK_ENV'] != 'development' && last_update
     
-    @o = settings.stats_checker.show_stats
+    @o ||= settings.stats_checker.show_stats
     
     haml :index
   end

data/lib/pimon/pimon_config.rb

@@ -2,8 +2,8 @@ require 'pimon/hash_extensions'
 require 'yaml'
 
 class PimonConfig
-  def self.create_new(environment = nil)
-    config = self.new(environment)
+  def self.create_new(filename)
+    config = self.new(filename)
     
     return config if config.valid?
   end
@@ -20,10 +20,6 @@ class PimonConfig
     @config[:chart]
   end
   
-  def environment
-    @config[:environment]
-  end
-  
   def is_basic_auth_enabled?
     @config[:basic_auth][:enabled]
   end
@@ -48,11 +44,9 @@ class PimonConfig
   
   private
   
-  def initialize(environment)
+  def initialize(filename)
     begin
-      filename = "#{File.dirname(__FILE__)}/../../config/#{ environment || 'development' }.yml"
       @config = YAML.load_file(filename).symbolize_keys
-      @config.merge!({ :environment => "#{ environment || 'development'}"})
       @config.freeze
     rescue Exception => e
       puts "Error while loading config file: #{filename}"

data/lib/pimon/version.rb

@@ -1,3 +1,3 @@
 module Pimon
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/pimon.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = [ 'Pedro Carriço' ]
   s.email       = [ 'pedro.carrico@gmail.com' ]
-  s.homepage    = 'https://github.com/pedrocarrico/pimon'
+  s.homepage    = 'http://pimon.pedrocarrico.net/'
   s.summary     = 'Pimon - Raspberry Pi server monitor'
   s.description = 'Pimon is a simple server monitor designed for the Raspberry Pi. It uses redis lists to keep the latest observed statistics and also uses highcharts to display some nice charts on your web browser.'
   

data/spec/pimon_config_spec.rb

@@ -1,19 +1,12 @@
 require 'spec_helper'
 
 describe 'PimonConfig' do
-  context 'when created with no arguments' do
-    subject { PimonConfig.create_new }
-    
-    its(:environment) { should == 'development' }
-  end
-  
   context 'when created for the test environment' do
-    subject { PimonConfig.create_new('test') }
+    subject { PimonConfig.create_new("#{File.dirname(__FILE__)}/../config/test.yml") }
     
     its(:basic_auth) { should == ['pimon', 'pimon'] }
     its(:chart) { should == { :cpu => { :color => '#D2691E' }, :disk => { :color => '#CDC673' }, :mem => { :color => '#87CEFA' }, :temp => {:color=>"#FF9B04"}, :swap => { :color => '#3CB371' } } }
     its(:is_basic_auth_enabled?) { should be_true }
-    its(:environment) { should == 'test' }
     its(:queues) { should == { :time => 'pimon_time', :cpu => 'pimon_cpu', :disk => 'pimon_disk', :mem => 'pimon_mem', :temp => 'pimon_temp', :swap => 'pimon_swap' } }
     its(:redis) { should == { :socket  => '/thou/shalt/not/use/redis/on/test/environment' } }
     its(:stats) { should == { :number_of_stats => 6, :time_period_in_min => 10 } }
@@ -28,7 +21,7 @@ describe 'PimonConfig' do
   
   context 'when created with a broken environment configuration with basic_auth enabled but no username/password' do
     it 'should raise an error' do
-      expect{ PimonConfig.create_new('test_broken') }.to raise_error(RuntimeError)
+      expect{ PimonConfig.create_new("#{File.dirname(__FILE__)}/../config/test_broken.yml") }.to raise_error(RuntimeError)
     end
   end
 end

data/spec/stats_collector_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe 'StatsCollector' do
   context 'when new with a valid config and redis' do
     before do
-      @stats_collector = StatsCollector.new(PimonConfig.create_new('test'), MockRedis.new)
+      @stats_collector = StatsCollector.new(PimonConfig.create_new("#{File.dirname(__FILE__)}/../config/test.yml"), MockRedis.new)
     end
     subject { @stats_collector }
     

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pimon
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-30 00:00:00.000000000 Z
+date: 2012-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -240,7 +240,7 @@ files:
 - spec/pimon_spec.rb
 - spec/spec_helper.rb
 - spec/stats_collector_spec.rb
-homepage: https://github.com/pedrocarrico/pimon
+homepage: http://pimon.pedrocarrico.net/
 licenses: []
 post_install_message: 
 rdoc_options: []