techarch-newrelic_rpm 2.10.2

data/lib/new_relic/version.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/ruby
+module NewRelic
+  module VERSION #:nodoc:
+    MAJOR = 2
+    MINOR = 10
+    TINY  = 1
+    EXPERIMENTAL = 12
+    STRING = [MAJOR, MINOR, TINY, EXPERIMENTAL].compact.join('.')
+  end
+  
+  # Helper class for managing version comparisons 
+  class VersionNumber
+    attr_reader :parts
+    include Comparable
+    def initialize(version_string)
+      version_string ||= '1.0.0'
+      @parts = version_string.split('.').map{|n| n.to_i }
+    end
+    def major_version; @parts[0]; end
+    def minor_version; @parts[1]; end
+    def tiny_version; @parts[2]; end
+    
+    def <=>(other)
+      other = self.class.new(other) if other.is_a? String
+      self.class.compare(self.parts, other.parts)
+    end
+    
+    def to_s
+      @parts.join(".")
+    end
+    
+    def hash
+      @parts.hash
+    end
+    
+    def eql? other
+      (self <=> other) == 0
+    end
+    
+    private
+    def self.compare(parts1, parts2)
+      a, b = parts1.first, parts2.first
+      case
+        when a.nil? && b.nil? then 0
+        when a.nil? then -1
+        when b.nil? then 1
+        when a == b
+          compare(parts1[1..-1], parts2[1..-1])
+        else
+          a <=> b
+      end
+    end
+  end
+end

data/lib/new_relic_api.rb

@@ -0,0 +1,313 @@
+# == REST API Helpers
+#
+# 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::Control.instance['license_key']}
+        h['Authorization'] = 'Basic ' + ["#{NewRelicApi.email}:#{NewRelicApi.password}"].pack('m').delete("\r\n") if NewRelicApi.email
+        h
+      end
+
+      def site_url
+        host = NewRelicApi.host || NewRelic::Control.instance.api_server.name
+        port = NewRelicApi.port || NewRelic::Control.instance.api_server.port
+        "#{port == 443 ? 'https' : 'http'}://#{host}:#{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
+    has_many :account_views
+
+    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
+
+    # Add a user to an account.
+    # +user_params+:: User parameters as a hash consisting of the following:
+    #                 email, first_name, password, password_confirmation
+    #                 If a user record already exists for this email, the name
+    #                 and password fields are ignored.
+    # +is_admin+:: Set administrative privileges for this user.
+    def add_user(user_params, is_admin = false)
+      account_id = self.id
+      account_view = NewRelicApi::Account::AccountView.create(:account_id => account_id, :user => user_params, :is_admin => is_admin)
+      account_views << account_view if account_view.valid?
+      account_view
+    end
+
+    # Change the subscription for an account
+    # +product_id+:: ID or name of product (e.g. Lite) (required).
+    # +number_of_hosts+:: Number of hosts. This is required for fixed host products.
+    #                     For utility based products, this is set to the maximum
+    #                     number of hosts allowed to connect.
+    def change_subscription(sub_params)
+      NewRelicApi::Subscription.create(sub_params.merge(:account_id => self.id))
+    end
+
+    # Remove a user's access from an account.
+    # +email+:: User's email address.
+    def remove_user(email)
+      view = account_views.detect{|av| av.user.email == email}
+      if view
+        view.destroy
+      else
+        raise "No user matching email #{email} for account"
+      end
+    end
+
+    # Change the primary admin for an account. The administrator must be a
+    # user that is already associated with the account
+    # +email+:: Email address of the new administrator
+    def change_primary_admin(email)
+      put(:update_primary_admin, :email => email)
+    end
+
+    class AccountView < BaseResource
+      self.prefix = ACCOUNT_RESOURCE_PATH
+
+      def query_params(extra_params = {}) #:nodoc:
+        {:account_id => account_id}.merge(extra_params)
+      end
+
+      def user
+        @attributes['user']
+      end
+    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
+
+  class Subscription < BaseResource
+    def query_params(extra_params = {}) #:nodoc:
+      {:account_id => account_id}.merge(extra_params)
+    end
+  end
+
+  class User < BaseResource
+  end
+
+end
+

data/lib/newrelic_rpm.rb

@@ -0,0 +1,40 @@
+# == New Relic Initialization
+# 
+# When installed as a gem, you can activate the New Relic agent one of the following ways:
+#
+# For Rails, add:
+#    config.gem 'newrelic_rpm'
+# to your initialization sequence.
+#
+# For merb, do 
+#    dependency 'newrelic_rpm'
+# in the Merb config/init.rb
+#
+# For other frameworks, or to manage the agent manually, invoke NewRelic::Agent#manual_start
+# directly.
+#
+require 'new_relic/control'
+
+def log!(message)
+  STDERR.puts "[NewRelic] #{message}"
+end
+
+# 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::Control.instance.init_plugin :config => Rails.configuration
+  end
+elsif defined? Merb
+  module NewRelic
+    class MerbBootLoader < Merb::BootLoader
+      after Merb::BootLoader::ChooseAdapter
+
+      def self.run
+        NewRelic::Control.instance.init_plugin
+      end
+    end
+  end  
+else
+  NewRelic::Control.instance.init_plugin
+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/lib/tasks/tests.rake

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

data/newrelic.yml

@@ -0,0 +1,227 @@
+#
+# 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 %>'
+  
+  # Agent Enabled (Rails Only)
+  # Use this setting to force the agent to run or not run.
+  # Default is 'auto' which means the agent will install and run only
+  # if a valid dispatcher such as Mongrel is running.  This prevents
+  # it from running with Rake or the console.  Set to false to
+  # completely turn the agent off regardless of the other settings.
+  # Valid values are true, false and auto.
+  # agent_enabled: auto
+  
+  # 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. If you want
+  # to map this instance into multiple apps, like "AJAX Requests" and
+  # "All UI" then specify a semicolon separated list of up to three
+  # distinct names.  If you comment this out, it defaults to the 
+  # capitalized RAILS_ENV (i.e., Production, Staging, etc)
+  app_name: My Application
+
+  # When "true", the agent collects performance data about your 
+  # application and reports this data to the NewRelic RPM service at 
+  # newrelic.com. This global switch is normally overridden for each 
+  # environment below. (formerly called 'enabled')
+  monitor_mode: true
+
+  # Developer mode should be off in every environment but
+  # development as it has very high overhead in memory.
+  developer_mode: 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
+
+  # EXPERIMENTAL: enable verification of the SSL certificate sent by
+  # the server. This setting has no effect unless SSL is enabled
+  # above. This may block your application. Only enable it if the data
+  # you send us needs end-to-end verified certificates.
+  #
+  # This means we cannot cache the DNS lookup, so each request to the
+  # RPM service will perform a lookup. It also means that we cannot
+  # use a non-blocking lookup, so in a worst case, if you have DNS
+  # problems, your app may block indefinitely.
+  # verify_certificate: true
+  
+  # Set your application's Apdex threshold value with the 'apdex_t'
+  # setting, in seconds. The apdex_t value determines the buckets used
+  # to compute your overall Apdex score. 
+  # Requests that take less than apdex_t seconds to process will be
+  # classified as Satisfying transactions; more than apdex_t seconds
+  # as Tolerating transactions; and more than four times the apdex_t
+  # value as Frustrating transactions. 
+  # For more about the Apdex standard, see
+  # http://support.newrelic.com/faqs/general/apdex
+
+  apdex_t: 0.5
+
+  # 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: hostname
+  # proxy_port: 8080
+  # proxy_user:
+  # proxy_pass:
+
+  
+  # Tells transaction tracer and error collector (when enabled)
+  # whether or not to capture HTTP params.  When true, frameworks can
+  # exclude HTTP parameters from being captured.
+  # Rails: the RoR filter_parameter_logging excludes parameters
+  # Java: create a config setting called "ignored_params" and set it to
+  #     a comma separated list of HTTP parameter names.
+  #     ex: ignored_params: credit_card, ssn, password 
+  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
+    
+    # Threshold in seconds for when to collect a transaction
+    # trace. When the response time of a controller action exceeds
+    # this threshold, a transaction trace will be recorded and sent to
+    # RPM. Valid values are any float value, or (default) "apdex_f",
+    # which will use the threshold for an dissatisfying Apdex
+    # controller action - four times the Apdex T value.
+    transaction_threshold: apdex_f
+ 
+    # 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
+
+    # Determines whether the agent will capture query plans for slow
+    # SQL queries.  Only supported in mysql and postgres.  Should be
+    # set to false when using other adapters.
+    # explain_enabled: true
+
+    # Threshold for query execution time below which query plans will not 
+    # not be captured.  Relevant only when `explain_enabled` is true.
+    # explain_threshold: 0.5
+  
+  # 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
+    
+    # Rails Only - 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, ...
+
+  # (Advanced) Uncomment this to ensure the cpu and memory samplers
+  # won't run.  Useful when you are using the agent to monitor an
+  # external resource
+  # disable_samplers: true
+  
+  # If you aren't interested in visibility in these areas, you can disable
+  # the instrumentation to reduce overhead.
+  #
+  # disable_view_instrumentation: true
+  # disable_activerecord_instrumentation: true
+  # disable_memcache_instrumentation: true
+  
+  # Certain types of instrumentation such as GC stats will not work if 
+  # you are running multi-threaded.  Please let us know.
+  # multi_threaded = false
+
+# Application Environments
+# ------------------------------------------
+# Environment specific settings are in this section.
+# For Rails applications, RAILS_ENV is used to determine the environment
+# For Java applications, pass -Dnewrelic.environment <environment> to set
+# the 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 (also 
+  # 'enabled').
+  # NOTE: for initial evaluation purposes, you may want to temporarily 
+  # turn the agent on in development mode.
+  monitor_mode: false
+
+  # Rails Only - 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.
+  # NOTE: There is substantial overhead when running in developer mode.
+  # Do not use for production or load testing.  
+  developer_mode: true
+  
+  # Enable textmate links
+  # textmate: true
+
+test:
+  <<: *default_settings
+  # It almost never makes sense to turn on the agent when running
+  # unit, functional or integration tests or the like.
+  monitor_mode: 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
+  monitor_mode: 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
+  monitor_mode: true
+  app_name: My Application (Staging)