apocalypse-client 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rspec

@@ -0,0 +1 @@
+--colour -f progress

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in apocalypse-reporter.gemspec
+gemspec

data/README.md

@@ -0,0 +1,82 @@
+# Apocalypse Client
+
+Apocalypse Client is a ruby gem that can be installed on a remote
+server.
+
+## Installation
+
+Apocalypse Client currently focusses on Debian/Ubuntu systems only.
+
+There is only one dependency to the operating system, namely the
+`sysstat` package. This package is used to gather information about disk
+utilisation and performance.
+
+    sudo apt-get install sysstat
+
+Next install the ruby gem.
+
+    sudo gem install apocalypse-client
+
+Now you can create the file `/etc/cron.d/apocalypse` with the following
+content:
+
+    * * * * * root PATH=$PATH:/sbin:/usr/sbin /usr/bin/env apocalypse-client report --server SERVER --port PORT --hostid HOSTID > /dev/null
+
+This will send metrics data every minute to your Apocalypse server. If
+you require different intervals, refer to `man 5 crontab` for details on
+how to schedule reporting.
+
+You need to replace the placeholders with actual data:
+
+ * `SERVER` - The ip or hostname for your Apocalypse server. E.g.
+   apocalyse.example.org
+ * `PORT` - The port number the Apocalypse server is listening on.
+   Default: 80
+ * `HOSTID` - An ID identifying this server. You are free to choose
+   whatever you want. But be careful not to chose a duplicate hostid,
+because it will mess up you statistics. 
+
+If an error occurs cron will try to notify you by email. This depends on
+how your systems cron is configured.
+
+## Choosing a proper hostid
+
+Choosing a proper hostid is important, because it can be arbitrarily
+chosen. There are several options:
+
+ * Use the format `appname-role-number`. E.g. `ariejannet-db-01` or
+   `reddis-memcached-42`.
+ * IP Address of the server, this guarantees some level of uniqueness
+
+Note: at this time, there is not convention for picking hostids.
+However, the first method is likely to become the convention and will
+allow logical grouping of servers by role and application.
+
+## Authors
+
+ * Ariejan de Vroom <ariejan@ariejan.net>
+ * Kabisa ICT - http://kabisa.nl
+
+## License
+
+    Copyright (c) 2011 Ariejan de Vroom
+    
+    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/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+
+task :default => :spec
+
+desc "Run all specs"
+task "spec" do
+  exec "bundle exec rspec spec"
+end
+

data/apocalypse-client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "apocalypse-client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "apocalypse-client"
+  s.version     = Apocalypse::Client::VERSION
+  s.authors     = ["Ariejan de Vroom"]
+  s.email       = ["ariejan@ariejan.net"]
+  s.homepage    = ""
+  s.summary     = %q{Watch out for the apocalypse}
+  s.description = %q{Server monitoring made easy}
+
+  s.rubyforge_project = "apocalypse-client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("json", ["~> 1.5.3"])
+  s.add_dependency("trollop", ["~> 1.16.2"])
+
+  s.add_development_dependency("rspec", ["~> 2.6.0"])
+end

data/bin/apocalypse-client

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "apocalypse-client"
+require 'trollop'
+
+SUB_COMMANDS = %w(report install check)
+
+global_opts = Trollop::options do
+  banner "Apocalypse Reporter"
+  stop_on SUB_COMMANDS
+end
+
+cmd = ARGV.shift
+cmd_opts = case cmd
+  when "report"
+    Trollop::options do
+      opt :server,  "Hostname of the Apocalypse Server", :type => :string, :short => "-s"
+      opt :port,    "Port the Apocalypse Server is listening on. Default: 80", :type => :string, :default => '80', :short => "-p"
+      opt :hostid,  "Identifier for this server", :type => :string, :short => "-i"
+    end
+  when "install"
+    Trollop::options do
+      # TODO
+    end
+  when "check"
+    Trollop::options do
+      # TODO
+    end
+  else
+    Trollop::die "unknown command #{cmd.inspect}"
+  end
+
+reporter = Apocalypse::Client.new
+reporter.send(cmd, cmd_opts)

data/lib/apocalypse-client.rb

@@ -0,0 +1,133 @@
+require 'rubygems'
+require 'net/http'
+require 'json'
+
+class Hash
+  #
+  # Create a hash from an array of keys and corresponding values.
+  def self.zip(keys, values, default=nil, &block)
+    hsh = block_given? ? Hash.new(&block) : Hash.new(default)
+    keys.zip(values) { |k,v| hsh[k]=v }
+    hsh
+  end
+end
+
+module Apocalypse
+  class Client
+    ## Commands
+
+    # Report metrics
+    def report(options)
+      puts options.inspect
+			request = Net::HTTP::Post.new("/api/metrics/#{options[:hostid]}", initheader = {'Content-Type' =>'application/json'})
+		  request.body = gather_metrics.to_json
+      response = Net::HTTP.new(options[:server], options[:port]).start {|http| http.request(request) }
+      puts "Response #{response.code} #{response.message}: #{response.body}"
+    end
+
+    # Check if all local deps are available
+    def check(options)
+      errors = []
+      [
+        ["/usr/bin/iostat",   "sysstat"]
+      ].each do |filename, package|
+        errors << "Cannot find `#{filename}`. Please run `apt-get install #{package}` to resolve this." if !File.exists?(filename)
+      end
+
+      if errors.empty?
+        puts "Everything seems to be in place. You're good to go."
+      else
+        errors.each { |error| puts errors }
+      end
+    end
+
+    def install(options)
+      puts <<-EOF
+Sorry, no automated installation yet. Installation is, however, quite easy.
+
+Simply create the file `/etc/cron.d/apocalypse` and put the following line in it:
+
+* * * * * root PATH=$PATH:/sbin:/usr/sbin /usr/bin/env apocalypse-reporter report --server APOCALYPSE_SERVER --hostid SERVER_ID > /dev/null
+
+Make sure to replace the server and hostid placeholders with something more useful.
+      EOF
+    end
+
+    # Gather metrics
+    def gather_metrics
+      {
+        'cpu' => {
+          'cores' => cpu_cores.strip,
+          'loadavg' => cpu_loadavg
+        },
+        'memory' => memory_metrics,
+        'swap' => swap_metrics,
+        'blockdevices' => blockdevice_metrics,
+        'network' => network_metrics
+      }
+    end
+
+    # Returns the number of CPU Cores for this system
+    def cpu_cores
+      `cat /proc/cpuinfo | grep bogomips | wc -l`.strip
+    end
+
+    # Gather load average data
+    def cpu_loadavg
+      `cat /proc/loadavg`.split
+    end
+
+    def blockdevice_metrics
+      columns = ["tps", "rps", "wps", "size", "used", "available", "usage", "mount"]
+
+      io_data = `/usr/bin/env iostat -dk | tail -n+4`.split("\n").map { |line| line.split[0...-2] }
+      usage_data = `df -l --block-size=M | grep -i ^/dev/[sh]`.split("\n").map { |line| line.split }
+
+      io_data.collect do |device_data|
+        device_name = device_data.shift
+        device_usage = usage_data.select { |x| x[0].include? device_name }.flatten
+
+        unless device_usage.empty?
+          device_data += device_usage[1..-1]
+        end
+
+        { device_name => Hash.zip(columns, device_data) }
+      end
+    end
+
+    def memory_metrics
+      {
+        'free' => `cat /proc/meminfo | grep MemFree | awk '{print $2}'`.strip,
+        'total' => `cat /proc/meminfo | grep MemTotal | awk '{print $2}'`.strip
+      }
+    end
+
+    def swap_metrics
+      {
+        'free' => `cat /proc/meminfo | grep SwapFree | awk '{print $2}'`.strip,
+        'total' => `cat /proc/meminfo | grep SwapTotal | awk '{print $2}'`.strip
+      }
+    end
+
+    def network_metrics
+      devices = `/usr/bin/env ifconfig | egrep 'Link encap' | grep -v 'lo' | awk '{print $1}'`.split
+
+      devices.collect do |device_name|
+        { device_name => {
+          'hwaddr' => `/usr/bin/env ifconfig #{device_name} | egrep -o 'HWaddr \([0-9a-fA-F]\{2\}\:*\){6}' | awk '{print $2}'`.strip,
+          'mtu' => `/usr/bin/env ifconfig #{device_name} | egrep -o MTU\:[0-9]+ | tr -s ':' ' ' | awk '{print $2}'`.strip,
+          'metric' => `/usr/bin/env ifconfig #{device_name} | egrep -o Metric\:[0-9]+ | tr -s ':' ' ' | awk '{print $2}'`.strip,
+          'encapsulation' => `/usr/bin/env ifconfig #{device_name} | egrep -o 'Link encap\:[a-zA-Z]+' | cut -d":" -f2`.strip,
+          'rxbytes' => `/usr/bin/env ifconfig #{device_name} | grep bytes | awk '/RX/ {print $2}' | tr -s ':' ' ' | awk '{print $2}'`.strip,
+          'txbytes' => `/usr/bin/env ifconfig #{device_name} | grep bytes | awk '/TX/ {print $6}' | tr -s ':' ' ' | awk '{print $2}'`.strip,
+          'ipv4address' => `/usr/bin/env ifconfig #{device_name} | egrep -o 'inet addr\:[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}' | tr -s ':' ' ' | awk '{print $3}'`.strip,
+          'broadcast' => `/usr/bin/env ifconfig #{device_name} | egrep -o Bcast\:[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\} | tr -s ':' ' ' | awk '{print $2}'`.strip,
+          'netmask' => `/usr/bin/env ifconfig #{device_name} | egrep -o Mask\:[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\} | tr -s ':' ' ' | awk '{print $2}'`.strip,
+          'gateway' => `netstat -rn | grep ^0.0.0.0 | grep UG | grep #{device_name} | awk '{print $2}' | head -n1`.strip,
+          'ipv6addr' => `/usr/bin/env ifconfig #{device_name} | egrep -o 'inet6 addr\:\ \([a-fA-F0-9]\{1,4}\:\{1,2\}[a-fA-F0-9]\{1,4}\:\{1,2\}\)+[A-Fa-f0-9\/^\ ]+' | awk '{print $3}'`.strip,
+          'ipv6scope' => `/usr/bin/env ifconfig #{device_name} | egrep -o Scope\:[a-zA-Z]+ | cut -d":" -f2`.strip
+        }}
+      end
+    end
+  end
+end

data/lib/apocalypse-client/version.rb

@@ -0,0 +1,5 @@
+module Apocalypse
+  class Client
+    VERSION = "0.0.2"
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+describe Apocalypse::Client do
+  before(:each) do
+    @reporter = Apocalypse::Client.new
+  end
+
+  describe "cpu cores" do
+    it "should return the correct number of cores" do
+      @reporter.should_receive(:`).with("cat /proc/cpuinfo | grep bogomips | wc -l").and_return("4")
+      @reporter.cpu_cores.should eql("4")
+    end
+  end
+
+  describe "cpu loadavg" do
+    it "should return the correct loadavg values" do
+      @reporter.should_receive(:`).with("cat /proc/loadavg").and_return("0.89 0.92 1.12 1/124 28786")
+      @reporter.cpu_loadavg.should eql(["0.89", "0.92", "1.12", "1/124", "28786"])
+    end
+  end
+
+  describe "memory" do
+    it "should gather free and used memory" do
+      @reporter.should_receive(:`).with("cat /proc/meminfo | grep MemFree | awk '{print $2}'").and_return("998452")
+      @reporter.should_receive(:`).with("cat /proc/meminfo | grep MemTotal | awk '{print $2}'").and_return("7864548")
+
+      memory_metrics = @reporter.memory_metrics
+      memory_metrics["free"].should eql("998452")
+      memory_metrics["total"].should eql("7864548")
+    end
+  end
+
+  describe "swap" do
+    it "should gather free and used swap" do
+      @reporter.should_receive(:`).with("cat /proc/meminfo | grep SwapFree | awk '{print $2}'").and_return("934452")
+      @reporter.should_receive(:`).with("cat /proc/meminfo | grep SwapTotal | awk '{print $2}'").and_return("15728632")
+
+      swap_metrics = @reporter.swap_metrics
+      swap_metrics["free"].should eql("934452")
+      swap_metrics["total"].should eql("15728632")
+    end
+  end
+
+  describe "networking" do
+    it "should get network metrics" do
+      {
+        "/usr/bin/env ifconfig | egrep 'Link encap' | grep -v 'lo' | awk '{print $1}'" => "eth0",
+        "/usr/bin/env ifconfig eth0 | egrep -o 'HWaddr \([0-9a-fA-F]\{2\}\:*\){6}' | awk '{print $2}'" => "bc:de:12:ba:38:b3",
+        "/usr/bin/env ifconfig eth0 | egrep -o MTU\:[0-9]+ | tr -s ':' ' ' | awk '{print $2}'" => "1500",
+        "/usr/bin/env ifconfig eth0 | egrep -o Metric\:[0-9]+ | tr -s ':' ' ' | awk '{print $2}'" => "1",
+        "/usr/bin/env ifconfig eth0 | egrep -o 'Link encap\:[a-zA-Z]+' | cut -d\":\" -f2" => "Ethernet",
+        "/usr/bin/env ifconfig eth0 | grep bytes | awk '/RX/ {print $2}' | tr -s ':' ' ' | awk '{print $2}'" => "384735745",
+        "/usr/bin/env ifconfig eth0 | grep bytes | awk '/TX/ {print $6}' | tr -s ':' ' ' | awk '{print $2}'" => "3575372573",
+        "/usr/bin/env ifconfig eth0 | egrep -o 'inet addr\:[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}' | tr -s ':' ' ' | awk '{print $3}'" => "10.187.234.18",
+        "/usr/bin/env ifconfig eth0 | egrep -o Bcast\:[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\} | tr -s ':' ' ' | awk '{print $2}'" => "10.187.234.254",
+        "/usr/bin/env ifconfig eth0 | egrep -o Mask\:[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\}\.[0-9]\{1,3\} | tr -s ':' ' ' | awk '{print $2}'" => "255.0.0.0",
+        "netstat -rn | grep ^0.0.0.0 | grep UG | grep eth0 | awk '{print $2}' | head -n1" => "10.187.234.1",
+        "/usr/bin/env ifconfig eth0 | egrep -o 'inet6 addr\:\ \([a-fA-F0-9]\{1,4}\:\{1,2\}[a-fA-F0-9]\{1,4}\:\{1,2\}\)+[A-Fa-f0-9\/^\ ]+' | awk '{print $3}'" => "fe80::1031:3cff:fe00:bde1/64",
+        "/usr/bin/env ifconfig eth0 | egrep -o Scope\:[a-zA-Z]+ | cut -d\":\" -f2" => "Link"
+      }.each do |command, result|
+        @reporter.should_receive(:`).with(command).and_return(result)
+      end
+
+      network_metrics = @reporter.network_metrics.first["eth0"]
+
+      network_metrics["hwaddr"].should eql("bc:de:12:ba:38:b3")
+      network_metrics["mtu"].should eql("1500")
+      network_metrics["metric"].should eql("1")
+      network_metrics["encapsulation"].should eql("Ethernet")
+      network_metrics["rxbytes"].should eql("384735745")
+      network_metrics["txbytes"].should eql("3575372573")
+      network_metrics["ipv4address"].should eql("10.187.234.18")
+      network_metrics["broadcast"].should eql("10.187.234.254")
+      network_metrics["netmask"].should eql("255.0.0.0")
+      network_metrics["gateway"].should eql("10.187.234.1")
+      network_metrics["ipv6addr"].should eql("fe80::1031:3cff:fe00:bde1/64")
+      network_metrics["ipv6scope"].should eql("Link")
+    end
+  end
+
+  describe "block devices" do
+    it "should gather the correct block device info" do
+      iostat = <<-EOF
+sda1              0.21         1.95         2.35     157872     189884
+sda2              5.74        18.53        22.08    1496597    1783516
+
+EOF
+
+      df = <<-EOF
+/dev/sda2               29529M     7506M    20524M  27% /
+EOF
+
+      @reporter.should_receive(:`).with("/usr/bin/env iostat -dk | tail -n+4").and_return(iostat)
+      @reporter.should_receive(:`).with("df -l --block-size=M | grep -i ^/dev/[sh]").and_return(df)
+
+      result = @reporter.blockdevice_metrics
+
+      result.size.should eql(2)
+
+      # sda1
+      sda1 = result.select{ |a| a.keys.include?("sda1") }.first["sda1"]
+
+      sda1["tps"].should eql("0.21")
+      sda1["rps"].should eql("1.95")
+      sda1["wps"].should eql("2.35")
+      sda1["size"].should be_nil
+      sda1["usage"].should be_nil
+      sda1["used"].should be_nil
+      sda1["available"].should be_nil
+      sda1["mount"].should be_nil
+
+      # sda2
+      sda2 = result.select{ |a| a.keys.include?("sda2") }.first["sda2"]
+
+      sda2["tps"].should eql("5.74")
+      sda2["rps"].should eql("18.53")
+      sda2["wps"].should eql("22.08")
+      sda2["size"].should eql("29529M")
+      sda2["usage"].should eql("27%")
+      sda2["used"].should eql("7506M")
+      sda2["available"].should eql("20524M")
+      sda2["mount"].should eql("/")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'apocalypse-client'
+
+require 'rspec'
+require 'json'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: apocalypse-client
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Ariejan de Vroom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        - 3
+        version: 1.5.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 83
+        segments: 
+        - 1
+        - 16
+        - 2
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 2
+        - 6
+        - 0
+        version: 2.6.0
+  type: :development
+  version_requirements: *id003
+description: Server monitoring made easy
+email: 
+- ariejan@ariejan.net
+executables: 
+- apocalypse-client
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- apocalypse-client.gemspec
+- bin/apocalypse-client
+- lib/apocalypse-client.rb
+- lib/apocalypse-client/version.rb
+- spec/client_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: apocalypse-client
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Watch out for the apocalypse
+test_files: 
+- spec/client_spec.rb
+- spec/spec_helper.rb