copperegg-apm 1.0.0.pre6 → 1.0.0.pre7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25fc7205faebae36a3c3900d91b3cd4f9b546cdc
-  data.tar.gz: 62b6fc328ed9103b6d6b2da9b1530c0e1f88a9dc
+  metadata.gz: b6e3a0e3531849de3332f35761ab4e58d19e0b21
+  data.tar.gz: 21a430c08d341f29129701aeb46366f12df4ba96
 SHA512:
-  metadata.gz: d9aeef33236e8d6d4a0a97ad9e7e75646fffb3e256670f4ecab417fcdb7fa064dbaaf6b06f3305b9faaaa4c36df0602b4618a6b63e1f5c6a40476ac74443d47d
-  data.tar.gz: f2fbbe012180b90691727279be8837957886d20c6f22ede1d31a52d4f9620142ab2d615dcaec15565638bde3ea7157c2577c75fd234feb53af0f3624cdf73366
+  metadata.gz: bf59d18d0970a2eb9b4783e6d4233c7e311de3e80260d335656d93b59172a8b278ddee6c4035773bd02927e04a5a01fd0a5c433b318bc4fcee28bf14f760b3de
+  data.tar.gz: abcfa2620a899fba57a03015cc376e48d3f2e9a2092174885735d0257f368f6e05300e094f788445b4f50ccfeac329c17d4ac2b7e9fa9fd8cec991eec7ad5f1b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    copperegg-apm (1.0.0.pre6)
+    copperegg-apm (1.0.0.pre7)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,11 +1,13 @@
 # CopperEgg APM
 
-Monitor the performance of your application with code instrumentation and exception aggregation.
+Monitor the performance of your application with code instrumentation, exception aggregation, and real user monitoring.
 
 **Code instrumentation** measures the elapsed time used to execute a SQL statement, outbound HTTP request, or method call.
 
 **Exception aggregation** monitors the number and type of exceptions occurring in your code.
 
+**Real User Monitoring (RUM)** provides metrics for your we application as it runs within web browsers from the perspective of the end user.
+
 ## Getting Started
 
 ### Prerequisites
@@ -177,6 +179,73 @@ Outbound HTTP requests performed within your project will be benchmarked from an
 
 When exception benchmarking is enabled, any exception raised in your project will be aggregated by class, source location, and system.
 
+## Real User Monitoring
+
+Browser monitoring is added to your HTML pages using either Rack middleware or a helper method.
+
+### Rails
+
+For Rails projects, you can automatically monitor browser performance by setting the configuration directive `benchmark_browser`:
+
+```ruby
+config.benchmark_browser = true
+```
+
+This will add the `CopperEgg::APM::RUMBlender` to the bottom of the middleware stack.
+
+Alternatively, in the Rails configuration, you can insert this anywhere in your middleware stack. For example:
+
+```ruby
+config.middleware.insert_after ActionDispatch::ParamsParser, CopperEgg::APM::RUMBlender
+```
+
+If you prefer to add RUM to your HTML pages manually, you can call the helper method `ce_rum_javascript_tag` in your HTML templates:
+
+```ruby
+<%= ce_rum_javascript_tag %>
+```
+
+For versions prior to 3.2, you will need to include the `CopperEgg::APM::RUM` module into your helper modules:
+
+```ruby
+module ApplicationHelper
+   include CopperEgg::APM::RUM
+```
+
+Alternatively, you can include the module in your controllers:
+
+```ruby
+class UsersController < ActionController::Base
+  helper CopperEgg::APM::RUM
+```
+
+### Sinatra
+
+The following is an example of adding RUM to your Sinatra app:
+
+```ruby
+require 'sinatra'
+require 'copperegg_apm_config'
+
+use Rack::Lint
+use CopperEgg::APM::RUM
+
+get '/hello' do
+  'Hello World'
+end
+```
+
+### Other Rack-based Projects
+
+For other Rack-based projects, you can add RUMBlender in your `config.ru` file like so: 
+
+```ruby
+require 'copperegg_apm_config'
+
+use CopperEgg::APM::RUMBlender
+run MyRackApplication
+```
+
 ## Disable Gem Functionality
 
 To disable all functionality of this gem, call `config.disable` in the configuration block and then restart your application:

data/lib/copperegg/apm.rb

@@ -18,6 +18,7 @@ end
   pg/connection 
   restclient/request
   rum
+  rum_blender
   sqlite3/database
   typhoeus/hydra
   unbound_method

data/lib/copperegg/apm/benchmark.rb

@@ -54,8 +54,8 @@ module CopperEgg
     def benchmarkable_methods
       return @@benchmarkable_methods if @@benchmarkable_methods.size > 0
 
-      if defined?(::Rails) && Rails.respond_to?(:application) && Rails.application.respond_to?(:eager_load!)
-        Rails.application.eager_load!
+      if defined?(::Rails) && ::Rails.respond_to?(:application) && ::Rails.application.respond_to?(:eager_load!)
+        ::Rails.application.eager_load!
       end
       
       ObjectSpace.each_object(Class) do |class_or_module|

data/lib/copperegg/apm/configuration.rb

@@ -19,6 +19,7 @@ module CopperEgg
       @@benchmark_active_record   = false
       @@benchmark_http            = true
       @@benchmark_exceptions      = true
+      @@benchmark_browser         = false
       @@benchmark_methods_level   = :disabled
       @@only_methods              = []
       @@exclude_methods           = []
@@ -105,6 +106,15 @@ module CopperEgg
         @@benchmark_exceptions
       end
 
+      def self.benchmark_browser=(boolean)
+        raise ConfigurationError.new("Boolean expected for benchmark_browser") if boolean != true && boolean != false
+        @@benchmark_browser = boolean
+      end
+
+      def self.benchmark_browser?
+        @@benchmark_browser
+      end
+
       def self.benchmark_methods(level, options={})
         raise ConfigurationError.new("Method benchmark level can only be :disabled, :basic, :moderate, :full, or :custom") if !BENCHMARK_METHOD_LEVELS.include?(level)
 
@@ -159,7 +169,7 @@ module CopperEgg
 
         if @@app_root.empty?
           @@app_root =  if defined?(::Rails) && Rails.respond_to?(:root)
-                          Rails.root.to_s
+                          ::Rails.root.to_s
                         elsif defined?(RAILS_ROOT)
                           RAILS_ROOT
                         else
@@ -167,14 +177,20 @@ module CopperEgg
                         end
         end
 
-        if @@disabled
-          @@benchmark_sql = @@benchmark_active_record = @@benchmark_http = @@benchmark_exceptions = false
+        if @@disabled || @@instrument_key.empty?
+          @@benchmark_sql = @@benchmark_active_record = @@benchmark_http = @@benchmark_exceptions = @@benchmark_browser = false
           @@benchmark_methods_level   = :disabled
           @@only_methods              = []
           @@exclude_methods           = []
           @@include_methods           = []
-        elsif @@benchmark_methods_level != :disabled
-          CopperEgg::APM.add_method_benchmarking
+        else
+          if @@benchmark_methods_level != :disabled
+            CopperEgg::APM.add_method_benchmarking
+          end
+
+          if @@benchmark_browser && defined?(::Rails) && ::Rails.respond_to?(:configuration) && ::Rails.configuration.respond_to?(:middleware) && ::Rails.configuration.middleware.respond_to?(:use)
+            ::Rails.configuration.middleware.use CopperEgg::APM::RUMBlender
+          end
         end
       end
 

data/lib/copperegg/apm/railtie.rb

@@ -6,7 +6,7 @@ module CopperEgg
     class Railtie < ::Rails::Railtie
       initializer "copperegg_apm.helpers" do
         ActiveSupport.on_load_all do
-          helper CopperEgg::APM::Rum
+          helper CopperEgg::APM::RUM
         end
       end
       

data/lib/copperegg/apm/rum.rb

@@ -1,23 +1,22 @@
 module CopperEgg
   module APM
-    module Rum
-      def real_user_monitoring_javascript_tag
-        script = %Q(
-        <script type="text/javascript">
-        var BACON = BACON || {};
+    module RUM
+      def ce_rum_javascript_tag
+        tag = %Q(
+<script type="text/javascript">
+var BACON = BACON || {};
 
-        BACON.id = '#{CopperEgg::APM::Configuration.instrument_key}';
-        BACON.short_url = #{CopperEgg::APM::Configuration.rum_short_url};
-        BACON.beaconUrl = '#{CopperEgg::APM::Configuration.rum_beacon_url}';
+BACON.id = '#{Configuration.instrument_key}';
+BACON.short_url = #{Configuration.rum_short_url};
+BACON.beaconUrl = '#{Configuration.rum_beacon_url}';
 
-        BACON.starttime = new Date().getTime();
-        (function(d, s) { var js = d.createElement(s);
-            js.async = true; js.src = "http://cdn.copperegg.com/rum/bacon.min.js";
-            var s = d.getElementsByTagName(s)[0]; s.parentNode.insertBefore(js, s);
-        })(document, "script");
-        </script>
-        )
-        script.respond_to?(:html_safe) ? script.html_safe : script
+BACON.starttime = new Date().getTime();
+(function(d, s) { var js = d.createElement(s);
+    js.async = true; js.src = "http://cdn.copperegg.com/rum/bacon.min.js";
+    var s = d.getElementsByTagName(s)[0]; s.parentNode.insertBefore(js, s);
+})(document, "script");
+</script>)
+        tag.respond_to?(:html_safe) ? tag.html_safe : tag
       end
     end
   end

data/lib/copperegg/apm/rum_blender.rb

@@ -0,0 +1,51 @@
+require 'rack'
+
+module CopperEgg
+  module APM
+    class RUMBlender
+      include RUM
+      RUM_BLENDED_KEY = 'THIS_RUM_BLENDED_FOR_YOU_BY_COPPEREGG'
+
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        status, headers, response = @app.call(env)
+
+        if status != 200 || env[RUM_BLENDED_KEY] || !CopperEgg::APM::Configuration.benchmark_browser? || !html_request?(headers)
+          return [status, headers, response]
+        else
+          html = ''
+          response.each {|part| html << part}
+          open_head_tag_index   = html.index /<head[^>]*>/
+          close_head_tag_index  = html.index '</head>'
+          open_body_tag_index   = html.index /<body[^>]*>/
+          close_body_tag_index  = html.index '</body>'
+
+          if open_head_tag_index && open_head_tag_index < close_head_tag_index.to_i && open_head_tag_index < open_body_tag_index.to_i
+            html.sub!(/<head[^>]*>/) do |match|
+              match.to_s.insert(-1, ce_rum_javascript_tag)
+            end
+          elsif open_body_tag_index && open_body_tag_index < close_body_tag_index.to_i
+            html.sub!(/<body[^>]*>/) do |match|
+              match.to_s.insert(-1, ce_rum_javascript_tag)
+            end
+          else
+            return [status, headers, response]
+          end
+
+          headers['Content-Length'] = html.length if headers['Content-Length']
+          response = Rack::Response.new(html, status, headers)
+          response.finish
+        end
+      end
+
+      private
+
+      def html_request?(headers)
+        headers["Content-Type"].to_s =~ /text\/html/ && !(headers['Content-Disposition'].to_s =~ /attachment/)
+      end
+    end
+  end
+end

data/lib/copperegg/apm/version.rb

@@ -1,5 +1,5 @@
 module CopperEgg
   module APM
-    GEM_VERSION = '1.0.0.pre6' unless defined? GEM_VERSION
+    GEM_VERSION = '1.0.0.pre7' unless defined? GEM_VERSION
   end
 end

data/spec/rum_spec.rb

@@ -2,17 +2,17 @@
 require 'spec_helper'
 
 class String
-  include CopperEgg::APM::Rum
+  include CopperEgg::APM::RUM
 end
 
-describe CopperEgg::APM::Rum do
-  describe "#copperegg_real_user_monitoring" do
+describe CopperEgg::APM::RUM do
+  describe "#ce_rum_javascript_tag" do
     before do
       CopperEgg::APM::Configuration.rum_short_url = true
     end
 
     it "should return javascript" do
-      javascript = "".real_user_monitoring_javascript_tag
+      javascript = "".ce_rum_javascript_tag
 
       expect(javascript).to match(/^[\s\n]*<script type="text\/javascript">.*<\/script>[\s\n]*$/m)
       expect(javascript.include?("BACON.id = '#{CopperEgg::APM::Configuration.instrument_key}';")).to be_true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: copperegg-apm
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre6
+  version: 1.0.0.pre7
 platform: ruby
 authors:
 - Mike Bradford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-05 00:00:00.000000000 Z
+date: 2013-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -209,7 +209,7 @@ files:
 - ./lib/copperegg/apm/railtie.rb
 - ./lib/copperegg/apm/restclient/request.rb
 - ./lib/copperegg/apm/rum.rb
-- ./lib/copperegg/apm/rum_middleware.rb
+- ./lib/copperegg/apm/rum_blender.rb
 - ./lib/copperegg/apm/sqlite3/database.rb
 - ./lib/copperegg/apm/tasks.rb
 - ./lib/copperegg/apm/typhoeus/hydra.rb
@@ -293,7 +293,7 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: copperegg-apm-1.0.0.pre6
+summary: copperegg-apm-1.0.0.pre7
 test_files:
 - spec/action_controller_spec.rb
 - spec/apm_spec.rb

data/lib/copperegg/apm/rum_middleware.rb

@@ -1,45 +0,0 @@
-require 'rack'
-
-module CopperEgg
-  module APM
-    class RumMiddleware
-      RUM_INJECTED_KEY = "COPPEREGG_APM_RUM_INJECTED"
-
-      def initialize(app)
-        @app = app
-      end
-
-      def call(evn)
-        status, headers, response = @app.call(env)
-
-        if status != 200 || rum_injected?(env) || !html_request?(env)
-          return [status, headers, response]
-        elsif has_head_tag?(response)
-            # if html request, extract <head>...</head> from request
-
-            # if <head> is extracted, insert rum <script> tag at the bottom
-        else
-          return [status, headers, response]
-        end
-      end
-
-      private
-
-      def rum_injected?(env)
-        env[RUM_INJECTED_KEY]
-      end
-
-      def html_request?(env)
-        env["Content-Type"] && env["Content-Type"] =~ /text\/html/
-      end
-
-      def has_head_tag?(response)
-
-      end
-
-      def inject_rum(response, headers)
-
-      end
-    end
-  end
-end