appoptics_apm 4.9.0 → 4.10.0

data/lib/appoptics_apm/inst/faraday.rb

@@ -37,7 +37,15 @@ module AppOpticsAPM
             AppOpticsAPM::XTrace.continue_service_context(xtrace, xtrace_new)
           end
           kvs = {}
-          kvs[:Middleware] = @builder.handlers
+
+          # this seems the safer condition than trying to identify the
+          # faraday version when adapter started to work without arg
+          # and handlers don't include the adapter anymore
+          if @builder.method(:adapter).parameters.find { |ele| ele[0] == :req }
+            kvs[:Middleware] = @builder.handlers
+          else
+            kvs[:Middleware] = [@builder.adapter] + @builder.handlers
+          end
           kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:faraday][:collect_backtraces]
 
           # Only send service KVs if we're not using an adapter
@@ -68,16 +76,20 @@ module AppOpticsAPM
 
       # This is only considered a remote service call if the middleware/adapter is not instrumented
       def remote_call?
-        (@builder.handlers.map(&:name) & APPOPTICS_INSTR_ADAPTERS).count == 0
+        if @builder.method(:adapter).parameters.find { |ele| ele[0] == :req }
+          (@builder.handlers.map(&:name) & APPOPTICS_INSTR_ADAPTERS).count == 0
+        else
+          ((@builder.handlers.map(&:name) << @builder.adapter.name) & APPOPTICS_INSTR_ADAPTERS).count == 0
+        end
       end
 
-      def rsc_kvs(url, method, result)
+      def rsc_kvs(_url, method, result)
         kvs = { :Spec => 'rsc',
                 :IsService => 1,
                 :HTTPMethod => method.upcase,
                 :HTTPStatus => result.status, }
         kvs[:Blacklisted] = true if url_blacklisted?
-        kvs[:RemoteURL] = result.to_hash[:url].to_s
+        kvs[:RemoteURL] = result.env.to_hash[:url].to_s
         kvs[:RemoteURL].split('?').first unless AppOpticsAPM::Config[:faraday][:log_args]
 
         kvs

data/lib/appoptics_apm/sdk/tracing.rb

@@ -32,6 +32,7 @@ module AppOpticsAPM
     # * +AppOpticsAPM::SDK.start_trace+
     # * +AppOpticsAPM::SDK.start_trace_with_target+
     # * +AppOpticsAPM::SDK.trace+
+    # * +AppOpticsAPM::SDK.trace_method+
     # * +AppOpticsAPM::SDK.tracing?+
     #
     # === Example:
@@ -207,6 +208,123 @@ module AppOpticsAPM
         result
       end
 
+      ##
+      # Add tracing to a given method
+      #
+      # This instruments the given method so that every time it is called it
+      # will create a span depending on the current context.
+      #
+      # The method can be of any (accessible) type (instance, singleton,
+      # private, protected etc.).
+      #
+      # The motivating use case for this is MetalController methods in Rails,
+      # which can't be auto-instrumented.
+      #
+      # === Arguments:
+      # * +klass+  - The module/class the method belongs to.
+      # * +method+ - The method name as symbol
+      # * +config+   - (optional) possible keys are:
+      #              :name the name of the span (default: the method name)
+      #              :backtrace true/false (default: false) if true the backtrace will be added to the space
+      # * +opts+    - (optional) hash containing key/value pairs that will be reported with this span.
+      #
+      # === Example:
+      #
+      #   module ExampleModule
+      #     def do_sum(a, b)
+      #       a + b
+      #     end
+      #   end
+      #
+      #  AppOpticsAPM::SDK.trace_method(ExampleModule, :do_sum, {name: 'computation', backtrace: true}, { CustomKey: "some_info"})
+      #
+      def trace_method(klass, method, config = {}, opts = {})
+        # 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 AppOpticsAPM.loaded
+
+        if !klass.is_a?(Module)
+          AppOpticsAPM.logger.warn "[appoptics_apm/error] trace_method: Not sure what to do with #{klass}.  Send a class or module."
+          return false
+        end
+
+        if method.is_a?(String)
+          method = method.to_sym
+        elsif !method.is_a?(Symbol)
+          AppOpticsAPM.logger.warn "[appoptics_apm/error] trace_method: Not sure what to do with #{method}.  Send a string or symbol for method."
+          return false
+        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
+          AppOpticsAPM.logger.warn "[appoptics_apm/error] trace_method: Can't instrument #{klass}.#{method} as it doesn't seem to exist."
+          AppOpticsAPM.logger.warn "[appoptics_apm/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_appoptics = "#{safe_method_name}_without_appoptics"
+        with_appoptics    = "#{safe_method_name}_with_appoptics"
+
+        # Check if already profiled
+        if instance_method && klass.instance_methods.include?(with_appoptics.to_sym) ||
+          class_method && klass.singleton_methods.include?(with_appoptics.to_sym)
+          AppOpticsAPM.logger.warn "[appoptics_apm/error] trace_method: #{klass}::#{method} already instrumented.\n#{__FILE__}:#{__LINE__}"
+          return false
+        end
+
+        report_kvs = opts.dup
+        if defined?(::AbstractController::Base) && klass.ancestors.include?(::AbstractController::Base)
+          report_kvs[:Controller] = klass.to_s
+          report_kvs[:Action] = method.to_s
+        else
+          klass.is_a?(Class) ? report_kvs[:Class] = klass.to_s : report_kvs[:Module] = klass.to_s
+          report_kvs[:MethodName] = safe_method_name
+        end
+        backtrace = config[:backtrace]
+
+        span = config[:name] || method
+        if instance_method
+          klass.class_eval do
+            define_method(with_appoptics) do |*args, &block|
+              # if this is a rails controller we want to set the transaction for the outbound metrics
+              if report_kvs[:Controller] && defined?(request) && defined?(request.env)
+                request.env['appoptics_apm.controller'] = report_kvs[:Controller]
+                request.env['appoptics_apm.action'] = report_kvs[:Action]
+              end
+
+              AppOpticsAPM::SDK.trace(span, report_kvs) do
+                report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace(2) if backtrace
+                send(without_appoptics, *args, &block)
+              end
+            end
+
+            alias_method without_appoptics, method.to_s
+            alias_method method.to_s, with_appoptics
+          end
+        elsif class_method
+          klass.define_singleton_method(with_appoptics) do |*args, &block|
+            AppOpticsAPM::SDK.trace(span, report_kvs) do
+              report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace(2) if backtrace
+              send(without_appoptics, *args, &block)
+            end
+          end
+
+          klass.singleton_class.class_eval do
+            alias_method without_appoptics, method.to_s
+            alias_method method.to_s, with_appoptics
+          end
+        end
+        true
+      end
+
+      ##
       # Provide a custom transaction name
       #
       # The AppOpticsAPM gem tries to create meaningful transaction names from controller+action

data/lib/appoptics_apm/support/transaction_metrics.rb

@@ -15,6 +15,7 @@ module AppOpticsAPM
       def metrics(env, settings)
         if settings.do_metrics
           req = ::Rack::Request.new(env)
+          # TODO rails 3x is not supported anymore ...
           url = req.url   # saving it here because rails3.2 overrides it when there is a 500 error
           start = Time.now
 

data/lib/appoptics_apm/version.rb

@@ -7,7 +7,7 @@ module AppOpticsAPM
   # appoptics_apm.gemspec during gem build process
   module Version
     MAJOR = 4 # breaking,
-    MINOR = 9 # feature,
+    MINOR = 10 # feature,
     PATCH = 0 # fix => BFF
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')

data/lib/appoptics_apm/xtrace.rb

@@ -97,16 +97,16 @@ module AppOpticsAPM
       # +finish+ is the context returned to us (as an HTTP response header
       # if that be the case)
       #
-      def continue_service_context(start, finish)
-        if AppOpticsAPM::XTrace.valid?(finish) && AppOpticsAPM.tracing?
+      def continue_service_context(start_xtrace, end_xtrace)
+        if AppOpticsAPM::XTrace.valid?(end_xtrace) && AppOpticsAPM.tracing?
 
-          # Assure that we received back a valid X-Trace with the same task_id
+          # Make sure that we received back a valid X-Trace with the same task_id
           # and the sampling bit is set, otherwise it is a response from a non-sampling service
-          if AppOpticsAPM::XTrace.task_id(start) == AppOpticsAPM::XTrace.task_id(finish) &&
-            AppOpticsAPM::XTrace.sampled?(finish)
-            AppOpticsAPM::Context.fromString(finish)
+          if AppOpticsAPM::XTrace.task_id(start_xtrace) == AppOpticsAPM::XTrace.task_id(end_xtrace) &&
+            AppOpticsAPM::XTrace.sampled?(end_xtrace)
+            AppOpticsAPM::Context.fromString(end_xtrace)
           else
-            AppOpticsAPM.logger.debug "[XTrace] Sampling flag unset or mismatched start and finish ids:\n#{start}\n#{finish}"
+            AppOpticsAPM.logger.debug "[XTrace] Sampling flag unset or mismatched start and finish ids:\n#{start_xtrace}\n#{end_xtrace}"
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.9.0
+  version: 4.10.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -117,7 +117,6 @@ files:
 - ".dockerignore"
 - ".github/ISSUE_TEMPLATE/bug-or-feature-request.md"
 - ".gitignore"
-- ".irbrc"
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
@@ -126,11 +125,8 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - appoptics_apm.gemspec
 - bin/appoptics_apm_config
-- build_gem.sh
-- build_gem_upload_to_packagecloud.sh
 - examples/SDK/01_basic_tracing.rb
 - examples/carrying_context.rb
 - ext/oboe_metal/README.md
@@ -151,7 +147,6 @@ files:
 - lib/appoptics_apm/api/logging.rb
 - lib/appoptics_apm/api/memcache.rb
 - lib/appoptics_apm/api/metrics.rb
-- lib/appoptics_apm/api/profiling.rb
 - lib/appoptics_apm/api/tracing.rb
 - lib/appoptics_apm/api/util.rb
 - lib/appoptics_apm/base.rb
@@ -160,13 +155,11 @@ files:
 - lib/appoptics_apm/frameworks/padrino.rb
 - lib/appoptics_apm/frameworks/rails.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller.rb
-- lib/appoptics_apm/frameworks/rails/inst/action_controller3.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller4.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller5.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller6.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_controller_api.rb
 - lib/appoptics_apm/frameworks/rails/inst/action_view.rb
-- lib/appoptics_apm/frameworks/rails/inst/action_view_30.rb
 - lib/appoptics_apm/frameworks/rails/inst/active_record.rb
 - lib/appoptics_apm/frameworks/rails/inst/connection_adapters/mysql.rb
 - lib/appoptics_apm/frameworks/rails/inst/connection_adapters/mysql2.rb
@@ -204,10 +197,8 @@ files:
 - lib/appoptics_apm/inst/twitter-cassandra.rb
 - lib/appoptics_apm/inst/typhoeus.rb
 - lib/appoptics_apm/instrumentation.rb
-- lib/appoptics_apm/legacy_method_profiling.rb
 - lib/appoptics_apm/loading.rb
 - lib/appoptics_apm/logger.rb
-- lib/appoptics_apm/method_profiling.rb
 - lib/appoptics_apm/noop/README.md
 - lib/appoptics_apm/noop/context.rb
 - lib/appoptics_apm/noop/metadata.rb
@@ -228,16 +219,9 @@ files:
 - lib/appoptics_apm/xtrace.rb
 - lib/joboe_metal.rb
 - lib/oboe.rb
-- lib/oboe/README
-- lib/oboe/backward_compatibility.rb
-- lib/oboe/inst/rack.rb
 - lib/oboe_metal.rb
 - lib/rails/generators/appoptics_apm/install_generator.rb
 - lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb
-- oboe.code-workspace
-- scrap.rb
-- scrap_gemfile
-- scrap_gemfile.lock
 - yardoc_frontpage.md
 homepage: https://www.appoptics.com/
 licenses:

data/Rakefile

@@ -1,236 +0,0 @@
-#!/usr/bin/env rake
-
-require 'rubygems'
-require 'fileutils'
-require 'open-uri'
-require 'bundler/setup'
-require 'rake/testtask'
-require 'appoptics_apm/test'
-
-Rake::TestTask.new do |t|
-  t.verbose = false
-  t.warning = false
-  t.ruby_opts = []
-  t.libs << 'test'
-
-  # Since we support so many libraries and frameworks, tests
-  # runs are segmented into gemfiles that have different
-  # sets and versions of gems (libraries and frameworks).
-  #
-  # Here we detect the Gemfile the tests are being run against
-  # and load the appropriate tests.
-  #
-  case AppOpticsAPM::Test.gemfile
-  when /delayed_job/
-    require 'delayed/tasks'
-    t.test_files = FileList['test/queues/delayed_job*_test.rb']
-  when /rails/
-    # Pre-load rails to get the major version number
-    require 'rails'
-
-    if Rails::VERSION::MAJOR == 5
-      t.test_files = FileList["test/frameworks/rails#{Rails::VERSION::MAJOR}x_test.rb"] +
-                     FileList["test/frameworks/rails#{Rails::VERSION::MAJOR}x_api_test.rb"]
-    elsif Rails::VERSION::MAJOR == 6
-      t.test_files = FileList["test/frameworks/rails5x_test.rb"] +
-                     FileList["test/frameworks/rails5x_api_test.rb"]
-    else
-      t.test_files = FileList["test/frameworks/rails#{Rails::VERSION::MAJOR}x_test.rb"]
-    end
-
-  when /frameworks/
-    t.test_files = FileList['test/frameworks/sinatra*_test.rb'] +
-                   FileList['test/frameworks/padrino*_test.rb'] +
-                   FileList['test/frameworks/grape*_test.rb']
-  when /libraries/
-    t.test_files = FileList['test/support/*_test.rb'] +
-                   FileList['test/reporter/*_test.rb'] +
-                   FileList['test/instrumentation/*_test.rb'] +
-                   FileList['test/profiling/*_test.rb'] -
-                   ['test/instrumentation/twitter-cassandra_test.rb']
-  when /instrumentation_mocked/
-    # WebMock is interfering with other tests, so these have to run separately
-    t.test_files = FileList['test/mocked/*_test.rb']
-  when /noop/
-    t.test_files = FileList['test/noop/*_test.rb']
-  when /unit/
-    t.test_files = FileList['test/unit/*_test.rb'] +
-                   FileList['test/unit/*/*_test.rb']
-  end
-
-  if defined?(JRUBY_VERSION)
-      t.ruby_opts << ['-J-javaagent:/usr/local/tracelytics/tracelyticsagent.jar']
-    end
-  end
-
-
-  desc "Run all test suites defined by travis"
-  task "docker_tests" do
-    Dir.chdir('test/run_tests')
-    exec('docker-compose run ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh test --remove-orphans')
-  end
-
-  desc "Start docker container for testing and debugging"
-  task "docker" do
-    Dir.chdir('test/run_tests')
-    exec('docker-compose run ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh bash --remove-orphans')
-  end
-
-  desc "Stop all containers that were started for testing and debugging"
-  task "docker_down" do
-    Dir.chdir('test/run_tests')
-    exec('docker-compose down')
-  end
-
-  desc "Fetch extension dependency files"
-  task :fetch_ext_deps do
-    swig_version = %x{swig -version} rescue ''
-    swig_version = swig_version.scan(/swig version [34].0.\d*/i)
-    if swig_version.empty?
-      $stderr.puts '== ERROR ================================================================='
-      $stderr.puts "Could not find required swig version >3.0.8, found #{swig_version.inspect}"
-      $stderr.puts 'Please install swig "~ 3.0.12" and try again.'
-      $stderr.puts '=========================================================================='
-      raise
-    end
-
-    # The c-lib version is different from the gem version
-    oboe_version = ENV['OBOE_VERSION'] || 'latest'
-    oboe_s3_dir = "https://s3-us-west-2.amazonaws.com/rc-files-t2/c-lib/#{oboe_version}"
-    ext_src_dir = File.expand_path('ext/oboe_metal/src')
-
-    # VERSION is used by extconf.rb to download the correct liboboe when installing the gem
-    remote_file = File.join(oboe_s3_dir, 'VERSION')
-    local_file = File.join(ext_src_dir, 'VERSION')
-    puts "fetching #{remote_file} to #{local_file}"
-    open(remote_file, 'rb') do |rf|
-      content = rf.read
-      File.open(local_file, 'wb') { |f| f.puts content }
-      puts "!!!!!!! C-Lib VERSION: #{content.strip} !!!!!!!!"
-    end
-
-    # oboe and bson header files
-    FileUtils.mkdir_p(File.join(ext_src_dir, 'bson'))
-    %w(oboe.h oboe.hpp oboe_debug.h oboe.i bson/bson.h bson/platform_hacks.h).each do |filename|
-    # %w(oboe.h oboe_debug.h bson/bson.h bson/platform_hacks.h).each do |filename|
-      remote_file = File.join(oboe_s3_dir, 'include', filename)
-      local_file = File.join(ext_src_dir, filename)
-
-      puts "fetching #{remote_file} to #{local_file}"
-      open(remote_file, 'rb') do |rf|
-        content = rf.read
-        File.open(local_file, 'wb') { |f| f.puts content }
-      end
-    end
-
-    FileUtils.cd(ext_src_dir) do
-      system('swig -c++ -ruby -module oboe_metal oboe.i')
-      FileUtils.rm('oboe.i')
-    end
-  end
-
-  task :fetch => :fetch_ext_deps
-
-desc "Build the gem's c extension"
-task :compile do
-  if !defined?(JRUBY_VERSION)
-    puts "== Building the c extension against Ruby #{RUBY_VERSION}"
-
-    pwd      = Dir.pwd
-    ext_dir  = File.expand_path('ext/oboe_metal')
-    final_so = File.expand_path('lib/oboe_metal.so')
-    so_file  = File.expand_path('ext/oboe_metal/oboe_metal.so')
-
-    Dir.chdir ext_dir
-    # ENV['APPOPTICS_FROM_S3'] = 'true'
-    cmd = [Gem.ruby, 'extconf.rb']
-    sh cmd.join(' ')
-    sh '/usr/bin/env make'
-
-    File.delete(final_so) if File.exist?(final_so)
-
-    if File.exist?(so_file)
-      FileUtils.mv(so_file, final_so)
-      Dir.chdir(pwd)
-      puts "== Extension built and moved to #{final_so}"
-    else
-      Dir.chdir(pwd)
-      puts '!! Extension failed to build (see above). Have the required binary and header files been fetched?'
-      puts '!! Try the tasks in this order: clean > fetch_ext_deps > compile.'
-    end
-  else
-    puts '== Nothing to do under JRuby.'
-  end
-end
-
-desc 'Clean up extension build files'
-task :clean do
-  if !defined?(JRUBY_VERSION)
-    pwd     = Dir.pwd
-    ext_dir = File.expand_path('ext/oboe_metal')
-    symlinks = [
-      File.expand_path('lib/oboe_metal.so'),
-      File.expand_path('ext/oboe_metal/lib/liboboe.so'),
-      File.expand_path('ext/oboe_metal/lib/liboboe-1.0.so.0')
-    ]
-
-    symlinks.each do |symlink|
-      FileUtils.rm_f symlink
-    end
-    Dir.chdir ext_dir
-    sh '/usr/bin/env make clean' if File.exist? 'Makefile'
-
-    FileUtils.rm_f "src/oboe_wrap.cxx"
-    Dir.chdir pwd
-  else
-    puts '== Nothing to do under JRuby.'
-  end
-end
-
-desc 'Remove all built files and extensions'
-task :distclean do
-  if !defined?(JRUBY_VERSION)
-    pwd     = Dir.pwd
-    ext_dir = File.expand_path('ext/oboe_metal')
-    mkmf_log = File.expand_path('ext/oboe_metal/mkmf.log')
-    symlinks = [
-      File.expand_path('lib/oboe_metal.so'),
-      File.expand_path('ext/oboe_metal/lib/liboboe.so'),
-      File.expand_path('ext/oboe_metal/lib/liboboe-1.0.so.0')
-    ]
-
-    if File.exist? mkmf_log
-      symlinks.each do |symlink|
-        FileUtils.rm_f symlink
-      end
-      Dir.chdir ext_dir
-      sh '/usr/bin/env make distclean' if File.exist? 'Makefile'
-
-      Dir.chdir pwd
-    else
-      puts 'Nothing to distclean. (nothing built yet?)'
-    end
-  else
-    puts '== Nothing to do under JRuby.'
-  end
-end
-
-desc "Rebuild the gem's c extension"
-task :recompile => [:distclean, :compile]
-
-task :environment do
-  ENV['APPOPTICS_GEM_VERBOSE'] = 'true'
-
-  Bundler.require(:default, :development)
-  AppOpticsAPM::Config[:tracing_mode] = :enabled
-  AppOpticsAPM::Test.load_extras
-
-  if AppOpticsAPM::Test.gemfile?(:delayed_job)
-    require 'delayed/tasks'
-  end
-end
-
-# Used when testing Resque locally
-task 'resque:setup' => :environment do
-  require 'resque/tasks'
-end