newrelic_rpm 2.8.0

data/lib/new_relic/version.rb

@@ -0,0 +1,111 @@
+#!/usr/bin/ruby
+module NewRelic
+  module VERSION #:nodoc:
+  MAJOR = 2
+  MINOR = 8
+  TINY  = 0
+  STRING = [MAJOR, MINOR, TINY].join('.')
+  def self.changes
+    puts "NewRelic RPM Plugin Version: #{NewRelic::VERSION}"
+    puts CHANGELOG
+  end
+
+  CHANGELOG = <<EOF
+2008-12-18 version 2.8.0
+  * add beta of api in new_relic_api.rb
+  * instrumented dynamic finders in ActiveRecord
+  * preliminary support for capturing deployment information via capistrano
+  * change memory sampler for solaris to use /usr/bin/ps
+  * allow ERB in newrelic.yml file
+  * merged support for merb into this version 
+  * fix incompatibility in the developer mode with the safe_erb plugin
+  * fix module namespace issue causing an error accessing NewRelic::Instrumentation modules
+  * fix issue where the agent sometimes failed to start up if there was a transient network problem
+  * fix IgnoreSilentlyException message
+2008-12-09 version 2.7.4
+  * fix error when trying to serialize some kinds of Enumerable objects
+  * added extra debug logging
+  * added app_name to app mapping
+2008-11-26 version 2.7.3
+  * fix compatibility issue with 1.8.5 causing error with Dir.glob
+2008-11-24 version 2.7.2
+  * fix problem with passenger edge not being a detected environment
+2008-11-22 verison 2.7.1
+  * fix problem with skipped dispatcher instrumentation
+2008-11-23 version 2.7.0
+  * Repackage to support both plugin and Gem installation
+  * Support passenger/litespeed/jruby application naming
+  * Update method for calculating dispatcher queue time
+  * Show stack traces in RPM Transaction Traces
+  * Capture error source for TemplateErrors
+  * Clean up error stack traces.
+  * Support query plans from postgres
+  * Performance tuning
+  * bugfixes
+2008-10-06 version 2.5.3
+  * fix error in transaction tracing causing traces not to show up
+2008-09-30 version 2.5.2
+  * fixes for postgres explain plan support
+2008-09-09 version 2.5.1
+  * bugfixes
+2008-08-29 version 2.5.0
+  * add agent support for rpm 1.1 features
+  * Fix regression error with thin support
+2008-08-27 version 2.4.3
+  * added 'newrelic_ignore' controller class method with :except and :only options for finer grained control
+    over the blocking of instrumentation in controllers.
+  * bugfixes
+2008-07-31 version 2.4.2
+  * error reporting in early access
+2008-07-30 version 2.4.1
+  * bugfix: initializing developer mode
+2008-07-29 version 2.4.0
+  * Beta support for LiteSpeed and Passenger
+2008-07-28 version 2.3.7
+  * bugfixes
+2008-07-28 version 2.3.6
+  * bugfixes
+2008-07-17 version 2.3.5
+  * bugfixes: pie chart data, rails 1.1 compability
+2008-07-11 version 2.3.4
+  * bugfix
+2008-07-10 version 2.3.3
+  * bugfix for non-mysql databases
+2008-07-07 version 2.3.2
+  * bugfixes
+  * Add enhancement for Transaction Traces early access feature
+2008-06-26 version 2.3.1
+  * bugfixes
+2008-06-26 version 2.3.0
+  + Add support for Transaction Traces early access feature
+2008-06-13 version 2.2.2
+  * bugfixes
+2008-06-10 version 2.2.1
+  + Add rails 2.1 support for Developer Mode
+  + Changes to memory sampler: Add support for JRuby and fix Solaris support.  
+  * Stop catching exceptions and start catching StandardError; other exception cleanup
+  * Add protective exception catching to the stats engine
+  * Improved support for thin domain sockets
+  * Support JRuby environments
+2008-05-22 version 2.1.6
+  * bugfixes
+2008-05-22 version 2.1.5
+  * bugfixes
+2008-05-14 version 2.1.4
+  * bugfixes
+2008-05-13 version 2.1.3
+  * bugfixes
+2008-05-08 version 2.1.2
+  * bugfixes
+2008-05-07 version 2.1.1
+  * bugfixes
+2008-04-25 version 2.1.0
+  * release for private beta
+EOF
+  end
+end
+
+if __FILE__ == $0
+  NewRelic::VERSION.changes
+end
+

data/lib/new_relic_api.rb

@@ -0,0 +1,275 @@
+# Ruby lib for working with the New Relic API's XML interface.  Requires Rails 2.0 or later to be loaded.
+#
+# Can also be used as a script using script/runner
+#
+# Authentication is handled using your agent license key or HTTP Basic Authentication.  To authenticate
+# using your license key your newrelic.yml configuration file must be in your application config directory
+# and contain your license key.  The New Relic account associated with the license key must allow api access.  
+# Log into RPM, click Account at the top of the page and check the "Make my account data accessible" checkbox.
+#
+# Basic authentication uses your site credentials to authenticate.  
+#
+#   # To authenticate using basic authentication, make this call with your username and password:
+#   NewRelicApi.authenticate('user@example.com', 'test')
+#
+# This API does not have any agent dependencies.  It can be used independent of the agent by copying it into your application.
+#
+# ==Examples
+#   # Fetching the list of applications for an account
+#   NewRelicApi::Account.find(:first).applications
+#  
+#   # Fetching the health values for all account applications
+#   NewRelicApi::Account.application_health
+#
+#   # Fetching the health values for an application
+#   NewRelicApi::Account.find(:first).applications.first.threshold_values
+#
+#   # Finding an application by name
+#   NewRelicApi::Account.find(:first).applications(:params => {:conditions => {:name => 'My App'}})
+#
+
+module NewRelicApi
+  
+  # This mixin defines ActiveRecord style associations (like has_many) for ActiveResource objects.
+  # ActiveResource objects using this mixin must define the method 'query_params'. 
+  module ActiveResourceAssociations #:nodoc:
+    class << self
+      
+      protected
+      def included(base)
+        class << base
+          # a special activeresource implementation of has_many
+          def has_many(*associations)
+            associations.to_a.each do |association|
+              define_method association do |*args|
+                val = attributes[association.to_s] # if we've already fetched the relationship in the initial fetch, return it
+                return val if val
+                
+                options = args.extract_options!
+                type = args.first || :all
+                
+                begin
+                  # look for the class definition within the current class
+                  clazz = ( self.class.name + '::' + association.to_s.camelize.singularize).constantize
+                rescue
+                  # look for the class definition in the NRAPI module
+                  clazz = ( 'NewRelicApi::' + association.to_s.camelize.singularize).constantize
+                end
+                params = (options[:params] || {}).update(self.query_params)
+                options[:params] = params
+                clazz.find(type, options)
+                
+                #clazz.find(type, :params => options.update(self.query_params))
+              end
+            end
+          end          
+        end
+      end
+    end
+    
+  end
+  class << self
+    attr_accessor :email, :password, :license_key, :ssl, :host, :port
+    
+    # Sets up basic authentication credentials for all the resources.  This is not necessary if you are
+    # using agent license key authentication.
+    def authenticate(email, password)
+      @password = password
+      @email    = email
+    end
+    
+    # Resets the base path of all resources.  This should be called when overridding the newrelic.yml settings
+    # using the ssl, host or port accessors.
+    def reset!
+      @classes.each {|klass| klass.reset!} if @classes
+      NewRelicApi::Account.site_url
+    end
+    
+    
+    def track_resource(klass) #:nodoc:
+      (@classes ||= []) << klass
+    end
+  end
+  class BaseResource < ActiveResource::Base #:nodoc:
+    include ActiveResourceAssociations
+
+    class << self
+      def inherited(klass) #:nodoc:
+        NewRelicApi.track_resource(klass)
+      end
+      
+      def headers
+        h = {'x-license-key' => NewRelicApi.license_key || NewRelic::Config.instance['license_key']}
+        h['Authorization'] = 'Basic ' + ["#{NewRelicApi.email}:#{NewRelicApi.password}"].pack('m').delete("\r\n") if NewRelicApi.email
+        h
+      end
+      
+      def site_url
+        "http#{'s' if (NewRelicApi.ssl || NewRelic::Config.instance['ssl'])}://#{NewRelicApi.host || NewRelic::Config.instance['host']}:#{NewRelicApi.port || NewRelic::Config.instance['port']}"
+      end
+      
+      def reset!
+        self.site = self.site_url
+      end
+      
+      protected
+      
+      def fix_fields(*fields)
+        fields.to_a.each do |field|
+          define_method field do
+            yield super
+          end
+        end
+      end
+      
+      def fix_integer_fields(*fields)
+        fix_fields(*fields) { |sup| sup.to_i }
+      end
+      
+      def fix_float_fields(*fields)
+        fix_fields(*fields) { |sup| sup.to_f }
+      end
+      
+    end
+    self.site = self.site_url
+  end
+  ACCOUNT_RESOURCE_PATH = '/accounts/:account_id/' #:nodoc:
+  ACCOUNT_AGENT_RESOURCE_PATH = ACCOUNT_RESOURCE_PATH + 'agents/:agent_id/' #:nodoc:
+  ACCOUNT_APPLICATION_RESOURCE_PATH = ACCOUNT_RESOURCE_PATH + 'applications/:application_id/' #:nodoc:
+  
+  module AccountResource #:nodoc:
+    def account_id
+      prefix_options[:account_id]
+    end
+    def account_query_params(extra_params = {})
+      {:account_id => account_id}.merge(extra_params)
+    end
+    
+    def query_params#:nodoc:
+      account_query_params
+    end
+    
+  end
+  
+  module AgentResource #:nodoc:
+    include ActiveResourceAssociations
+  end
+    
+  # An application has many:
+  # +agents+:: the agent instances associated with this app
+  # +threshold_values+:: the health indicators for this application.
+  class Application < BaseResource
+    include AccountResource
+    include AgentResource
+    
+    has_many :agents, :threshold_values
+    
+    self.prefix = ACCOUNT_RESOURCE_PATH
+    
+    def query_params#:nodoc:
+      account_query_params(:application_id => id)
+    end
+    
+    class Agent < BaseResource
+      include AccountResource
+      include AgentResource
+      
+      self.prefix = ACCOUNT_APPLICATION_RESOURCE_PATH
+      
+      def query_params#:nodoc:
+        super.merge(:application_id => cluster_agent_id)
+      end
+    end
+    
+  end
+  
+  # A threshold value represents a single health indicator for an application such as CPU, memory or response time.
+  #
+  # ==Fields
+  # +name+:: The name of the threshold setting associated with this threshold value.
+  # +threshold_value+:: A value of 0, 1, 2 or 3 representing gray (not reporting), green, yellow and red
+  # +metric_value+:: The metric value associated with this threshold
+  class ThresholdValue < BaseResource
+    self.prefix = ACCOUNT_APPLICATION_RESOURCE_PATH
+    #      attr_reader :name, :begin_time, :metric_value, :threshold_value
+    
+    fix_integer_fields :threshold_value
+    fix_float_fields :metric_value
+    
+    # Returns the color value for this threshold (Gray, Green, Yellow or Red).
+    def color_value
+      case threshold_value
+        when 3: 'Red'
+        when 2: 'Yellow'
+        when 1: 'Green'
+      else 'Gray'
+      end
+    end
+    
+    def to_s #:nodoc:
+      "#{name}: #{color_value} (#{formatted_metric_value})"
+    end
+  end
+  
+  # An account contains your basic account information.
+  #
+  # Accounts have many
+  # +applications+:: the applications contained within the account
+  # 
+  # Find Accounts
+  #
+  #   NewRelicApi::Account.find(:all) # find all accounts for the current user.
+  #   NewRelicApi::Account.find(44)   # find individual account by ID
+  #
+  class Account < BaseResource
+    has_many :applications
+    
+    def query_params #:nodoc:
+      {:account_id => id}
+    end
+    
+    # Returns an account including all of its applications and the threshold values for each application.
+    def self.application_health(type = :first)
+      find(type, :params => {:include => :application_health})
+    end
+  end
+  
+  
+  # This model is used to mark production deployments in RPM
+  # Only create is supported.
+  # ==Examples
+  #   # Creating a new deployment
+  #   NewRelicApi::Deployment.create
+  #
+  class Deployment < BaseResource
+  end
+  
+end
+if (__FILE__ == $0) || ($0 =~ /script\/runner$/)
+  # Run the command given by the first argument.  Right
+  # now all we have is deployments. We hope to have other
+  # kinds of events here later
+  command = "(no command given)"
+  extra = [command]
+  ARGV.options do |opts|
+    script_name = File.basename($0)
+    opts.banner = "Usage: #{__FILE__} command [options]"
+    
+    opts.separator ""
+    
+    opts.on("-e", "--environment=name", String,
+          "Specifies the environment for the runner to operate under (test/development/production).",
+          "Default: development")
+    
+    extra = opts.order!
+  end
+  command = extra.shift
+  begin
+    require "new_relic/api/#{command}"
+    command_class = NewRelic::API.const_get(command.camelize) 
+  rescue
+    STDERR.puts "Unknown command: #{command}"
+    exit 1
+  end
+  command_class.new(extra).run
+end

data/lib/newrelic_rpm.rb

@@ -0,0 +1,27 @@
+# Initialization script for the gem.
+# Add 
+#    #require 'new_relic'
+# to your initialization sequence, as late as possible.
+#
+require 'new_relic/config'
+
+def log!(message)
+  STDERR.puts "[NewRelic] #{message}"
+end
+
+# START THE AGENT
+# We install the shim agent unless the tracers are enabled, the plugin
+# env setting is not false, and the agent started okay.
+if !NewRelic::Config.instance.tracers_enabled?
+  require 'new_relic/shim_agent'
+else
+  # After verison 2.0 of Rails we can access the configuration directly.
+  # We need it to add dev mode routes after initialization finished. 
+  if defined? Rails.configuration
+    Rails.configuration.after_initialize do
+      NewRelic::Config.instance.start_plugin Rails.configuration
+    end
+  else
+    NewRelic::Config.instance.start_plugin
+  end
+end

data/lib/tasks/agent_tests.rake

@@ -0,0 +1,14 @@
+# run unit tests for the NewRelic Agent
+namespace :test do
+  AGENT_HOME = File.expand_path(File.join(File.dirname(__FILE__), "..",".."))
+  Rake::TestTask.new(:agent) do |t|
+    t.libs << "#{AGENT_HOME}/test"
+    t.libs << "#{AGENT_HOME}/lib"
+    t.pattern = "#{AGENT_HOME}/test/**/tc_*.rb"
+    t.verbose = true
+  end
+  Rake::Task['test:agent'].comment = "Run the unit tests for the Agent"
+
+  Rake::TestTask.new(:all => ["test", "test:agent"])
+  Rake::Task['test:all'].comment = "Run all tests including agent code"
+end

data/lib/tasks/all.rb

@@ -0,0 +1,4 @@
+# This is required to load in task definitions from merb
+Dir.glob(File.join(File.dirname(__FILE__),'*.rake')) do |file|
+  load file
+end

data/lib/tasks/install.rake

@@ -0,0 +1,7 @@
+# run unit tests for the NewRelic Agent
+namespace :newrelic do
+  desc "install a default config/newrelic.yml file"
+  task :install do
+    load File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "install.rb"))  
+  end
+end

data/newrelic.yml

@@ -0,0 +1,137 @@
+#
+# This file configures the NewRelic RPM Agent, NewRelic RPM monitors Rails 
+# applications with deep visibility and low overhead.  For more information, 
+# visit www.newrelic.com.
+#
+# <%= generated_for_user %>
+#
+# here are the settings that are common to all environments
+common: &default_settings
+  # ============================== LICENSE KEY ===============================
+  # You must specify the licence key associated with your New Relic account.
+  # This key binds your Agent's data to your account in the New Relic RPM service.
+  license_key: '<%= license_key %>'
+  
+  # Application Name
+  # Set this to be the name of your application as you'd like it show up in RPM.
+  # RPM will then auto-map instances of your application into a RPM "application"
+  # on your home dashboard page. This setting does not prevent you from manually
+  # defining applications.
+  app_name: My Application
+
+  # the 'enabled' setting is used to turn on the NewRelic Agent.  When false,
+  # your application is not instrumented and the Agent does not start up or
+  # collect any data; it is a complete shut-off.
+  #
+  # when turned on, the agent collects performance data by inserting lightweight
+  # tracers on key methods inside the rails framework and asynchronously aggregating
+  # and reporting this performance data to the NewRelic RPM service at NewRelic.com.
+  # below.
+  enabled: false
+
+  # The newrelic agent generates its own log file to keep its logging information
+  # separate from that of your application.  Specify its log level here.
+  log_level: info
+  
+  # The newrelic agent communicates with the RPM service via http by default.
+  # If you want to communicate via https to increase security, then turn on
+  # SSL by setting this value to true.  Note, this will result in increased
+  # CPU overhead to perform the encryption involved in SSL communication, but this
+  # work is done asynchronously to the threads that process your application code, so
+  # it should not impact response times.
+  ssl: false
+  
+
+  # Proxy settings for connecting to the RPM server.
+  #
+  # If a proxy is used, the host setting is required.  Other settings are optional.  Default
+  # port is 8080.
+  #
+  # proxy_host: proxy.sample.com
+  # proxy_port: 8080
+  # proxy_user:
+  # proxy_pass:
+
+  
+  # Tells transaction tracer and error collector (when enabled) whether or not to capture HTTP params. 
+  # When true, the RoR filter_parameters mechanism is used so that sensitive parameters are not recorded
+  capture_params: false
+
+
+  # Transaction tracer captures deep information about slow
+  # transactions and sends this to the RPM service once a minute. Included in the
+  # transaction is the exact call sequence of the transactions including any SQL statements
+  # issued.
+  transaction_tracer:
+  
+    # Transaction tracer is enabled by default. Set this to false to turn it off. This feature
+    # is only available at the Silver and above product levels.
+    enabled: true
+  
+ 
+    # When transaction tracer is on, SQL statements can optionally be recorded. The recorder
+    # has three modes, "off" which sends no SQL, "raw" which sends the SQL statement in its 
+    # original form, and "obfuscated", which strips out numeric and string literals
+    record_sql: obfuscated
+    
+    # Threshold in seconds for when to collect stack trace for a SQL call. In other words, 
+    # when SQL statements exceed this threshold, then capture and send to RPM the current
+    # stack trace. This is helpful for pinpointing where long SQL calls originate from  
+    stack_trace_threshold: 0.500
+  
+  # Error collector captures information about uncaught exceptions and sends them to RPM for
+  # viewing
+  error_collector:
+    
+    # Error collector is enabled by default. Set this to false to turn it off. This feature
+    # is only available at the Silver and above product levels
+    enabled: true
+    
+    # Tells error collector whether or not to capture a source snippet around the place of the
+    # error when errors are View related.
+    capture_source: true    
+    
+    # To stop specific errors from reporting to RPM, set this property to comma separated 
+    # values
+    #
+    #ignore_errors: ActionController::RoutingError, ...
+
+
+# override default settings based on your application's environment
+
+# NOTE if your application has other named environments, you should
+# provide newrelic conifguration settings for these enviromnents here.
+
+development:
+  <<: *default_settings
+  # turn off communication to RPM service in development mode.
+  # NOTE: for initial evaluation purposes, you may want to temporarily turn
+  # the agent on in development mode.
+  enabled: false
+
+  # When running in Developer Mode, the New Relic Agent will present 
+  # performance information on the last 100 transactions you have 
+  # executed since starting the mongrel.  to view this data, go to 
+  # http://localhost:3000/newrelic
+  developer: true
+
+test:
+  <<: *default_settings
+  # it almost never makes sense to turn on the agent when running unit, functional or
+  # integration tests or the like.
+  enabled: false
+
+# Turn on the agent in production for 24x7 monitoring.  NewRelic testing shows
+# an average performance impact of < 5 ms per transaction, you you can leave this on
+# all the time without incurring any user-visible performance degredation.
+production:
+  <<: *default_settings
+  enabled: true
+
+# many applications have a staging environment which behaves identically to production.
+# Support for that environment is provided here.  By default, the staging environment has
+# the agent turned on.
+staging:
+  <<: *default_settings
+  enabled: true
+  app_name: My Application (Staging)