monittr 0.0.2 → 0.0.3

data/README.markdown

@@ -1,32 +1,45 @@
 # Monittr : A Web Interface for Monit Statistics #
 
-_Monittr_ provides a _Ruby_ interface for displaying [_Monit_](http://mmonit.com/) statistics in [_Sinatra_](http://www.sinatrarb.com/) based web applications.
+_Monittr_ provides a _Ruby_ interface for the [_Monit_](http://mmonit.com/monit/) systems management system.
 
-It loads information from the [web server embedded in _Monit_](http://mmonit.com/monit/documentation/monit.html#monit_httpd) and makes it accessible as Ruby objects.
+Its main goal is to display statistics from multiple _Monit_ instances in an attractive web interface.
 
-It also displays the information in HTML with the provided helpers. You can use the default template, or provide your own. The default template is located in `lib/monittr/sinatra/template.erb`.
+_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 _Monit_ information into any page, or create a dedicated page.
+
+You can use the default template, or create your own. The default template is located in `lib/monittr/sinatra/template.erb`.
+
+The default template is pictured below.
 
 ![Screenshot: Monittr, a web interface for Monit statistics](https://github.com/karmi/monittr/raw/master/screenshot.png)
 
 
 ## Usage ##
 
-First, clone or download the sources from [_Github_](https://github.com/karmi/monittr/zipball/master).
+First, clone or [download](https://github.com/karmi/monittr/zipball/master)
+the sources from [_Github_](https://github.com/karmi/monittr/), to get the latest version:
 
-You can try the interface in a IRB console:
+    $ git clone http://github.com/karmi/monittr.git
+    $ cd monittr
+
+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 running Monit web server XML output, eg. `http://admin:monit@example.com:2812/`.
+You have to pass one or more full URLs to a local or remote Monit web server output:
 
-In case you don't have a running Monit handy, fake its output:
+    cluster = Monittr::Cluster.new ['http://localhost:2812/']
 
-    require 'fakeweb'
-    FakeWeb.register_uri(:get, 'http://localhost:2812/', :body => File.read('test/fixtures/status.xml') ); nil
+In case you don't have a running _Monit_ at hand, use the provided _FakeWeb_ setup:
 
-Now, retrieve information from the cluster:
+    require 'fakeweb'
+    FakeWeb.register_uri(:get, 'http://localhost:2812/_status?format=xml', :body => File.read('test/fixtures/status.xml') ); nil
 
     cluster = Monittr::Cluster.new ['http://localhost:2812/']
+
+Now, you can display the information from the cluster:
+
     cluster.servers.size
 
     server = cluster.servers.first
@@ -42,17 +55,19 @@ Now, retrieve information from the cluster:
 
     ...
 
-You can also check out the HTML output by running the example application:
+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.
 
-Provide the URLs to _Monit_ instances by setting the appropriate option:
+Provide the URLs to live _Monit_ instances by setting the appropriate option in `application.rb`:
 
     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.
+
 
 ## Customization ##
 
@@ -62,7 +77,7 @@ 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 more.
+Please see the example application for prepared examples.
 
 
 ## Installation ##
@@ -78,9 +93,11 @@ Stable versions of the gem can be installed from _Rubygems_:
     $ gem install monittr
 
 
-## Other Information ##
+## Other ##
+
+The code is useful for the intended purpose as it is, but if you've got any feedback, suggestions or patches, please send me an e-mail or use _Github_ Issues/Pull Requests.
 
-See the [_monit_](https://github.com/k33l0r/monit) gem for another Ruby interface to _Monit_.
+Check out the [_monit_](https://github.com/k33l0r/monit) gem for another Ruby interface to _Monit_.
 
 -----
 

data/Rakefile

@@ -1,2 +1,11 @@
 require 'bundler'
-Bundler::GemHelper.install_tasks
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/examples/application.rb

@@ -7,17 +7,29 @@ require 'fakeweb'
 
 require 'monittr/sinatra/monittr'
 
-FakeWeb.register_uri(:get, 'http://localhost:2812/_status?format=xml', :body => File.read( File.expand_path('../../test/fixtures/status.xml', __FILE__)))
+# --- Comment these lines to enable loading data from http://localhost:2812 ---
+FakeWeb.register_uri(:get, 'http://localhost:2812/_status?format=xml',
+                     :body => File.read( File.expand_path('../../test/fixtures/status.xml', __FILE__)))
+# -----------------------------------------------------------------------------
 
+# --- Set URLs to your Monit instances here -----------------------------------
 set :monit_urls,  %w[ http://localhost:2812 http://localhost:2812 ]
+# -----------------------------------------------------------------------------
 
+# --- Use your own template ---------------------------------------------------
 # set :template,   Proc.new { File.join(root, 'template.erb') }
+# -----------------------------------------------------------------------------
+
+# --- Use your own stylesheet for the `stylesheet` helper ---------------------
 # set :stylesheet, '/path/to/my/stylesheet'
+# -----------------------------------------------------------------------------
+
 
 get "/" do
   erb :index
 end
 
+
 __END__
 
 @@ layout
@@ -28,7 +40,8 @@ __END__
   <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   <style>
     body     { color: #222; font-family: sans-serif; margin: 2em; }
-    #example { border: 4px solid #ccc; padding: 1em; }
+    p        { margin: 0 0 0.5em 0; }
+    #example { border: 4px solid #ccc; padding: 1em; margin: 1em 0 1em 0; }
   </style>
 </head>
 <body>

data/examples/template.erb

@@ -1,20 +1,30 @@
-<h1>A Customized template for <em>Monittr</em></h1>
+<style>
+  body { color: #222; font-size: 85%; }
+  a    { color: #222;  }
+  h1   { font-size: 18px; }
+  h2   { font-size: 16px; margin: 1em 0 .25em 0; }
+  h3   { font-size: 14px; margin: .25em 0 .25em 0; }
+  ul   { margin: 0 0 0 1.2em; padding: 0; list-style-type: square; }
+</style>
 
-<p>You can customize the template as you wish,
-  just set the path to it with something like this in your application:</p>
-
-<pre>set :template,  Proc.new { File.join(root, 'template.erb') }</pre>
+<h1>A Customized Template for <em>Monittr</em></h1>
 
 <hr>
 
-<% cluster.servers.each do |server| %>
-  <h2>Server: <em><%= server.system.name %></em> // status: <%= server.system.status %></h2>
+<% server = cluster.servers.first %>
 
-  <h3>Processes</h3>
-  <ul>
-    <% server.processes.each do |process| %>
-    <li><%= process.name %></li>
-    <% end %>
-  </ul>
+<h2>
+    Server: <em><a href="<%= server.url %>"><%= server.system.name %></a></em>
+    // status: <%= server.system.status    == 0 ? 'running'   : 'not running' %> and
+               <%= server.system.monitored == 1 ? 'monitored' : '<b>not</b> monitored' %>
+</h2>
 
-<% end %>
+<ul>
+  <% server.processes.each do |process| %>
+  <li>
+    <%= process.name %>
+    <em><%= process.status == 0 ? 'running' : 'stopped' %> and <%= process.monitored == 1 ? 'monitored' : '<b>not</b> monitored' %></em>
+    <small>(CPU: <%= process.cpu || 'N/A' %>%, MEM: <%= process.memory || 'N/A' %>%)</small>
+  </li>
+  <% end %>
+</ul>

data/lib/monittr/sinatra/style.css

@@ -6,7 +6,6 @@
 
 #monittr .rounded
   { -moz-border-radius: 0.5em;
-	  -webkit-border-radius: 0.5em;
 	  border-radius: 0.5em }
 
 #monittr a
@@ -29,7 +28,6 @@
     display: block;
     float: left;
     -moz-border-radius: 6px;
-    -webkit-border-radius: 6px;
     border-radius: 6px; }
 #monittr .dot.running
   { background-color: green; }
@@ -42,13 +40,14 @@
   { color: #222;
     background-color: #F8F8F8;
     margin: 0.2em 0 0 0;
-    border: 1px solid #ccc; }
+    border: 1px solid #ccc;
+    border-top: none; }
 
 #monittr .server h2
   { font-size: 14px;
     font-weight: normal;
     background-color: #ccc;
-    padding: 0.5em 0.5em 0.4em 0.5em;
+    padding: 0.6em 0.5em 0.4em 1em;
     margin: 0; }
 #monittr .server.running h2
   { background-color: #66E98A; }
@@ -57,14 +56,14 @@
     background-color: #CC033E; }
 #monittr .server.failure h2 *
   { color: #fff !important; }
+#monittr .server h2 a
+  { margin-left: 0.25em; }
 
 #monittr .server.expanded h2
   { -moz-border-radius-bottomleft: 0;
     -moz-border-radius-bottomright: 0;
-	  -webkit-border-radius-bottomleft: 0;
-	  -webkit-border-radius-bottomright: 0
-	  border-radius-bottomleft: 0;
-	  border-radius-bottomright: 0; }
+	  border-bottom-left-radius: 0;
+	  border-bottom-right-radius: 0; }
 
 #monittr .server h2 small
   { font-size: 75%;
@@ -124,7 +123,6 @@
     font-weight: normal;
     padding: 0.25em 0.5em 0.15em 0.5em;
     -moz-border-radius:    0.5em;
-  	-webkit-border-radius: 0.5em;
   	border-radius:         0.5em; }
 
 #monittr .server .segment strong .label.running
@@ -132,4 +130,4 @@
 #monittr .server .segment strong .label.warning
   { background-color: orange; }
 #monittr .server .segment strong .label.failure
-  { background-color: red; }
+  { background-color: red; }

data/lib/monittr/sinatra/template.erb

@@ -9,8 +9,8 @@
     <div class="server rounded">
       <h2 class="rounded">
         <strong>
-          <span class="dot status <%= server.system.status == 0 ? 'running' : 'failure' %>">&middot;</span>
-          <span class="dot monitored <%= server.system.monitored == 1 ? 'running' : 'failure' %>">&middot;</span>
+          <span title="status" class="dot status <%= server.system.status == 0 ? 'running' : 'failure' %>">&middot;</span>
+          <span title="monitored" class="dot monitored <%= server.system.monitored == 1 ? 'running' : 'failure' %>">&middot;</span>
           <a href="<%= server.url %>"><%= server.system.name %></a>
           <%= "<em>#{server.system.message}</em>" if server.system.message %>
         </strong>
@@ -79,17 +79,25 @@
 $(function() {
   $('#monittr .server .content').hide();
 
-  $('#monittr .server h2').click(function() {
-    $(this).parent().toggleClass('expanded').find('.content').toggle('fast', function() { });
+  $('#monittr .server').bind('expand', function() {
+    $(this).addClass('expanded').find('.content').show('fast', function() { });
   });
+  $('#monittr .server').bind('collapse', function() {
+    $(this).removeClass('expanded').find('.content').hide('fast', function() { });
+  });
+
+  $('#monittr .server h2').toggle(
+    function() { $(this).parent().trigger('expand') },
+    function() { $(this).parent().trigger('collapse') }
+  );
 
   $('#toggle').toggle(
     function() {
-      $('#monittr .server .content').show('fast');
+      $('#monittr .server').trigger('expand');
       $(this).html('- Collapse all');
     },
     function() {
-      $('#monittr .server .content').hide('fast');
+      $('#monittr .server').trigger('collapse');
       $(this).html('+ Expand all');
     }
   );

data/lib/monittr/version.rb

@@ -1,3 +1,3 @@
 module Monittr
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/fixtures/status.xml

@@ -7,7 +7,7 @@
     <uptime>937661</uptime>
     <poll>10</poll>
     <startdelay>0</startdelay>
-    <localhostname>myapplication.cz</localhostname>
+    <localhostname>application.com</localhostname>
     <controlfile>/usr/local/etc/monitrc</controlfile>
     <httpd>
       <address/>
@@ -459,56 +459,6 @@
       <percenttotal>0.0</percenttotal>
     </cpu>
   </service>
-  <service type="3">
-    <collected_sec>1290526733</collected_sec>
-    <collected_usec>939824</collected_usec>
-    <name>scheduler_workers</name>
-    <status>0</status>
-    <status_hint>0</status_hint>
-    <monitor>1</monitor>
-    <monitormode>0</monitormode>
-    <pendingaction>0</pendingaction>
-    <groups/>
-    <pid>12870</pid>
-    <ppid>12869</ppid>
-    <uptime>656652</uptime>
-    <children>1</children>
-    <memory>
-      <percent>0.6</percent>
-      <percenttotal>1.3</percenttotal>
-      <kilobyte>56596</kilobyte>
-      <kilobytetotal>116260</kilobytetotal>
-    </memory>
-    <cpu>
-      <percent>0.0</percent>
-      <percenttotal>0.0</percenttotal>
-    </cpu>
-  </service>
-  <service type="3">
-    <collected_sec>1290526733</collected_sec>
-    <collected_usec>939890</collected_usec>
-    <name>scheduler</name>
-    <status>0</status>
-    <status_hint>0</status_hint>
-    <monitor>1</monitor>
-    <monitormode>0</monitormode>
-    <pendingaction>0</pendingaction>
-    <groups/>
-    <pid>12681</pid>
-    <ppid>1</ppid>
-    <uptime>656765</uptime>
-    <children>0</children>
-    <memory>
-      <percent>0.7</percent>
-      <percenttotal>0.7</percenttotal>
-      <kilobyte>66200</kilobyte>
-      <kilobytetotal>66200</kilobytetotal>
-    </memory>
-    <cpu>
-      <percent>0.2</percent>
-      <percenttotal>0.2</percenttotal>
-    </cpu>
-  </service>
   <service type="3">
     <collected_sec>1290526733</collected_sec>
     <collected_usec>939892</collected_usec>
@@ -523,7 +473,7 @@
   <service type="5">
     <collected_sec>1290526733</collected_sec>
     <collected_usec>939894</collected_usec>
-    <name>myapplication.cz</name>
+    <name>application.com</name>
     <status>0</status>
     <status_hint>0</status_hint>
     <monitor>1</monitor>

data/test/monittr_test.rb

@@ -65,7 +65,7 @@ module Monittr
         assert_not_nil     @server.system
         assert_equal 0,    @server.system.status
         assert_equal 1,    @server.system.monitored
-        assert_equal 'myapplication.cz', @server.system.name
+        assert_equal 'application.com', @server.system.name
         assert_equal 5.28, @server.system.load
         assert_equal 0,    @server.system.status
         assert_equal 937661, @server.system.uptime
@@ -84,7 +84,7 @@ module Monittr
 
       should "return processes info" do
         assert_not_nil @server.processes
-        assert_equal 15, @server.processes.size
+        assert_equal 13, @server.processes.size
 
         thin = @server.processes.first
         assert_not_nil thin

data/test/sinatra_helper_test.rb

@@ -23,7 +23,7 @@ class SinatraHelperTest < Test::Unit::TestCase
       get '/'
 
       assert last_response.ok?
-      assert last_response.body.include?('myapplication.cz'), "Response body should contain: myapplication.cz"
+      assert last_response.body.include?('application.com'), "Response body should contain: application.com"
       assert last_response.body.include?('thin_1'),           "Response body should contain: thin_1"
     end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Karel Minarik
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-25 00:00:00 +01:00
+date: 2010-11-28 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -103,7 +103,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id007
-description: "    Monittr provides a Ruby interface for displaying Monit statistics\n    in Sinatra based web applications.\n\n    It loads information from the web server embedded in Monit and\n    makes it accessible as Ruby objects.\n\n    It also displays the information in HTML with the provided helpers.\n"
+description: "    Monittr provides a Ruby interface for loading and displaying statistics\n    from multiple Monit instances and helpers for Sinatra web applications.\n"
 email: karmi@karmi.cz
 executables: []
 
@@ -159,6 +159,6 @@ rubyforge_project:
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: Web interface for Monit statistics
+summary: A Ruby and web interface for Monit statistics
 test_files: []