traceview 3.1.0-java → 3.2.1-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ab475ce550edae53924cbe72eaf7b93e337df71
-  data.tar.gz: 12ee03213258aa59f4fd7641247db417833cde06
+  metadata.gz: 96c087aab94a58d443be7e150a674f72cffbf110
+  data.tar.gz: 08616ab412adefe991cc489aecb9c960c64dc8db
 SHA512:
-  metadata.gz: c3f934605ce6a37c9e5b11d6d9490a01c279b104b6a4fe055bc8db4f76d63bf95df4591081b81534d8505d4c2fc2b5bffab4227bb1b6340253df5c03a6742943
-  data.tar.gz: c4a2ea84c0a5e861f7878304fb59aa66d3f9f47165bc909dd25ff95c74f745cd72984473d6e5955f8f3ceb9357a16a2b9f48715bd461bbe3ea546e62a33e8a20
+  metadata.gz: 8f950a8ad1c44cf89064f94c4eb17b26020a74e2c1156af6e4cb8cfc1c80612e0e96aefb4576bcff8ffab3908e0358a0c2d3edd0338c69cc2fd44215e6b0100d
+  data.tar.gz: 311bb5d286c6eef95149a6807f81334117a727ab1d440c773442c6d7c6ce6e8e647bfad93742b2ac1e227245b6d2aba988533d279404eabbf9482c9c91b66690

data/.travis.yml

@@ -63,8 +63,8 @@ before_install:
   - sudo service cassandra start
 
 install:
-  - wget https://www.tracelytics.com/install_tracelytics.sh
-  - sudo sh ./install_tracelytics.sh f51e2a43-0ee5-4851-8a54-825773b3218e
+  - wget https://files.appneta.com/install_appneta.sh
+  - sudo sh ./install_appneta.sh f51e2a43-0ee5-4851-8a54-825773b3218e
   - sudo apt-get install -y tracelytics-java-agent
 
 before_script:

data/CHANGELOG.md

@@ -4,6 +4,18 @@ https://github.com/appneta/oboe-ruby/releases
 
 Dates in this file are in the format MM/DD/YYYY.
 
+# traceview 3.2.0
+
+This minor release adds the following:
+
+* New and improved method profiling: #135
+* Fix URL Query config: #136
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/traceview/versions/3.2.0
+https://rubygems.org/gems/traceview/versions/3.2.0-java
+
 # traceview 3.1.0
 
 This minor release adds the following:

data/lib/traceview.rb

@@ -40,6 +40,7 @@ begin
 
   require 'traceview/config'
   require 'traceview/loading'
+  require 'traceview/legacy_method_profiling'
   require 'traceview/method_profiling'
 
   if TraceView.loaded

data/lib/traceview/api/profiling.rb

@@ -45,6 +45,152 @@ module TraceView
           TraceView::API.log(nil, 'profile_exit', exit_kvs)
         end
       end
+
+      ##
+      # Public: Profile a method on a class or module.  That method can be of any (accessible)
+      # type (instance, singleton, private, protected etc.).
+      #
+      # klass  - the class or module that has the method to profile
+      # method - the method to profile.  Can be singleton, instance, private etc...
+      # opts   - a hash specifying the one or more of the following options:
+      #   * :arguments  - report the arguments passed to <tt>method</tt> on each profile (default: false)
+      #   * :result     - report the return value of <tt>method</tt> on each profile (default: false)
+      #   * :backtrace  - report the return value of <tt>method</tt> on each profile (default: false)
+      #   * :name       - alternate name for the profile reported in the dashboard (default: method name)
+      # extra_kvs - a hash containing any additional KVs you would like reported with the profile
+      #
+      # Example
+      #
+      #   opts = {}
+      #   opts[:backtrace] = true
+      #   opts[:arguments] = false
+      #   opts[:name] = :array_sort
+      #
+      #   TraceView::API.profile_method(Array, :sort, opts)
+      #
+      def profile_method(klass, method, opts = {}, extra_kvs = {})
+
+        # If we're on an unsupported platform (ahem Mac), just act
+        # like we did something to nicely play the no-op part.
+        return true unless TraceView.loaded
+
+        if RUBY_VERSION < '1.9.3'
+          TraceView.logger.warn "[traceview/error] profile_method: Use the legacy method profiling for Ruby versions before 1.9.3"
+          return false
+
+        elsif !klass.is_a?(Module)
+          TraceView.logger.warn "[traceview/error] profile_method: Not sure what to do with #{klass}.  Send a class or module."
+          return false
+
+        elsif !method.is_a?(Symbol)
+          if method.is_a?(String)
+            method = method.to_sym
+          else
+            TraceView.logger.warn "[traceview/error] profile_method: Not sure what to do with #{method}.  Send a string or symbol for method."
+            return false
+          end
+        end
+
+        instance_method = klass.instance_methods.include?(method) || klass.private_instance_methods.include?(method)
+        class_method = klass.singleton_methods.include?(method)
+
+        # Make sure the request klass::method exists
+        if !instance_method && !class_method
+          TraceView.logger.warn "[traceview/error] profile_method: Can't instrument #{klass}.#{method} as it doesn't seem to exist."
+          TraceView.logger.warn "[traceview/error] #{__FILE__}:#{__LINE__}"
+          return false
+        end
+
+        # Strip '!' or '?' from method if present
+        safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
+        safe_method_name ||= method
+
+        without_traceview = "#{safe_method_name}_without_traceview"
+        with_traceview    = "#{safe_method_name}_with_traceview"
+
+        # Check if already profiled
+        if klass.instance_methods.include?(with_traceview.to_sym) ||
+          klass.singleton_methods.include?(with_traceview.to_sym)
+          TraceView.logger.warn "[traceview/error] profile_method: #{klass}::#{method} already profiled."
+          TraceView.logger.warn "[traceview/error] profile_method: #{__FILE__}:#{__LINE__}"
+          return false
+        end
+
+        source_location = []
+        if instance_method
+          ::TraceView::Util.send_include(klass, ::TraceView::MethodProfiling)
+          source_location = klass.instance_method(method).source_location
+        elsif class_method
+          ::TraceView::Util.send_extend(klass, ::TraceView::MethodProfiling)
+          source_location = klass.method(method).source_location
+        end
+
+        report_kvs = collect_profile_kvs(klass, method, opts, extra_kvs, source_location)
+        report_kvs[:MethodName] = safe_method_name
+
+        if instance_method
+          klass.class_eval do
+            define_method(with_traceview) { | *args, &block |
+              profile_wrapper(without_traceview, report_kvs, opts, *args, &block)
+            }
+
+            alias_method without_traceview, "#{method}"
+            alias_method "#{method}", with_traceview
+          end
+        elsif class_method
+          klass.define_singleton_method(with_traceview) { | *args, &block |
+            profile_wrapper(without_traceview, report_kvs, opts, *args, &block)
+          }
+
+          klass.singleton_class.class_eval do
+            alias_method without_traceview, "#{method}"
+            alias_method "#{method}", with_traceview
+          end
+        end
+        true
+      end
+
+      private
+
+      ##
+      # Private: Helper method to aggregate KVs to report
+      #
+      # klass  - the class or module that has the method to profile
+      # method - the method to profile.  Can be singleton, instance, private etc...
+      # opts   - a hash specifying the one or more of the following options:
+      #   * :arguments  - report the arguments passed to <tt>method</tt> on each profile (default: false)
+      #   * :result     - report the return value of <tt>method</tt> on each profile (default: false)
+      #   * :backtrace  - report the return value of <tt>method</tt> on each profile (default: false)
+      #   * :name       - alternate name for the profile reported in the dashboard (default: method name)
+      # extra_kvs - a hash containing any additional KVs you would like reported with the profile
+      # source_location - array returned from klass.method(:name).source_location
+      #
+      def collect_profile_kvs(klass, method, opts, extra_kvs, source_location)
+        report_kvs = {}
+        report_kvs[:Language] ||= :ruby
+        report_kvs[:ProfileName] ||= opts[:name] ? opts[:name] : method
+
+        if klass.is_a?(Class)
+          report_kvs[:Class] = klass.to_s
+        else
+          report_kvs[:Module] = klass.to_s
+        end
+
+        # If this is a Rails Controller, report the KVs
+        if defined?(::AbstractController::Base) && klass.ancestors.include?(::AbstractController::Base)
+          report_kvs[:Controller] = klass.to_s
+          report_kvs[:Action] = method.to_s
+        end
+
+        # We won't have access to this info for native methods (those not defined in Ruby).
+        if source_location.is_a?(Array) && source_location.length == 2
+          report_kvs[:File] = source_location[0]
+          report_kvs[:LineNumber] = source_location[1]
+        end
+
+        # Merge in any extra_kvs requested
+        report_kvs.merge!(extra_kvs)
+      end
     end
   end
 end

data/lib/traceview/api/util.rb

@@ -22,15 +22,16 @@ module TraceView
 
       # Internal: Get the current backtrace.
       #
-      # ignore - Number of frames to ignore at the end of the backtrace. Use
-      #          when you know how many layers deep in oboe the call is being
+      # ignore - Number of frames to ignore at the top of the backtrace. Use
+      #          when you know how many layers deep in the key call is being
       #          made.
       #
       # Returns a string with each frame of the backtrace separated by '\r\n'.
       #
-      # FIXME: ignore is not currently used (see BACKTRACE_CUTOFF)
-      def backtrace(_ignore = 1)
-        trim_backtrace(Kernel.caller).join("\r\n")
+      def backtrace(ignore = 0)
+        bt = Kernel.caller
+        bt.slice!(0, ignore)
+        trim_backtrace(bt).join("\r\n")
       end
 
       # Internal: Trim a backtrace to a manageable size

data/lib/traceview/base.rb

@@ -168,9 +168,8 @@ module TraceViewBase
   # False otherwise
   #
   def tracing?
-    return false unless TraceView.loaded
-
-    TraceView::Context.isValid && !TraceView.never?
+    return false if !TraceView.loaded || TraceView.never?
+    TraceView::Context.isValid
   end
 
   def log(layer, label, options = {})

data/lib/traceview/config.rb

@@ -18,7 +18,7 @@ module TraceView
                          :typhoeus]
 
     # Subgrouping of instrumentation
-    @@http_clients = [:curb, :excon, :faraday, :httpclient, :nethttp, :rest_client, :typhoeus]
+    @@http_clients = [:curb, :excon, :em_http_request, :faraday, :httpclient, :nethttp, :rest_client, :typhoeus]
 
     ##
     # Return the raw nested hash.
@@ -217,14 +217,14 @@ module TraceView
       elsif key == :include_url_query_params
         # Obey the global flag and update all of the per instrumentation
         # <tt>:log_args</tt> values.
-        @@http_clients.each do |i|
-          @@config[i][:log_args] = value
-        end
+        @@config[:rack][:log_args] = value
 
       elsif key == :include_remote_url_params
         # Obey the global flag and update all of the per instrumentation
         # <tt>:log_args</tt> values.
-        @@config[:rack][:log_args] = value
+        @@http_clients.each do |i|
+          @@config[i][:log_args] = value
+        end
       end
 
       # Update liboboe if updating :tracing_mode

data/lib/traceview/legacy_method_profiling.rb

@@ -0,0 +1,97 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+##
+# Provides the methods necessary for method profiling.  Profiling
+# results are sent to the TraceView dashboard.
+#
+# Example usage:
+# class MyApp
+#   include TraceViewMethodProfiling
+#
+#   def process_request()
+#     # The hard work
+#   end
+#
+#   # call syntax: profile_method <method>, <profile_name>
+#   profile_method :process_request, 'request_processor'
+# end
+module TraceViewMethodProfiling
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def profile_method_noop(*args)
+      nil
+    end
+
+    def profile_method_real(method_name, profile_name, store_args = false, store_return = false, *_)
+      begin
+        # this only gets file and line where profiling is turned on, presumably
+        # right after the function definition. ruby 1.9 and 2.0 has nice introspection (Method.source_location)
+        # but its appears no such luck for ruby 1.8
+        file = ''
+        line = ''
+        if RUBY_VERSION >= '1.9'
+          info = instance_method(method_name).source_location
+          unless info.nil?
+            file = info[0].to_s
+            line = info[1].to_s
+          end
+        else
+          info = Kernel.caller[0].split(':')
+          file = info.first.to_s
+          line = info.last.to_s
+        end
+
+        # Safety:  Make sure there are no quotes or double quotes to break the class_eval
+        file = file.gsub(/[\'\"]/, '')
+        line = line.gsub(/[\'\"]/, '')
+
+        # profiling via ruby-prof, is it possible to get return value of profiled code?
+        code = "def _traceview_profiled_#{method_name}(*args, &block)
+                  entry_kvs                  = {}
+                  entry_kvs['Language']      = 'ruby'
+                  entry_kvs['ProfileName']   = '#{TraceView::Util.prettify(profile_name)}'
+                  entry_kvs['FunctionName']  = '#{TraceView::Util.prettify(method_name)}'
+                  entry_kvs['File']          = '#{file}'
+                  entry_kvs['LineNumber']    = '#{line}'
+                  entry_kvs['Args']          = TraceView::API.pps(*args) if #{store_args}
+                  entry_kvs.merge!(::TraceView::API.get_class_name(self))
+
+                  TraceView::API.log(nil, 'profile_entry', entry_kvs)
+
+                  ret = _traceview_orig_#{method_name}(*args, &block)
+
+                  exit_kvs =  {}
+                  exit_kvs['Language'] = 'ruby'
+                  exit_kvs['ProfileName'] = '#{TraceView::Util.prettify(profile_name)}'
+                  exit_kvs['ReturnValue'] = TraceView::API.pps(ret) if #{store_return}
+
+                  TraceView::API.log(nil, 'profile_exit', exit_kvs)
+                  ret
+                end"
+      rescue => e
+        TraceView.logger.warn "[traceview/warn] profile_method: #{e.inspect}"
+      end
+
+      begin
+        class_eval code, __FILE__, __LINE__
+        alias_method "_traceview_orig_#{method_name}", method_name
+        alias_method method_name, "_traceview_profiled_#{method_name}"
+      rescue => e
+        TraceView.logger.warn "[traceview/warn] Fatal error profiling method (#{method_name}): #{e.inspect}" if TraceView::Config[:verbose]
+      end
+    end
+
+    # This allows this module to be included and called even if the gem is in
+    # no-op mode (no base libraries).
+    if TraceView.loaded
+      alias :profile_method :profile_method_real
+    else
+      alias :profile_method :profile_method_noop
+    end
+
+  end
+end

data/lib/traceview/method_profiling.rb

@@ -1,97 +1,25 @@
-# Copyright (c) 2013 AppNeta, Inc.
-# All rights reserved.
 
-##
-# Provides the methods necessary for method profiling.  Profiling
-# results are sent to the TraceView dashboard.
-#
-# Example usage:
-# class MyApp
-#   include TraceViewMethodProfiling
-#
-#   def process_request()
-#     # The hard work
-#   end
-#
-#   # call syntax: profile_method <method>, <profile_name>
-#   profile_method :process_request, 'request_processor'
-# end
-module TraceViewMethodProfiling
-  def self.included(klass)
-    klass.extend ClassMethods
-  end
+module TraceView
+  module MethodProfiling
+    def profile_wrapper(method, report_kvs, opts, *args, &block)
+      report_kvs[:Backtrace] = TraceView::API.backtrace(2) if opts[:backtrace]
+      report_kvs[:Arguments] = args if opts[:arguments]
 
-  module ClassMethods
-    def profile_method_noop(*args)
-      nil
-    end
+      TraceView::API.log(nil, 'profile_entry', report_kvs)
 
-    def profile_method_real(method_name, profile_name, store_args = false, store_return = false, *_)
       begin
-        # this only gets file and line where profiling is turned on, presumably
-        # right after the function definition. ruby 1.9 and 2.0 has nice introspection (Method.source_location)
-        # but its appears no such luck for ruby 1.8
-        file = ''
-        line = ''
-        if RUBY_VERSION >= '1.9'
-          info = instance_method(method_name).source_location
-          unless info.nil?
-            file = info[0].to_s
-            line = info[1].to_s
-          end
-        else
-          info = Kernel.caller[0].split(':')
-          file = info.first.to_s
-          line = info.last.to_s
-        end
-
-        # Safety:  Make sure there are no quotes or double quotes to break the class_eval
-        file = file.gsub(/[\'\"]/, '')
-        line = line.gsub(/[\'\"]/, '')
-
-        # profiling via ruby-prof, is it possible to get return value of profiled code?
-        code = "def _traceview_profiled_#{method_name}(*args, &block)
-                  entry_kvs                  = {}
-                  entry_kvs['Language']      = 'ruby'
-                  entry_kvs['ProfileName']   = '#{TraceView::Util.prettify(profile_name)}'
-                  entry_kvs['FunctionName']  = '#{TraceView::Util.prettify(method_name)}'
-                  entry_kvs['File']          = '#{file}'
-                  entry_kvs['LineNumber']    = '#{line}'
-                  entry_kvs['Args']          = TraceView::API.pps(*args) if #{store_args}
-                  entry_kvs.merge!(::TraceView::API.get_class_name(self))
-
-                  TraceView::API.log(nil, 'profile_entry', entry_kvs)
-
-                  ret = _traceview_orig_#{method_name}(*args, &block)
-
-                  exit_kvs =  {}
-                  exit_kvs['Language'] = 'ruby'
-                  exit_kvs['ProfileName'] = '#{TraceView::Util.prettify(profile_name)}'
-                  exit_kvs['ReturnValue'] = TraceView::API.pps(ret) if #{store_return}
-
-                  TraceView::API.log(nil, 'profile_exit', exit_kvs)
-                  ret
-                end"
+        rv = self.send(method, *args, &block)
+        report_kvs[:ReturnValue] = rv if opts[:result]
+        rv
       rescue => e
-        TraceView.logger.warn "[traceview/warn] profile_method: #{e.inspect}"
-      end
-
-      begin
-        class_eval code, __FILE__, __LINE__
-        alias_method "_traceview_orig_#{method_name}", method_name
-        alias_method method_name, "_traceview_profiled_#{method_name}"
-      rescue => e
-        TraceView.logger.warn "[traceview/warn] Fatal error profiling method (#{method_name}): #{e.inspect}" if TraceView::Config[:verbose]
+        TraceView::API.log_exception(nil, e)
+        raise
+      ensure
+        report_kvs.delete(:Backtrace)
+        report_kvs.delete(:Controller)
+        report_kvs.delete(:Action)
+        TraceView::API.log(nil, 'profile_exit', report_kvs)
       end
     end
-
-    # This allows this module to be included and called even if the gem is in
-    # no-op mode (no base libraries).
-    if TraceView.loaded
-      alias :profile_method :profile_method_real
-    else
-      alias :profile_method :profile_method_noop
-    end
-
   end
 end