newrelic_f5_plugin 1.0.4 → 1.0.6

data/lib/newrelic_f5_plugin/util.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+
+require 'newrelic_plugin'
+require 'snmp'
+
+
+
+#
+# Walk the SNMP OIDs
+#
+def gather_snmp_metrics_by_name(metric_prefix, metric_names, oids, snmp)
+  metrics = { }
+  index   = 0
+
+  if metric_prefix.nil? or metric_prefix.empty?
+    NewRelic::PlatformLogger.debug("Invalid metric_prefix passed to gather_snmp_metrics_by_name")
+    return metrics
+  end
+
+  if metric_names.nil? or metric_names.empty? or not metric_names.kind_of?(Array)
+    NewRelic::PlatformLogger.debug("Invalid metric_names passed to gather_snmp_metrics_by_name")
+    return metrics
+  end
+
+  if oids.nil? or oids.empty?
+    NewRelic::PlatformLogger.debug("Invalid oids passed to gather_snmp_metrics_by_name")
+    return metrics
+  end
+
+  # Convert to Array if not passed as one
+  oids = [oids] if not oids.kind_of?(Array)
+
+  metric_prefix = "#{metric_prefix}/" unless metric_prefix.end_with?("/")
+
+  if snmp
+    begin
+      snmp.walk(oids) do |row|
+        row.each do |vb|
+          metrics["#{metric_prefix}#{metric_names[index]}"] = vb.value.to_i
+          index += 1
+        end
+      end
+    rescue Exception => e
+      NewRelic::PlatformLogger.error("Unable to gather SNMP metrics with error: #{e}")
+    end
+  end
+
+  return metrics
+end
+
+
+#
+# Return all of the OID values in an array
+#
+def gather_snmp_metrics_array(oids, snmp)
+  metrics = [ ]
+
+  if oids.nil? or oids.empty?
+    NewRelic::PlatformLogger.debug("Invalid oids passed to gather_snmp_metrics_array")
+    return metrics
+  end
+
+  # Convert to Array if not passed as one
+  oids = [oids] if not oids.kind_of?(Array)
+
+  if snmp
+    begin
+      metrics = snmp.get_value(oids)
+    rescue Exception => e
+      NewRelic::PlatformLogger.error("Unable to gather SNMP metrics with error: #{e}")
+      return
+    end
+  end
+
+  return metrics
+end
+

data/lib/newrelic_f5_plugin/virtuals.rb

@@ -1,7 +1,6 @@
 #!/usr/bin/env ruby
 
 require 'newrelic_plugin'
-require 'snmp'
 
 #LtmVirtualServStatEntry
 #  ltmVirtualServStatName                                 LongDisplayString,
@@ -83,12 +82,17 @@ module NewRelic
         if snmp
           @vs_names.clear
 
-          snmp.walk([OID_LTM_VIRTUAL_SERV_STAT_NAME]) do |row|
-            row.each do |vb|
-              @vs_names.push(vb.value)
+          begin
+            snmp.walk([OID_LTM_VIRTUAL_SERV_STAT_NAME]) do |row|
+              row.each do |vb|
+                @vs_names.push(vb.value)
+              end
             end
+          rescue Exception => e
+            NewRelic::PlatformLogger.error("Unable to gather Virtual Server names with error: #{e}")
           end
 
+          NewRelic::PlatformLogger.debug("Virtual Servers: Found #{@vs_names.size} virtual servers")
           return @vs_names
         end
       end
@@ -99,22 +103,12 @@ module NewRelic
       # Gather VS Total Requests
       #
       def get_requests(snmp = nil)
-        metrics = { }
-        index   = 0
-        snmp    = snmp_manager unless snmp
-
-        if snmp
-          get_names(snmp) if @vs_names.empty?
-
-          snmp.walk([OID_LTM_VIRTUAL_SERV_STAT_TOT_REQUESTS]) do |row|
-            row.each do |vb|
-              metrics["Virtual Servers/Requests/#{@vs_names[index]}"] = vb.value.to_i
-              index += 1
-            end
-          end
+        snmp = snmp_manager unless snmp
 
-          return metrics
-        end
+        get_names(snmp) if @vs_names.empty?
+        res = gather_snmp_metrics_by_name("Virtual Servers/Requests", @vs_names, OID_LTM_VIRTUAL_SERV_STAT_TOT_REQUESTS, snmp)
+        NewRelic::PlatformLogger.debug("Virtual Servers: Got #{res.size}/#{@vs_names.size} Request metrics")
+        return res
       end
 
 
@@ -123,22 +117,12 @@ module NewRelic
       # Gather VS Connection count
       #
       def get_conns_current(snmp = nil)
-        metrics = { }
-        index   = 0
-        snmp    = snmp_manager unless snmp
-
-        if snmp
-          get_names(snmp) if @vs_names.empty?
-
-          snmp.walk([OID_LTM_VIRTUAL_SERV_STAT_CLIENT_CUR_CONNS]) do |row|
-            row.each do |vb|
-              metrics["Virtual Servers/Current Connections/#{@vs_names[index]}"] = vb.value.to_i
-              index += 1
-            end
-          end
+        snmp = snmp_manager unless snmp
 
-          return metrics
-        end
+        get_names(snmp) if @vs_names.empty?
+        res = gather_snmp_metrics_by_name("Virtual Servers/Current Connections", @vs_names, OID_LTM_VIRTUAL_SERV_STAT_CLIENT_CUR_CONNS, snmp)
+        NewRelic::PlatformLogger.debug("Virtual Servers: Got #{res.size}/#{@vs_names.size} Current Connection metrics")
+        return res
       end
 
 
@@ -147,22 +131,12 @@ module NewRelic
       # Gather VS Connection rate
       #
       def get_conns_total(snmp = nil)
-        metrics = { }
-        index   = 0
-        snmp    = snmp_manager unless snmp
-
-        if snmp
-          get_names(snmp) if @vs_names.empty?
-
-          snmp.walk([OID_LTM_VIRTUAL_SERV_STAT_CLIENT_TOT_CONNS]) do |row|
-            row.each do |vb|
-              metrics["Virtual Servers/Connection Rate/#{@vs_names[index]}"] = vb.value.to_i
-              index += 1
-            end
-          end
+        snmp = snmp_manager unless snmp
 
-          return metrics
-        end
+        get_names(snmp) if @vs_names.empty?
+        res = gather_snmp_metrics_by_name("Virtual Servers/Connection Rate", @vs_names, OID_LTM_VIRTUAL_SERV_STAT_CLIENT_TOT_CONNS, snmp)
+        NewRelic::PlatformLogger.debug("Virtual Servers: Got #{res.size}/#{@vs_names.size} Connection Rate metrics")
+        return res
       end
 
 
@@ -171,46 +145,28 @@ module NewRelic
       # Gather VS Throughput Inbound (returns in bits)
       #
       def get_throughput_in(snmp = nil)
-        metrics = { }
-        index   = 0
-        snmp    = snmp_manager unless snmp
-
-        if snmp
-          get_names(snmp) if @vs_names.empty?
-
-          snmp.walk([OID_LTM_VIRTUAL_SERV_STAT_CLIENT_BYTES_IN]) do |row|
-            row.each do |vb|
-              metrics["Virtual Servers/Throughput/In/#{@vs_names[index]}"] = (vb.value.to_f * 8)
-              index += 1
-            end
-          end
+        snmp = snmp_manager unless snmp
 
-          return metrics
-        end
+        get_names(snmp) if @vs_names.empty?
+        res = gather_snmp_metrics_by_name("Virtual Servers/Throughput/In", @vs_names, OID_LTM_VIRTUAL_SERV_STAT_CLIENT_BYTES_IN, snmp)
+        res = res.each_key { |n| res[n] *= 8 }
+        NewRelic::PlatformLogger.debug("Virtual Servers: Got #{res.size}/#{@vs_names.size} Inbound Throughput metrics")
+        return res
       end
 
 
 
       #
-      # Gather VS Throughput Inbound (returns in bits)
+      # Gather VS Throughput Outbound (returns in bits)
       #
       def get_throughput_out(snmp = nil)
-        metrics = { }
-        index   = 0
-        snmp    = snmp_manager unless snmp
-
-        if snmp
-          get_names(snmp) if @vs_names.empty?
-
-          snmp.walk([OID_LTM_VIRTUAL_SERV_STAT_CLIENT_BYTES_OUT]) do |row|
-            row.each do |vb|
-              metrics["Virtual Servers/Throughput/Out/#{@vs_names[index]}"] = (vb.value.to_f * 8)
-              index += 1
-            end
-          end
+        snmp = snmp_manager unless snmp
 
-          return metrics
-        end
+        get_names(snmp) if @vs_names.empty?
+        res = gather_snmp_metrics_by_name("Virtual Servers/Throughput/Out", @vs_names, OID_LTM_VIRTUAL_SERV_STAT_CLIENT_BYTES_OUT, snmp)
+        res = res.each_key { |n| res[n] *= 8 }
+        NewRelic::PlatformLogger.debug("Virtual Servers: Got #{res.size}/#{@vs_names.size} Outbound Throughput metrics")
+        return res
       end
 
 
@@ -219,26 +175,14 @@ module NewRelic
       # Gather VS Connection rate
       #
       def get_cpu_usage_1m(snmp = nil)
-        metrics = { }
-        index   = 0
-        snmp    = snmp_manager unless snmp
-
-        if snmp
-          get_names(snmp) if @vs_names.empty?
-
-          snmp.walk([OID_LTM_VIRTUAL_SERV_STAT_VS_USAGE_RATIO_1M]) do |row|
-            row.each do |vb|
-              metrics["Virtual Servers/CPU Usage/1m/#{@vs_names[index]}"] = vb.value.to_i
-              index += 1
-            end
-          end
+        snmp = snmp_manager unless snmp
 
-          return metrics
-        end
+        get_names(snmp) if @vs_names.empty?
+        res = gather_snmp_metrics_by_name("Virtual Servers/CPU Usage/1m", @vs_names, OID_LTM_VIRTUAL_SERV_STAT_VS_USAGE_RATIO_1M, snmp)
+        NewRelic::PlatformLogger.debug("Virtual Servers: Got #{res.size}/#{@vs_names.size} CPU metrics")
+        return res
       end
 
-
-
     end
   end
 end

data/lib/newrelic_f5_plugin.rb

@@ -1,4 +1,6 @@
 require 'rubygems'
+require 'newrelic_f5_plugin/util'
+require 'newrelic_f5_plugin/device'
 require 'newrelic_f5_plugin/nodes'
 require 'newrelic_f5_plugin/pools'
 require 'newrelic_f5_plugin/virtuals'

data/newrelic_f5_plugin.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'newrelic_f5_plugin'
-  s.version           = '1.0.4'
-  s.date              = '2013-09-16'
+  s.version           = '1.0.6'
+  s.date              = '2013-10-23'
   s.rubyforge_project = 'newrelic_f5_plugin'
 
   ## Make sure your summary is short. The description may be as long
@@ -51,7 +51,7 @@ This is the New Relic plugin for monitoring F5 devices developed by New Relic, I
   ## The newrelic_plugin needs to be installed.  Prior to public release, the
   # gem needs to be downloaded from git@github.com:newrelic-platform/newrelic_plugin.git
   # and built using the "rake build" command
-  s.add_dependency('newrelic_plugin', "= 1.0.2")
+  s.add_dependency('newrelic_plugin', "~> 1.3.0")
   s.add_dependency('snmp', ">= 1.1.0")
 
   s.post_install_message = <<-EOF
@@ -75,11 +75,14 @@ to find out how to install and run the plugin agent.
     config/newrelic_plugin.yml
     lib/newrelic_f5_plugin.rb
     lib/newrelic_f5_plugin/agent.rb
+    lib/newrelic_f5_plugin/device.rb
     lib/newrelic_f5_plugin/nodes.rb
     lib/newrelic_f5_plugin/pools.rb
+    lib/newrelic_f5_plugin/util.rb
     lib/newrelic_f5_plugin/virtuals.rb
     newrelic_f5_plugin.gemspec
     test/f5_monitor_test.rb
+    test/nodes_test.rb
     test/plugin_test.rb
     test/test_helper.rb
   ]

data/test/nodes_test.rb

@@ -0,0 +1,72 @@
+require 'test_helper.rb'
+require 'snmp'
+
+#
+# Custom transport, based on the snmp test suite
+#  https://github.com/hallidave/ruby-snmp/
+#
+class NodeTransport
+  def initialize
+  end
+
+  def close
+  end
+
+  def send(data, host, port)
+    @data = data
+  end
+
+  def recv(max_bytes)
+    SNMP::Message.decode(@data).response.encode[0,max_bytes]
+  end
+end
+
+
+class NodeTest < Test::Unit::TestCase
+
+  include SNMP
+
+  def setup
+    @manager = Manager.new(:Transport => NodeTransport.new)
+    @status  = {
+      :empty => {
+                  "Nodes/Monitor Status/checking"           => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/disabled"           => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/down"               => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/down-manual-resume" => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/forced-down"        => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/forced-up"          => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/inband"             => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/inband-down"        => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/irule-down"         => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/maint"              => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/unchecked"          => {:count=>0, :label=>"nodes"},
+                  "Nodes/Monitor Status/up"                 => {:count=>0, :label=>"nodes"},
+                },
+    }
+  end
+
+  def teardown
+    @manager.close
+  end
+
+
+
+  def test_init
+    @nodes = NewRelic::F5Plugin::Nodes.new @manager
+    assert_equal(@manager, @nodes.snmp_manager)
+  end
+
+  def test_get_status_default
+    @nodes = NewRelic::F5Plugin::Nodes.new @manager
+    @node_status = @nodes.get_status
+    assert_equal(@node_status, @status[:empty])
+  end
+
+  def test_get_status_args
+    @nodes = NewRelic::F5Plugin::Nodes.new @manager
+    @node_status = @nodes.get_status @manager
+    assert_equal(@node_status, @status[:empty])
+  end
+end
+

data/test/plugin_test.rb

@@ -13,17 +13,18 @@ newrelic:
 agents:
   f5:
     -
-      name:           'My F5 LTM'
       hostname:       'my-f5'
       port:           161
       snmp_community: 'public'
-      EOF
+EOF
       NewRelic::Plugin::Setup.install_agent :f5, NewRelic::F5Plugin
     end
 
     should "create a run" do
       # The run loop is stubbed out so this just verifies the agent initializes correctly.
       NewRelic::Plugin::Run.any_instance.expects :setup_from_config
+      NewRelic::Plugin::Run.any_instance.expects :setup_no_config_agents
+      NewRelic::Plugin::Run.any_instance.expects :agent_startup
       NewRelic::Plugin::Run.any_instance.expects :loop_forever
       NewRelic::F5Plugin.run
     end
@@ -40,37 +41,9 @@ agents:
       end
 
       should "have one configured agent" do
-        assert_equal "My F5 LTM", @agent.name
+        assert_equal "my-f5", @agent.hostname
       end
 
-      #context "test db" do
-      #  setup do
-      #    # Setup a test database
-      #    @client = Mysql2::Client.new :host => 'localhost', :username => 'root'
-      #    @client.query "create database nr_mysql_plugin" rescue nil
-      #    @client.query "create table nr_mysql_plugin.example (id int)"
-      #    @client.query "create table nr_mysql_plugin.ignored (id int)"
-      #    @client.query "insert into nr_mysql_plugin.example values (1),(2),(3),(4),(5)"
-      #  end
-      #  teardown do
-      #    @client.query "drop database nr_mysql_plugin" rescue nil
-      #  end
-      #  should "get table stats" do
-      #    schemas = @agent.mysql_table_stats
-      #    assert_equal 1, schemas.size
-      #    tables = schemas['nr_mysql_plugin']
-      #    assert_equal 1, tables.size
-      #    rec = tables.first
-      #    assert_equal "example", rec.name
-      #    assert_equal 5, rec.rows
-      #  end
-      #  should "poll" do
-      #    # This stubs out the remote connection--we're not testing the plugin agent here
-      #    NewRelic::Plugin::DataCollector.any_instance.stubs :process
-      #    @agent.run 60 # seconds
-      #  end
-      #end
-
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_f5_plugin
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,24 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-16 00:00:00.000000000 Z
+date: 2013-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: newrelic_plugin
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: snmp
   requirement: !ruby/object:Gem::Requirement
@@ -66,11 +66,14 @@ files:
 - config/newrelic_plugin.yml
 - lib/newrelic_f5_plugin.rb
 - lib/newrelic_f5_plugin/agent.rb
+- lib/newrelic_f5_plugin/device.rb
 - lib/newrelic_f5_plugin/nodes.rb
 - lib/newrelic_f5_plugin/pools.rb
+- lib/newrelic_f5_plugin/util.rb
 - lib/newrelic_f5_plugin/virtuals.rb
 - newrelic_f5_plugin.gemspec
 - test/f5_monitor_test.rb
+- test/nodes_test.rb
 - test/plugin_test.rb
 - test/test_helper.rb
 homepage: http://newrelic.com