panoptimon 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ec4c546129725a6c662ae42fab05ac37d2ef7d5
-  data.tar.gz: 3c52bd2b259bf5d5b43b168d6c0b078b29169681
+  metadata.gz: fb30066421e308022d06fc05ff455ce9a399bf8d
+  data.tar.gz: e1cf21306197c7b0e1eed6493b58b93e1b5ddcf9
 SHA512:
-  metadata.gz: 0baa25a867349f8702542e9232e7e7478074cb918c901033a5de65ae0b310e2cfeee7e164f4666faa6ae1b4a9abca1735d5a17f7fa27e7b4e4b4294655002652
-  data.tar.gz: 332e77a896f7291841125ff938d4f80004f91c164e704027cc327c3ae9113e6534d5a3da809d77f630c7a31c41b628a0d3d172aaedc86951ed5704fe61374ed9
+  metadata.gz: 139b276a174075928ecd7a495e7ffac36dd554dabf9b1198ca00fb3d5a7c7acd20aca3f03d57b316360e29f5117b7efcb2aa34ae81659b9e825425f10a4c35fc
+  data.tar.gz: 583b0a56837a75a046f2950c6187498d4411e6de376e5dc9004fca93b57387179c7cd90a69d8fcf51285456ffd40526592ff83e8f5141066f0b1dba64fa4732c

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# 0.1.0
+
+Added functionality to search for executables in the PATH environment variable directories.
+If there a collector named 'thing.json', if it cannot find the 'thing' executable locally
+it will search PATH for 'pancollect-thing'.

data/lib/panoptimon/monitor.rb

@@ -20,14 +20,20 @@ class Monitor
     @bus = EM.spawn { |metric| me.bus_driver(metric) }
   end
 
+  # Search directories for JSON files
   def _dirjson (x)
     x = Pathname.new(x)
     x.entries.find_all {|f| f.to_s =~ /\.json$/i}.
       map {|f| x + f}
   end
 
-  def find_collectors; _dirjson(config.collectors_dir); end
-  def find_plugins;    _dirjson(config.plugins_dir);    end
+  def find_collectors
+    _dirjson(config.collectors_dir)
+  end
+
+  def find_plugins
+    _dirjson(config.plugins_dir)
+  end
 
   def load_collectors
     find_collectors.each {|f|
@@ -42,25 +48,48 @@ class Monitor
 
   def _load_collector_config (file)
     conf = JSON.parse(file.read, {:symbolize_names => true})
-    base = file.basename.sub(/\.json$/, '').to_s
-    command = conf[:exec] ||= base
-    command = file.dirname + base + command unless command =~ /^\//
+
+    # Determine the command path
+    collector_name = file.basename.sub(/\.json$/, '').to_s
+    command = Pathname.new(conf[:exec] || collector_name)
+    command = file.dirname + collector_name + command \
+      unless command.absolute?
+
+    command = _autodetect_collector_command_path(collector_name) \
+      unless command.exist? || !conf[:exec].nil?
+
+    # TODO - interval/timeout defaults should be configurable
     return conf.
       merge({
-        name: base,
+        name: collector_name,
         interval: (self.config.collector_interval || 99).to_i,
         timeout:  (self.config.collector_timeout || 99).to_i
       }) {|k,a,b| a}.
       merge({command: command})
   end
 
+  # Searches for 'pancollect-' executables in $PATH
+  # Returns nil if no command found
+  def _autodetect_collector_command_path(name)
+    pathdirs = ENV["PATH"].split(":")
+    name = 'pancollect-' + name
+    pathdirs.each{|basepath|
+      path = File.join(basepath, name)
+      logger.debug "checking path #{path}"
+      return path if File.exists?(path)
+    }
+    return nil
+  end
+
   def _init_collector (conf)
     name    = conf.delete(:name)
     command = conf.delete(:command)
+    full_cmd = [command.to_s] + conf[:args].to_a
+    logger.debug "#{name} command: #{full_cmd}"
     collector = Collector.new(
       name: name,
       bus: @bus,
-      command: [command.to_s] + conf[:args].to_a,
+      command: full_cmd,
       config: conf,
     )
     collectors << collector

data/lib/panoptimon/version.rb

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

data/spec/collector/load_path.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'rspec'
+require 'panoptimon'
+
+describe "PATH search" do
+  before(:each) do
+    @test_bin_dir = "/tmp/panoptimon/test_bin/"
+    FileUtils.mkdir_p @test_bin_dir
+    fakepath = @test_bin_dir + ":/should/not/exist/"
+    ENV["PATH"] = fakepath
+
+    @test_conf_dir = Pathname.new "/tmp/panoptimon/test_conf/"
+    FileUtils.mkdir_p @test_conf_dir
+
+    @test_collector_name = "thing"
+    @test_conf_path = @test_conf_dir + "#{@test_collector_name}.json"
+    f = File.new(@test_conf_path, "w")
+    f.write('{"hey": "yo"}')
+    f.close
+
+    @monitor = Panoptimon::Monitor.new(
+      config: Panoptimon.load_options(['-c', '',
+        '-o', 'collector_interval=9',
+        '-o', 'collector_timeout=12',
+        ])
+      )
+  end
+
+  it "should return nil if no file is found" do
+    expect(@monitor._autodetect_collector_command_path("bad_collector")).to be_nil
+
+    @monitor._load_collector_config(@test_conf_path).should include(:command => nil)
+  end
+
+  it "should return a path if the command is found" do
+    path = File.join(@test_bin_dir, "pancollect-thing")
+    f = File.new(path, "w")
+    f.close
+    expect(@monitor._autodetect_collector_command_path("thing")).to eq(path)
+
+    @monitor._load_collector_config(@test_conf_path).should include(:command => path)
+  end
+
+  it "should not search PATH if exec is stipulated" do
+    path = File.join(@test_bin_dir, "pancollect-thing")
+    f = File.new(path, "w")
+    f.close
+
+    # Non-absolute exec path
+    f = File.new(@test_conf_path, 'w')
+    f.write('{"exec": "something_else"}')
+    f.close
+    non_abs_exec_path = @test_conf_dir.join(@test_collector_name, "something_else")
+
+    @monitor._load_collector_config(@test_conf_path).should include(:command => non_abs_exec_path)
+
+    # Absolute exec path
+    f = File.new(@test_conf_path, 'w')
+    exec_cmd = Pathname.new('/usr/bin/true')
+    f.write("{\"exec\": \"#{exec_cmd}\"}")
+    f.close
+
+    @monitor._load_collector_config(@test_conf_path).should include(:command => exec_cmd)
+  end
+
+  after(:each) do
+    FileUtils.rm_rf @test_bin_dir
+    FileUtils.rm_rf @test_conf_path
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: panoptimon
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Eric Wilhelm
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-10 00:00:00.000000000 Z
+date: 2013-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -116,6 +116,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -282,6 +283,7 @@ files:
 - sample_configs/timeout_not/plugins/.exists
 - spec/collector/config_spec.rb
 - spec/collector/initialize_spec.rb
+- spec/collector/load_path.rb
 - spec/collector/metric_spec.rb
 - spec/passthru_spec.rb
 - spec/util_spec.rb
@@ -314,6 +316,7 @@ summary: Panoptimon collects and routes system metrics.
 test_files:
 - spec/collector/config_spec.rb
 - spec/collector/initialize_spec.rb
+- spec/collector/load_path.rb
 - spec/collector/metric_spec.rb
 - spec/passthru_spec.rb
 - spec/util_spec.rb