rubix 0.0.4 → 0.0.5

data/README.rdoc

@@ -22,6 +22,8 @@ few goals:
 - Have as few dependencies as possible: the core classes only depend
   on Ruby 1.8 standard library & +JSON+ and scripts additionally
   depend on +Configliere+[http://github.com/mrflip/configliere].
+
+- Play nicely with Chef[http://www.opscode.com/chef/]  
   
 There are a lot of other projects out there that connect Ruby to
 Zabbix.  Here's a quick list:
@@ -88,14 +90,21 @@ quietly for you:
 
   response = Rubix.connection.request('host.get', 'filter' => { 'host' => 'My Zabbix Host' })
 
-  # We can check for errors, whether they are non-200 responses or 200
-  responses with a Zabbix API error.
-  puts response.error_message unless response.success?
-
-  # See the result
-  puts response.result
-  #=> [{"hostid"=>"10017"}]
-
+  case
+  when response.has_data?
+    # Response is a success and "has data" -- it's not empty.  This
+    # means we found our host.
+    puts response.result
+    #=> [{"hostid"=>"10017"}]
+  when response.success?
+    # Response was succssful but doesn't "have data" -- it's empty, no
+    # such host!
+    puts "No such host"
+  else
+    # Response was an error.  Uh oh!
+    puts response.error_message
+  end
+  
 === On the command line
 
 Rubix comes with a command line utility +zabbix_api+ which lets you
@@ -105,7 +114,7 @@ issue these sorts of requests directly on the command line.
   [{"hostid"=>"10017"}]
 
 +zabbix_api+ lets you specify the credentials and will pretty-print
-responses for you.
+responses for you.  Try <tt>zabbix_api --help</tt> for more details.
 
 == ORM
 
@@ -119,33 +128,31 @@ complete with host groups, templates, applications, and so on.
   Rubix.connect('http://localhost/api_jsonrpc.php', 'admin', 'zabbix')
 
   # Ensure the host group we want exists.
-  host_group = Rubix::HostGroup.new(:name => "My Zabbix Hosts")
-  host_group.create unless host_group.exists?
+  host_group = Rubix::HostGroup.find_or_create(:name => "My Zabbix Hosts")
 
   # Now the template -- created templates are empty by default!
   template = Rubix::Template.new(:name => "Template_Some_Service")
-  template.create unless template.exists?
+  template.save
   
   # Now the host.
   host = Rubix::Host.new(:name => "My Host", :ip => '123.123.123.123', :templates => [template], :host_groups => [host_group])
-  # 'register' means the same as 'create unless exist' above...
-  host.register
+  host.save
 
   # Now for the application
   app = Rubix::Application.new(:name => 'Some App', :host => host)
-  app.register
+  app.save
 
   # Now the item
   item = Rubix::Item.new(:host => host, :key => 'foo.bar.baz', :description => "Some Item", :value_type => :unsigned_int, :applications => [app])
-  item.register
+  item.save
 
-You can also +update+, +destroy+ or +unregister+ ('destroy if exists')
-resources.  
+You can also +update+ and +destroy+ resources.
 
-Only host groups, templates, hosts, applications, and items are
-available at present.  Other Zabbix resources (actions, alerts,
-events, maps, users, &c.) can be similarly wrapped, they just haven't
-been because we don't use them as much as we use these core resources.
+Only host groups, templates, hosts, applications, user macros, and
+items are available at present.  Other Zabbix resources (actions,
+alerts, events, maps, users, &c.) can be similarly wrapped, they just
+haven't been yet because we don't use them as much as we use these
+core resources.
 
 == Sender
 
@@ -165,9 +172,9 @@ data one line at a time from any of these sources and uses the
 
 Here's an example of starting +zabbix_pipe+ and sending some data onto
 Zabbix.  (Credentials and addresses for the Zabbix server and the
-Zabbix API can all be customized; try the <tt>--help</tt> option.)
+Zabbix API can all be customized; see the <tt>--help</tt> option.)
 
-  # Send one data point
+  # Send one data point -- this is tab separated!
   $ echo "foo.bar.baz	123" | zabbix_pipe --host='My Zabbix Host'
   # Send a bunch of data points in a file
   $ cat my_data.tsv | zabbix_pipe --host='My Zabbix Host'
@@ -254,9 +261,93 @@ itself.
 
 A good pattern is to set up a production pipe (in <tt>--fast</tt>)
 mode at <tt>/dev/zabbix</tt> and to do all development/deployment with
-a separate copy of +zabbix_pipe+.  Once development/deployment is
+a separate instance of +zabbix_pipe+.  Once development/deployment is
 complete and all hosts, groups, templates, applications, and items
-have been created, switch to using production mode.
+have been created, switch to writing all data in "production mode"
+using the <tt>--fast</tt> pipe at <tt>/dev/zabbix</tt>.
 
 == Monitors
 
+Rubix also comes with some classes that make it easy to write simple
+monitors.  The output of these monitors should match the expected
+input format of +zabbix_pipe+.  This way they can be chained together.
+Here's an example of a simple monitor that calculates the currently
+used memory in bytes.
+
+  # in memory_monitor.rb
+  require 'rubix'
+
+  class MemoryMonitor < Rubix::Monitor
+    def measure
+      write do |data|
+        mem_used = `free | tail -n+2 | head -n1`.chomp.split[2].to_i
+        data << [['mem.used', mem_used]]
+      end
+    end
+  end
+
+  MemoryMonitor.run if $0 == __FILE__
+
+The file <tt>memory_monitor.rb</tt> can now be run on the command line in
+various ways:
+
+  # Write the output to STDOUT
+  $ ruby memory_monitor.rb
+  'mem.used'	11595908
+
+  # Loop every 30 seconds
+  $ ruby memory_monitor.rb --loop=30
+
+  'mem.used'	11595760
+  'mem.used'	11595800
+  'mem.used'	11596016
+  'mem.used'	11596008
+
+It can be piped into a running +zabbix_pipe+:
+
+  $ ruby memory_monitor.rb --loop=30 > /dev/zabbix &
+
+=== Monitors with Chef
+
+It's useful to be able to monitor resources defined in
+Chef[http://www.opscode.com/chef/] and so Rubix comes with a
++ChefMonitor+ class.
+
+  # in webserver_monitor.rb
+  require 'rubix'
+  require 'net/http'
+  require 'uri'
+  
+  class WebserverMonitor < Rubix::ChefMonitor
+
+    def webserver
+      @webserver ||= chef_node_from_node_name('my_webserver')
+    end
+
+    def uri
+      URI.parse("http://#{webserver['ec2']['public_hostname']}")
+    end
+  
+    def measure
+      begin
+        if Net::HTTP.get_response(uri).code.to_i == 200
+	  availability = 1
+	else
+	  availability = 0
+	end
+      rescue => e
+        availability = 0
+      end
+      write do |data|
+        data << ([['webserver.available', availability]])
+      end
+    end
+  end
+
+  WebserverMonitor.run if $0 == __FILE__
+
+To run this monitor you'll have to pass in credentials used to authenticate with Chef:
+
+  $ sudo ruby webserver_monitor.rb --chef_server_url=http://api.opscode.com/organizations/my_company --chef_node_name=this_node --chef_client_key=/etc/chef/client.pem --loop=30 > /dev/zabbix
+
+Make sure you can read the file at <tt>/etc/chef/client.pem</tt>!

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/rubix/examples/es_monitor.rb

@@ -9,11 +9,15 @@ require 'open-uri'
 class ESMonitor < Rubix::ClusterMonitor
 
   # Hostgroup for any hosts that needs to be created.
-  HOSTGROUP = 'Elasticsearch clusters'
+  CLUSTER_HOSTGROUPS = 'Elasticsearch clusters'
 
   # Templates for any hosts that need to be created.
   CLUSTER_TEMPLATES = 'Template_Elasticsearch_Cluster'
   NODE_TEMPLATES    = 'Template_Elasticsearch_Node'
+  
+  # Applications for new items
+  CLUSTER_APPLICATIONS = '_cluster'
+  NODE_APPLICATIONS    = 'Elasticsearch'
 
   def node_query
     'provides_service:*-elasticsearch'
@@ -45,9 +49,9 @@ class ESMonitor < Rubix::ClusterMonitor
     end
     write({
             :hostname    => "#{cluster_name}-elasticsearch",
-            :application => "_cluster",                 
+            :hostgroup   => self.class::CLUSTER_HOSTGROUPS
             :templates   => self.class::CLUSTER_TEMPLATES,
-            :hostgroup   => self.class::HOSTGROUP
+            :application => self.class::CLUSTER_APPLICATIONS
           }) do |d|
       d << ['status',              cluster_health['status']               ]
       d << ['nodes.total',         cluster_health['number_of_nodes']      ]
@@ -70,9 +74,9 @@ class ESMonitor < Rubix::ClusterMonitor
     index_data['indices'].each_pair do |index_name, index_data|
       write({
               :hostname   => "#{cluster_name}-elasticsearch",
-              :appliation => index_name,
+              :hostgroup  => self.class::CLUStER_HOSTGROUP,
               :templates  => self.class::CLUSTER_TEMPLATES,
-              :hostgroup  => self.class::HOSTGROUP
+              :appliation => index_name
             }) do |d|
         d << ["#{index_name}.size",           index_data["index"]["size_in_bytes"] ]
         d << ["#{index_name}.docs.num",       index_data["docs"]["num_docs"]       ]
@@ -102,8 +106,8 @@ class ESMonitor < Rubix::ClusterMonitor
       next unless node_name
       write({
               :hostname    => node_name,
-              :application => "Elasticsearch",
-              :templates   => self.class::NODE_TEMPLATES
+              :templates   => self.class::NODE_TEMPLATES,
+              :application => self.class::NODE_APPLICATIONS
             }) do |d|
         # concurrency
         d << ['es.jvm.threads.count',     stats['jvm']['threads']['count']                   ]

data/lib/rubix/examples/hbase_monitor.rb

@@ -1,18 +1,25 @@
 #!/usr/bin/env ruby
 
-require 'zabbix_cluster_monitor'
+RUBIX_ROOT = File.expand_path('../../../../lib', __FILE__)
+$: << RUBIX_ROOT unless $:.include?(RUBIX_ROOT)
+
+require 'rubix'
 require 'net/http'
 require 'crack'
 
-class HBaseMonitor < ZabbixClusterMonitor
+class HBaseMonitor < Rubix::ClusterMonitor
 
   # Hostgroups for clusters & hosts that need to be created.
-  CLUSTER_HOSTGROUP = 'HBase clusters'
+  CLUSTER_HOSTGROUPS = 'HBase clusters'
 
   # Templates for any hosts that need to be created.
   CLUSTER_TEMPLATES = 'Template_HBase_Cluster'
   NODE_TEMPLATES    = 'Template_HBase_Node'
 
+  # Applications for items that are written
+  CLUSTER_APPLICATIONS = '_cluster'
+  NODE_APPLICATIONS    = "Hbase"
+
   def matching_chef_nodes
     Chef::Search::Query.new.search('node', 'provides_service:*hbase-stargate AND facet_name:alpha')
   end
@@ -45,8 +52,8 @@ class HBaseMonitor < ZabbixClusterMonitor
 
     write({
             :hostname    => "#{cluster_name}-hbase",
-            :application => '_cluster',
-            :hostgroup   => 'HBase Clusters',
+            :hostgroup   => self.class::CLUSTER_HOSTGROUPS,
+            :application => self.class::CLUSTER_APPLICATIONS,
             :templates   => self.class::CLUSTER_TEMPLATES
           }) do |d|
       d << ['requests',    cluster_status['requests']]
@@ -72,7 +79,7 @@ class HBaseMonitor < ZabbixClusterMonitor
       next unless node_name
       write({
               :hostname    => node_name,
-              :application => "HBase",
+              :application => self.class::NODE_APPLICATIONS,
               :templates   => self.class::NODE_TEMPLATES
             }) do |d|
         d << ['hbase.regions',   (live_node['Region'] || []).size]

data/lib/rubix/examples/mongo_monitor.rb

@@ -1,17 +1,23 @@
 #!/usr/bin/env ruby
 
-require 'zabbix_cluster_monitor'
+RUBIX_ROOT = File.expand_path('../../../../lib', __FILE__)
+$: << RUBIX_ROOT unless $:.include?(RUBIX_ROOT)
+
+require 'rubix'
 require 'open-uri'
 require 'set'
 require 'mongo'
 
-class MongoMonitor < ZabbixClusterMonitor
+class MongoMonitor < Rubix::ClusterMonitor
   
   # Hostgroup for any hosts that needs to be created.
-  HOSTGROUP = 'MongoDB clusters'
+  CLUSTER_HOSTGROUPS = 'MongoDB clusters'
 
   # Templates for any hosts that need to be created.
-  TEMPLATES = 'Template_MongoDB'
+  CLUSTER_TEMPLATES = 'Template_MongoDB'
+
+  # Applications
+  CLUSTER_APPLICATIONS = '_cluster'
 
   # Names of database to ignore when we find them.
   IGNORED_DATABASES = %w[db test admin local].to_set
@@ -44,12 +50,11 @@ class MongoMonitor < ZabbixClusterMonitor
     initial = db.command(command) ; sleep 1.0 ; final = db.command(command)
     return false unless initial && final
     dt = final['localTime'].to_f - initial['localTime'].to_f
-
     write({
-             :hostname    => "#{cluster_name}-mongodb",
-             :application => '_cluster',
-             :hostgroup   => self.class::HOSTGROUP,
-             :templates   => self.class::TEMPLATES
+            :hostname    => "#{cluster_name}-mongodb",
+            :hostgroup   => self.class::CLUSTER_HOSTGROUPS,
+            :templates   => self.class::CLUSTER_TEMPLATES,
+            :application => self.class::CLUSTER_APPLICATIONS
            }) do |d|
       
       # operations
@@ -102,10 +107,10 @@ class MongoMonitor < ZabbixClusterMonitor
       stats = connection.db(database_name).stats()
 
       write({
-               :hostname    => "#{cluster_name}-mongodb",
-               :application => database_name,
-               :hostgroup   => self.class::HOSTGROUP,
-               :templates   => self.class::TEMPLATES
+              :hostname    => "#{cluster_name}-mongodb",
+              :hostgroup   => self.class::CLUSTER_HOSTGROUPS,
+              :templates   => self.class::CLUSTER_TEMPLATES,
+              :application => database_name
              }) do |d|
         d << ["#{database_name}.collections",      stats["collections"] ]
         d << ["#{database_name}.objects.count",    stats["objects"]     ]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rubix
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Dhruv Bansal
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-21 00:00:00 Z
+date: 2011-11-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec