appoptics_apm 4.7.0 → 4.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: dbff2f2eda2d2c65cf7dbac060957eb6505b3eba743f11dc415f6b06c67217cb
-  data.tar.gz: 6008d6151ab8eb3b29aa465ebb131eef38139d159587e35d5d68dd07de716104
+SHA1:
+  metadata.gz: 37478c40a16c8636f4589a15e63db8d1b2eb0eae
+  data.tar.gz: 2f2ac3b316e00963c42593680e638ecfc1792e3b
 SHA512:
-  metadata.gz: 1247aa650e5ff98074d479248c01ff11c8b18f0c63dac47987f79b75efe7518987f43af8ce9adf63cf50df7b9f8d9024deb59da1b9d4b3bd9be56c9d70252114
-  data.tar.gz: 7196764529dfde97d4ca10871d9506a21e411454e5acdd0218945241de2acb22b1ece9e38876ed054d586ed695b276d602ebe116b1f08ff2cf5a98c9537fd5de
+  metadata.gz: f695fc74e9f23d799709c32faab13b8c8c56e2f7da34b6968a5f085daf964927d3c98ffcadc49be6ab181fb66a872a4ec97d121468f01ed205c449e0d0873abc
+  data.tar.gz: 730addb2cda57f6555d4965656cfeb1e753e32e7886e13cc1714c8b97b094664c4d0702a5494dc49ea7c266de6c101b25c4927a82ed652822890a581e45550b0

data/.travis.yml

@@ -11,10 +11,9 @@ env:
   - DBTYPE=mysql
 
 rvm:
-  - 2.6.2
-  - 2.5.3
+  - 2.6.4
+  - 2.5.5
   - 2.4.5
-  - 2.3.8
   - ruby-head
 #  - jruby-9.0.5.0
 
@@ -24,6 +23,7 @@ gemfile:
   - gemfiles/instrumentation_mocked.gemfile
   - gemfiles/instrumentation_mocked_oldgems.gemfile
   - gemfiles/frameworks.gemfile
+  - gemfiles/rails60.gemfile
   - gemfiles/rails52.gemfile
   - gemfiles/rails42.gemfile
   - gemfiles/delayed_job.gemfile
@@ -33,13 +33,14 @@ matrix:
   exclude:
     - rvm: ruby-head
       gemfile: gemfiles/rails42.gemfile
-    - rvm: 2.6.2
+    - rvm: 2.6.4
       gemfile: gemfiles/rails42.gemfile
+    - rvm: 2.4.5
+      gemfile: gemfiles/rails60.gemfile
 
-
-    - rmv: 2.6.2
+    - rmv: 2.6.4
       env: DBTYPE=mysql
-    - rvm: 2.5.3
+    - rvm: 2.5.5
       env: DBTYPE=mysql
     - rvm: 2.4.5
       env: DBTYPE=mysql
@@ -58,10 +59,10 @@ matrix:
       env: DBTYPE=mysql
     - gemfile: gemfiles/frameworks.gemfile
       env: DBTYPE=mysql
-    - gemfile: gemfiles/rails51.gemfile
-      env: DBTYPE=mysql
     - gemfile: gemfiles/rails52.gemfile
       env: DBTYPE=mysql
+    - gemfile: gemfiles/rails60.gemfile
+      env: DBTYPE=mysql
     - gemfile: gemfiles/delayed_job.gemfile
       env: DBTYPE=mysql
 
@@ -86,12 +87,15 @@ matrix:
 # Attempt Travis/Cassandra fix re: https://github.com/travis-ci/travis-ci/issues/1484
 # Updated Cassandra: https://github.com/travis-ci/travis-ci/issues/1650
 
-before_install:
-  - sudo service cassandra stop
-  - sudo sh -c "echo 'JVM_OPTS=\"\${JVM_OPTS} -Djava.net.preferIPv4Stack=false\"' >> /etc/cassandra/cassandra-env.sh"
-  - echo "127.0.0.1 localhost"  | sudo tee /etc/hosts
-  - echo "127.0.0.1 " `hostname` | sudo tee -a /etc/hosts
-  - sudo service cassandra start
+# the following is not working anymore on travis
+# commenting it out as per AO-13532 as we currently don't have instrumentation
+# for cassandra
+#before_install:
+#  - sudo service cassandra stop
+#  - sudo sh -c "echo 'JVM_OPTS=\"\${JVM_OPTS} -Djava.net.preferIPv4Stack=false\"' >> /etc/cassandra/cassandra-env.sh"
+#  - echo "127.0.0.1 localhost"  | sudo tee /etc/hosts
+#  - echo "127.0.0.1 " `hostname` | sudo tee -a /etc/hosts
+#  - 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
@@ -101,22 +105,32 @@ install:
   - popd
 
 before_script:
-  - bundle update --jobs=3 --retry=3
-  - bundle exec rake fetch_ext_deps
-  - bundle exec rake clean
-  - bundle exec rake compile
+  - export APPOPTICS_GEM_TEST=true
+  - export APPOPTICS_REPORTER=file
+  - export APPOPTICS_COLLECTOR=/tmp/appoptics_traces.bson
+  - 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 exec rake clean fetch compile
   - psql -c 'create database travis_ci_test;' -U postgres
   - mysql -e 'create database travis_ci_test;'
   - redis-server --requirepass secret_pass &
   - sleep 10
-  - export APPOPTICS_TOKEN_BUCKET_CAPACITY=1000
-  - export APPOPTICS_TOKEN_BUCKET_RATE=1000
 
 script: "N=1 bundle exec rake test"
 
 services:
   - mongodb
   - memcached
-  - cassandra
-#  - redis
+  - mysql
+#  - cassandra
+  - postgresql
+#  - redis-server
   - rabbitmq
+
+addons:
+  apt:
+    packages:
+      - rabbitmq-server

data/.yardopts

@@ -1,5 +1,6 @@
 --no-private
 --readme yardoc_frontpage.md
+lib/appoptics_apm/sdk/logging.rb
 lib/appoptics_apm/sdk/tracing.rb
 lib/appoptics_apm/sdk/custom_metrics.rb
 lib/appoptics_apm/sdk/current_trace.rb

data/README.md

@@ -2,7 +2,7 @@
 
 The appoptics_apm gem provides [AppOptics APM](https://www.appoptics.com/) performance instrumentation for Ruby.
 
-![Ruby AppOpticsAPM](https://docs.appoptics.com/_images/ruby_trace.png)
+![Ruby AppOpticsAPM](https://docs.appoptics.com/_images/ruby_trace_smaller.png)
 
 It has the ability to report performance metrics on an array of libraries, databases and frameworks such as Rails, 
 Mongo, Memcache, ActiveRecord, Cassandra, Rack, Resque 
@@ -390,4 +390,4 @@ See the README in the test directory.
 
 Copyright (c) 2018 SolarWinds, LLC
 
-Released under the [Librato Open License](https://docs.appoptics.com/kb/apm_tracing/librato-open-license/)
+Released under the [Librato Open License](https://docs.appoptics.com/kb/apm_tracing/librato-open-license/)

data/Rakefile

@@ -31,6 +31,9 @@ Rake::TestTask.new do |t|
     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
@@ -63,13 +66,13 @@ 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')
+  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 ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh bash --remove-orphans')
+  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"
@@ -81,11 +84,11 @@ 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)
+  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.*, found #{swig_version.inspect}"
-    $stderr.puts 'Please install swig "~ 3.0.8" and try again.'
+    $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
   end
@@ -108,6 +111,7 @@ task :fetch_ext_deps do
   # 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)
 
@@ -124,6 +128,8 @@ task :fetch_ext_deps do
   end
 end
 
+task :fetch => :fetch_ext_deps
+
 desc "Build the gem's c extension"
 task :compile do
   if !defined?(JRUBY_VERSION)

data/build_gem_upload_to_packagecloud.sh

@@ -8,13 +8,8 @@ else
   ./build_gem.sh
 fi
 
-# save current rbenv setting and switch to 2.4.1 for the package_cloud commands
-current_ruby=`rbenv global`
-rbenv global 2.4.1
+gem install package_cloud --no-document
 
 # prerequisite: package_cloud token needs to be in ~/.packagecloud
 gem=`ls -dt1 appoptics_apm-[^pre]*.gem | head -1`
 package_cloud push solarwinds/appoptics-apm-ruby $gem
-
-# restore ruby version
-rbenv global $current_ruby

data/examples/SDK/01_basic_tracing.rb

@@ -63,8 +63,6 @@ def do_traced_work
   end
 end
 
-# Example with logging
 AppOpticsAPM::SDK.start_trace('outer_span_2') do
-  AppopticsAPM.logger.warn "Hello World!"
   do_traced_work
 end

data/ext/oboe_metal/README.md

@@ -0,0 +1,69 @@
+# Debug the c-code with gdb
+
+inspired by: https://dev.to/wataash/how-to-create-and-debug-ruby-gem-with-c-native-extension-3l8b
+
+
+## install ruby with sources
+
+rbenv is your friend ;) 😄 -k means keep sources
+
+```
+rbenv install -k 2.6.3
+rbenv shell 2.6.3
+
+# check that ruby is debuggable
+type ruby           # => ruby is /home/wsh/.rbenv/shims/ruby
+rbenv which ruby    # => /home/wsh/.rbenv/versions/2.6.3/bin/ruby
+```
+
+
+##
+## add debug info when compiling appoptics_apm
+add this line to extconf.rb to turn off optimization
+
+```
+CONFIG["optflags"] = "-O0"
+```
+
+
+##
+## start ruby app with gdb
+
+This will run ruby and load the app with a breakpoint in the Reporter::startThread
+c-function.
+
+`bundle exec gdb -q -ex 'set breakpoint pending on' -ex 'b Reporter::startThread' -ex run --args ruby -e 'require "./app"'`
+
+If there is a bug in the ruby code or a ruby byebug binding that halts the 
+script, the debugger will hang without showing any output. 
+So, make sure `bundle exec ruby app.rb` runs.
+
+use the gdb navigation commands to step through the code. If it says:
+
+```
+(gdb) n
+Single stepping until exit from function _ZN8Reporter11startThreadEv@plt,
+which has no line number information.
+```
+
+type `c` and it may end up stopping in the right location.
+
+##
+## make ruby .gdbinit macros available
+
+These macros are pretty elaborate. They are checked in the ruby github 
+repo: https://github.com/ruby/ruby/blob/master/.gdbinit
+The code is nicely formatted and colorized in github and easiest to read there.
+
+installation in the user's home dir:
+```
+wget https://github.com/ruby/ruby/blob/master/.gdbinit
+```
+##
+## examples
+
+Some inspiring examples here:
+
+https://jvns.ca/blog/2016/06/12/a-weird-system-call-process-vm-readv/
+
+https://medium.com/@zanker/finding-a-ruby-bug-with-gdb-56d6b321bc86

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-4.1.0
+5.1.1

data/lib/appoptics_apm.rb

@@ -21,22 +21,23 @@ begin
       require 'joboe_metal'
     elsif RUBY_PLATFORM =~ /linux/
       require_relative './oboe_metal.so'
+      require 'appoptics_apm/oboe_init_options'
       require 'oboe_metal.rb'  # sets AppOpticsAPM.loaded = true if successful
     else
-      $stderr.puts '==================================================================='
-      $stderr.puts "AppOptics warning: Platform #{RUBY_PLATFORM} not yet supported."
-      $stderr.puts 'see: https://docs.appoptics.com/kb/apm_tracing/supported_platforms/'
-      $stderr.puts 'Tracing disabled.'
-      $stderr.puts 'Contact support@appoptics.com if this is unexpected.'
-      $stderr.puts '==================================================================='
+      AppOpticsAPM.logger.warn '==================================================================='
+      AppOpticsAPM.logger.warn "AppOptics warning: Platform #{RUBY_PLATFORM} not yet supported."
+      AppOpticsAPM.logger.warn 'see: https://docs.appoptics.com/kb/apm_tracing/supported_platforms/'
+      AppOpticsAPM.logger.warn 'Tracing disabled.'
+      AppOpticsAPM.logger.warn 'Contact support@appoptics.com if this is unexpected.'
+      AppOpticsAPM.logger.warn '==================================================================='
     end
   rescue LoadError => e
     unless ENV['RAILS_GROUP'] == 'assets' or ENV['IGNORE_APPOPTICS_WARNING']
-      $stderr.puts '=============================================================='
-      $stderr.puts 'Missing AppOpticsAPM libraries.  Tracing disabled.'
-      $stderr.puts "Error: #{e.message}"
-      $stderr.puts 'See: https://docs.appoptics.com/kb/apm_tracing/ruby/'
-      $stderr.puts '=============================================================='
+      AppOpticsAPM.logger.error '=============================================================='
+      AppOpticsAPM.logger.error 'Missing AppOpticsAPM libraries.  Tracing disabled.'
+      AppOpticsAPM.logger.error "Error: #{e.message}"
+      AppOpticsAPM.logger.error 'See: https://docs.appoptics.com/kb/apm_tracing/ruby/'
+      AppOpticsAPM.logger.error '=============================================================='
     end
   end
 
@@ -46,8 +47,6 @@ begin
   require 'appoptics_apm/method_profiling'
 
   if AppOpticsAPM.loaded
-    # tracing mode is configured via config file but can only be set once we have oboe_metal loaded
-    AppOpticsAPM.set_tracing_mode(AppOpticsAPM::Config[:tracing_mode].to_sym)
     require 'appoptics_apm/instrumentation'
     require 'appoptics_apm/support/transaction_metrics'
 
@@ -57,10 +56,11 @@ begin
     require 'appoptics_apm/frameworks/padrino'
     require 'appoptics_apm/frameworks/grape'
   else
-    $stderr.puts '=============================================================='
-    $stderr.puts 'AppOpticsAPM not loaded. Tracing disabled.'
-    $stderr.puts 'Service Key may be wrong or missing.'
-    $stderr.puts '=============================================================='
+    AppOpticsAPM.logger.warn '=============================================================='
+    AppOpticsAPM.logger.warn 'AppOpticsAPM not loaded. Tracing disabled.'
+    AppOpticsAPM.logger.warn 'There may be a problem with the service key or other settings.'
+    AppOpticsAPM.logger.warn 'Please check previous log messages.'
+    AppOpticsAPM.logger.warn '=============================================================='
     require 'appoptics_apm/noop/context'
     require 'appoptics_apm/noop/metadata'
   end

data/lib/appoptics_apm/base.rb

@@ -21,13 +21,10 @@ SAMPLE_SOURCE_MASK = 0b1111000000000000000000000000
 # ZERO_SAMPLE_RATE_MASK   = 0b1111000000000000000000000000
 # ZERO_SAMPLE_SOURCE_MASK = 0b0000111111111111111111111111
 
-APPOPTICS_STR_BLANK = ''.freeze
+# APPOPTICS_STR_BLANK = ''.freeze
 APPOPTICS_STR_LAYER = 'Layer'.freeze
 APPOPTICS_STR_LABEL = 'Label'.freeze
 
-# Used in tests to store local trace data
-TRACE_FILE = '/tmp/appoptics_traces.bson'.freeze
-
 ##
 # This module is the base module for the various implementations of AppOpticsAPM reporting.
 # Current variations as of 2014-09-10 are a c-extension, JRuby (using AppOpticsAPM Java

data/lib/appoptics_apm/config.rb

@@ -67,19 +67,22 @@ module AppOpticsAPM
         ].join(' ')
       end
       load(config_files[0])
-      check_env_vars
+      # sets AppOpticsAPM::Config[:debug_level], AppOpticsAPM.logger.level
+      set_log_level
+
+      # the verbose setting is only relevant for ruby, ENV['APPOPTICS_GEM_VERBOSE'] overrides
+      if ENV.key?('APPOPTICS_GEM_VERBOSE')
+        AppOpticsAPM::Config[:verbose] = ENV['APPOPTICS_GEM_VERBOSE'].downcase == 'true'
+      end
     end
 
-    # There are 4 variables that can be set in the config file or as env vars.
-    # Oboe will override vars passed in if it finds an environment variable
-    # :debug_level and :verbose need special consideration, because they are used in Ruby
-    def self.check_env_vars
+    def self.set_log_level
       unless (-1..6).include?(AppOpticsAPM::Config[:debug_level])
         AppOpticsAPM::Config[:debug_level] = 3
       end
 
-      # let's find and use the  equivalent debug level for ruby
-      debug_level = ENV['APPOPTICS_DEBUG_LEVEL'] ? ENV['APPOPTICS_DEBUG_LEVEL'].to_i : AppOpticsAPM::Config[:debug_level]
+      # let's find and use the equivalent debug level for ruby
+      debug_level = (ENV['APPOPTICS_DEBUG_LEVEL'] || AppOpticsAPM::Config[:debug_level] || 3).to_i
       if debug_level < 0
         # there should be no logging if APPOPTICS_DEBUG_LEVEL == -1
         # In Ruby level 5 is UNKNOWN and it can log, but level 6 is quiet
@@ -87,11 +90,7 @@ module AppOpticsAPM
       else
         AppOpticsAPM.logger.level = [4 - debug_level, 0].max
       end
-
-      # the verbose setting is only relevant for ruby, ENV['APPOPTICS_GEM_VERBOSE'] overrides
-      if ENV.key?('APPOPTICS_GEM_VERBOSE')
-        AppOpticsAPM::Config[:verbose] = ENV['APPOPTICS_GEM_VERBOSE'].downcase == 'true'
-      end
+      AppOpticsAPM::Config[:debug_level] = debug_level
     end
 
     ##
@@ -144,9 +143,6 @@ module AppOpticsAPM
       # no guarantee of completeness in the user's config file
       load(File.join(File.dirname(File.dirname(__FILE__)),
                     'rails/generators/appoptics_apm/templates/appoptics_apm_initializer.rb'))
-
-      # to make sure we include the service_key if it is set as an ENV var
-      check_env_vars
     end
     # rubocop:enable Metrics/AbcSize
 
@@ -243,11 +239,12 @@ module AppOpticsAPM
           @@config[i][:log_args] = value
         end
 
-      # Update liboboe if updating :tracing_mode
       elsif key == :tracing_mode
-        AppOpticsAPM.set_tracing_mode(value.to_sym) if AppOpticsAPM.loaded
+      #   CAN'T DO THIS 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
       end
     end

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

@@ -84,18 +84,18 @@ module AppOpticsAPM
 end
 
 # ActionController::Base
-if defined?(ActionController::Base) && AppOpticsAPM::Config[:action_controller][:enabled]
+if defined?(ActionController::Base) && AppOpticsAPM::Config[:action_controller][:enabled] && Rails::VERSION::MAJOR <= 6
   AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting actioncontroller' if AppOpticsAPM::Config[:verbose]
   require "appoptics_apm/frameworks/rails/inst/action_controller#{Rails::VERSION::MAJOR}"
   if Rails::VERSION::MAJOR >= 5
     ActionController::Base.send(:prepend, ::AppOpticsAPM::Inst::ActionController)
-  else
+  elsif Rails::VERSION::MAJOR < 5
     AppOpticsAPM::Util.send_include(::ActionController::Base, AppOpticsAPM::Inst::ActionController)
   end
 end
 
-# ActionController::API - Rails 5+ or via the rails-api gem
-if defined?(ActionController::API) && AppOpticsAPM::Config[:action_controller_api][:enabled]
+# ActionController::API - Rails 5 or via the rails-api gem
+if defined?(ActionController::API) && AppOpticsAPM::Config[:action_controller_api][:enabled]  && Rails::VERSION::MAJOR <= 6
   AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting actioncontroller api' if AppOpticsAPM::Config[:verbose]
   require "appoptics_apm/frameworks/rails/inst/action_controller_api"
   ActionController::API.send(:prepend, ::AppOpticsAPM::Inst::ActionControllerAPI)

data/lib/appoptics_apm/frameworks/rails/inst/action_controller6.rb

@@ -0,0 +1,50 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    #
+    # ActionController
+    #
+    # This modules contains the instrumentation code specific
+    # to Rails v6
+    #
+    module ActionController
+      include AppOpticsAPM::Inst::RailsBase
+
+      def process_action(method_name, *args)
+        kvs = {
+            :Controller   => self.class.name,
+            :Action       => self.action_name,
+        }
+        request.env['appoptics_apm.controller'] = kvs[:Controller]
+        request.env['appoptics_apm.action'] = kvs[:Action]
+
+        return super(method_name, *args) unless AppOpticsAPM.tracing?
+        begin
+          kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:action_controller][:collect_backtraces]
+
+          AppOpticsAPM::API.log_entry('rails', kvs)
+          super(method_name, *args)
+
+        rescue Exception => e
+          AppOpticsAPM::API.log_exception('rails', e) if log_rails_error?(e)
+          raise
+        ensure
+          AppOpticsAPM::API.log_exit('rails')
+        end
+      end
+
+      #
+      # render
+      #
+      # Our render wrapper that calls 'trace', which will log if we are tracing
+      #
+      def render(*args, &blk)
+        trace('actionview') do
+          super(*args, &blk)
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,7 @@
 # Copyright (c) 2016 SolarWinds, LLC.
 # All rights reserved.
 
-if defined?(ActionView::Base) && AppOpticsAPM::Config[:action_view][:enabled]
+if defined?(ActionView::Base) && AppOpticsAPM::Config[:action_view][:enabled]  && Rails::VERSION::MAJOR < 6
 
   ##
   # ActionView Instrumentation is version dependent.  ActionView 2.x is separate

data/lib/appoptics_apm/frameworks/rails/inst/active_record.rb

@@ -5,13 +5,13 @@ require 'appoptics_apm/frameworks/rails/inst/connection_adapters/mysql'
 require 'appoptics_apm/frameworks/rails/inst/connection_adapters/mysql2'
 require 'appoptics_apm/frameworks/rails/inst/connection_adapters/postgresql'
 
-if AppOpticsAPM::Config[:active_record][:enabled] && !defined?(JRUBY_VERSION)
+if AppOpticsAPM::Config[:active_record][:enabled] && !defined?(JRUBY_VERSION) && Rails::VERSION::MAJOR <= 6
   begin
     adapter = ActiveRecord::Base.connection_config[:adapter]
 
     if Rails::VERSION::MAJOR < 5
       require 'appoptics_apm/frameworks/rails/inst/connection_adapters/utils'
-    else
+    elsif Rails::VERSION::MAJOR >= 5
       require 'appoptics_apm/frameworks/rails/inst/connection_adapters/utils5x'
     end
 

data/lib/appoptics_apm/inst/logger_formatter.rb

@@ -23,13 +23,14 @@ module AppOpticsAPM
         if current_trace.log?
           case msg
           when ::String
-            msg.strip.empty? ? msg : insert_before_empty_lines(msg, current_trace.for_log)
+            msg = msg.strip.empty? ? msg : insert_before_empty_lines(msg, current_trace.for_log)
           when ::Exception
             # conversion to String copied from Logger::Formatter private method #msg2str
-            "#{msg.message} (#{msg.class}) #{current_trace.for_log}\n" <<
-              (msg.backtrace || []).join("\n")
+            msg = ("#{msg.message} (#{msg.class}) #{current_trace.for_log}\n" <<
+              (msg.backtrace || []).join("\n"))
           end
         end
+        msg
       end
 
       def insert_before_empty_lines(msg, for_log)

data/lib/appoptics_apm/inst/sidekiq-worker.rb

@@ -35,11 +35,12 @@ module AppOpticsAPM
       # args: 0: worker, 1: msg, 2: queue
       report_kvs = collect_kvs(args)
 
+      # TODO remove completely once it is determined that this works without
       # Something is happening across Celluloid threads where liboboe settings
       # are being lost.  So we re-set the tracing mode to assure
       # we sample as desired.  Setting the tracing mode will re-update
       # the liboboe settings.
-      AppOpticsAPM.set_tracing_mode(AppOpticsAPM::Config[:tracing_mode].to_sym)
+      # AppOpticsAPM.set_tracing_mode(AppOpticsAPM::Config[:tracing_mode].to_sym)
 
       # Continue the trace from the enqueue side?
       if args[1].is_a?(Hash) && AppOpticsAPM::XTrace.valid?(args[1]['SourceTrace'])

data/lib/appoptics_apm/oboe_init_options.rb

@@ -0,0 +1,183 @@
+# Copyright (c) 2019 SolarWinds, LLC.
+# All rights reserved.
+
+require 'singleton'
+
+module AppOpticsAPM
+
+  class OboeInitOptions
+    include Singleton
+
+    attr_reader :reporter, :host, :service_name  # exposing these mainly for testing
+
+    # TODO decide if these globals are useful when testing
+    # OBOE_HOSTNAME_ALIAS = 0
+    # OBOE_DEBUG_LEVEL = 1
+    # OBOE_LOGFILE = 2
+    #
+    # OBOE_MAX_TRANSACTIONS = 3
+    # OBOE_FLUSH_MAX_WAIT_TIME = 4
+    # OBOE_EVENTS_FLUSH_INTERVAL = 5
+    # OBOE_EVENTS_FLUSH_BATCH_SIZE = 6
+    #
+    # OBOE_REPORTER = 7
+    # OBOE_COLLECTOR = 8
+    # OBOE_SERVICE_KEY = 9
+    # OBOE_TRUSTEDPATH = 10
+    #
+    # OBOE_BUFSIZE = 11
+    # OBOE_TRACE_METRICS = 12
+    # OBOE_HISTOGRAM_PRECISION = 13
+    # OBOE_TOKEN_BUCKET_CAPACITY = 14
+    # OBOE_TOKEN_BUCKET_RATE = 15
+    # OBOE_FILE_SINGLE = 16
+
+    def initialize
+      # optional hostname alias
+      @hostname_alias = ENV['APPOPTICS_HOSTNAME_ALIAS'] || AppOpticsAPM::Config[:hostname_alias] || ''
+      # level at which log messages will be written to log file (0-6)
+      @debug_level = (ENV['APPOPTICS_DEBUG_LEVEL'] || AppOpticsAPM::Config[:debug_level] || 3).to_i
+      # file name including path for log file
+      # TODO eventually find better way to combine ruby and oboe logs
+      @log_file_path = ENV['APPOPTICS_LOGFILE'] || ''
+      # maximum number of transaction names to track
+      @max_transactions = (ENV['APPOPTICS_MAX_TRANSACTIONS'] || -1).to_i
+      # maximum wait time for flushing data before terminating in milli seconds
+      @max_flush_wait_time = (ENV['APPOPTICS_FLUSH_MAX_WAIT_TIME'] || -1).to_i
+      # events flush timeout in seconds (threshold for batching messages before sending off)
+      @events_flush_interval = (ENV['APPOPTICS_EVENTS_FLUSH_INTERVAL'] || -1).to_i
+      # events flush batch size in KB (threshold for batching messages before sending off)
+      @event_flush_batch_size = (ENV['APPOPTICS_EVENTS_FLUSH_BATCH_SIZE'] || -1).to_i
+
+      # the reporter to be used (ssl, upd, file, null)
+      # collector endpoint (reporter=ssl), udp address (reporter=udp), or file path (reporter=file)
+      @reporter, @host = reporter_and_host
+
+      # the service key
+      @service_key = read_and_validate_service_key
+      # path to the SSL certificate (only for ssl)
+      @trusted_path = ENV['APPOPTICS_TRUSTEDPATH'] || ''
+      # size of the message buffer
+      @buffer_size = (ENV['APPOPTICS_BUFSIZE'] || -1).to_i
+      # flag indicating if trace metrics reporting should be enabled (default) or disabled
+      @trace_metrics = (ENV['APPOPTICS_TRACE_METRICS'] || -1).to_i
+      # the histogram precision (only for ssl)
+      @histogram_precision = (ENV['APPOPTICS_HISTOGRAM_PRECISION'] || -1).to_i
+      # custom token bucket capacity
+      @token_bucket_capacity = (ENV['APPOPTICS_TOKEN_BUCKET_CAPACITY'] || -1).to_i
+      # custom token bucket rate
+      @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
+    end
+
+    def re_init # for testing with changed ENV vars
+      initialize
+    end
+
+    def array_for_oboe
+      [
+        @hostname_alias,
+        @debug_level,
+        @log_file_path,
+        @max_transactions,
+        @max_flush_wait_time,
+        @events_flush_interval,
+        @event_flush_batch_size,
+
+        @reporter,
+        @host,
+        @service_key,
+        @trusted_path,
+        @buffer_size,
+        @trace_metrics,
+        @histogram_precision,
+        @token_bucket_capacity,
+        @token_bucket_rate,
+        @file_single
+      ]
+    end
+
+    def service_key_ok?
+      return !@service_key.empty? || @reporter != 'ssl'
+    end
+
+    private
+
+    def reporter_and_host
+
+      reporter = ENV['APPOPTICS_REPORTER'] || 'ssl'
+      # override with 'file', e.g. when running tests
+      # changed my mind => set the right reporter in the env when running tests !!!
+      # reporter = 'file' if ENV.key?('APPOPTICS_GEM_TEST')
+
+      host = ''
+      case reporter
+      when 'ssl', 'file'
+        host = ENV['APPOPTICS_COLLECTOR'] || ''
+      when 'udp'
+        host = ENV['APPOPTICS_COLLECTOR'] ||
+                "#{AppOpticsAPM::Config[:reporter_host]}:#{AppOpticsAPM::Config[:reporter_port]}"
+        # TODO decide what to do
+        # ____ AppOpticsAPM::Config[:reporter_host] and
+        # ____ AppOpticsAPM::Config[:reporter_port] were moved here from
+        # ____ oboe_metal.rb and are not documented anywhere
+        # ____ udp is for internal use only
+      when 'null'
+        host = ''
+      end
+
+      [reporter, host]
+    end
+
+    def read_and_validate_service_key
+      return '' unless @reporter == 'ssl'
+
+      service_key = ENV['APPOPTICS_SERVICE_KEY'] || AppOpticsAPM::Config[:service_key]
+      unless service_key
+        AppOpticsAPM.logger.error "[appoptics_apm/oboe_options] APPOPTICS_SERVICE_KEY not configured."
+        return ''
+      end
+
+      match = service_key.match( /([^:]+)(:{0,1})(.*)/ )
+      token = match[1]
+      service_name = match[3]
+
+      return '' unless validate_token(token)
+      return '' unless validate_transform_service_name(service_name)
+
+      return "#{token}:#{service_name}"
+    end
+
+    def validate_token(token)
+      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
+      end
+
+      true
+    end
+
+    def validate_transform_service_name(service_name)
+      service_name = 'test_ssl_collector' if ENV['APPOPTICS_COLLECTOR'] == "sslcollector:12222"
+      if service_name.empty?
+        AppOpticsAPM.logger.error "[appoptics_apm/oboe_options] APPOPTICS_SERVICE_KEY problem. Service Name is missing"
+        return false
+      end
+
+      name = service_name.dup
+      name.downcase!
+      name.gsub!(/[^a-z0-9.:_-]/, '')
+      name = name[0..254]
+
+      if name != service_name
+        AppOpticsAPM.logger.warn "[appoptics_apm/oboe_options] APPOPTICS_SERVICE_KEY problem. Service Name transformed from #{service_name} to #{name}"
+        service_name = name
+      end
+      @service_name = service_name # instance variable used in testing
+      true
+    end
+  end
+end
+

data/lib/appoptics_apm/support/transaction_settings.rb

@@ -17,7 +17,7 @@ AO_TRACING_DECISIONS_QUEUE_FULL = 5
 
 module AppOpticsAPM
   ##
-  # This module helps with setting up the filters and applying them
+  # This module helps with setting up the transaction filters and applying them
   #
   class TransactionSettings
 
@@ -40,8 +40,9 @@ module AppOpticsAPM
         return
       end
 
-      if AppOpticsAPM.tracing_disabled? && !tracing_enabled?(url) ||
+      if tracing_mode_disabled? && !tracing_enabled?(url) ||
         tracing_disabled?(url)
+
         tracing_mode = AO_TRACING_DISABLED
       end
 
@@ -51,7 +52,6 @@ module AppOpticsAPM
 
       metrics, sample, @rate, @source, return_code = AppOpticsAPM::Context.getDecisions(*args)
 
-      puts "return_code class: #{return_code.class}" unless return_code.is_a? Integer
       if return_code > AO_TRACING_DECISIONS_OK
         AppOpticsAPM.logger.warn "[appoptics-apm/sample] Problem getting the sampling decisions, code: #{return_code}"
       end
@@ -65,6 +65,14 @@ module AppOpticsAPM
     end
 
     private
+
+    ##
+    # check the config setting for :tracing_mode
+    def tracing_mode_disabled?
+      AppOpticsAPM::Config[:tracing_mode] &&
+        [:disabled, :never].include?(AppOpticsAPM::Config[:tracing_mode])
+    end
+
     ##
     # tracing_enabled?
     #

data/lib/appoptics_apm/version.rb

@@ -6,9 +6,9 @@ module AppOpticsAPM
   # The current version of the gem.  Used mainly by
   # appoptics_apm.gemspec during gem build process
   module Version
-    MAJOR = 4
-    MINOR = 7
-    PATCH = 0
+    MAJOR = 4 # breaking,
+    MINOR = 8 # feature,
+    PATCH = 4 # fix => BFF
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/oboe_metal.rb

@@ -18,25 +18,12 @@ module AppOpticsAPM
       # Start the AppOpticsAPM Reporter
       #
       def start
+        AppOpticsAPM.loaded = false unless AppOpticsAPM::OboeInitOptions.instance.service_key_ok?
         return unless AppOpticsAPM.loaded
 
         begin
-          options = []
-
-          ENV['APPOPTICS_REPORTER'] = 'file' if ENV.key?('APPOPTICS_GEM_TEST')
-
-          case ENV['APPOPTICS_REPORTER']
-          when 'file'
-            ENV['APPOPTICS_REPORTER_FILE'] = TRACE_FILE
-          when 'udp'
-            ENV['APPOPTICS_REPORTER_UDP'] = "#{AppOpticsAPM::Config[:reporter_host]}:#{AppOpticsAPM::Config[:reporter_port]}"
-          else # default is ssl, service_key is mandatory
-            return unless valid_service_key?
-            # Oboe will override these settings if there are env settings for them
-            options << AppOpticsAPM::Config[:service_key].to_s
-            options << AppOpticsAPM::Config[:hostname_alias].to_s
-            options << AppOpticsAPM::Config[:debug_level] unless AppOpticsAPM::Config[:debug_level].nil?
-          end
+          options = AppOpticsAPM::OboeInitOptions.instance.array_for_oboe # creates an array with the options in the right order
+
           AppOpticsAPM.reporter = Oboe_metal::Reporter.new(*options)
 
           # Only report __Init from here if we are not instrumenting a framework.
@@ -52,19 +39,6 @@ module AppOpticsAPM
       end
       alias :restart :start
 
-      def valid_service_key?
-        service_key = (ENV['APPOPTICS_SERVICE_KEY'] || AppOpticsAPM::Config[:service_key]).to_s
-        if service_key == ''
-          AppOpticsAPM.logger.warn '[appoptics_apm/warn] APPOPTICS_SERVICE_KEY not set. Cannot submit data.'
-          AppOpticsAPM.loaded = false
-          return false
-        elsif service_key !~ /^[0-9a-fA-F]{64}:[-.:_?\\\/\w ]{1,255}$/
-          AppOpticsAPM.logger.warn '[appoptics_apm/warn] APPOPTICS_SERVICE_KEY problem. No service name or api token in wrong format. Cannot submit data.'
-          AppOpticsAPM.loaded = false
-          return false
-        end
-        true
-      end
       ##
       # sendReport
       #
@@ -89,7 +63,7 @@ module AppOpticsAPM
       # Truncates the trace output file to zero
       #
       def clear_all_traces
-        File.truncate(TRACE_FILE, 0)
+        File.truncate(AppOpticsAPM::OboeInitOptions.instance.host, 0)
       end
 
       ##
@@ -98,14 +72,14 @@ module AppOpticsAPM
       # Retrieves all traces written to the trace file
       #
       def get_all_traces
-        io = File.open(TRACE_FILE, 'r')
+        io = File.open(AppOpticsAPM::OboeInitOptions.instance.host, 'r')
         contents = io.readlines(nil)
+        io.close
 
         return contents if contents.empty?
 
         traces = []
 
-        #
         # We use Gem.loaded_spec because older versions of the bson
         # gem didn't even have a version embedded in the gem.  If the
         # gem isn't in the bundle, it should rightfully error out
@@ -140,49 +114,49 @@ module AppOpticsAPM
   end
 
   class << self
-    def sample?(opts = {})
-      # Return false if no-op mode
-      return false unless AppOpticsAPM.loaded
-
-      # Assure defaults since SWIG enforces Strings
-      xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip       : APPOPTICS_STR_BLANK
-
-      # the first arg has changed to be the service name, blank means to use the default (from the service key)
-      rv = AppOpticsAPM::Context.sampleRequest(APPOPTICS_STR_BLANK, xtrace)
-
-      if rv == 0
-        AppOpticsAPM.sample_rate = -1
-        AppOpticsAPM.sample_source = -1
-        false
-      else
-        # liboboe version > 1.3.1 returning a bit masked integer with SampleRate and
-        # source embedded
-        AppOpticsAPM.sample_rate = (rv & SAMPLE_RATE_MASK)
-        AppOpticsAPM.sample_source = (rv & SAMPLE_SOURCE_MASK) >> 24
-        true
-      end
-    rescue StandardError => e
-      AppOpticsAPM.logger.debug "[oboe/error] sample? error: #{e.inspect}"
-      false
-    end
-
-    def set_tracing_mode(mode)
-      return unless AppOpticsAPM.loaded
-
-      value = mode.to_sym
-
-      case value
-      when :disabled, :never
-        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_DISABLED)
-
-      when :enabled, :always
-        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_ENABLED)
-
-      else
-        AppOpticsAPM.logger.fatal "[oboe/error] Invalid tracing mode set: #{mode}"
-        AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_DISABLED)
-      end
-    end
+    # def sample?(opts = {})
+    #   # Return false if no-op mode
+    #   return false unless AppOpticsAPM.loaded
+    #
+    #   # Assure defaults since SWIG enforces Strings
+    #   xtrace  = opts[:xtrace]     ? opts[:xtrace].to_s.strip       : APPOPTICS_STR_BLANK
+    #
+    #   # the first arg has changed to be the service name, blank means to use the default (from the service key)
+    #   rv = AppOpticsAPM::Context.sampleRequest(APPOPTICS_STR_BLANK, xtrace)
+    #
+    #   if rv == 0
+    #     AppOpticsAPM.sample_rate = -1
+    #     AppOpticsAPM.sample_source = -1
+    #     false
+    #   else
+    #     # liboboe version > 1.3.1 returning a bit masked integer with SampleRate and
+    #     # source embedded
+    #     AppOpticsAPM.sample_rate = (rv & SAMPLE_RATE_MASK)
+    #     AppOpticsAPM.sample_source = (rv & SAMPLE_SOURCE_MASK) >> 24
+    #     true
+    #   end
+    # rescue StandardError => e
+    #   AppOpticsAPM.logger.debug "[oboe/error] sample? error: #{e.inspect}"
+    #   false
+    # end
+
+    # def set_tracing_mode(mode)
+    #   return unless AppOpticsAPM.loaded
+    #
+    #   value = mode.to_sym
+    #
+    #   case value
+    #   when :disabled, :never
+    #     AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_DISABLED)
+    #
+    #   when :enabled, :always
+    #     AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_ENABLED)
+    #
+    #   else
+    #     AppOpticsAPM.logger.fatal "[oboe/error] Invalid tracing mode set: #{mode}"
+    #     AppOpticsAPM::Context.setTracingMode(APPOPTICS_TRACE_DISABLED)
+    #   end
+    # end
 
     def set_sample_rate(rate)
       return unless AppOpticsAPM.loaded

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.4
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-23 00:00:00.000000000 Z
+date: 2019-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -132,6 +132,7 @@ files:
 - 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
@@ -161,6 +162,7 @@ files:
 - 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
@@ -208,6 +210,7 @@ files:
 - lib/appoptics_apm/noop/README.md
 - lib/appoptics_apm/noop/context.rb
 - lib/appoptics_apm/noop/metadata.rb
+- lib/appoptics_apm/oboe_init_options.rb
 - lib/appoptics_apm/ruby.rb
 - lib/appoptics_apm/sdk/current_trace.rb
 - lib/appoptics_apm/sdk/custom_metrics.rb
@@ -254,7 +257,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