strelka-newrelic 0.0.1

data/History.rdoc

@@ -0,0 +1,4 @@
+== v0.0.1 [2013-01-16] Michael Granger <ged@FaerieMUD.org>
+
+Initial release.
+

data/Manifest.txt

@@ -0,0 +1,8 @@
+ChangeLog
+History.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/strelka/app/newrelic.rb
+newrelic.yml
+spec/strelka/app/newrelic_spec.rb

data/README.rdoc

@@ -0,0 +1,69 @@
+= Strelka-NewRelic
+
+home   :: http://deveiate.org/projects/strelka/newrelic.html
+code   :: http://bitbucket.org/ged/strelka-newrelic
+github :: http://github.com/ged/strelka-newrelic
+docs   :: http://deveiate.org/code/strelka-newrelic/
+
+
+== Description
+
+Strelka-NewRelic is a Strelka plugin for monitoring a Strelka application with
+NewRelic's application performance management service.
+
+
+== Installation
+
+    gem install strelka-newrelic
+
+
+== Usage
+
+Load the plugin in your application:
+
+    class MyApp < Strelka::App
+        plugin :newrelic
+    end
+
+Make a 'newrelic' section in your Strelka config, and (at a minimum) point
+it to your newrelic.yml:
+
+    newrelic:
+      config_path: /path/to/newrelic.yml
+
+You can also provide overrides by including items with the same keys as
+the newrelic.yml file. The values in the strelka config will take precedence.
+
+
+== License
+
+Copyright © 2013, Michael Granger
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+
+

data/Rakefile

@@ -0,0 +1,50 @@
+#!/usr/bin/env rake
+
+begin
+	require 'hoe'
+rescue LoadError
+	abort "This Rakefile requires 'hoe' (gem install hoe)"
+end
+
+# Sign gems
+Hoe.plugin :signing
+Hoe.plugin :mercurial
+Hoe.plugin :deveiate
+
+hoespec = Hoe.spec 'strelka-newrelic' do
+	self.readme_file = 'README.rdoc'
+	self.history_file = 'History.rdoc'
+	self.extra_rdoc_files = FileList[ '*.rdoc' ]
+
+	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
+
+	self.dependency 'strelka', '~> 0.3'
+	self.dependency 'newrelic_rpm', '~> 3.5'
+	self.dependency 'hoe-deveiate', '~> 0.2', :developer
+
+	self.spec_extras[:licenses] = ["BSD"]
+	self.spec_extras[:rdoc_options] = ['-f', 'fivefish', '-t', 'Strelka New Relic Analysis']
+	self.require_ruby_version( '>=1.9.2' )
+	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
+	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
+
+	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
+end
+
+ENV['VERSION'] ||= hoespec.spec.version.to_s
+
+# Ensure the specs pass before checking in
+task 'hg:precheckin' => [:check_manifest, :check_history, :spec]
+
+# Rebuild the ChangeLog immediately before release
+task :prerelease => [:check_manifest, :check_history, 'ChangeLog']
+
+task :check_manifest => 'ChangeLog'
+
+
+desc "Build a coverage report"
+task :coverage do
+	ENV["COVERAGE"] = 'yes'
+	Rake::Task[:spec].invoke
+end
+

data/lib/strelka/app/newrelic.rb

@@ -0,0 +1,131 @@
+# -*- ruby -*-
+# vim: set nosta noet ts=4 sw=4:
+# encoding: utf-8
+
+require 'loggability'
+require 'newrelic_rpm'
+
+require 'strelka' unless defined?( Strelka )
+require 'strelka/app' unless defined?( Strelka::App )
+
+# Monkeypatch NewRelic to use Loggability.
+module NewRelic
+	extend Loggability
+	log_as :newrelic
+
+	module Agent
+		class AgentLogger
+
+			# No-op this unhelpful crap
+			remove_method :set_log_format!
+			def set_log_format!; end
+
+		end
+	end
+
+end
+
+
+# Strelka::App plugin module for reporting application performance to New Relic.
+module Strelka::App::NewRelic
+	extend Strelka::Plugin,
+	       Configurability
+
+	include NewRelic::Agent::Instrumentation::ControllerInstrumentation
+
+
+	# Library version constant
+	VERSION = '0.0.1'
+
+	# Version-control revision constant
+	REVISION = %q$Revision: 16e6c9702fe8 $
+
+
+
+	# Insert this plugin after routing in the app's stack
+	run_after :routing
+
+	# Configurability API -- load newrelic configuration from the 'newrelic'
+	# section of the universal config. Since NewRelic's config is separate
+	# this only *needs* to point to the newrelic.yml config file, but it can
+	# also override settings from there
+	config_key :newrelic
+
+
+	### Configurability API -- configure this class with the appropriate
+	### section of the universal config when it's installed.
+	def self::configure( config=nil )
+		if config
+			logger = Loggability[ NewRelic ]
+			ra_logger = NewRelic::Agent::AgentLogger.new( {:log_level => 'debug'}, '', logger )
+			NewRelic::Agent.logger = ra_logger
+
+			self.log.info "Applying NewRelic config: %p" % [ config.to_hash ]
+			NewRelic::Agent.config.apply_config( config.to_hash, 1 )
+		end
+	end
+
+
+	### Set up the NewRelic agent.
+	def run( * )
+		self.start_newrelic_agent
+		super
+	end
+
+
+	### Starts the New Relic agent in a background thread.
+	def start_newrelic_agent
+		environment = if self.class.in_devmode? then 'development' else 'production' end
+		options     = { env: environment, dispatcher: :strelka }
+
+		self.log.info "Starting the NewRelic agent."
+		NewRelic::Agent.manual_start( options )
+
+		return self
+	end
+
+
+	### Mark and time the app.
+	def handle_request( request )
+		self.log.debug "[:newrelic] Instrumenting with NewRelic."
+
+		txname = if !request.notes[:routing][:route].empty?
+				note = request.notes[:routing][:route]
+				self.log.debug "Making route name out of the route notes: %p" % [ note ]
+				self.make_route_name( note )
+			else
+				self.log.debug "Making route name out of the verb (%p) and app path (%p)" %
+					[ request.verb, request.app_path ]
+					"handle_request"
+			end
+
+		options = {
+			name:     txname.to_s,
+			request:  request,
+			category: 'Controller/Strelka',
+		}
+		response = self.perform_action_with_newrelic_trace( options ) do
+			super
+		end
+
+		response.notes[:rum_header] = NewRelic::Agent.browser_timing_header
+		response.notes[:rum_footer] = NewRelic::Agent.browser_timing_footer
+
+		self.log.debug "  response notes: %p" % [ response.notes ]
+
+		return response
+	rescue => err
+		NewRelic::Agent.notice_error( err.message )
+		raise
+	end
+
+
+	### Make a normalized transaction name from the specified +route+.
+	def make_route_name( route )
+		action_method = route[:action] or return '(Unknown)'
+		return action_method.name
+	end
+
+end # module Strelka::App::Metriks
+
+

data/newrelic.yml

@@ -0,0 +1,216 @@
+#
+# This file configures the New Relic Agent.  New Relic monitors
+# Ruby, Java, .NET, PHP, and Python applications with deep visibility and low overhead.
+# For more information, visit www.newrelic.com.
+#
+# Generated January 09, 2013
+#
+# This configuration file is custom generated for Michael Granger - ged@FaerieMUD.org
+
+# Here are the settings that are common to all environments:
+common: &default_settings
+  # ============================== LICENSE KEY ===============================
+
+  # You must specify the license key associated with your New Relic
+  # account.  This key binds your Agent's data to your account in the
+  # New Relic service.
+  license_key: 'fbd5c4937223d4f7b0a8ae244d18d4a8642789cb'
+  
+  # Agent Enabled (Ruby/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 New Relic.  New Relic will then auto-map instances of your application
+  # into a New Relic "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: DevEiate
+
+  # When "true", the agent collects performance data about your 
+  # application and reports this data to the New Relic 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: debug *
+  
+  # The newrelic agent communicates with the New Relic 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
+  # New Relic 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
+
+  # Proxy settings for connecting to the New Relic 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 New Relic 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 Professional
+    # product level.
+    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
+    # New Relic. 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 New Relic 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 New Relic 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 Professional
+    # product level.
+    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 New Relic, set this property
+    # to comma-separated values.  Default is to ignore routing errors,
+    # which are how 404's get triggered.
+    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
+  # disable_dj: 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 configuration settings for these environments here.
+
+development:
+  <<: *default_settings
+  # Turn off communication to New Relic service in development mode (also
+  # 'enabled').
+  # NOTE: for initial evaluation purposes, you may want to temporarily 
+  # turn agent communication on in development mode.
+  monitor_mode: true
+
+  # 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 app server.
+  # 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.  New Relic
+# testing shows an average performance impact of < 5 ms per
+# transaction, so you can leave this on all the time without
+# incurring any user-visible performance degradation.
+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: DevEiate (Staging)