appoptics_apm 4.8.4 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 37478c40a16c8636f4589a15e63db8d1b2eb0eae
-  data.tar.gz: 2f2ac3b316e00963c42593680e638ecfc1792e3b
+SHA256:
+  metadata.gz: c4b87b6581745b8485f7ddb38f17cb6eab85244a950e7d67cecfe0e97cdbd0bc
+  data.tar.gz: dce765afa7ceb92b523c448cd9b1b10efc1b6c5bb0f2f92842dc6af3c1934b27
 SHA512:
-  metadata.gz: f695fc74e9f23d799709c32faab13b8c8c56e2f7da34b6968a5f085daf964927d3c98ffcadc49be6ab181fb66a872a4ec97d121468f01ed205c449e0d0873abc
-  data.tar.gz: 730addb2cda57f6555d4965656cfeb1e753e32e7886e13cc1714c8b97b094664c4d0702a5494dc49ea7c266de6c101b25c4927a82ed652822890a581e45550b0
+  metadata.gz: d9b446519730872b09136e9b80e546a68dce40abf52fbb0e5ac139244c6ed3c7fa8ef45eb855714d8e11924886d0b972aa04332cec6342339c65772f5b7aec0f
+  data.tar.gz: 80df368e2ed2c868348ba5e7e9b24dfa2498d6f0cb703d568fbf8310879d06fee5ac59187a70747f04c040d4d54df2b8925faa856dc5a01b036375f21edacfbe

data/.gitignore

@@ -1,5 +1,5 @@
 oboe*.gem
-Gemfile.lock
+*.lock
 gemfiles/*.lock
 .ruby-version
 *~
@@ -27,3 +27,7 @@ coverage
 doc
 .*byebug*
 gemfiles/vendor*
+scrap.rb
+scarp_gemfile
+.irbrc
+*.code-workspace

data/.travis.yml

@@ -98,9 +98,9 @@ matrix:
 #  - sudo service cassandra start
 
 install:
-  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.8/swig-3.0.8.tar.gz
-  - tar xzf swig-3.0.8.tar.gz
-  - pushd swig-3.0.8
+  - curl -LO http://kent.dl.sourceforge.net/project/swig/swig/swig-3.0.12/swig-3.0.12.tar.gz
+  - tar xzf swig-3.0.12.tar.gz
+  - pushd swig-3.0.12
   - ./configure && make && sudo make install
   - popd
 
@@ -111,8 +111,8 @@ before_script:
   - export APPOPTICS_REPORTER_FILE_SINGLE=false
   - export APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
   - export APPOPTICS_TOKEN_BUCKET_RATE=1000
-  - export OBOE_VERSION=5.1.1
-  - bundle --jobs=3 --retry=3
+
+  - bundle update --jobs=3 --retry=3
   - bundle exec rake clean fetch compile
   - psql -c 'create database travis_ci_test;' -U postgres
   - mysql -e 'create database travis_ci_test;'

data/CONFIG.md

@@ -17,7 +17,7 @@ Name | Description | Default
 
 Name | Description | Default
 ---- | ----------- | -------
-`APPOPTICS_GEM_TEST` | puts the gem in test mode.  Traces are written to /tmp/trace_output.bson. | `false`
+`APPOPTICS_GEM_TEST` | puts the gem in test mode to avoid restarting certain background services used in testing.   `false`
 `DBTYPE` | For tests on Ruby on Rails, specifies the database type to test against.  `postgres`, `mysql` and `mysql2` are valid options. | `postgres`
 `APPOPTICS_CASSANDRA_SERVER` | specifies the Cassandra server to test against. | `127.0.0.1:9160`
 `APPOPTICS_MONGO_SERVER` | specifies the Mongo server to test against. | `127.0.0.1:27017`

data/Rakefile

@@ -59,76 +59,77 @@ Rake::TestTask.new do |t|
   end
 
   if defined?(JRUBY_VERSION)
-    t.ruby_opts << ['-J-javaagent:/usr/local/tracelytics/tracelyticsagent.jar']
+      t.ruby_opts << ['-J-javaagent:/usr/local/tracelytics/tracelyticsagent.jar']
+    end
   end
-end
-
-desc "Run all test suites defined by travis"
-task "docker_tests" do
-  Dir.chdir('test/run_tests')
-  exec('docker-compose run --rm 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 --rm 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 "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 "Fetch extension dependency files"
-task :fetch_ext_deps do
-  swig_version = %x{swig -version} rescue ''
-  swig_version = swig_version.scan(/swig version [34]/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.8" and try again.'
-    $stderr.puts '=========================================================================='
-    raise
+  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
 
-  # 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} !!!!!!!!"
+  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
 
-  # 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)
+  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
-  end
 
-  FileUtils.cd(ext_src_dir) do
-    system('swig -c++ -ruby -module oboe_metal oboe.i')
-    FileUtils.rm('oboe.i')
+    # 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
-end
 
-task :fetch => :fetch_ext_deps
+  task :fetch => :fetch_ext_deps
 
 desc "Build the gem's c extension"
 task :compile do
@@ -141,7 +142,7 @@ task :compile do
     so_file  = File.expand_path('ext/oboe_metal/oboe_metal.so')
 
     Dir.chdir ext_dir
-    ENV['APPOPTICS_FROM_S3'] = 'true'
+    # ENV['APPOPTICS_FROM_S3'] = 'true'
     cmd = [Gem.ruby, 'extconf.rb']
     sh cmd.join(' ')
     sh '/usr/bin/env make'
@@ -179,6 +180,7 @@ task :clean do
     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.'

data/appoptics_apm.gemspec

@@ -54,6 +54,6 @@ Automatic tracing and metrics for Ruby applications. Get started at appoptics.co
     s.add_development_dependency('benchmark-ips', '>= 2.7.2')
   end
 
-  s.required_ruby_version = '>= 2.0.0'
+  s.required_ruby_version = '>= 2.4.0'
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
 end

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-5.1.1
+6.0.0

data/lib/appoptics_apm.rb

@@ -49,6 +49,7 @@ begin
   if AppOpticsAPM.loaded
     require 'appoptics_apm/instrumentation'
     require 'appoptics_apm/support/transaction_metrics'
+    require 'appoptics_apm/support/x_trace_options'
 
     # Frameworks
     require 'appoptics_apm/frameworks/rails'

data/lib/appoptics_apm/config.rb

@@ -16,13 +16,16 @@ module AppOpticsAPM
     @@instrumentation = [:action_controller, :action_controller_api, :action_view,
                          :active_record, :bunnyclient, :bunnyconsumer, :cassandra, :curb,
                          :dalli, :delayed_jobclient, :delayed_jobworker,
-                         :em_http_request, :excon, :faraday, :grpc_client, :grpc_server, :grape,
+                         # :em_http_request,
+                         :excon, :faraday, :grpc_client, :grpc_server, :grape,
                          :httpclient, :nethttp, :memcached, :mongo, :moped, :padrino, :rack, :redis,
                          :resqueclient, :resqueworker, :rest_client,
                          :sequel, :sidekiqclient, :sidekiqworker, :sinatra, :typhoeus]
 
     # Subgrouping of instrumentation
-    @@http_clients = [:curb, :excon, :em_http_request, :faraday, :httpclient, :nethttp, :rest_client, :typhoeus]
+    @@http_clients = [:curb, :excon,
+                      # :em_http_request,
+                      :faraday, :httpclient, :nethttp, :rest_client, :typhoeus]
 
     ##
     # load_config_file
@@ -240,11 +243,15 @@ module AppOpticsAPM
         end
 
       elsif key == :tracing_mode
-      #   CAN'T DO THIS ANYMORE, ALL TRACING COMMUNICATION TO OBOE
+      #   CAN'T DO `set_tracing_mode` ANYMORE, ALL TRACING COMMUNICATION TO OBOE
       #   IS NOW HANDLED BY TransactionSettings
       #   AppOpticsAPM.set_tracing_mode(value.to_sym) if AppOpticsAPM.loaded
 
-      # Make sure that the mode is stored as a symbol
+        # Make sure that the mode is stored as a symbol
+        @@config[key.to_sym] = value.to_sym
+
+      elsif key == :trigger_tracing_mode
+        # Make sure that the mode is stored as a symbol
         @@config[key.to_sym] = value.to_sym
       end
     end

data/lib/appoptics_apm/inst/rack.rb

@@ -27,30 +27,30 @@ if AppOpticsAPM.loaded
       end
 
       def call(env)
-        incoming = AppOpticsAPM::Context.isValid
 
         # In the case of nested Ruby apps such as Grape inside of Rails
         # or Grape inside of Grape, each app has it's own instance
         # of rack middleware. We want to avoid tracing rack more than once
         return @app.call(env) if AppOpticsAPM.tracing? && AppOpticsAPM.layer == :rack
 
+        incoming = AppOpticsAPM::Context.isValid
         AppOpticsAPM.transaction_name = nil
 
         url = env['PATH_INFO']
+        options = AppOpticsAPM::XTraceOptions.new(env['HTTP_X_TRACE_OPTIONS'], env['HTTP_X_TRACE_OPTIONS_SIGNATURE'])
         xtrace = AppOpticsAPM::XTrace.valid?(env['HTTP_X_TRACE']) ? (env['HTTP_X_TRACE']) : nil
-
-        settings = AppOpticsAPM::TransactionSettings.new(url, xtrace)
-
-        # AppOpticsAPM.logger.warn "%%% FILTER: #{settings} %%%"
+        settings = AppOpticsAPM::TransactionSettings.new(url, xtrace, options)
 
         response =
           propagate_xtrace(env, settings, xtrace) do
-            sample(env, settings) do
+            sample(env, settings, options) do
               AppOpticsAPM::TransactionMetrics.metrics(env, settings) do
                 @app.call(env)
               end
             end
           end || [500, {}, nil]
+        options.add_response_header(response[1], settings)
+
         AppOpticsAPM::Context.clear unless incoming
         response
       rescue
@@ -66,7 +66,7 @@ if AppOpticsAPM.loaded
 
       private
 
-      def collect(env, settings)
+      def collect(env)
         req = ::Rack::Request.new(env)
         report_kvs = {}
 
@@ -84,8 +84,6 @@ if AppOpticsAPM.loaded
 
           report_kvs[:URL] = AppOpticsAPM::Config[:rack][:log_args] ? ::CGI.unescape(req.fullpath) : ::CGI.unescape(req.path)
           report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:rack][:collect_backtraces]
-          report_kvs[:SampleRate]        = settings.rate
-          report_kvs[:SampleSource]      = settings.source
 
           # Report any request queue'ing headers.  Report as 'Request-Start' or the summed Queue-Time
           report_kvs[:'Request-Start']     = env['HTTP_X_REQUEST_START']    if env.key?('HTTP_X_REQUEST_START')
@@ -126,11 +124,13 @@ if AppOpticsAPM.loaded
         [status, headers, response]
       end
 
-      def sample(env, settings)
+      def sample(env, settings, options)
         xtrace = env['HTTP_X_TRACE']
         if settings.do_sample
           begin
-            report_kvs = collect(env, settings)
+            report_kvs = collect(env)
+            settings.add_kvs(report_kvs)
+            options&.add_kvs(report_kvs, settings)
 
             AppOpticsAPM::API.log_start(:rack, xtrace, report_kvs, settings)
 

data/lib/appoptics_apm/oboe_init_options.rb

@@ -8,7 +8,7 @@ module AppOpticsAPM
   class OboeInitOptions
     include Singleton
 
-    attr_reader :reporter, :host, :service_name  # exposing these mainly for testing
+    attr_reader :reporter, :host, :service_name, :ec2_md_timeout  # exposing these mainly for testing
 
     # TODO decide if these globals are useful when testing
     # OBOE_HOSTNAME_ALIAS = 0
@@ -69,6 +69,8 @@ module AppOpticsAPM
       @token_bucket_rate = (ENV['APPOPTICS_TOKEN_BUCKET_RATE'] || -1).to_i
       # use single files in file reporter for each event
       @file_single = (ENV['APPOPTICS_REPORTER_FILE_SINGLE'].to_s.downcase == 'true') ? 1 : 0
+      # timeout for ec2 metadata
+      @ec2_md_timeout = read_and_validate_ec2_md_timeout
     end
 
     def re_init # for testing with changed ENV vars
@@ -94,7 +96,8 @@ module AppOpticsAPM
         @histogram_precision,
         @token_bucket_capacity,
         @token_bucket_rate,
-        @file_single
+        @file_single,
+        @ec2_md_timeout
       ]
     end
 
@@ -150,7 +153,7 @@ module AppOpticsAPM
     end
 
     def validate_token(token)
-      if (token !~ /^[0-9a-fA-F]{64}|[0-9a-zA-Z_\-]{71}$/) && ENV['APPOPTICS_COLLECTOR'] != "sslcollector:12222"
+      if (token !~ /^[0-9a-fA-F]{64}|[0-9a-zA-Z_-]{71}$/) && ENV['APPOPTICS_COLLECTOR'] != "sslcollector:12222"
         masked = "#{token[0..3]}...#{token[-4..-1]}"
         AppOpticsAPM.logger.error "[appoptics_apm/oboe_options] APPOPTICS_SERVICE_KEY problem. API Token in wrong format. Masked token: #{masked}"
         return false
@@ -178,6 +181,13 @@ module AppOpticsAPM
       @service_name = service_name # instance variable used in testing
       true
     end
+
+    def read_and_validate_ec2_md_timeout
+      timeout = (ENV['APPOPTICS_EC2_METADATA_TIMEOUT'] || AppOpticsAPM::Config[:ec2_metadata_timeout])
+      return 1000 unless timeout.is_a?(Integer) || timeout =~ /^\d+$/
+      timeout = timeout.to_i
+      return timeout.between?(0, 3000) ? timeout : 1000
+    end
   end
 end
 

data/lib/appoptics_apm/support/transaction_settings.rb

@@ -6,14 +6,9 @@ AO_TRACING_ENABLED = 1
 AO_TRACING_DISABLED = 0
 AO_TRACING_UNSET = -1
 
-AO_TRACING_DECISIONS_TRACING_DISABLED = -2
-AO_TRACING_DECISIONS_XTRACE_NOT_SAMPLED = -1
 AO_TRACING_DECISIONS_OK = 0
-AO_TRACING_DECISIONS_NULL_OUT = 1
-AO_TRACING_DECISIONS_NO_CONFIG = 2
-AO_TRACING_DECISIONS_REPORTER_NOT_READY = 3
-AO_TRACING_DECISIONS_NO_VALID_SETTINGS = 4
-AO_TRACING_DECISIONS_QUEUE_FULL = 5
+
+OBOE_SETTINGS_UNSET = -1
 
 module AppOpticsAPM
   ##
@@ -21,13 +16,15 @@ module AppOpticsAPM
   #
   class TransactionSettings
 
-    attr_accessor :do_metrics, :do_sample
-    attr_reader   :do_propagate, :rate, :source
+    attr_accessor :do_sample, :do_metrics
+    attr_reader   :auth_msg, :do_propagate, :status_msg, :type, :source, :rate, :xtrace
+                  #, :status
 
-    def initialize(url = nil, xtrace = '')
+    def initialize(url = '', xtrace = '', options = nil)
       @do_metrics = false
       @do_sample = false
       @do_propagate = true
+      @xtrace = xtrace || ''
       tracing_mode = AO_TRACING_ENABLED
 
       if AppOpticsAPM::Context.isValid
@@ -46,14 +43,23 @@ module AppOpticsAPM
         tracing_mode = AO_TRACING_DISABLED
       end
 
-      args = [xtrace || '']
+      args = [@xtrace]
       args << tracing_mode
-      args << AppOpticsAPM::Config[:sample_rate] if AppOpticsAPM::Config[:sample_rate]&. >= 0
+      args << (AppOpticsAPM::Config[:sample_rate] || OBOE_SETTINGS_UNSET)
+
+      if options && (options.options || options.signature)
+        args << (options.trigger_trace ? 1 : 0)
+        args << (trigger_tracing_mode_disabled? ? 0 : 1)
+        args << options.options
+        args << options.signature
+        args << options.timestamp
+      end
 
-      metrics, sample, @rate, @source, return_code = AppOpticsAPM::Context.getDecisions(*args)
+      metrics, sample, @rate, @source, @type, @auth, @status_msg, @auth_msg, @status =
+        AppOpticsAPM::Context.getDecisions(*args)
 
-      if return_code > AO_TRACING_DECISIONS_OK
-        AppOpticsAPM.logger.warn "[appoptics-apm/sample] Problem getting the sampling decisions, code: #{return_code}"
+      if @status > AO_TRACING_DECISIONS_OK
+        AppOpticsAPM.logger.warn "[appoptics-apm/sample] Problem getting the sampling decisions: #{@status_msg} code: #{@status}"
       end
 
       @do_metrics = metrics > 0
@@ -64,6 +70,20 @@ module AppOpticsAPM
       "do_propagate: #{do_propagate}, do_sample: #{do_sample}, do_metrics: #{do_metrics} rate: #{rate}, source: #{source}"
     end
 
+    def add_kvs(kvs)
+      kvs[:SampleRate] = @rate
+      kvs[:SampleSource] = @source
+    end
+
+    def triggered_trace?
+      @type == 1
+    end
+
+    def auth_ok?
+      # @auth is undefined if initialize is called with an existing context
+      !@auth || @auth < 1
+    end
+
     private
 
     ##
@@ -103,6 +123,11 @@ module AppOpticsAPM
       false
     end
 
+    def trigger_tracing_mode_disabled?
+      AppOpticsAPM::Config[:trigger_tracing_mode] &&
+        AppOpticsAPM::Config[:trigger_tracing_mode] == :disabled
+    end
+
     ##
     # asset?
     #

data/lib/appoptics_apm/support/x_trace_options.rb

@@ -0,0 +1,110 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+
+
+module AppOpticsAPM
+  class XTraceOptions
+
+    attr_reader :options, :signature, :trigger_trace, :timestamp
+    attr_reader :pd_keys, :custom_kvs, :ignored # used in tests
+    ##
+    # Params:
+    # +options+ : An X-Trace-Options @options string
+    # +signature+ : hmac signature to pass on for verification
+    #
+    # populates:
+    # - @force_trace (true|false)
+    # - @app_id (as given by Pingdom)
+    # - @probe_id (as given by Pingdom)
+    # - @loc (2 characters given by Pingdom)
+    # - @custom_kvs (hash)
+    # - @ignored (array)
+    #
+    # split it up by ';' separator
+    # kv assignment by '='
+    # currently valid keys:
+    # - force_trace (valid: 0,1) unless we use just a kv
+    # - application_id (format defined by pingdom (no validation))
+    # - probe_id
+    # - custom_* (';=' not allowed in key), value (validate max. length)
+    # - ts (unix timestamp)
+    # - other keys will be reported in the response options as ignored
+
+    def initialize(options, signature = nil)
+      @options = options.dup
+      @signature = signature.dup
+      @trigger_trace = false
+      @custom_kvs = {}
+      @pd_keys = nil
+      @ignored = []
+      @timestamp = 0
+
+      options&.split(/;+/)&.each do |val|
+        k = val.split('=', 2)
+
+        next unless k[0] # it can be nil, eg when the header starts with ';'
+
+        k[0]&.strip!
+        case k[0]
+        when 'trigger-trace'
+          if k[1]
+            @ignored << 'trigger-trace'
+          else
+            @trigger_trace = true
+          end
+        when 'pd-keys'
+          if @pd_keys
+            AppOpticsAPM.logger.info "[appoptics_apm/x-trace-options] Duplicate key: #{k[0]}"
+          else
+            @pd_keys = k[1].strip
+          end
+        when /^custom-[^\s]*$/
+          if @custom_kvs[k[0]]
+            AppOpticsAPM.logger.info "[appoptics_apm/x-trace-options] Duplicate key: #{k[0]}"
+          else
+            @custom_kvs[k[0]] = k[1].strip
+          end
+        when 'ts'
+          if @timestamp > 0
+            AppOpticsAPM.logger.info "[appoptics_apm/x-trace-options] Duplicate key: #{k[0]}"
+          else
+            @timestamp = k[1].to_i
+          end
+        else
+          @ignored << k[0]
+        end
+      end
+      unless @ignored.empty?
+        msg = "[appoptics_apm/x-trace-options] Some keys were ignored: #{@ignored.join(',' )}"
+        AppOpticsAPM.logger.info(msg)
+      end
+    end
+
+    def add_kvs(kvs, settings)
+      return unless settings.auth_ok?
+
+      @custom_kvs.each { |k,v| kvs[k] = v } unless @custom_kvs.empty?
+      kvs['PDKeys'] = @pd_keys if @pd_keys
+      kvs['TriggeredTrace'] = true if settings.triggered_trace?
+    end
+
+    def add_response_header(headers, settings)
+      return unless options
+
+      response = []
+      response << "auth=#{settings.auth_msg}" if @signature
+      if settings.auth_ok?
+        if @trigger_trace
+          trigger_msg = !settings.xtrace.empty? && settings.type == 0 ? 'ignored' : settings.status_msg
+        else
+          trigger_msg = 'not-requested'
+        end
+        response << "trigger-trace=#{trigger_msg}"
+        response << "ignored=#{@ignored.join(',')}" unless @ignored.empty?
+      end
+
+      headers['X-Trace-Options-Response'] = response.join(';')
+    end
+
+  end
+end

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 = 4 # fix => BFF
+    MINOR = 9 # feature,
+    PATCH = 0 # fix => BFF
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   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

data/scrap_gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'rails', '~> 6.0.0'
+gem 'puma'
+gem 'pg'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.8.4
+  version: 4.9.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-10 00:00:00.000000000 Z
+date: 2019-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -117,6 +117,7 @@ files:
 - ".dockerignore"
 - ".github/ISSUE_TEMPLATE/bug-or-feature-request.md"
 - ".gitignore"
+- ".irbrc"
 - ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
@@ -218,6 +219,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
@@ -232,6 +234,10 @@ files:
 - 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:
@@ -249,7 +255,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:
   - - ">="
@@ -257,7 +263,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: AppOptics APM performance instrumentation gem for Ruby