newrelic_plugin 1.2.1 → 1.3.0

data/CHANGELOG.md

@@ -4,6 +4,12 @@
 
 **Features**
 
+### v1.3.0 - October 3, 2013 ###
+
+**Changes**
+
+* Stop sending components that did not collect any data for the poll cycle.
+* Output stacktrace for errors that occur in the agents poll cycle code.
 
 ### v1.2.1 - September 10, 2013 ###
 

data/lib/newrelic_platform_binding.rb

@@ -1,4 +1,4 @@
-require 'newrelic_platform_binding/logger'
+require 'newrelic_platform_binding/platform_logger'
 require 'newrelic_platform_binding/config'
 require 'newrelic_platform_binding/request'
 require 'newrelic_platform_binding/context'

data/lib/newrelic_platform_binding/config.rb

@@ -4,7 +4,7 @@ module NewRelic
       def self.endpoint=(url)
         @endpoint = url
         if self.use_ssl? and !self.ssl_supported?
-          Logger.warn('Using SSL is not recommended when using Ruby versions below 1.9')
+          PlatformLogger.warn('Using SSL is not recommended when using Ruby versions below 1.9')
         end
       end
 
@@ -24,7 +24,7 @@ module NewRelic
         @endpoint = 'https://platform-api.newrelic.com'
       else
         @endpoint = 'http://platform-api.newrelic.com'
-        Logger.warn('SSL is disabled by default when using Ruby 1.8.x')
+        PlatformLogger.warn('SSL is disabled by default when using Ruby 1.8.x')
       end
       @uri = '/platform/v1/metrics'
       @ssl_host_verification = true

data/lib/newrelic_platform_binding/connection.rb

@@ -15,7 +15,7 @@ module NewRelic
 
       def send_request(data)
         begin
-          Logger.debug("JSON payload: #{data}")
+          PlatformLogger.debug("JSON payload: #{data}")
           uri = URI.parse(url)
           if Config.proxy.nil?
             http = Net::HTTP.new(uri.host, uri.port)
@@ -36,10 +36,10 @@ module NewRelic
           response = http.request(request)
           return evaluate_response(response)
         rescue Timeout::Error => err
-          Logger.warn "Connection Timeout Error: #{err.inspect} #{err.message}"
+          PlatformLogger.warn "Connection Timeout Error: #{err.inspect} #{err.message}"
           return false
         rescue => err
-          Logger.warn "HTTP Connection Error: #{err.inspect} #{err.message}"
+          PlatformLogger.warn "HTTP Connection Error: #{err.inspect} #{err.message}"
           return false
         end
       end
@@ -57,7 +57,7 @@ module NewRelic
               return_status = "FAILED[#{response.code}] <#{url}>: #{last_result["error"]}"
             end
           elsif response && response.code == '403' && response.body == "DISABLE_NEW_RELIC"
-            Logger.fatal "Agent has been disabled remotely by New Relic"
+            PlatformLogger.fatal "Agent has been disabled remotely by New Relic"
             abort "Agent has been disabled remotely by New Relic"
           else
             if response.body.size > 0
@@ -72,9 +72,9 @@ module NewRelic
         end
         if return_status
           if response and response.code == '503'
-            Logger.warn("Collector temporarily unavailable. Continuing.")
+            PlatformLogger.warn("Collector temporarily unavailable. Continuing.")
           else
-            Logger.error("#{return_status}")
+            PlatformLogger.error("#{return_status}")
           end
         end
 

data/lib/newrelic_platform_binding/context.rb

@@ -21,6 +21,16 @@ module NewRelic
         return component
       end
 
+      def get_component(name, guid)
+        component = find_component(name, guid)
+        component = create_component(name, guid) if component.nil?
+        component
+      end
+
+      def find_component(name, guid)
+        @components.find { |c| c.key == name + guid }
+      end
+
       def get_request()
         if past_aggregation_limit?
           @components.each do |component|

data/lib/newrelic_platform_binding/metric.rb

@@ -15,7 +15,7 @@ module NewRelic
           @max = options[:max].to_f
           @sum_of_squares = options[:sum_of_squares].to_f
         else
-          Logger.warn("Metric #{@name} count, min, max, and sum_of_squares are all required if one is set, falling back to value only") unless options.size == 0
+          PlatformLogger.warn("Metric #{@name} count, min, max, and sum_of_squares are all required if one is set, falling back to value only") unless options.size == 0
           @count = 1
           @min = value
           @max = value

data/lib/newrelic_platform_binding/{logger.rb → platform_logger.rb}

@@ -2,7 +2,7 @@ module NewRelic
   require 'time'
   require 'logger'
 
-  class Logger
+  class PlatformLogger
     @log = ::Logger.new(STDOUT)
     @log.level = ::Logger::WARN
     @log.formatter = proc { |severity, datetime, progname, msg| "[#{Time.iso8601(Time.now.utc.iso8601).to_s}] #{severity}: #{msg}\n" }

data/lib/newrelic_platform_binding/request.rb

@@ -26,7 +26,7 @@ module NewRelic
               component.last_delivered_at = delivered_at
             end
           end
-          Logger.warn("Duration of more than 10 minutes between sending data to New Relic, this will cause plugins to show up as not reporting") if duration_warning
+          PlatformLogger.warn("Duration of more than 10 minutes between sending data to New Relic, this will cause plugins to show up as not reporting") if duration_warning
         end
       end
 
@@ -82,25 +82,33 @@ module NewRelic
       def build_components_array
         components_array = []
         @context.components.each do |component|
-          component_hash = {
-            'name' => component.name,
-            'guid' => component.guid,
-            'duration' => component.duration,
-            'metrics' => build_metrics_hash(component)
-          }
-          components_array.push(component_hash)
+          if component_has_metrics?(component)
+            component_hash = {
+              'name' => component.name,
+              'guid' => component.guid,
+              'duration' => component.duration,
+              'metrics' => build_metrics_hash(component)
+            }
+            components_array.push(component_hash)
+          else
+            PlatformLogger.debug("Component with name \"#{component.name}\" and guid \"#{component.guid}\" had no metrics")
+          end
         end
         return components_array
       end
 
+      def component_has_metrics?(component)
+        @metrics.has_key?(component.key) && @metrics[component.key].size > 0
+      end
+
       def build_metrics_hash(component)
         metrics_hash = {}
-        if @metrics.has_key?(component.key)
+        if component_has_metrics?(component)
           @metrics[component.key].each do |metric|
             metrics_hash.merge!(metric.to_hash)
           end
         else
-          Logger.warn("Component with name \"#{component.name}\" and guid \"#{component.guid}\" had no metrics")
+          PlatformLogger.warn("Component with name \"#{component.name}\" and guid \"#{component.guid}\" had no metrics")
         end
         metrics_hash
       end

data/lib/newrelic_plugin/processors/rate_processor.rb

@@ -15,8 +15,8 @@ module NewRelic::Processor
   #
   class Rate < NewRelic::Plugin::Processor::Base
     def initialize
-      Logger.warn("OBSOLESCENCE WARNING: The 'Rate' processor is obsolete and should not be used.")
-      Logger.warn("OBSOLESCENCE WARNING: It will be completely removed in the near future.")
+      PlatformLogger.warn("OBSOLESCENCE WARNING: The 'Rate' processor is obsolete and should not be used.")
+      PlatformLogger.warn("OBSOLESCENCE WARNING: It will be completely removed in the near future.")
       super :rate,"Rate"
     end
     def process val

data/lib/newrelic_plugin/run.rb

@@ -25,40 +25,40 @@ module NewRelic
 
       def configuration_and_logging
         if @config.newrelic["verbose"].to_i > 0
-          NewRelic::Logger.log_level = ::Logger::DEBUG
+          NewRelic::PlatformLogger.log_level = ::Logger::DEBUG
         end
-        Logger.info("Using Ruby SDK version: #{NewRelic::Plugin::VERSION}")
+        PlatformLogger.info("Using Ruby SDK version: #{NewRelic::Plugin::VERSION}")
 
         if @config.newrelic['endpoint']
           NewRelic::Binding::Config.endpoint = @config.newrelic['endpoint']
-          Logger.info("Using alternate endpoint: #{NewRelic::Binding::Config.endpoint}")
+          PlatformLogger.info("Using alternate endpoint: #{NewRelic::Binding::Config.endpoint}")
         end
 
         unless @config.newrelic['ssl_host_verification'].nil?
           NewRelic::Binding::Config.ssl_host_verification = !!@config.newrelic['ssl_host_verification']
-          Logger.info("Disabling ssl host verification") unless NewRelic::Binding::Config.ssl_host_verification
+          PlatformLogger.info("Disabling ssl host verification") unless NewRelic::Binding::Config.ssl_host_verification
         end
 
         if @config.newrelic['proxy']
           NewRelic::Binding::Config.proxy = @config.newrelic['proxy']
-          Logger.info("Using a proxy: #{NewRelic::Binding::Config.proxy.inspect}")
+          PlatformLogger.info("Using a proxy: #{NewRelic::Binding::Config.proxy.inspect}")
         end
 
         @poll_cycle_period = (@config.newrelic["poll"] || 60).to_i
         NewRelic::Binding::Config.poll_cycle_period = @poll_cycle_period
         if @poll_cycle_period <= 0
           message = "A poll cycle period less than or equal to 0 is invalid"
-          Logger.fatal(message)
+          PlatformLogger.fatal(message)
           abort message
         end
         if @poll_cycle_period != 60
-          Logger.warn("WARNING: Poll cycle period differs from 60 seconds (current is #{@poll_cycle_period})")
+          PlatformLogger.warn("WARNING: Poll cycle period differs from 60 seconds (current is #{@poll_cycle_period})")
         end
       end
 
       def installed_agents
         if Setup.installed_agents.size == 0
-          Logger.error("No agents installed!")
+          PlatformLogger.error("No agents installed!")
           raise NoAgents, "No agents installed"
         end
         Setup.installed_agents
@@ -100,12 +100,12 @@ module NewRelic
         if configured_agents.size == 0
           err_msg = "No agents configured!"
           err_msg += " Check the agents portion of your yml file." unless NewRelic::Plugin::Config.config.options.empty?
-          Logger.error(err_msg)
+          PlatformLogger.error(err_msg)
           raise NoAgents, err_msg
         end
         installed_agents.each do |agent_id,installed_agent|
           version = installed_agent[:agent_class].version
-          Logger.info("Agent #{installed_agent[:label]} is at version #{version}") if version
+          PlatformLogger.info("Agent #{installed_agent[:label]} is at version #{version}") if version
         end
         configured_agents.each do |agent|
           agent.startup if agent.respond_to? :startup
@@ -126,33 +126,34 @@ module NewRelic
             request = @context.get_request()
             run_agent_data_collection(request)
             request.deliver
-            Logger.info("Gathered #{request.metric_count} statistics from #{request.component_count} components")
+            PlatformLogger.info("Gathered #{request.metric_count} statistics from #{request.component_count} components")
 
             seconds_to_delay = @poll_cycle_period - (Time.now - @last_run_time)
             sleep(seconds_to_delay) if seconds_to_delay > 0
           end
         rescue Interrupt => err
-          Logger.info "Shutting down..."
+          PlatformLogger.info "Shutting down..."
         end
       end
 
       def run_agent_data_collection(request)
-        Logger.debug('Start collecting agent data for poll cycle')
+        PlatformLogger.debug('Start collecting agent data for poll cycle')
         configured_agents.each do |agent|
           begin
             agent.run(request)
           rescue => err
-            Logger.error("Error occurred in poll cycle: #{err}")
+            PlatformLogger.error("Error occurred in poll cycle: #{err}")
+            PlatformLogger.debug("Stacktrace:\n#{err.backtrace.join("\n")}")
           end
         end
-        Logger.debug('Finished collecting agent data for poll cycle')
+        PlatformLogger.debug('Finished collecting agent data for poll cycle')
       end
 
       def agent_shutdown
         configured_agents.each do |agent|
           agent.shutdown if agent.respond_to? :shutdown
         end
-        Logger.info("Shutdown complete")
+        PlatformLogger.info("Shutdown complete")
       end
 
       def agent_setup

data/lib/newrelic_plugin/version.rb

@@ -1,5 +1,5 @@
 module NewRelic
   module Plugin
-    VERSION = "1.2.1"
+    VERSION = "1.3.0"
   end
 end

data/test/newrelic_platform_binding/config_test.rb

@@ -47,9 +47,9 @@ class ConfigTest < Minitest::Test
   def test_set_ssl_endpoint
     new_endpoint = 'https://example.com'
     if NewRelic::Binding::Config.ssl_supported?
-      NewRelic::Logger.expects(:warn).with('Using SSL is not recommended when using Ruby versions below 1.9').never
+      NewRelic::PlatformLogger.expects(:warn).with('Using SSL is not recommended when using Ruby versions below 1.9').never
     else
-      NewRelic::Logger.expects(:warn).with('Using SSL is not recommended when using Ruby versions below 1.9')
+      NewRelic::PlatformLogger.expects(:warn).with('Using SSL is not recommended when using Ruby versions below 1.9')
     end
     NewRelic::Binding::Config.endpoint = new_endpoint
     assert_equal new_endpoint, NewRelic::Binding::Config.endpoint

data/test/newrelic_platform_binding/connection_test.rb

@@ -21,46 +21,46 @@ class ConnectionTest < Minitest::Test
 
   def test_deliver_error_codes
     FakeWeb.register_uri(:post, "#{@endpoint}/platform/v1/metrics", :body => '{"error":"Missing metric data"}', :status => [200, "Success"])
-    NewRelic::Logger.expects(:error).with("FAILED[200] <#{@endpoint}/platform/v1/metrics>: Missing metric data")
+    NewRelic::PlatformLogger.expects(:error).with("FAILED[200] <#{@endpoint}/platform/v1/metrics>: Missing metric data")
     assert_equal false, @connection.send_request('data')
   end
 
   def test_deliver_disabled_by_new_relic
     FakeWeb.register_uri(:post, "#{@endpoint}/platform/v1/metrics", :body => 'DISABLE_NEW_RELIC', :status => [403, 'Unauthorized'])
-    NewRelic::Logger.expects(:fatal).with("Agent has been disabled remotely by New Relic")
+    NewRelic::PlatformLogger.expects(:fatal).with("Agent has been disabled remotely by New Relic")
     NewRelic::Binding::Connection.any_instance.expects(:abort)
     @connection.send_request('data')
   end
 
   def test_deliver_no_response
     Net::HTTP.any_instance.expects(:request).returns(nil)
-    NewRelic::Logger.expects(:error).with("FAILED: No response")
+    NewRelic::PlatformLogger.expects(:error).with("FAILED: No response")
     assert_equal false, @connection.send_request('data')
   end
 
   def test_deliver_no_data_returned
     FakeWeb.register_uri(:post, "#{@endpoint}/platform/v1/metrics", :body => '', :status => [204, "No Content"])
-    NewRelic::Logger.expects(:error).with("FAILED[204] <#{@endpoint}/platform/v1/metrics>: no data returned")
+    NewRelic::PlatformLogger.expects(:error).with("FAILED[204] <#{@endpoint}/platform/v1/metrics>: no data returned")
     assert_equal false, @connection.send_request('data')
   end
 
   def test_deliver_non_json_response_body_unexpected_response_code
     FakeWeb.register_uri(:post, "#{@endpoint}/platform/v1/metrics", :body => 'test', :status => [203, "Non-Authoritative Information"])
     JSON::ParserError.any_instance.stubs(:message => 'parse error')
-    NewRelic::Logger.expects(:error).with("FAILED[203] <#{@endpoint}/platform/v1/metrics>: Could not parse response: parse error")
+    NewRelic::PlatformLogger.expects(:error).with("FAILED[203] <#{@endpoint}/platform/v1/metrics>: Could not parse response: parse error")
     assert_equal false, @connection.send_request('data')
   end
 
   def test_deliver_non_json_response_body_success_response_code
     FakeWeb.register_uri(:post, "#{@endpoint}/platform/v1/metrics", :body => 'test', :status => [200, "Success"])
     JSON::ParserError.any_instance.stubs(:message => 'parse error')
-    NewRelic::Logger.expects(:error).with("FAILED[200] <#{@endpoint}/platform/v1/metrics>: Could not parse response: parse error")
+    NewRelic::PlatformLogger.expects(:error).with("FAILED[200] <#{@endpoint}/platform/v1/metrics>: Could not parse response: parse error")
     assert_equal false, @connection.send_request('data')
   end
 
   def test_deliver_service_unavailable
     FakeWeb.register_uri(:post, "#{@endpoint}/platform/v1/metrics", :body => 'test', :status => [503, "Service Unavailable"])
-    NewRelic::Logger.expects(:warn).with("Collector temporarily unavailable. Continuing.")
+    NewRelic::PlatformLogger.expects(:warn).with("Collector temporarily unavailable. Continuing.")
     assert_equal false, @connection.send_request('data')
   end
 

data/test/newrelic_platform_binding/metric_test.rb

@@ -11,7 +11,7 @@ class MetricTest < Minitest::Test
   end
 
   def test_initialize_without_options_does_not_trigger_options_warning
-    NewRelic::Logger.expects(:warn).never
+    NewRelic::PlatformLogger.expects(:warn).never
     NewRelic::Binding::Metric.new(@component, 'Component/Test/rate[units]', '10')
   end
 
@@ -36,22 +36,22 @@ class MetricTest < Minitest::Test
   end
 
   def test_count_with_only_count_option_set
-    NewRelic::Logger.expects(:warn).with('Metric Component/Test/rate[units] count, min, max, and sum_of_squares are all required if one is set, falling back to value only')
+    NewRelic::PlatformLogger.expects(:warn).with('Metric Component/Test/rate[units] count, min, max, and sum_of_squares are all required if one is set, falling back to value only')
     assert_equal 1, initialize_metric(:count => 2).count
   end
 
   def test_min_with_only_min_option_set
-    NewRelic::Logger.expects(:warn).with('Metric Component/Test/rate[units] count, min, max, and sum_of_squares are all required if one is set, falling back to value only')
+    NewRelic::PlatformLogger.expects(:warn).with('Metric Component/Test/rate[units] count, min, max, and sum_of_squares are all required if one is set, falling back to value only')
     assert_equal 10, initialize_metric(:min => 5).min
   end
 
   def test_max_with_only_max_option_set
-    NewRelic::Logger.expects(:warn).with('Metric Component/Test/rate[units] count, min, max, and sum_of_squares are all required if one is set, falling back to value only')
+    NewRelic::PlatformLogger.expects(:warn).with('Metric Component/Test/rate[units] count, min, max, and sum_of_squares are all required if one is set, falling back to value only')
     assert_equal 10, initialize_metric(:max => 15).max
   end
 
   def test_sum_of_squares_with_only_sum_of_squares_option_set
-    NewRelic::Logger.expects(:warn).with('Metric Component/Test/rate[units] count, min, max, and sum_of_squares are all required if one is set, falling back to value only')
+    NewRelic::PlatformLogger.expects(:warn).with('Metric Component/Test/rate[units] count, min, max, and sum_of_squares are all required if one is set, falling back to value only')
     assert_equal 100, initialize_metric(:sum_of_squares => 400).sum_of_squares
   end
 

data/test/newrelic_platform_binding/{logger_test.rb → platform_logger_test.rb}

@@ -1,33 +1,33 @@
 require 'test_helper'
 
-class LoggerTest < Minitest::Test
+class PlatformLoggerTest < Minitest::Test
 
   def setup
-    @log = NewRelic::Logger.instance_variable_get(:@log)
+    @log = NewRelic::PlatformLogger.instance_variable_get(:@log)
   end
 
   def test_debug_calls_log_debug
     @log.expects(:debug).with('test')
-    NewRelic::Logger.debug('test')
+    NewRelic::PlatformLogger.debug('test')
   end
 
   def test_info_calls_log_info
     @log.expects(:info).with('test')
-    NewRelic::Logger.info('test')
+    NewRelic::PlatformLogger.info('test')
   end
 
   def test_warn_calls_log_warn
     @log.expects(:warn).with('test')
-    NewRelic::Logger.warn('test')
+    NewRelic::PlatformLogger.warn('test')
   end
 
   def test_error_calls_log_error
     @log.expects(:error).with('test')
-    NewRelic::Logger.error('test')
+    NewRelic::PlatformLogger.error('test')
   end
 
   def test_fatal_calls_log_fatal
     @log.expects(:fatal).with('test')
-    NewRelic::Logger.fatal('test')
+    NewRelic::PlatformLogger.fatal('test')
   end
 end

data/test/newrelic_platform_binding/request_test.rb

@@ -71,9 +71,17 @@ class RequestTest < Minitest::Test
     assert_equal example_hash, @request.send(:build_request_data_structure)
   end
 
+  def test_build_request_data_structure_does_not_include_components_without_metrics
+    metric_setup
+    second_component = @context.create_component('name2', 'com.test')
+    @request.add_metric(@component, 'Component/test/first[units]', 1)
+    @request.add_metric(@component, 'Component/test/second[units]', 2)
+    assert_equal example_hash, @request.send(:build_request_data_structure)
+  end
+
   def test_build_request_data_structure_when_component_has_no_metrics
     metric_setup
-    ::NewRelic::Logger.expects(:warn).with("Component with name \"name\" and guid \"com.test\" had no metrics")
+    ::NewRelic::PlatformLogger.expects(:debug).with("Component with name \"name\" and guid \"com.test\" had no metrics")
     @request.send(:build_request_data_structure)
   end
 

data/test/newrelic_plugin/run_test.rb

@@ -8,18 +8,18 @@ class RunTest < Minitest::Test
   end
 
   def test_log_level_set_verbose
-    NewRelic::Logger.expects(:log_level=).with(::Logger::DEBUG)
+    NewRelic::PlatformLogger.expects(:log_level=).with(::Logger::DEBUG)
     @newrelic['verbose'] = 1
     initialize_run
   end
 
   def test_log_level_not_set
-    NewRelic::Logger.expects(:log_level=).never
+    NewRelic::PlatformLogger.expects(:log_level=).never
     initialize_run
   end
 
   def test_log_level_set_to_not_verbose
-    NewRelic::Logger.expects(:log_level=).never
+    NewRelic::PlatformLogger.expects(:log_level=).never
     @newrelic['verbose'] = 0
     initialize_run
   end

data/test/test_helper.rb

@@ -10,7 +10,7 @@ require 'timecop'
 
 
 module TestingAgent
-  NewRelic::Logger.log_level = ::Logger::FATAL
+  NewRelic::PlatformLogger.log_level = ::Logger::FATAL
   class Agent < NewRelic::Plugin::Agent::Base
     agent_guid 'com.newrelic.test'
     agent_version '0.0.1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_plugin
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-10 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -128,8 +128,8 @@ files:
 - lib/newrelic_platform_binding/config.rb
 - lib/newrelic_platform_binding/connection.rb
 - lib/newrelic_platform_binding/context.rb
-- lib/newrelic_platform_binding/logger.rb
 - lib/newrelic_platform_binding/metric.rb
+- lib/newrelic_platform_binding/platform_logger.rb
 - lib/newrelic_platform_binding/request.rb
 - lib/newrelic_plugin.rb
 - lib/newrelic_plugin/agent.rb
@@ -148,8 +148,8 @@ files:
 - test/newrelic_platform_binding/config_test.rb
 - test/newrelic_platform_binding/connection_test.rb
 - test/newrelic_platform_binding/context_test.rb
-- test/newrelic_platform_binding/logger_test.rb
 - test/newrelic_platform_binding/metric_test.rb
+- test/newrelic_platform_binding/platform_logger_test.rb
 - test/newrelic_platform_binding/request_test.rb
 - test/newrelic_plugin/agent_test.rb
 - test/newrelic_plugin/run_test.rb