cloudscopes 0.8.0

data/README.md

@@ -0,0 +1,53 @@
+Cloudscopes
+===========
+
+Ruby gem to report system statistics to web based monitoring services such as CloudWatch
+
+Features:
+
+ * Easy to extend with additional metrics, using system classes or ruby experssions
+ * Easily readable configuration using YAML
+ * Metric conditions (only evaluate and publish metric if condition is met) allowing single simple configuration for hetrogenous environments
+ * Conditions and value calculation done using Ruby expressions, allowing infinite customizability
+
+Supported monitoring providers:
+
+ * Amazon Cloudwatch
+
+Supported metrics to monitor:
+
+  * Linux /proc/meminfo data
+  * Linux /proc/cpuinfo data
+  * Linux /proc/loadavg data
+  * Linux /proc/diskstats data
+  * Linux SysV service status
+  * Bluepill service status
+  * Redis queue size (for Resque, but may possible work with other protocols)
+  * Network port listen status
+
+## Installation
+
+1. Install the gem into your system's Ruby:
+   `$ sudo gem install cloudscopes`
+1. Setup the system with the default configuration and cron job:
+   `$ sudo cloudscopes-setup`
+1. Edit the configuration file according to your requirements:
+   `$ sudo editor /etc/cloudscopes-monitoring.yaml`
+
+## Usage
+
+Cloudscopes monitoring script will be run every minute using the cron system, and will publish all specified metrics to the monitoring
+service. Alternatively, the cloudscopes-monitor command can be called directly, by providing the path to the cloudscopes configuration file and one of the following options:
+
+  * -t : instead of publishing the calculated metrics, dump them to the console. Useful for testing
+
+If no additional options are specified, the default behavior of the monitor command is to publish the metrics using the configured provider.
+
+## Contributing
+
+1. Fork it ( https://github.com/guss77/cloudscopes/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/cloudscopes-monitor

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'cloudscopes'
+
+def handle(metrics)
+  return publish metrics if Cloudscopes.should_publish
+  metrics.each do |category, samples|
+    valid_data = samples.select(&:valid)
+    next if valid_data.empty?
+    puts "#{category.rjust(10,' ')}: "
+    valid_data.each { |s| puts "#{' '*12}#{s.name} - #{s.value} #{s.unit} (#{s.to_cloudwatch_metric_data})" }
+  end
+end
+
+metrics = Cloudscopes.init
+handle metrics.collect { |metric| sample metric } 

data/bin/cloudscopes-setup

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+basedir = File.expand_path(File.dirname(__FILE__) + "/..")
+FileUtils.cp "#{basedir}/config/cron.config", '/etc/cron.d/cloudscopes-monitoring'
+FileUtils.cp "#{basedir}/config/monitoring.yaml", '/etc/cloudscopes-monitoring.yaml'

data/cloudscopes.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cloudscopes/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloudscopes"
+  spec.version       = Cloudscopes::VERSION
+  spec.authors       = ["Oded Arbel"]
+  spec.email         = ["oded@geek.co.il"]
+  spec.summary       = %q{Ruby gem to report system statistics to web based monitoring services such as CloudWatch}
+  spec.description   = %q{Ruby gem to report system statistics to web based monitoring services such as CloudWatch}
+  spec.homepage      = "http://github.com/guss77/cloudscopes"
+  spec.license       = "GPLv3"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.extra_rdoc_files = ["README.md"]
+
+  spec.add_dependency 'aws-sdk', '~> 1.40'
+  spec.add_dependency 'redis', '~> 3.0'
+  spec.add_dependency 'ffi', '~> 1.9', '>= 1.9.3'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", '~> 0'
+end

data/config/cron.config

@@ -0,0 +1 @@
+*/1 * * * *	root cloudscopes-monitor /etc/cloudscopes-monitoring.yaml

data/config/monitoring.yaml

@@ -0,0 +1,39 @@
+settings:
+  provider: cloudwatch
+  key: AWS_KEY_ID 
+  secret: AWS_SECRET_KEY
+  region: us-west-2
+
+metrics:
+  Systems: 
+    - name: Load Per CPU
+      unit: Percent
+      value: 100 * system.loadavg5 / system.cpucount
+    - name: Pending IO
+      unit: Count
+      value: system.iostat[8]
+    - name: Memory Utilization
+      unit: Percent
+      value: 100 * memory.Active / memory.MemTotal
+      
+    - name: Available Space on System
+      unit: Gigabytes
+      value: filesystem.df("/").avail / 1024 / 1024 / 1024
+
+  Queues:      
+    - name: Pending Resque Items
+      unit: Count
+      value: redis.resque_size("some_queue")
+      requires: system.service('redis-server')
+      
+  Services:
+    - name: My service status
+      value: if system.service('my-service') then 1 else 0 end
+      requires: File.exists?('/usr/sbin/my-service')     
+    - name: Nginx Running
+      value: if network.port_open?(80) then 1 else 0 end
+      requires: File.exists?(Dir.glob("/etc/nginx/sites-enabled/*").first || "")
+
+    - name: Bluepill service Running
+      value: if system.bluepill_ok?('my-service') then 1 else 0 end
+      requires: system.service('my-service')

data/lib/cloudscopes/configuration.rb

@@ -0,0 +1,39 @@
+module Cloudscopes
+
+  attr_reader :should_publish, :usage_requested
+
+  def self.init
+    @opts = Monitoring::Options.new
+    usage if usage_requested
+    configuration = {}
+    (@opts.files.empty?? [ STDIN ] : @opts.files.collect { |fn| File.new(fn) }).each do |configfile|
+      configuration.merge! YAML.load(configfile.read)
+    end
+    @settings = configuration['settings']
+    configuration['metrics']
+  end
+
+  def self.usage_requested
+    @opts.usage
+  end
+
+  def self.should_publish
+    @opts.publish != false
+  end
+
+  def self.usage
+    puts "#{@opts}"
+    exit 5
+  end
+
+  def self.client
+    @client ||= initClient
+  end
+
+  def self.initClient
+    AWS::CloudWatch.new access_key_id: @settings['aws-key'],
+                          secret_access_key: @settings['aws-secret'],
+                          region: @settings['region']
+  end
+
+end

data/lib/cloudscopes/filesystem.rb

@@ -0,0 +1,48 @@
+module Cloudscopes
+  
+  module StatFs
+    # The result of a statfs operation, see "man statfs" for more information
+    # on each field.  We add some helper methods that deal in bytes.
+    class Result < Struct.new(:type, :bsize, :blocks, :bfree, :bavail, :files, :ffree)
+      def total; blocks * bsize; end
+      def free; bfree * bsize; end
+      def avail; bavail * bsize; end
+    end
+    
+    module Lib
+      extend FFI::Library
+      ffi_lib FFI::Library::LIBC
+      attach_function 'statfs64', [:string, :pointer], :int
+    end
+    
+    # Drives the interface to the C library, returns a StatFs::Result object
+    # to show filesystem information for the given path.
+    #
+    def self.statfs(path)
+      output = FFI::MemoryPointer.new(128)
+      begin
+        error_code = Lib::statfs64(path, output)
+        raise "statfs raised error #{error_code}" if error_code != 0
+        return Result.new(*output[0].read_array_of_long(7))
+      ensure
+        output.free
+      end
+    end
+  end
+    
+  class Filesystem
+    
+    @@mountpoints = File.read("/proc/mounts").split("\n").grep(/(?:xv|s)d/).collect { |l| l.split(/\s+/)[1] }
+    
+    def mountpoints
+      @@mountpoints
+    end
+    
+    def df(path)
+      StatFs.statfs(path)
+    end
+    
+  end
+
+end
+

data/lib/cloudscopes/globals.rb

@@ -0,0 +1,25 @@
+##
+# public API expressed through kernel (global) methods, for simplicity
+#
+
+def publish(samples)
+  raise "Not running in EC2, so won't publish!" unless File.executable?("/usr/bin/ec2metadata")
+  samples.each do |type,metric_samples|
+    begin
+      valid_data = metric_samples.select(&:valid)
+      next if valid_data.empty?
+      valid_data.each_slice(4) do |slice| # slice metrics to chunks - the actual limit is 20, but CloudWatch starts misbehaving if I put too much data
+        Monitoring.client.put_metric_data namespace: type,
+                                          metric_data: slice.collect(&:to_cloudwatch_metric_data)
+      end
+    rescue Exception => e
+      puts "Error publishing metrics for #{type}: #{e}"
+    end
+  end
+end
+
+def sample(category, *metrics)
+  category, metrics = category if category.is_a? Array # sample may be passed the single yield variable of Hash#each
+  metrics = [ metrics ] unless metrics.is_a? Array
+  [ category, metrics.collect { |m| Monitoring::Sample.new(category, m) } ]
+end

data/lib/cloudscopes/network.rb

@@ -0,0 +1,29 @@
+require 'socket'
+require 'timeout'
+
+module Cloudscopes
+  
+  class Network
+    
+    def local_ip
+      Socket.ip_address_list.detect {|intf| intf.ipv4? and !intf.ipv4_loopback? and !intf.ipv4_multicast? }.ip_address
+    end
+    
+    def port_open?(port)
+      begin
+        Timeout::timeout(1) do
+          begin
+            TCPSocket.new(local_ip, port).close
+            return true
+          rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+            return false
+          end
+        end
+      rescue Timeout::Error
+        return false
+      end
+    end
+    
+  end
+  
+end

data/lib/cloudscopes/options.rb

@@ -0,0 +1,17 @@
+module Cloudscopes
+  
+  class Options
+
+    attr_reader :publish, :usage, :files
+        
+    def initialize
+      @publish = true
+      @files = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$0} [options] [<config.yaml>]\n\nOptions:"
+        opts.on("-t", "dump samples to the console instead of publishing, for testing") { @publish = false }
+        opts.on_tail("-?", "-h", "--help", "Show this message") { @usage = true }
+      end.parse!
+    end
+  end
+  
+end

data/lib/cloudscopes/redis.rb

@@ -0,0 +1,34 @@
+module Cloudscopes
+  
+  class RedisClient
+    
+    def initialize(host,port)
+      @redis = Redis.new(host: host, port: port)
+    end
+    
+    def resque_size(*keys)
+      keys = [ keys ] unless keys.is_a? Array
+      keys.collect do |key|
+        @redis.llen("resque:queue:#{key}")
+      end.reduce(0,:+)
+    end
+    
+    def list_size(*keys)
+      keys = [ keys ] unless keys.is_a? Array
+      keys.collect do |key|
+        @redis.llen("#{key}")
+      end.reduce(0,:+)
+    end
+    
+    def resques(pattern)
+      @redis.smembers("resque:queues").grep(pattern)
+    end
+    
+  end
+  
+  def self.redis(host = 'localhost', port = 6379)
+    RedisClient.new(host,port)
+  end
+  
+end
+

data/lib/cloudscopes/sample.rb

@@ -0,0 +1,38 @@
+module Cloudscopes
+  
+  class Sample
+    
+    attr_reader :name, :value, :unit
+    
+    ec2_instanceid_file = "/var/lib/cloud/data/previous-instance-id"
+    @@instanceid = File.exists?(ec2_instanceid_file) ? File.read(ec2_instanceid_file).chomp : nil
+    
+    def initialize(namespace, metric)
+      @name = metric['name']
+      @unit = metric['unit']
+      @value = nil
+      
+      begin
+        return if metric['requires'] and ! Monitoring.get_binding.eval(metric['requires']) 
+        @value = Monitoring.get_binding.eval(metric['value'])
+      rescue => e
+        STDERR.puts("Error evaluating #{@name}: #{e}")
+        puts e.backtrace
+      end
+    end
+    
+    def valid
+      ! @value.nil?
+    end
+    
+    def to_cloudwatch_metric_data
+      return nil if @value.nil?
+      data = { metric_name: @name, value: @value }
+      data[:unit] = @unit if @unit
+      data[:dimensions] = [ { name: "InstanceId", value: @@instanceid } ] unless @@instanceid.nil?
+      data
+    end
+    
+  end
+  
+end

data/lib/cloudscopes/system.rb

@@ -0,0 +1,52 @@
+module Cloudscopes
+  
+  class Memory
+
+    File.read('/proc/meminfo').split("\n").collect do |line|
+      line =~ /(\w+):\s+(\d+)/ and { name: $1, value: $2.to_i } 
+    end.each do |data|
+      next if data.nil? 
+      define_method(data[:name]) { data[:value] }
+    end
+
+  end
+  
+  class System
+    
+    def loadavg5
+      File.read("/proc/loadavg").split(/\s+/).first.to_f
+    end
+    
+    def cpucount
+      File.read("/proc/cpuinfo").split("\n").grep(/^processor\s+/).count
+    end
+    
+    # Read https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats for the field meanings
+    # this method returns fields 4~14 as sum for all devices (as array indexes 0..10)
+    def iostat
+      File.read("/proc/diskstats").split("\n").collect do |dev|
+        dev.gsub(/^\s+/,"").split(/\s+/)[3..13].collect(&:to_i) 
+      end.inject() do |sums,vals| 
+        sums ||= vals.collect { 0 } # init with zeros
+        sums.zip(vals).map {|a| a.reduce(:+) } # sum array values
+      end
+    end
+    
+    def service(name)
+      %x(PATH=/usr/sbin:/usr/bin:/sbin:/bin /usr/sbin/service #{name} status 2>/dev/null)
+      $?.exitstatus == 0
+    end
+    
+    def bluepill_ok?(name)
+      %x(/usr/local/bin/bluepill wfs status | grep -v up | grep pid)
+      $?.exitstatus == 1 # grep pid should not match because all the pids are "up"
+    end
+    
+  end
+  
+  def self.system # must define, otherwise kernel.system matches
+    System.new
+  end
+  
+end
+

data/lib/cloudscopes/version.rb

@@ -0,0 +1,3 @@
+module Cloudscopes
+  VERSION = "0.8.0"
+end

data/lib/cloudscopes.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+
+#require 'bundler/setup' #if ENV['BUNDLE_GEMFILE'] && File.exists?(ENV['BUNDLE_GEMFILE'])
+
+require 'aws-sdk'
+require 'redis'
+require 'optparse'
+require 'ffi'
+
+require 'cloudscopes/version'
+require 'cloudscopes/configuration'
+require 'cloudscopes/options'
+require 'cloudscopes/globals'
+require 'cloudscopes/sample'
+require 'cloudscopes/system'
+require 'cloudscopes/filesystem'
+require 'cloudscopes/redis'
+require 'cloudscopes/network'
+
+module Cloudscopes
+
+  def self.get_binding
+    return binding()
+  end
+
+  def self.method_missing(*args)
+    Monitoring.const_get(args.shift.to_s.capitalize).new(*args)
+  end
+
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: cloudscopes
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+platform: ruby
+authors:
+- Oded Arbel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.40'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.40'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby gem to report system statistics to web based monitoring services
+  such as CloudWatch
+email:
+- oded@geek.co.il
+executables:
+- cloudscopes-monitor
+- cloudscopes-setup
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- .buildpath
+- .gitignore
+- .project
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/cloudscopes-monitor
+- bin/cloudscopes-setup
+- cloudscopes.gemspec
+- config/cron.config
+- config/monitoring.yaml
+- lib/cloudscopes.rb
+- lib/cloudscopes/configuration.rb
+- lib/cloudscopes/filesystem.rb
+- lib/cloudscopes/globals.rb
+- lib/cloudscopes/network.rb
+- lib/cloudscopes/options.rb
+- lib/cloudscopes/redis.rb
+- lib/cloudscopes/sample.rb
+- lib/cloudscopes/system.rb
+- lib/cloudscopes/version.rb
+homepage: http://github.com/guss77/cloudscopes
+licenses:
+- GPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby gem to report system statistics to web based monitoring services such
+  as CloudWatch
+test_files: []