appoptics_apm 4.8.2 → 4.10.1

data/lib/appoptics_apm/version.rb

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

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

data/lib/rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb

@@ -50,7 +50,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:verbose] = false
 
   #
-  # Turn tracing on or off
+  # Turn Tracing on or off
   #
   # By default tracing is set to :enabled, the other option is :disabled.
   # :enabled means that sampling will be done according to the current
@@ -61,31 +61,41 @@ if defined?(AppOpticsAPM::Config)
   #
   AppOpticsAPM::Config[:tracing_mode] = :enabled
 
+  #
+  # Turn Trigger Tracing on or off
+  #
+  # By default trigger tracing is :enabled, the other option is :disabled.
+  # It allows to use the X-Trace-Options header to force a request to be
+  # traced (within rate limits set for trigger tracing)
+  #
+  AppOpticsAPM::Config[:trigger_tracing_mode] = :enabled
+
   #
   # Trace Context in Logs
   #
-  # Configure if and when the traceId should be included in application logs.
+  # Configure if and when the Trace ID should be included in application logs.
   # Common Ruby and Rails loggers are auto-instrumented, so that they can include
-  # the current traceId in log messages.
+  # the current Trace ID in log messages.
   #
   # The added string will look like: "ao.traceId=7435A9FE510AE4533414D425DADF4E180D2B4E36-0"
   # It ends in '-1' if the request is sampled and in '-0' otherwise.
   #
   # The following options are available:
   # :never    (default)
-  # :sampled  only include the traceId of sampled requests
-  # :traced   include the traceId for all traced requests
-  # :always   always add a traceId, it will be '0000000000000000000000000000000000000000-0'
+  # :sampled  only include the Trace ID of sampled requests
+  # :traced   include the Trace ID for all traced requests
+  # :always   always add a Trace ID, it will be '0000000000000000000000000000000000000000-0'
   #           when there is no tracing context.
   #
   AppOpticsAPM::Config[:log_traceId] = :never
 
   #
-  # Prepend domain to transaction name
+  # Prepend Domain to Transaction Name
   #
-  # If this is set to `true` transaction names will be composed as `my.host.com/controller.action` instead of
-  # `controller.action`. This configuration applies to all transaction names, whether deduced by the instrumentation
-  # or implicitly set.
+  # If this is set to `true` transaction names will be composed as
+  # `my.host.com/controller.action` instead of `controller.action`.
+  # This configuration applies to all transaction names, whether deduced by the
+  # instrumentation or implicitly set.
   #
   AppOpticsAPM::Config[:transaction_name][:prepend_domain] = false
 
@@ -195,6 +205,21 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:report_rescued_errors] = false
   #
 
+  #
+  # EC2 Metadata Fetching Timeout
+  #
+  # The timeout can be in the range 0 - 3000 (milliseconds)
+  # Setting to 0 milliseconds effectively disables fetching from
+  # the metadata URL (not waiting), and should only be used if
+  # not running on EC2 / Openstack to minimize agent start up time.
+  #
+  AppOpticsAPM::Config[:ec2_metadata_timeout] = 1000
+
+
+  #############################################
+  ## SETTINGS FOR INDIVIDUAL GEMS/FRAMEWORKS ##
+  #############################################
+
   #
   # Bunny Controller and Action
   #
@@ -235,7 +260,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:dalli][:enabled] = true
   AppOpticsAPM::Config[:delayed_jobclient][:enabled] = true
   AppOpticsAPM::Config[:delayed_jobworker][:enabled] = true
-  AppOpticsAPM::Config[:em_http_request][:enabled] = false
+  # AppOpticsAPM::Config[:em_http_request][:enabled] = false # not supported anymore
   AppOpticsAPM::Config[:excon][:enabled] = true
   AppOpticsAPM::Config[:faraday][:enabled] = true
   AppOpticsAPM::Config[:grpc_client][:enabled] = true
@@ -301,7 +326,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:dalli][:collect_backtraces] = false
   AppOpticsAPM::Config[:delayed_jobclient][:collect_backtraces] = false
   AppOpticsAPM::Config[:delayed_jobworker][:collect_backtraces] = false
-  AppOpticsAPM::Config[:em_http_request][:collect_backtraces] = true
+  # AppOpticsAPM::Config[:em_http_request][:collect_backtraces] = true # not supported anymore
   AppOpticsAPM::Config[:excon][:collect_backtraces] = true
   AppOpticsAPM::Config[:faraday][:collect_backtraces] = false
   AppOpticsAPM::Config[:grape][:collect_backtraces] = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.8.2
+  version: 4.10.1
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -125,13 +125,11 @@ 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
 - ext/oboe_metal/extconf.rb
 - ext/oboe_metal/lib/.keep
 - ext/oboe_metal/noop/noop.c
@@ -149,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
@@ -158,12 +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
@@ -201,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
@@ -216,6 +210,7 @@ files:
 - lib/appoptics_apm/sdk/tracing.rb
 - lib/appoptics_apm/support/transaction_metrics.rb
 - lib/appoptics_apm/support/transaction_settings.rb
+- lib/appoptics_apm/support/x_trace_options.rb
 - lib/appoptics_apm/support_report.rb
 - lib/appoptics_apm/test.rb
 - lib/appoptics_apm/thread_local.rb
@@ -224,9 +219,6 @@ 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
@@ -247,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -255,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: AppOptics APM performance instrumentation gem for Ruby

data/Rakefile

@@ -1,229 +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"]
-    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 3.0.\d*/i)
-  if swig_version.empty?
-    $stderr.puts '== ERROR ================================================================='
-    $stderr.puts "Could not find required swig version 3.0.*, found #{swig_version.inspect}"
-    $stderr.puts 'Please install swig "~ 3.0.8" 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
-
-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'
-
-    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