collectd-interface 0.1.0

data/views/README.md

@@ -0,0 +1,134 @@
+Created 10 Feb 2012 -- Last change 14 Feb 2012  
+By Victor Penso
+
+Description
+===========
+
+_Collectd-Interface_ serves a web user-interface to data stored 
+by [Collectd](http://collectd.org/). Furthermore it provides REST 
+access to all data.
+
+Installation
+============
+
+Download and install Collectd following the instructions 
+from the developers. 
+
+On Debian flavored Linux use:
+
+    apt-get install collectd rrdtool
+
+You will need the [RRDtool](http://oss.oetiker.ch/rrdtool/) too.
+
+Usage
+=====
+
+Get help:
+
+    collectd-interface-daemon --help
+
+Start the Collectd Interface in fore-ground:
+
+    collectd-interface-daemon
+
+Open the web-interface <a href='localhost:4567'>localhost:4567</a>.
+
+Start the Collectd Interface as daemon:
+
+    collectd-interface-daemon -p 5000 -l /var/log/ -P /var/run/ &
+
+
+Interfaces
+==========
+
+Collectd-Interface servers three different kinds of output:
+
+1. `/graph` is the user-interface showing line charts of many
+   of the data accumulated by Collectd.
+2. `/report` presents tables of system specific information
+   like disk capacity of a list of network sockets.
+3. `/data` servers an REST API to all data available from 
+   Collectd.
+
+All content from `/graph`, `/report` and `/data` is accessible 
+by a REST interface, to allow embedding this content into other
+applications.
+
+Graph
+-----
+
+![Screenshot of User-Interface](https://github.com/vpenso/collectd-interface/raw/master/public/readme/user-interface.png  "Screenshot of the User-Interface")
+
+You can select individual graphs using the drop-down menu followed by 
+clicking the "Show" button. In case you just want to have the image, to
+embed it into another web-page, use the links beneath the graph.
+
+Once the graph is generated the caller will be redirected to `/image/`.
+
+**Parameters**
+
+It is possible to limit the time-frame of the graph using the option
+`last=10h`(us (m)inutes,(d)ays or (w)eeks). 
+
+This simple example:
+
+    http://.../memory?last=1w&image=svg
+
+Requests an SVG image with the memory graph for the last week.
+
+**Plugin**
+
+You can create add a custom graph rendering data from Collectd
+by creating a template which is used to generate the <tt>rrdtool graph</tt>.
+Take a look to the <tt>graphs/</tt> and <tt>disabled/graphs/</tt> directories 
+for examples. I recommend you the start the Collectd-Interface in
+debug mode (option <tt>-d</tt>) while you develop new graph templates.
+
+In case you want to enable graphs from <tt>disabled/graphs/</tt> create 
+a soft link from <tt>graphs/</tt>. The <tt>collectd-interface</tt> daemon will 
+automatically recognize new templates within <tt>graphs</tt> on start.
+
+Report
+------
+
+Reports a basically wrappers around commands like <tt>df -l</tt> or
+<tt>ss -ar</tt>. The output is available as HTML in the "Report" section
+of the user-interface. 
+
+TODO
+
+Data
+----
+
+List all available values <a href="/data/">/data/</a> from 
+Collectd. Get the time-series of a specific value.
+
+    http://.../data/interface/if_packets-eth0/rx
+
+By default the severs will answer with averages 
+of all data-points and an HTML document.
+
+**Parameters**
+
+    http://.../value?last=36h&resolution=3600
+
+Request only values from the last 36 hours, with a
+data point resolution of 1 hour (3600 seconds).
+Default resolution is the highest possible and you
+will get by default values of the last 24 hours.
+In the time specification you can also use (w)eeks,
+(d)ays and (m)inutes.
+
+    http://.../rx?function=max&format=json
+
+Request the maximum of all data points for the past
+in the JSON format. Other consolidation functions
+are average (default) and min, for the smallest value
+in a time-frame.
+
+
+Copying
+=======
+
+Copyright 2011 Victor Penso  
+License [GPLv3](http://www.gnu.org/licenses/gpl-3.0.html) (see LICENSE file)

data/views/data.erb

@@ -0,0 +1,3 @@
+<script>
+window.onload=toggle();
+</script>

data/views/graph.erb

@@ -0,0 +1,19 @@
+<ul>
+<% if @display.first == 'all' then %>
+  <% @graphs.keys.sort.each do |name| %>
+    <% url = "/graph/#{name}?#{@args}" %>
+  <li>
+    <img src="<%= url %>"/><br/>
+    <a href="<%= url %>"><%= url %></a>
+  </li>
+  <% end %>
+<% else %>
+<%   @display.each do |graph| %>
+  <% url = "/graph/#{graph}?#{@args}"%>
+  <li>
+    <img src="<%= url %>"/><br/>
+    <a href="<%= url %>"><%= url %></a>
+  </li>
+<%   end%>
+<% end %>
+</ul>

data/views/readme.erb

@@ -0,0 +1,3 @@
+<div class="docs">
+  <%= markdown(:README) %>
+</div>

data/views/report.erb

@@ -0,0 +1,17 @@
+<ul style='list-style-type:none; padding-left:0'>
+<% if @display == 'all' %>
+<%   for val in @reports %>
+  <li>
+<%=    erb("/reports/#{val}".to_sym)  %>
+<%     url = "/report/#{val}?format=json" %>
+    <a href="<%= url %>"><%= url %></a>
+  </li>
+<%   end %>
+<% else %>
+  <li>
+<%=   erb("/reports/#{@display}".to_sym)%>
+<%    url = "/report/#{@display}?format=json" %>
+    <a href="<%= url%>"><%= url %></a>
+  </li>
+<% end %>
+</ul>

data/views/reports/disk-free.erb

@@ -0,0 +1,20 @@
+<% require 'json' 
+content = `df -lh`.split("\n") 
+if @type == 'text' then %><%= content.join("\n") %>
+<% elsif @type == 'json' 
+  keys = content[0].chop.chop.split.map! { |v| v.downcase } 
+  json = Array.new 
+  content[1..-1].each { |values|  json << Hash[*keys.zip(values.split).flatten] } %><%= JSON.pretty_generate json %>
+<% else %>
+  <div style="font-size:160%"><strong>Local Storage</strong></div>
+  <table>
+  <thead>
+    <tr><th><%= content[0].chop.chop.split.join('</th><th>') %></th></tr>
+  </thead>
+  <tbody>
+  <% content[1..-1].each do |line| %>
+    <tr><td><%= line.split.join('</td><td>') %></td></tr>
+  <% end %>
+  </tbody>
+</table>
+<% end %>

data/views/reports/list-open-files-lustre.erb.disabled

@@ -0,0 +1,44 @@
+<% path = '/lustre' %>
+<% content = `lsof -u ^root -S2 #{path} | tr -s ' ' | cut -d' ' -f2-4,9-` %>
+<% if @type == 'text' then %>
+<%=  content %>
+<% elsif @type == 'json' %>
+<%   require 'json' %>
+<%   struct = Array.new %>
+<%   content = content.split("\n")[1..-1] %>
+<%   keys = ['pid','user','state','file'] %>
+<%   unless content.empty? %>
+<%     content.each do |file| %>
+<%       file = file.split %>
+<%        values = file[0..2] %>
+<%        values << file[3..-1].join(' ') %>
+<%        struct <<  Hash[*keys.zip(values).flatten] %>
+<%     end %>
+<%   end %>
+<%=  JSON.pretty_generate struct %>
+<% else %>
+<div style="font-size:160%"><strong>Open Files in Lustre</strong></div>
+<table>
+  <thead>
+    <tr>
+      <td>Process&nbsp;ID</td>
+      <td>User</td>
+      <td>State</td>
+      <td>File</td>
+    </tr>
+  </thead>
+  <tbody>
+<% if content.empty? %>
+    <tr><td>none</td><td>none</td><td>none</td><td>none</td></tr>
+<% else %>
+<%   content.split("\n")[1..-1].each do |file| %>
+<%   file = file.split%>
+    <tr>
+      <td><%= file[0..2].join('</td><td>') %></td>
+      <td><span style="font-size:80%"><%= file[3..-1].join(' ')%></span></td>
+    </tr>
+<%   end %>
+<% end %>
+  </tbody>
+</table>
+<% end %>

data/views/reports/list-open-files-tmp.erb

@@ -0,0 +1,44 @@
+<% path = '/tmp' %>
+<% content = `lsof -u ^root -S2 #{path} | tr -s ' ' | cut -d' ' -f2-4,9-` %>
+<% if @type == 'text' then %>
+<%=  content %>
+<% elsif @type == 'json' %>
+<%   require 'json' %>
+<%   struct = Array.new %>
+<%   content = content.split("\n")[1..-1] %>
+<%   keys = ['pid','user','state','file'] %>
+<%   unless content.empty? %>
+<%     content.each do |file| %>
+<%       file = file.split %>
+<%        values = file[0..2] %>
+<%        values << file[3..-1].join(' ') %>
+<%        struct <<  Hash[*keys.zip(values).flatten] %>
+<%     end %>
+<%   end %>
+<%=  JSON.pretty_generate struct %>
+<% else %>
+<div style="font-size:160%"><strong>Open Files in Temp</strong></div>
+<table>
+  <thead>
+    <tr>
+      <td>Process&nbsp;ID</td>
+      <td>User</td>
+      <td>State</td>
+      <td>File</td>
+    </tr>
+  </thead>
+  <tbody>
+<% if content.empty? %>
+    <tr><td>none</td><td>none</td><td>none</td><td>none</td></tr>
+<% else %>
+<%   content.split("\n")[1..-1].each do |file| %>
+<%   file = file.split%>
+    <tr>
+      <td><%= file[0..2].join('</td><td>') %></td>
+      <td><span style="font-size:80%"><%= file[3..-1].join(' ')%></span></td>
+    </tr>
+<%   end %>
+<% end %>
+  </tbody>
+</table>
+<% end %>

data/views/reports/processes-cpu-usage.erb

@@ -0,0 +1,39 @@
+<% content = `ps -d -o pid,user,pcpu,pmem,state,time,args --sort pcpu | sed '/^ 0.0 /d' | tail -n 30` %>
+<% if @type == 'text' then %>
+<%=  content.split("\n").reverse.join("\n") %>
+<% elsif @type == 'json' %>
+<%   content = content.split("\n")[1..-1].reverse %>
+<%   keys = ['pid','user','cpu_percent','mem_percent','state','cpu_time','command'] %>
+<%   require 'json'; struct = Array.new %>
+<%   content.each do |process| %>
+<%     process = process.split %>
+<%     values = process[0..5] %>
+<%     values << process[6..-1].join(' ') %>
+<%     struct << Hash[*keys.zip(values).flatten] %>
+<%   end%>
+<%=  JSON.pretty_generate struct %>
+<% else %>
+  <div style="font-size:160%"><strong>Process CPU Usage</strong></div>
+<table>
+  <thead>
+    <tr>
+      <th>Process&nbsp;ID</th>
+      <th>User</th>
+      <th>CPU&nbsp;%</th>
+      <th>Memory&nbsp;%</th> 
+      <th>State</th>
+      <th>CPU&nbsp;Time</th>
+      <th>Command</th>
+    </tr>
+  </thead>
+  <tbody>
+<% content.split("\n")[1..-1].reverse.each do |process| %>
+<%   process = process.split %>
+    <tr>
+      <td><%= process[0..5].join('</td><td>') %></td>
+      <td><span style="font-size:80%"><%= process[6..-1].join(' ')%></span></td>
+    </tr>
+<% end %>
+  </tbody>
+</table>
+<% end %>

data/views/reports/system-sockets.erb

@@ -0,0 +1,32 @@
+<% content = `ss -ar` %>
+<% if @type == 'text' then %>
+<%=  content %>
+<% elsif @type == 'json' %>
+<%   content = content.split("\n")[1..-1] %>
+<%   keys = ['state','recive_queue','send_queue','local_address','peer_address'] %>
+<%   require 'json'; struct = Array.new %>
+<%   content.each do |values| %>
+<%     struct << Hash[*keys.zip(values.split).flatten] %>
+<%   end %>
+<%=  JSON.pretty_generate struct %>
+<% else %>
+<div style="font-size:160%"><strong>System Sockets</strong></div>
+<table>
+  <thead>
+    <tr>
+      <th>State</td>
+      <th>Recv-Q</th>
+      <th>Send-Q</th>
+      <th>Local Address:Port</th>
+      <th>Peer Address:Port</th>
+    </tr>
+  </thead>
+  <tbody>
+<%  content.split("\n")[1..-1].each do |line| %>
+    <tr>
+      <td><%=   line.split.join("</td>\n<td>") %></td>
+    </tr>
+<%  end %>
+  </tbody>
+</table>
+<% end %>

data/views/show_values.erb

@@ -0,0 +1,11 @@
+<html>
+<head>
+</head>
+<body>
+  <table> 
+     <% for entry in @data %>
+     <tr><td><b><%= entry[0] %></b></td><td><%= entry[1..-1].join(' ')%></td></tr>
+     <% end %>
+  </table>
+</body>
+</html>

data/views/template/default.erb

@@ -0,0 +1,21 @@
+<html>
+  <head>
+    <%= erb "template/header".to_sym %>
+    <title><%= @target.capitalize %></title>
+  </head>
+  <body>
+    <form action="/<%= @target %>" method='get' style="top"> 
+      <%= erb "template/navigation".to_sym %>
+      <div id="toggle" class="options">
+        <%= erb "template/options/#{@target}".to_sym %>
+        <div class="submitter">
+          <button class="primary" type="submit"/>Show</button>
+          <button type="button" onClick="toggleCancel()">Cancel</button>
+        </div>
+      </div>
+    </form>
+    <div class='content'>
+      <%= yield %>
+    </div>
+  </body>
+</html>

data/views/template/header.erb

@@ -0,0 +1,3 @@
+<link href='style/default.css' rel='stylesheet' type='text/css'>  
+<link href='style/nav.css' rel='stylesheet' type='text/css'>  
+<script src="script/toggle.js" type="text/javascript"></script>

data/views/template/navigation.erb

@@ -0,0 +1,9 @@
+<div class="navigation">
+  <ul>
+    <li><a href="/graph">Graph</a></li>
+    <li><a href='/data'>Data</a></li>
+    <li><a href='/report'>Report</a></li>
+    <li><a href='/help'>Help</a></li>
+  </ul>
+  <button type="button" onClick="toggle()">&#8595;</button>
+</div>

data/views/template/options/data.erb

@@ -0,0 +1,31 @@
+<ul>
+  <li>
+    <div class="label">Select data source:</div>
+    <select name="display">
+      <% for source in @data %>
+      <option><%= source %></option>
+      <% end %>
+    </select> 
+  </li>
+  <li>
+    <div class="label">Select output format:</div>
+    <select name="format">
+      <option>text</option>
+      <option>json</option>
+    </select>
+  </li>
+  <li>
+    <div class="label">Values of the last:</div>
+    <input type="text" name="last" value="12h"/>
+    <div class="explain">(s)econds (h)ours (d)ays (w)eeks</div>
+  </li>
+  <li>
+    <div class="label">Data accumulation function:</div>
+    <select name="function">
+      <option>max</option>
+      <option>min</option>
+      <option>average</option>
+      <option>last</option>
+    </select>
+  </li>
+</ul>