panoptimon 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.3.0
+
+* plugins/graphite/ - added
+* collectors/iostat/ - allow missing headers
+* `monitor.http.hostport()` logged on init
+* `panoptimon --plugin-test` with .rb file
+
 # 0.2.0
 
 Removed the mysql_status collector from core to reduce gem dependencies.

data/bin/panoptimon

@@ -61,8 +61,13 @@ end
 
 if opts.plugin_test
 
+  # allow either json (as-installed) or rb name + json on command-line
   opts.plugin_test.each do |p|
-    monitor._init_plugin(monitor._load_plugin_config(Pathname.new(p)))
+    p = Pathname.new(p)
+    c = p.to_s =~ /\.rb$/ ? JSON.parse(ARGV.shift).
+        merge({name: p.basename.to_s, base: p.dirname, rb: p})
+      : monitor._load_plugin_config(p)
+    monitor._init_plugin(c)
   end
 
   module MetricReader

data/collectors/iostat/iostat

@@ -16,7 +16,7 @@ p = IO.popen(cmd, 'r')
 
 puts '{}' # beep
 
-def prep l
+def parse_header l
   want = {
     'kb_read/s'  => 'rkB/s',
     'kb_write/s' => 'wkB/s',
@@ -33,8 +33,10 @@ def prep l
   }
   head = l.chomp.split(/\s+/)
   head = Hash[*head.zip(0..(head.length-1)).flatten]
-  raise "oops" unless head.values_at(*want.values).length == want.values.length
-  o = {}; want.each {|k,v| o[k] = head[v]}
+  want.values.find_all{|x| not(head[x])}.tap {|missed|
+    warn "missing headers: "+ missed.join(', ') if missed.length > 0
+  }
+  o = {}; want.each {|k,v| o[k] = head[v] if head[v]}
   return o
 end
 
@@ -43,7 +45,7 @@ group = {}
 
 until p.eof?
   l = p.readline("\n\n").split(/\n/)
-  omap ||= prep(l[0])
+  omap ||= parse_header(l[0])
   puts JSON::generate(Hash[*l.drop(1).map {|x|
     r = x.split(/\s+/)
     [r[0], # device name

data/lib/panoptimon/http.rb

@@ -18,6 +18,10 @@ class HTTP
     @http.backend.start
   end
 
+  def hostport
+    "#{@http.host}:#{@http.port}"
+  end
+
   def call (env)
     path = env['PATH_INFO']
     return favicon(env) if path == '/favicon.ico'

data/lib/panoptimon/monitor.rb

@@ -100,6 +100,8 @@ class Monitor
     # TODO rescue LoadError => nicer error message
     require 'panoptimon/http'
     @http = HTTP.new
+    logger.warn "Serving http on #{@http.hostport}"
+    @http
   end
 
   def empty_binding; binding; end

data/lib/panoptimon/version.rb

@@ -1,5 +1,5 @@
 # Copyright (C) 2012 Sourcefire, Inc.
 
 module Panoptimon
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/plugins/graphite/README.md

@@ -0,0 +1,56 @@
+# Graphite Plugin
+
+This plugin emits metrics to Graphite.
+
+# Supported Platforms
+
+* Linux
+* *others untested*
+
+# Metric Names
+
+The panoptimon field separator is '|', but graphite uses '.' or '/'.
+The metric names emitted by this plugin will be rewritten to use '.'
+as a field separator, and any existing '.' or '/' characters are
+replaced with '_'.  This *could* cause a conflict with some metrics,
+but is rather unlikely.
+
+    example: disk|/dev/sda3|space_used
+    becomes: disk._dev_sda3.space_used
+
+# Configuration
+
+### graphite.json example
+
+````
+{
+  "host": "graphite.example.com",
+  "port": 2003,
+  "prefix": "env.location.foo"
+}
+````
+
+## `host`
+
+The name or IP of your Graphite server
+
+Default: `localhost`
+
+## `port`
+
+The port carbon is listening on.
+
+Default: `2003`
+
+## `prefix`
+
+The prefix to the path streamed to Graphite. For instance, if you set
+`prefix` to `qa.san-jose.app1`, the full CPU idle path Graphite receives
+will be `qa.san-jose.app1.cpu.idle`.  This allows you to customize how
+metrics are organized in Graphite.
+
+Default: `<%= host %>`
+
+The erb-like strings `<%= host %>` and `<%= domain %>` will be replaced
+(respectively) with the first and remaining dot-separated parts of your
+host name.

data/plugins/graphite/graphite.json

@@ -0,0 +1,3 @@
+{
+  "host": "localhost",
+  "port": 2003 }

data/plugins/graphite/graphite.rb

@@ -0,0 +1,36 @@
+require 'socket'
+
+hostname = ->(;h){->(i){
+  unless h
+    a, b = Socket.gethostname.split(/\./, 2)
+    h = {host: a, domain: b}
+  end
+  h[i.to_sym]
+}}[]
+
+host   = config[:host]   || 'localhost'
+port   = config[:port]   || '2003'
+prefix = config[:prefix] || '<%= host %>'
+
+prefix.gsub!(/<%= *(host|domain) *%>/) { hostname[$1] }
+
+socket = TCPSocket.open(host, port)
+
+->(metrics) {
+  t = Time.now.to_i
+  metrics.keys.each { |k| 
+
+    metric = k.dup
+
+    # Graphite will use "/" and "." as a delim. Replace with "_".
+    # Not great, but... sanitize the output a bit.
+    metric.gsub!(/\//, '_')
+    metric.gsub!(/\./, '_')
+
+    # Replace pan's default "|" delim with "." so Graphite groups properly.
+    metric.gsub!(/\|/, '.')
+
+    stat = "#{prefix}.#{metric} #{metrics[k]} #{t}"
+    socket.write("#{stat}\n")
+  }
+}

metadata

@@ -1,99 +1,82 @@
 --- !ruby/object:Gem::Specification
 name: panoptimon
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
+  prerelease: 
 platform: ruby
 authors:
 - Eric Wilhelm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-30 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11208660 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
+  version_requirements: *11208660
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11208180 !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *11208180
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11207580 !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *11207580
 - !ruby/object:Gem::Dependency
   name: thin
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11206900 !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.5.0
+  version_requirements: *11206900
 - !ruby/object:Gem::Dependency
   name: riemann-client
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11206020 !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *11206020
 - !ruby/object:Gem::Dependency
   name: sys-filesystem
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &11205560 !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *11205560
 description: The All-Seeing System Monitor Daemon
 email: sysops@sourcefire.com
 executables:
@@ -217,6 +200,9 @@ files:
 - plugins/email/README.md
 - plugins/email/email.json
 - plugins/email/email.rb
+- plugins/graphite/README.md
+- plugins/graphite/graphite.json
+- plugins/graphite/graphite.rb
 - plugins/log_to_file/log_to_file.json
 - plugins/log_to_file/log_to_file.rb
 - plugins/log_to_logger/log_to_logger.json
@@ -276,26 +262,27 @@ files:
 homepage: https://github.com/synthesist/panoptimon
 licenses:
 - bsd
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - '>='
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 1.8.11
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Panoptimon collects and routes system metrics.
 test_files:
 - spec/collector/config_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 52529feb511cde3ec602078341a19d2d09060562
-  data.tar.gz: a672846b2ddea694e1f1b23fc9aa632629dfc131
-SHA512:
-  metadata.gz: 3cb1390a85c8037597ff699d5c1df7b38ff750b0356ad7c1a097f2ef86395dd1ba21470d83e63b139bcbcd202fb3fb87dedb6ed36019632fe101ab58b5b3ff1d
-  data.tar.gz: fee7c6f5b141321e96f58cf96087e69dc65d084a899a330c93afe82292b409556b788b034fefd51b4f40f772379f2100d2f16ccf36c7afbd2d1271044e30a879