oboe 1.3.5 → 1.3.6

data/lib/oboe/frameworks/rails/inst/action_controller.rb

@@ -13,7 +13,7 @@ module Oboe
       end
 
       def process_action(*args)
-        opts = {
+        report_kvs = {
           'HTTP-Host'   => @_request.headers['HTTP_HOST'],
           :URL          => @_request.headers['REQUEST_URI'],
           :Method       => @_request.headers['REQUEST_METHOD'],
@@ -22,12 +22,12 @@ module Oboe
         }
         super
 
-        opts[:Status] = @_response.status
-        Oboe::API.log('rails', 'info', opts)
+        report_kvs[:Status] = @_response.status
+        Oboe::API.log('rails', 'info', report_kvs)
       
       rescue Exception => exception
-        opts[:Status] = 500
-        Oboe::API.log('rails', 'info', opts)
+        report_kvs[:Status] = 500
+        Oboe::API.log('rails', 'info', report_kvs)
         raise
       end
 
@@ -54,6 +54,7 @@ if defined?(ActionController::Base)
       alias :perform_action_without_oboe :perform_action
       alias :rescue_action_without_oboe :rescue_action
       alias :process_without_oboe :process
+      alias :render_without_oboe :render
 
       def process(*args)
         header = args[0].headers['X-Trace']
@@ -63,25 +64,33 @@ if defined?(ActionController::Base)
       end
 
       def perform_action(*arguments)
-        opts = {
+        report_kvs = {
             'HTTP-Host'   => @_request.headers['HTTP_HOST'],
             :URL          => @_request.headers['REQUEST_URI'],
             :Method       => @_request.headers['REQUEST_METHOD'],
-            :Status       => @_response.status,
-            'Controller'  => @_request.path_parameters['controller'],
-            'Action'      => @_request.path_parameters['action']
+            :Controller  => @_request.path_parameters['controller'],
+            :Action      => @_request.path_parameters['action']
         }
 
-        Oboe::API.log('rails', 'info', opts)
         perform_action_without_oboe(*arguments)
+        begin
+          report_kvs[:Status] = @_response.status.to_i
+        rescue
+        end
+        Oboe::API.log('rails', 'info', report_kvs)
       end
 
       def rescue_action(exn)
         Oboe::API.log_exception('rails', exn)
         rescue_action_without_oboe(exn)
       end
+
+      def render(options = nil, extra_options = {}, &block)
+        Oboe::API.trace('render', {}) do
+          render_without_oboe(options, extra_options, &block)
+        end
+      end
     end
   end
   puts "[oboe/loading] Instrumenting ActionControler" if Oboe::Config[:verbose]
 end
-# vim:set expandtab:tabstop=2

data/lib/oboe/frameworks/rails/inst/action_view.rb

@@ -0,0 +1,191 @@
+# Copyright (c) 2012 by Tracelytics, Inc.
+# All rights reserved.
+
+if defined?(ActionView::Base)
+  if Rails::VERSION::MAJOR == 3
+    puts "[oboe/loading] Instrumenting ActionView" 
+
+    if Rails::VERSION::MINOR == 0
+      ActionView::Partials::PartialRenderer.class_eval do
+        alias :render_partial_without_oboe :render_partial
+        def render_partial(object = @object)
+          entry_kvs = {}
+          begin
+            entry_kvs[:Language]     = :ruby
+            entry_kvs[:ProfileName]  = @options[:partial] if @options.is_a?(Hash)
+            entry_kvs[:FunctionName] = :render_partial
+            entry_kvs[:Class]        = :PartialRenderer
+            entry_kvs[:Module]       = 'ActionView::Partials'
+            entry_kvs[:File]         = __FILE__
+            entry_kvs[:LineNumber]   = __LINE__
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
+          ret =  render_partial_without_oboe(object)
+
+          exit_kvs = {}
+          begin
+            exit_kvs[:Language] = :ruby
+            exit_kvs[:ProfileName]  = @options[:partial] if @options.is_a?(Hash)
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
+          ret
+        end
+        
+        alias :render_collection_without_oboe :render_collection
+        def render_collection
+          entry_kvs = {}
+          begin
+            entry_kvs[:Language]     = :ruby
+            entry_kvs[:ProfileName]  = @path
+            entry_kvs[:FunctionName] = :render_collection
+            entry_kvs[:Class]        = :PartialRenderer
+            entry_kvs[:Module]       = 'ActionView::Partials'
+            entry_kvs[:File]         = __FILE__
+            entry_kvs[:LineNumber]   = __LINE__
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
+          ret =  render_collection_without_oboe
+
+          exit_kvs = {}
+          begin
+            exit_kvs[:Language] = :ruby
+            exit_kvs[:ProfileName]  = @path
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
+          ret
+        end
+      end
+    else
+      ActionView::PartialRenderer.class_eval do
+        alias :render_partial_without_oboe :render_partial
+        def render_partial
+          entry_kvs = {}
+          begin
+            entry_kvs[:Language]     = :ruby
+            entry_kvs[:ProfileName]  = @options[:partial] if @options.is_a?(Hash)
+            entry_kvs[:FunctionName] = :render_partial
+            entry_kvs[:Class]        = :PartialRenderer
+            entry_kvs[:Module]       = :ActionView
+            entry_kvs[:File]         = __FILE__
+            entry_kvs[:LineNumber]   = __LINE__
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
+          ret =  render_partial_without_oboe
+
+          exit_kvs = {}
+          begin
+            exit_kvs[:Language] = :ruby
+            exit_kvs[:ProfileName]  = @options[:partial] if @options.is_a?(Hash)
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
+          ret
+        end
+
+        alias :render_collection_without_oboe :render_collection
+        def render_collection
+          entry_kvs = {}
+          begin
+            entry_kvs[:Language]     = :ruby
+            entry_kvs[:ProfileName]  = @path
+            entry_kvs[:FunctionName] = :render_collection
+            entry_kvs[:Class]        = :PartialRenderer
+            entry_kvs[:Module]       = :ActionView
+            entry_kvs[:File]         = __FILE__
+            entry_kvs[:LineNumber]   = __LINE__
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
+          ret =  render_collection_without_oboe
+
+          exit_kvs = {}
+          begin
+            exit_kvs[:Language] = :ruby
+            exit_kvs[:ProfileName]  = @path
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
+          ret
+        end
+      end
+    end
+  elsif Rails::VERSION::MAJOR == 2
+    puts "[oboe/loading] Instrumenting ActionView" 
+
+    ActionView::Partials.module_eval do
+      alias :render_partial_without_oboe :render_partial
+      def render_partial(options = {})
+        if options.has_key?(:partial) and options[:partial].is_a?(String)
+          entry_kvs = {}
+          begin
+            entry_kvs[:Language]     = :ruby
+            entry_kvs[:ProfileName]  = options[:partial]
+            entry_kvs[:FunctionName] = :render_partial
+            entry_kvs[:Class]        = :Partials
+            entry_kvs[:Module]       = :ActionView
+            entry_kvs[:File]         = __FILE__
+            entry_kvs[:LineNumber]   = __LINE__
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_entry', entry_kvs)
+          ret = render_partial_without_oboe(options)
+
+          exit_kvs = {}
+          begin
+            exit_kvs[:Language] = :ruby
+            exit_kvs[:ProfileName] = options[:partial]
+          rescue
+          end
+
+          Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
+        else
+          ret = render_partial_without_oboe(options)
+        end
+        ret
+      end
+      
+      alias :render_partial_collection_without_oboe :render_partial_collection
+      def render_partial_collection(options = {})
+        entry_kvs = {}
+        begin
+          entry_kvs[:Language]     = :ruby
+          entry_kvs[:ProfileName]  = :collection
+          entry_kvs[:FunctionName] = :render_partial_collection
+          entry_kvs[:Class]        = :Partials
+          entry_kvs[:Module]       = :ActionView
+          entry_kvs[:File]         = __FILE__
+          entry_kvs[:LineNumber]   = __LINE__
+        rescue
+        end
+
+        Oboe::Context.log(nil, 'profile_entry', entry_kvs)
+        ret =  render_partial_collection_without_oboe(options)
+
+        exit_kvs = {}
+        begin
+          exit_kvs[:Language] = :ruby
+          exit_kvs[:ProfileName] = :collection
+        rescue
+        end
+
+        Oboe::Context.log(nil, 'profile_exit', exit_kvs, false)
+        ret
+      end
+    end
+  end
+end
+# vim:set expandtab:tabstop=2

data/lib/oboe/frameworks/rails/inst/cassandra.rb

@@ -9,7 +9,7 @@ module Oboe
 
         begin
           report_kvs[:Op] = op.to_s
-          report_kvs[:Cf] = column_family.to_s
+          report_kvs[:Cf] = column_family.to_s if column_family
           report_kvs[:Key] = keys.to_s if keys
          
           # Open issue - how to handle multiple Cassandra servers
@@ -193,9 +193,12 @@ module Oboe
       def create_index_with_oboe(keyspace, column_family, column_name, validation_class)
         if Oboe::Config.tracing?
           report_kvs = extract_trace_details(:create_index, column_family, nil, nil)
-          report_kvs[:Keyspace] = keyspace.to_s
-          report_kvs[:Column_name] = column_name.to_s
-          report_kvs[:Validation_class] = validation_class.to_s
+          begin
+            report_kvs[:Keyspace] = keyspace.to_s
+            report_kvs[:Column_name] = column_name.to_s
+            report_kvs[:Validation_class] = validation_class.to_s
+          rescue
+          end
 
           Oboe::API.trace('cassandra', report_kvs) do
             create_index_without_oboe(keyspace, column_family, column_name, validation_class)
@@ -208,8 +211,11 @@ module Oboe
       def drop_index_with_oboe(keyspace, column_family, column_name)
         if Oboe::Config.tracing?
           report_kvs = extract_trace_details(:drop_index, column_family, nil, nil)
-          report_kvs[:Keyspace] = keyspace.to_s
-          report_kvs[:Column_name] = column_name.to_s
+          begin
+            report_kvs[:Keyspace] = keyspace.to_s
+            report_kvs[:Column_name] = column_name.to_s
+          rescue
+          end
 
           Oboe::API.trace('cassandra', report_kvs) do
             drop_index_without_oboe(keyspace, column_family, column_name)
@@ -222,7 +228,10 @@ module Oboe
       def add_column_family_with_oboe(cf_def)
         if Oboe::Config.tracing?
           report_kvs = extract_trace_details(:add_column_family, nil, nil, nil)
-          report_kvs[:Name] = cf_def[:name] if cf_def.is_a?(Hash) and cf_def.has_key?(:name)
+          begin
+            report_kvs[:Cf] = cf_def[:name] if cf_def.is_a?(Hash) and cf_def.has_key?(:name)
+          rescue
+          end
 
           Oboe::API.trace('cassandra', report_kvs) do
             add_column_family_without_oboe(cf_def)
@@ -247,7 +256,7 @@ module Oboe
       def add_keyspace_with_oboe(ks_def)
         if Oboe::Config.tracing?
           report_kvs = extract_trace_details(:add_keyspace, nil, nil, nil)
-          report_kvs[:Name] = ks_def[:name] if ks_def.is_a?(Hash) and ks_def.has_key?(:name)
+          report_kvs[:Name] = ks_def.name rescue ""
 
           Oboe::API.trace('cassandra', report_kvs) do
             add_keyspace_without_oboe(ks_def)
@@ -260,7 +269,7 @@ module Oboe
       def drop_keyspace_with_oboe(keyspace)
         if Oboe::Config.tracing?
           report_kvs = extract_trace_details(:drop_keyspace, nil, nil, nil)
-          report_kvs[:Name] = keyspace.to_s
+          report_kvs[:Name] = keyspace.to_s rescue ""
 
           Oboe::API.trace('cassandra', report_kvs) do
             drop_keyspace_without_oboe(keyspace)

data/lib/oboe/frameworks/rails/inst/mongo.rb

@@ -81,7 +81,7 @@ if defined?(::Mongo::Cursor)
               else
                 report_kvs[:Query] = 'all'
               end
-              report_kvs[:limit] = @limit if @limit != 0
+              report_kvs[:Limit] = @limit if @limit != 0
             end
 
           rescue
@@ -133,7 +133,7 @@ if defined?(::Mongo::Collection)
             if m == :map_reduce
               report_kvs[:Map_Function]    = args[0] 
               report_kvs[:Reduce_Function] = args[1]
-              report_kvs[:limit] = args[2][:limit] if args[2] and args[2].has_key?(:limit)
+              report_kvs[:Limit] = args[2][:limit] if args[2] and args[2].has_key?(:limit)
             end
 
             report_kvs[:New_Collection_Name] = args[0] if m == :rename
@@ -165,12 +165,12 @@ if defined?(::Mongo::Collection)
             args_length = args.length
 
             if m == :distinct and args_length >= 2
-              report_kvs[:key]   = args[0]
+              report_kvs[:Key]   = args[0]
               report_kvs[:Query] = args[1].try(:to_json) if args[1] and args[1].class == Hash
             end
 
             if m == :find and args_length > 0
-              report_kvs[:limit] = args[0][:limit] if !args[0].nil? and args[0].has_key?(:limit)
+              report_kvs[:Limit] = args[0][:limit] if !args[0].nil? and args[0].has_key?(:limit)
             end
 
             if m == :group

data/lib/oboe/version.rb

@@ -2,7 +2,7 @@ module Oboe
   module Version
     MAJOR = 1
     MINOR = 3
-    PATCH = 5
+    PATCH = 6
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/oboe_metal.rb

@@ -3,7 +3,7 @@
 
 module Oboe_metal
   class Context
-    def self.log(layer, label, options = {})
+    def self.log(layer, label, options = {}, with_backtrace = true)
       evt = Oboe::Context.createEvent()
       evt.addInfo("Layer", layer.to_s)
       evt.addInfo("Label", label.to_s)
@@ -12,7 +12,7 @@ module Oboe_metal
         evt.addInfo(k.to_s, v.to_s)
       end
 
-      evt.addInfo("Backtrace", Kernel.caller.join("\r\n"))
+      evt.addInfo("Backtrace", Kernel.caller.join("\r\n")) if with_backtrace
 
       Oboe.reporter.sendReport(evt)
     end

data/lib/rails/generators/oboe/install_generator.rb

@@ -0,0 +1,68 @@
+
+module Oboe
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.join(File.dirname(__FILE__), 'templates')
+    desc "Copies an oboe initializer files to your application."
+
+    def copy_initializer
+      # Set defaults
+      @tracing_mode = 'through'
+      @sampling_rate = '300000'
+      @verbose = 'false'
+
+      say ""
+      say set_color "Welcome to the Tracelytics Ruby instrumentation setup.", :green, :bold
+      say ""
+      say "To instrument your Rails application, you have the option to setup sampling strategies here."
+      say ""
+      say "More information on instrumenting Ruby applications can be found here:"
+      say "http://support.tracelytics.com/kb/ruby/instrumenting-ruby-apps"
+      while true do
+        say ""
+        say set_color "Tracing Mode", :green
+        say "------------"
+        say "When traces should be initiated for incoming requests. Valid options are 'always',"
+        say "'through' (when the request is initiated with a tracing header from upstream) and 'never'."
+        say "You must set this directive to 'always' in order to initiate tracing."
+        say ""
+        user_tracing_mode = ask set_color "* Tracing Mode? [through]:", :yellow
+        user_tracing_mode.downcase!
+
+        break if user_tracing_mode.blank?
+        valid = ['always', 'through', 'never'].include?(user_tracing_mode)
+        say set_color "Valid values are 'always', 'through' or 'never'", :red, :bold unless valid
+        if valid
+          @tracing_mode = user_tracing_mode
+          break
+        end
+      end
+
+      if @tracing_mode == "always"
+        while true do
+          say ""
+          say set_color "Sampling Rate", :green
+          say "-------------"
+          say "This value reflects the number of requests out of every million that will be traced, and must be an integer between 0 and 1000000. Default is 300000 (30%)."
+          say ""
+          user_sampling_rate = ask set_color "* Sampling Rate? [300000]:", :yellow
+          break if user_sampling_rate.blank?
+
+          valid = user_sampling_rate.to_i.between?(1, 1000000)
+          say set_color "Sampling Rate must be a number between 1 and 1000000", :red, :bold unless valid
+          if valid
+            @sampling_rate = user_sampling_rate.to_i
+            break
+          end
+        end
+      end
+
+      say ""
+      say "You can change these values in the future by modifying config/initializers/oboe.rb"
+      say ""
+      say "Thanks! Creating initialization file..."
+      say ""
+
+      template "oboe_initializer.rb", "config/initializers/oboe.rb"
+    end
+  end
+end

data/lib/rails/generators/oboe/templates/oboe_initializer.rb

@@ -0,0 +1,16 @@
+if defined?(::Oboe::Config) 
+  # When traces should be initiated for incoming requests. Valid options are 'always', 
+  # 'through' (when the request is initiated with a tracing header from upstream) and 'never'. 
+  # You must set this directive to 'always' in order to initiate tracing when there
+  # is no front-end webserver initiating traces.
+  Oboe::Config[:tracing_mode] = '<%= @tracing_mode %>'
+<% if ['through', 'never'].include?(@tracing_mode) %>
+  # sample_rate is a value from 0 - 1m indicating the fraction of requests per million to trace
+  # Oboe::Config[:sample_rate] = <%= @sampling_rate %>
+<% else %>
+  # sample_rate is a value from 0 - 1m indicating the fraction of requests per million to trace
+  Oboe::Config[:sample_rate] = <%= @sampling_rate %>
+<% end %>
+  # Verbose output of instrumentation initialization
+  # Oboe::Config[:verbose] = <%= @verbose %>
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oboe
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.3.6
   prerelease: 
 platform: ruby
 authors:
@@ -37,10 +37,13 @@ files:
 - lib/oboe/frameworks/rails/inst/action_controller.rb
 - lib/oboe/frameworks/rails/inst/dalli.rb
 - lib/oboe/frameworks/rails/inst/active_record.rb
+- lib/oboe/frameworks/rails/inst/action_view.rb
 - lib/oboe/frameworks/rails/inst/cassandra.rb
 - lib/oboe/frameworks/rails/inst/memcached.rb
 - lib/oboe/frameworks/rails/rails.rb
 - lib/oboe_fu.rb
+- lib/rails/generators/oboe/install_generator.rb
+- lib/rails/generators/oboe/templates/oboe_initializer.rb
 - lib/oboe/frameworks/rails/helpers/rum/rum_footer.js.erb
 - lib/oboe/frameworks/rails/helpers/rum/rum_ajax_header.js.erb
 - lib/oboe/frameworks/rails/helpers/rum/rum_header.js.erb