newrelic_plugin 1.0.2

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in newrelic_plugin.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 New Relic, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,46 @@
+# New Relic Platform Agent SDK
+
+## Requirements
+
+ * Tested with Ruby 1.8.7 and 1.9.3
+ * New Relic account on rpm.newrelic.com, with early access enabled 
+   (contact cooper@newrelic.com to set up early access)
+
+## Get Started
+
+This repo represents the core Ruby gem used to build plugin agents for
+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:
+
+```ruby
+gem "newrelic_plugin", :git => "git@github.com:newrelic-platform/newrelic_plugin.git", :branch => "release"
+```
+
+Alternatively you can build and install the gem locally:
+
+```bash
+git clone git@github.com:newrelic-platform/newrelic_plugin.git
+cd newrelic_plugin
+rake build
+gem install pkg/newrelic_plugin*
+```
+
+## Support
+
+Reach out to us at
+[support.newrelic.com](http://support.newrelic.com/).
+There you'll find documentation, FAQs, and forums where you can submit
+suggestions and discuss with staff and other users.
+
+Also available is community support on IRC: we generally use #newrelic
+on irc.freenode.net
+
+Find a bug? E-mail <support@newrelic.com>, or submit a ticket to
+
+[support.newrelic.com](http://support.newrelic.com/).
+
+Thank you!

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+require "bundler/gem_tasks"
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/lib/newrelic_plugin.rb

@@ -0,0 +1,12 @@
+require "newrelic_plugin/version"
+require "newrelic_plugin/error"
+require "newrelic_plugin/config"
+require "newrelic_plugin/new_relic_connection"
+require "newrelic_plugin/new_relic_message"
+require "newrelic_plugin/agent"
+require "newrelic_plugin/data_collector"
+require "newrelic_plugin/setup" # cleanup needed
+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

data/lib/newrelic_plugin/agent.rb

@@ -0,0 +1,155 @@
+module NewRelic
+  module Plugin
+#
+# Primary newrelic_plugin agent.
+#
+# Author:: Lee Atchison <lee@newrelic.com>
+# Copyright:: Copyright (c) 2012 New Relic, Inc.
+#
+    module Agent
+      class Base
+        class << self
+          attr_reader :label,:instance_label_proc,:guid,:version
+          attr_accessor :config_options_list
+
+
+          #
+          # Define the GUID for this agent.
+          #
+          def agent_guid str
+            raise "Did not set GUID" if str.nil? or str==""
+            @guid=str
+          end
+
+          #
+          # Define version for this agent
+          #
+          def agent_version str
+            @version = str
+          end
+
+          #
+          #
+          # Human Readable labels for plugin.
+          #   label - Name of the plugin
+          #   block return - Name of a particular instance of a plugin component.
+          #
+          #
+          def agent_human_labels label,&block
+            @label=label
+            @instance_label_proc=block
+          end
+
+          #
+          #
+          # Support for single instance, non-configurable agents.
+          #
+          #
+          def no_config_required
+            @no_config_required=true
+          end
+          def config_required?
+            !@no_config_required
+          end
+
+          #
+          #
+          # Specify name of configuration values used in plugin implementation.
+          #
+          #
+          def agent_config_options *args
+            @config_options_list||=[]
+            args.each do |config|
+              attr_accessor config
+              @config_options_list << config
+            end
+          end
+        end
+
+        #
+        # Instance Info
+        #
+        attr_reader :name,:agent_info
+        def guid
+          return @guid if @guid
+          @guid=self.class.guid
+          #
+          # Verify GUID is set correctly...
+          #
+          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}'"
+          end
+          raise "Did not set GUID" if @guid.nil? or @guid=="" or @guid=="guid" or @guid=="_TYPE_YOUR_GUID_HERE_"
+          @guid
+        end
+        def version
+          self.class.version
+        end
+        def label
+          self.class.label
+        end
+        #
+        # Instantiate a newrelic_plugin instance
+        def initialize name,agent_info,options={}
+          @name=name
+          @agent_info=agent_info
+          @ident=agent_info[:ident]
+          @options=options
+          if self.class.config_options_list
+            self.class.config_options_list.each do |config|
+              self.send("#{config}=",options[config])
+            end
+          end
+          @last_time=nil
+
+          #
+          # Run agent-specific metric setup, if necessary
+          setup_metrics if respond_to? :setup_metrics
+        end
+        def instance_label
+          if !respond_to? :instance_label_proc_method
+            mod=Module.new
+            mod.send :define_method,:instance_label_proc_method,self.class.instance_label_proc
+            self.extend mod
+          end
+          self.instance_label_proc_method
+        end
+
+        #
+        #
+        # Setup & Report Metrics
+        #
+        #
+        def report_metric metric_name,units,value,opts={}
+          return if value.nil?
+          @data_collector.add_data metric_name,units,value.to_f,opts
+        end
+
+        #
+        #
+        # Execute a poll cycle
+        #
+        #
+        def run poll_interval
+          #
+          # Start of cycle work, if any
+          cycle_start if respond_to? :cycle_start
+
+          #
+          # Collect Data
+          @data_collector=DataCollector.new self,poll_interval
+          poll_cycle
+          cnt=@data_collector.process
+          @data_collector=nil
+
+          #
+          # End of cycle work, if any
+          cycle_end if respond_to? :cycle_end
+          cnt
+        end
+      end
+    end
+  end
+end

data/lib/newrelic_plugin/config.rb

@@ -0,0 +1,84 @@
+require 'yaml'
+module NewRelic
+  module Plugin
+#
+#
+# Process global config file for NewRelic. This is defined per execution environment.
+#
+# Author:: Lee Atchison <lee@newrelic.com>
+# Copyright:: Copyright (c) 2012 New Relic, Inc.
+#
+# The system configuration can be accessed as a hash using this method. For example:
+#
+#   NewRelic::Plugin::Config.config.options['xxx']
+# or:
+#   NewRelic::Plugin::Config.config.newrelic['...']
+# or:
+#   NewRelic::Plugin::Config.config.agents['...']
+#
+#
+    class Config
+      attr_reader :options
+      # Creates an instance of a configuration object, loading the configuration
+      # from the YAML configuration file. Note: this method should not be used
+      # directly, rather the global method +config+ should be referenced instead.
+      def initialize
+        @options = YAML::load(Config.config_yaml) if Config.config_yaml
+        @options = YAML.load_file(Config.config_file) unless @options
+      end
+
+      #
+      # Return a hash of NewRelic configuration information.
+      #
+      # Usage: NewRelic::Plugin::Config.config.newrelic[...]
+      #
+      def newrelic
+        @options["newrelic"]
+      end
+      #
+      # Return a hash of agent configuration information.
+      #
+      # Usage: NewRelic::Plugin::Config.config.agents[...]
+      #
+      def agents
+        @options["agents"]
+      end
+
+      #
+      # Set the name of the configuration file:
+      #
+      #   NewRelic::Plugin::Config.config_file="lib/config.yml"
+      #
+      def self.config_file= config_file
+        @config_file=config_file
+        @config_yaml=nil
+        @instance=nil
+      end
+      def self.config_file
+        @config_file||="config/newrelic_plugin.yml"
+      end
+      #
+      # Set the content of the configuration as a YAML string
+      #
+      #   NewRelic::Plugin::Config.config_yaml="newrelic:\n  test: 2\n  test2: four\nagents:\n  test: 4\n  test2: six\n"
+      #
+      def self.config_yaml= config_yaml
+        @config_yaml=config_yaml
+        @config_file=nil
+        @instance=nil
+      end
+      def self.config_yaml
+        @config_yaml
+      end
+      #
+      # Returns a memoized version of the configuration object.
+      #
+      def self.config
+        @instance||=NewRelic::Plugin::Config.new
+      end
+    end
+  end
+end
+def plugin_config
+  NewRelic::Plugin::Config.config
+end

data/lib/newrelic_plugin/data_collector.rb

@@ -0,0 +1,67 @@
+module NewRelic
+  module Plugin
+#
+# Gather's data from agent and presents it to nr_connect for processing.
+#
+# This is a wrapper for nr_connect used in the context of an agent.
+#
+    class DataCollector
+      #
+      #
+      # Methods used within an agent implementation:
+      #
+      #
+      def add_data metric_name,units,data,opts={}
+        nrmsg.add_stat_fullname(
+            "Component/#{metric_name}[#{units}]",
+            1,
+            data,
+            :min => data,
+            :max => data,
+            :sum_of_squares => (data*data)
+        )
+        #puts "Metric '#{metric_name}' (#{units}): raw: #{value}, processed: #{data} (#{processor_type})" if verbose?
+        @cnt+=1
+        data
+      end
+
+
+      #
+      # Internal methods used within Agent class
+      #
+      def initialize agent,poll_interval
+        @agent=agent
+        @poll_interval=poll_interval
+        @cnt=0
+      end
+      def process
+        nrmsg_send
+        @cnt
+      end
+
+      ################################################################################
+      private
+
+      def verbose?
+        return @verbose unless @verbose.nil?
+        @verbose=NewRelic::Plugin::Config.config.newrelic["verbose"].to_i>0
+      end
+
+      #
+      # NewRelicConnection Handling
+      #
+      def nrmsg
+        @nrmsg||=nrobj.start_message @agent.instance_label,@agent.guid,@agent.version,@poll_interval
+      end
+      def nrmsg_send
+        return unless @nrmsg
+        @nrmsg.send_metrics
+        @nrmsg=nil
+      end
+      def nrobj
+        @nrobj||=NewRelic::Plugin::NewRelicConnection.new NewRelic::Plugin::Config.config.newrelic
+      end
+
+    end
+  end
+end

data/lib/newrelic_plugin/error.rb

@@ -0,0 +1,22 @@
+module NewRelic
+
+# Standard Errors
+#
+# Author:: Lee Atchison <lee@newrelic.com>
+# Copyright:: Copyright (c) 2012 New Relic, Inc.
+#
+  module Plugin # :nodoc: 
+    class AgentError<Exception;end
+    class NoAgents<Exception;end
+    class NoMetrics<Exception;end
+    class NewRelicCommError<Exception;end
+    class UnknownInstalledAgent<AgentError;end
+    class UnknownInstalledProcessor<AgentError;end
+    class CouldNotInitializeAgent<AgentError;end
+    class CouldNotInitializeProcessor<AgentError;end
+    class BadConfig<AgentError;end
+    class NoResultReturned<AgentError;end
+    class NoDataReturned<AgentError;end
+    class InvalidMetricValueType<AgentError;end
+  end
+end

data/lib/newrelic_plugin/new_relic_connection.rb

@@ -0,0 +1,67 @@
+require 'faraday'
+
+module NewRelic
+  module Plugin
+    class NewRelicConnection
+      #
+      # Allowed configuration Values:
+      #   license_key [required] Specifies RPM account to store metrics in
+      #   host [optional] override default production collector
+      #   port [optional] override default production collector
+      #   verbose [optional] log HTTP transactions to stdout
+      #
+      def initialize config = {}
+        @config = config
+      end
+      #
+      # Start creating a message containing a set of metrics to New Relic.
+      #
+      def start_message component_name,component_guid,component_version,duration_in_seconds
+        NewRelic::Plugin::NewRelicMessage.new self,component_name,component_guid,component_version,duration_in_seconds
+      end
+
+      #################### Internal Only
+      #
+      # Create HTTP tunnel to New Relic
+      #
+      def connect
+        @connect ||= Faraday.new(:url => url, :ssl => { :verify => ssl_host_verification } ) do |builder|
+          builder.request  :url_encoded
+          builder.response :logger if @config["log_http"].to_i>0
+          builder.use AuthenticationMiddleware,license_key
+          builder.adapter  :net_http
+        end
+      end
+      def url
+        @config["endpoint"] || "https://platform-api.newrelic.com"
+      end
+      def uri
+        @config["uri"] || "/platform/v1/metrics"
+      end
+      def ssl_host_verification
+        ssl_host_verification = @config["ssl_host_verification"]
+        return true if ssl_host_verification.nil?
+        !!ssl_host_verification
+      end
+      class AuthenticationMiddleware < Faraday::Middleware
+        def initialize(app,apikey)
+          super(app)
+          @apikey = apikey
+        end
+        def call(env)
+          unless env[:request_headers]['X-License-Key']
+            env[:request_headers]['X-License-Key'] = @apikey
+          end
+          @app.call(env)
+        end
+      end
+      def log_metrics?
+        @config["verbose"] || @config["log_metrics"]
+      end
+      def license_key
+        @config["license_key"]
+      end
+
+    end
+  end
+end