newrelic_plugin 1.0.2 → 1.0.3

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+## New Relic Ruby SDK Change Log ##
+
+### vNext - Future Date ###
+
+**Features**
+
+* To fill in
+### v1.0.3 - June 25, 2013 ###
+
+**Features**
+
+* Added timestamps to output to improve debugging experience.
+
+### v1.0.2 - June 19, 2013 ###
+
+**Features**
+
+* Released on [RubyGems](http://rubygems.org/gems/newrelic_plugin)
+
+### v1.0.1 - June 18, 2013 ###
+
+**Features**
+
+* Added configuration option for SSL hostname verification
+
+### v1.0.0 - June 14, 2013 ###
+
+**Features**
+
+* Initial public release version of the New Relic Platform Ruby SDK
+

data/README.md

@@ -13,11 +13,11 @@ the New Relic platform. If you are looking to build or use a platform
 component, please refer to the
 [getting started documentation](http://newrelic.com/docs/platform/plugin-development).
 
-Until this gem is published in rubygems.org, you will need to use this
-gem by adding it to your [bundler](http://gembundler.com/) Gemfile like this:
+Install this gem by running `gem install newrelic_plugin` or add it to your
+[bundler](http://gembundler.com/) Gemfile like this:
 
 ```ruby
-gem "newrelic_plugin", :git => "git@github.com:newrelic-platform/newrelic_plugin.git", :branch => "release"
+gem "newrelic_plugin"
 ```
 
 Alternatively you can build and install the gem locally:

data/lib/newrelic_plugin.rb

@@ -10,3 +10,4 @@ require "newrelic_plugin/run" # cleanup needed
 require "newrelic_plugin/processor"
 require "newrelic_plugin/processors/epoch_counter_processor" # port needed
 require "newrelic_plugin/processors/rate_processor" # port needed
+require "newrelic_plugin/logger"

data/lib/newrelic_plugin/agent.rb

@@ -79,7 +79,7 @@ module NewRelic
           if @guid=="guid" or @guid=="_TYPE_YOUR_GUID_HERE_"
             #this feels tightly coupled to the config class, testing this is difficult, thinking about refactoring (NH)
             @guid = NewRelic::Plugin::Config.config.newrelic['guids'][agent_info[:ident].to_s] if NewRelic::Plugin::Config.config.newrelic['guids']
-            puts "NOTE: GUID updated for #{instance_label} at run-time to '#{@guid}'"
+            Logger.write "NOTE: GUID updated for #{instance_label} at run-time to '#{@guid}'"
           end
           raise "Did not set GUID" if @guid.nil? or @guid=="" or @guid=="guid" or @guid=="_TYPE_YOUR_GUID_HERE_"
           @guid

data/lib/newrelic_plugin/logger.rb

@@ -0,0 +1,19 @@
+module NewRelic
+  module Plugin
+    require 'time'
+
+    class Logger
+      def self.write(message)
+        Logger.output "[#{Logger.timestamp}] #{message}"
+      end
+
+      def self.output(message)
+        puts message
+      end
+
+      def self.timestamp
+        Time.iso8601(Time.now.utc.iso8601).to_s
+      end
+    end
+  end
+end

data/lib/newrelic_plugin/new_relic_message.rb

@@ -56,7 +56,7 @@ module NewRelic
 
       def send_metrics
         return_errors = []
-        puts "Metrics for #{@component_name}[#{@component_guid}] for last #{@duration_in_seconds} seconds:" if new_relic_connection.log_metrics?
+        Logger.write "Metrics for #{@component_name}[#{@component_guid}] for last #{@duration_in_seconds} seconds:" if new_relic_connection.log_metrics?
         #
         # Send all metrics in a single transaction
         #
@@ -78,7 +78,7 @@ module NewRelic
         end
         return metrics_hash
       end
-      
+
       def build_request_payload
         data = {
           "agent" => {
@@ -92,7 +92,7 @@ module NewRelic
                 "guid" => @component_guid,
                 "duration" => @duration_in_seconds,
                 "metrics" => build_metrics_hash
-              } 
+              }
           ]
         }
         return data.to_json
@@ -106,7 +106,7 @@ module NewRelic
             req.body = build_request_payload
           end
         rescue => err
-          puts "HTTP Connection Error: #{err.inspect} #{err.message}"
+          Logger.write "HTTP Connection Error: #{err.inspect} #{err.message}"
         end
 
         return response
@@ -123,7 +123,7 @@ module NewRelic
             return_status = "FAILED[#{response.status}] <#{new_relic_connection.url}>: #{last_result["error"]}"
           end
         elsif response && response.status == 403 && response.body == "DISABLE_NEW_RELIC"
-          puts "Agent has been disabled remotely by New Relic"
+          Logger.write "Agent has been disabled remotely by New Relic"
           abort "Agent has been disabled remotely by New Relic"
         else
           begin
@@ -144,23 +144,23 @@ module NewRelic
         if return_status
           if response and response.status == 503 and !new_relic_connection.log_metrics?
             # If logging not enabled, and it's a 503...be less error-ish...
-            puts "  Collector temporarily unavailable...continuing"
+            Logger.write "  Collector temporarily unavailable...continuing"
           else
             # Otherwise, in all cases (logging enabled or not) print an error message
-            puts "  ****ERROR: #{return_status}"
+            Logger.write "  ****ERROR: #{return_status}"
           end
         end
-      end 
+      end
 
       def log_send_metrics
         if new_relic_connection.log_metrics?
-          puts "  Sent #{metrics.size} metrics to New Relic [#{new_relic_connection.url}]:"
+          Logger.write "  Sent #{metrics.size} metrics to New Relic [#{new_relic_connection.url}]:"
           metrics.each do |metric|
             val_strs = []
             [:count,:total,:min,:max,:sum_of_squares].each do |key|
               val_strs << "#{key}: #{metric[key]}" if metric[key]
             end
-            puts "    #{metric[:metric_name]}: #{val_strs.join(', ')}"
+            Logger.write "    #{metric[:metric_name]}: #{val_strs.join(', ')}"
           end
         end
       end

data/lib/newrelic_plugin/processors/rate_processor.rb

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

data/lib/newrelic_plugin/run.rb

@@ -19,11 +19,11 @@ module NewRelic
       def initialize
         @poll_cycle = (NewRelic::Plugin::Config.config.newrelic["poll"] || 60).to_i
         @poll_cycle = 60 if (@poll_cycle <= 0) or (@poll_cycle >= 600)
-        puts "WARNING: Poll cycle differs from 60 seconds (current is #{@poll_cycle})" if @poll_cycle!=60
+        Logger.write "WARNING: Poll cycle differs from 60 seconds (current is #{@poll_cycle})" if @poll_cycle!=60
       end
       def installed_agents
         if Setup.installed_agents.size==0
-          puts "No agents installed!"
+          Logger.write "No agents installed!"
           raise NoAgents, "No agents installed"
         end
         Setup.installed_agents
@@ -71,12 +71,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?
-          puts err_msg
+          Logger.write err_msg
           raise NoAgents, err_msg
         end
         installed_agents.each do |agent_id,installed_agent|
           version = installed_agent[:agent_class].version
-          puts "Agent #{installed_agent[:label]} is at version #{version}" if version
+          Logger.write "Agent #{installed_agent[:label]} is at version #{version}" if version
         end
         configured_agents.each do |agent|
           agent.startup if agent.respond_to? :startup
@@ -94,22 +94,22 @@ module NewRelic
               begin
                 cnt+=agent.run @poll_cycle
               rescue => err
-                puts "Error occurred in poll cycle: #{err}"
+                Logger.write "Error occurred in poll cycle: #{err}"
               end
             end
-            puts "Gathered #{cnt} statistics"
+            Logger.write "Gathered #{cnt} statistics"
             #
             # Delay until next run
             secs_to_delay=@poll_cycle-(Time.now-@last_run_time)
             sleep secs_to_delay if secs_to_delay>0
           end
         rescue Interrupt =>err
-          puts "Shutting down..."
+          Logger.write "Shutting down..."
         end
         configured_agents.each do |agent|
           agent.shutdown if agent.respond_to? :shutdown
         end
-        puts "Shutdown complete"
+        Logger.write "Shutdown complete"
       end
       #private
       def agent_setup

data/lib/newrelic_plugin/version.rb

@@ -1,5 +1,5 @@
 module NewRelic
   module Plugin
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

data/test/logger_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class LoggerTest < Test::Unit::TestCase
+
+  context 'self.write' do
+    should 'build expected log string and output it' do
+      NewRelic::Plugin::Logger.expects(:timestamp).returns('foobar')
+      NewRelic::Plugin::Logger.expects(:output).with('[foobar] test')
+      NewRelic::Plugin::Logger.write('test')
+    end
+  end
+
+  context 'self.timestamp' do
+    should 'format timestamp in iso8601' do
+      test_time = Time.new(2013, 6, 24, 0, 0, 0, "+00:00")
+      Time.expects(:now).twice.returns(test_time)
+      assert_equal '2013-06-24 00:00:00 UTC', NewRelic::Plugin::Logger.timestamp
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: newrelic_plugin
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-19 00:00:00.000000000 Z
+date: 2013-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -86,6 +86,7 @@ extra_rdoc_files:
 - LICENSE
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -95,6 +96,7 @@ files:
 - lib/newrelic_plugin/config.rb
 - lib/newrelic_plugin/data_collector.rb
 - lib/newrelic_plugin/error.rb
+- lib/newrelic_plugin/logger.rb
 - lib/newrelic_plugin/new_relic_connection.rb
 - lib/newrelic_plugin/new_relic_message.rb
 - lib/newrelic_plugin/processor.rb
@@ -107,6 +109,7 @@ files:
 - newrelic_plugin.gemspec
 - test/agent_test.rb
 - test/fixtures/valid_payload.json
+- test/logger_test.rb
 - test/manual_test.rb
 - test/new_relic_message_test.rb
 - test/test_helper.rb