monittr 0.0.4 → 0.0.5

data/README.markdown

@@ -1,6 +1,6 @@
 # Monittr #
 
-Monittr provides a Ruby interface for the [Monit](http://mmonit.com/monit/) systems management system. Its main goal is to display statistics from multiple Monit instances in an attractive web interface.
+Monittr provides a Ruby interface for the [Monit](http://mmonit.com/monit/) systems management system. Its main goal is to aggregate statistics from multiple Monit instances and display them in an attractive web interface.
 
 Monittr loads XML from the [web server embedded in Monit](http://mmonit.com/monit/documentation/monit.html#monit_httpd) and makes it accessible as Ruby objects. It also provides helpers for [Sinatra](http://www.sinatrarb.com/) applications, to display the information as HTML. You can insert the statistics into any page, or create a dedicated one. You can use the default template, or create your own. The default template is located in `lib/monittr/sinatra/template.erb` and pictured below.
 
@@ -15,11 +15,11 @@ the sources from [Github](https://github.com/karmi/monittr/), to get the latest
     $ git clone http://github.com/karmi/monittr.git
     $ cd monittr
 
-You can try the _Ruby_ interface in a IRB console:
+You can try the Ruby interface in a IRB console:
 
     $ irb -Ilib -rubygems -rmonittr
 
-You have to pass one or more full URLs to a local or remote Monit web server output:
+You have to pass one or more URLs to a local or remote Monit [HTTP server](http://mmonit.com/monit/documentation/monit.html#monit_httpd):
 
     cluster = Monittr::Cluster.new ['http://localhost:2812/']
 
@@ -52,13 +52,23 @@ You can also check out the HTML display by running the example application:
     $ ruby examples/application.rb
     $ open http://localhost:4567/
 
-You should see the information about two faked Monit instances in your browser.
+You should see the information about two faked Monit instances in your browser. (You may need to comment out the FakeWeb section, if you're passing `localhost` URLs.)
 
-Provide the URLs to live Monit instances by setting the appropriate option in `application.rb`:
+To use the gem in a Sinatra application, you have to require the gem, the Sinatra helper and provide the URLs to Monit instances:
 
+    require 'monittr'
+    require 'monittr/sinatra/monittr'
     set :monit_urls,  %w[ http://production.example.com:2812 http://staging.example.com:2812 ]
 
-You may also need to comment out the FakeWeb section, if you're passing `localhost` URLs.
+In a “modular” Sinatra application, you have to register the module explicitely as well:
+
+    register Sinatra::MonittrHTML
+
+Then, just call the helper in your template:
+
+    <%= monittr.html %>
+
+You may use the example application as the starting point.
 
 
 ## Customization ##
@@ -68,8 +78,6 @@ It's easy to customize the HTML output by setting the appropriate options in you
     set :template,   Proc.new { File.join(root, 'template.erb') }
     set :stylesheet, '/path/to/my/stylesheet'
 
-Please see the example application for prepared examples.
-
 
 ## Installation ##
 

data/examples/application.rb

@@ -5,7 +5,9 @@ require 'monittr'
 require 'sinatra'
 require 'fakeweb'
 
+# --- Require the Sinatra extension -------------------------------------------
 require 'monittr/sinatra/monittr'
+# -----------------------------------------------------------------------------
 
 # --- Comment these lines to enable loading data from http://localhost:2812 ---
 FakeWeb.register_uri(:get, 'http://localhost:2812/_status?format=xml',

data/lib/monittr/sinatra/style.css

@@ -15,6 +15,9 @@
 #monittr a:hover
   { text-decoration: underline; }
 
+#monittr p
+  { margin: 0; padding: 0; }
+
 #monittr #toggle
   { font-size: 80%;
     text-decoration: underline;

data/lib/monittr/sinatra/template.erb

@@ -19,12 +19,13 @@
           <span class="info"><span class="label">load:   </span><%= server.system.load   || 'N/A' %></span>
           <span class="info"><span class="label">cpu:    </span><%= server.system.cpu    || 'N/A' %></span>
           <span class="info"><span class="label">memory: </span><%= server.system.memory || 'N/A' %></span>
+          <span class="info"><span class="label">swap:   </span><%= server.system.swap   || 'N/A' %></span>
           <span class="info"><span class="label">uptime: </span><%= time_in_words(server.system.uptime) || 'N/A' %></span>
         </small>
       </h2>
 
       <div class="content">
-        <div class="segment filesystem">
+        <div class="segment filesystems">
           <h3>Filesystem</h3>
           <ul class="clearfix">
             <% server.filesystems.each do |fs| %>
@@ -39,7 +40,7 @@
             <% end %>
           </ul>
           <div class="clear"></div>
-        </div><!-- /filesystem -->
+        </div><!-- /filesystems -->
 
         <div class="segment processes">
           <h3>Processes</h3>
@@ -62,7 +63,28 @@
             <% end %>
           </ul>
           <div class="clear"></div>
-        </div><!-- /filesystem -->
+        </div><!-- /processes -->
+
+        <div class="segment hosts">
+          <h3>Hosts</h3>
+          <ul>
+            <% server.hosts.each do |host| %>
+            <li>
+              <strong>
+                <span class="dot status <%= host.status == 0 ? 'running' : 'failure' %>">&middot;</span>
+                <span class="dot monitored <%= host.monitored == 1 ? 'running' : 'failure' %>">&middot;</span>
+                <%= host.name %>
+                <% unless host.monitored == 1 %><span class="label warning">NOT MONITORED</span><% end %>
+              </strong>
+
+              <small>
+                <span class="info"><span class="label">response time: </span><%= host.response_time  || 'N/A' %></span>
+              </small>
+            </li>
+            <% end %>
+          </ul>
+          <div class="clear"></div>
+        </div><!-- /hosts -->
 
       </div><!-- /content -->
 

data/lib/monittr/version.rb

@@ -1,3 +1,3 @@
 module Monittr
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/lib/monittr.rb

@@ -22,7 +22,7 @@ module Monittr
   #
   class Server
 
-    attr_reader :url, :xml, :system, :filesystems, :processes
+    attr_reader :url, :xml, :system, :filesystems, :processes, :hosts
 
     def initialize(url, xml)
       @url = url
@@ -33,10 +33,12 @@ module Monittr
                                           :status  => 3
         @filesystems = []
         @processes   = []
+        @hosts   = []
       else
         @system      = Services::System.new(@xml.xpath("//service[@type=5]").first)
         @filesystems = @xml.xpath("//service[@type=0]").map { |xml| Services::Filesystem.new(xml) }
         @processes   = @xml.xpath("//service[@type=3]").map { |xml| Services::Process.new(xml) }
+        @hosts       = @xml.xpath("//service[@type=4]").map { |xml| Services::Host.new(xml) }
       end
     end
 
@@ -91,6 +93,7 @@ module Monittr
                  :load      => value('system/load/avg01',       :to_f),
                  :cpu       => value('system/cpu/user',         :to_f),
                  :memory    => value('system/memory/percent',   :to_f),
+                 :swap      => value('system/swap/percent',     :to_f),
                  :uptime    => value('//server/uptime',         :to_i)
                } )
       end
@@ -112,11 +115,11 @@ module Monittr
                  :usage     => value('block/usage'                   ),
                  :total     => value('block/total'                   )
                } )
-      rescue Exception => e
-        puts "ERROR: #{e.class} -- #{e.message}, In: #{e.backtrace.first}"
-       super( { :name => 'Error',
-                :status  => 3,
-                :message => e.message } )
+        rescue Exception => e
+          puts "ERROR: #{e.class} -- #{e.message}, In: #{e.backtrace.first}"
+         super( { :name => 'Error',
+                  :status  => 3,
+                  :message => e.message } )
       end
     end
 
@@ -136,13 +139,34 @@ module Monittr
                  :uptime    => value('uptime',                  :to_i),
                  :memory    => value('memory/percent',          :to_f),
                  :cpu       => value('cpu/percent',             :to_i)
+               } )
+        rescue Exception => e
+          puts "ERROR: #{e.class} -- #{e.message}, In: #{e.backtrace.first}"
+          super( { :name => 'Error',
+                   :status  => 3,
+                   :message => e.message } )
+      end
+    end
           
+    # A "host" service in Monit
+    #
+    # http://mmonit.com/monit/documentation/monit.html#connection_testing
+    #
+    # <service type="4">
+    #
+    class Host < Base
+      def initialize(xml)
+        @xml = xml
+        super( { :name          => value('name'                          ),
+                 :status        => value('status',                  :to_i),
+                 :monitored     => value('monitor',                 :to_i),
+                 :response_time => value('port/responsetime'             )
                } )
-       rescue Exception => e
-         puts "ERROR: #{e.class} -- #{e.message}, In: #{e.backtrace.first}"
-        super( { :name => 'Error',
-                 :status  => 3,
-                 :message => e.message } )
+        rescue Exception => e
+          puts "ERROR: #{e.class} -- #{e.message}, In: #{e.backtrace.first}"
+         super( { :name => 'Error',
+                  :status  => 3,
+                  :message => e.message } )
       end
     end
 

data/test/fixtures/status.xml

@@ -496,4 +496,24 @@
       </memory>
     </system>
   </service>
+
+  <service type="4">
+      <name>www.google.com</name>
+      <collected_sec>1291193687</collected_sec>
+      <collected_usec>388019</collected_usec>
+      <status>0</status>
+      <status_hint>0</status_hint>
+      <monitor>1</monitor>
+      <monitormode>0</monitormode>
+      <pendingaction>0</pendingaction>
+      <port>
+          <hostname>www.google.com</hostname>
+          <portnumber>80</portnumber>
+          <request>/</request>
+          <protocol>HTTP</protocol>
+          <type>TCP</type>
+          <responsetime>0.009</responsetime>
+      </port>
+  </service>
+
 </monit>

data/test/monittr_test.rb

@@ -96,6 +96,16 @@ module Monittr
         assert_equal 0.0, thin.cpu
       end
 
+      should "return hosts info" do
+        assert_not_nil @server.hosts
+        assert_equal 1, @server.hosts.size
+
+        assert_equal 'www.google.com', @server.hosts[0].name
+        assert_equal 0, @server.hosts[0].status
+        assert_equal 1, @server.hosts[0].monitored
+        assert_equal '0.009', @server.hosts[0].response_time
+      end
+
     end
 
     [ Services::System, Services::Filesystem, Services::Process ].each do |klass|

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Karel Minarik
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-28 00:00:00 +01:00
+date: 2010-12-01 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency