appoptics_apm 4.5.2 → 4.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 2f6f74865135bb353e7f453b844739e7c0a93d4c38d38d36982c7710f7f31907
-  data.tar.gz: cafe57a6604f715e5f33c2dcf657803d256cf3dea951facbc19ca05be1e7865b
+SHA1:
+  metadata.gz: cbe2fe3eb37b24986942279b151f1b75bcc1d992
+  data.tar.gz: 44afa0ee08b1835b75bfab6bfd18380d43bb9df4
 SHA512:
-  metadata.gz: 230aaaa311ae7741a6e65168326a79a7e7cee82edf857827d9ce4dff07624a6f3acff4a655a5fa98ac4d53ed05f90b2a71282cf995259c4e7d2e48ad7d3de9ba
-  data.tar.gz: 8f43e985fb4379c9c61356a2d24189710db9a1c1c2c9d03bfbc0727ac5e4fdcf7c66dd706120b6e908a346ef1e8942d40a6d28548c02d25554d2c923fbd52e89
+  metadata.gz: ea8bbfb90ddee8a6eeac9acba93eda3a66645ca409ded1d15fbb73ef2e9c05f14f0b0052072826a4f5e9704311e5509c528a4de613a902edfe646b8210bae19d
+  data.tar.gz: 4282a917fc4d523c471bb2d322f5bff18348b0154d5f18562fad85c8f777e421f091390f11c78adf4e19d75fe7da34c7ac8b9d1a8457239fa89c5b90836fe2ef

data/.travis.yml

@@ -11,11 +11,11 @@ env:
   - DBTYPE=mysql
 
 rvm:
-  - 2.6.0
+  - 2.6.2
   - 2.5.3
   - 2.4.5
   - 2.3.8
-#  - ruby-head
+  - ruby-head
 #  - jruby-9.0.5.0
 
 gemfile:
@@ -33,10 +33,11 @@ matrix:
   exclude:
     - rvm: ruby-head
       gemfile: gemfiles/rails42.gemfile
-    - rvm: 2.6.0
+    - rvm: 2.6.2
       gemfile: gemfiles/rails42.gemfile
 
-    - rmv: 2.6.0
+
+    - rmv: 2.6.2
       env: DBTYPE=mysql
     - rvm: 2.5.3
       env: DBTYPE=mysql

data/Gemfile

@@ -15,9 +15,9 @@ group :development, :test do
   gem 'benchmark-ips'
   gem 'ruby-debug',   :platforms =>  :jruby
   gem 'debugger',     :platform  =>  :mri_19
-  gem 'byebug',       :platforms => [:mri_22, :mri_23, :mri_24]
-  gem 'pry'
-  gem 'pry-byebug',   :platforms => [:mri_22, :mri_23, :mri_24]
+  gem 'byebug'
+  gem 'get_process_mem'
+  gem 'memory_profiler'
 end
 
 if defined?(JRUBY_VERSION)

data/README.md

@@ -185,8 +185,8 @@ Bundler.require
 require 'appoptics_apm'
  
 
-# Tracing mode can be 'never', 'through' (to follow upstream) or 'always'
-AppOpticsAPM::Config[:tracing_mode] = 'always'
+# Tracing mode can be :enabled or :disabled
+AppOpticsAPM::Config[:tracing_mode] = :enabled
  
 #
 # Update April 9, 2015 - this is done automagically now
@@ -233,7 +233,7 @@ Find more details in the [RubyDoc page](https://www.rubydoc.info/gems/appoptics_
 
 # Support
 
-If you find a bug or would like to request an enhancement, feel free to contact our tech support 
+If you run into a problem, find a bug, or would like to request an enhancement, feel free to contact our tech support 
 [support@appoptics.com](support@appoptics.com).  
 
 # Contributing

data/Rakefile

@@ -63,13 +63,19 @@ end
 desc "Run all test suites defined by travis"
 task "docker_tests" do
   Dir.chdir('test/run_tests')
-  exec('docker-compose run --service-ports ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh test')
+  exec('docker-compose run ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh test')
 end
 
 desc "Start docker container for testing and debugging"
 task "docker" do
   Dir.chdir('test/run_tests')
-  exec('docker-compose run --service-ports ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh bash')
+  exec('docker-compose run ruby_appoptics /code/ruby-appoptics/test/run_tests/ruby_setup.sh bash')
+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"
@@ -208,7 +214,7 @@ task :environment do
   ENV['APPOPTICS_GEM_VERBOSE'] = 'true'
 
   Bundler.require(:default, :development)
-  AppOpticsAPM::Config[:tracing_mode] = :always
+  AppOpticsAPM::Config[:tracing_mode] = :enabled
   AppOpticsAPM::Test.load_extras
 
   if AppOpticsAPM::Test.gemfile?(:delayed_job)
@@ -216,14 +222,6 @@ task :environment do
   end
 end
 
-task :console => :environment do
-  ARGV.clear
-  if AppOpticsAPM::Test.gemfile?(:delayed_job)
-    require './test/servers/delayed_job'
-  end
-  Pry.start
-end
-
 # Used when testing Resque locally
 task 'resque:setup' => :environment do
   require 'resque/tasks'

data/appoptics_apm.gemspec

@@ -46,14 +46,12 @@ Automatic tracing and metrics for Ruby applications. Get started at appoptics.co
   s.add_development_dependency('rake', '>= 0.9.0')
   s.add_development_dependency('simplecov', '>= 0.16.0') if ENV["SIMPLECOV_COVERAGE"]
   s.add_development_dependency('simplecov-console', '>= 0.4.0') if ENV["SIMPLECOV_COVERAGE"]
+  s.add_development_dependency('irb', '>= 1.0.0') if RUBY_VERSION >= '2.6.0'
 
   unless defined?(JRUBY_VERSION)
     s.add_development_dependency('byebug', '>= 8.0.0')
-    s.add_development_dependency('pry', '>= 0.10.0')
-    s.add_development_dependency('pry-byebug', '>= 3.0.0')
     s.add_development_dependency('minitest-hooks', '>= 1.5.0')
-  else
-    s.add_development_dependency('pry', '>= 0.10.0')
+    s.add_development_dependency('benchmark-ips', '>= 2.7.2')
   end
 
   s.required_ruby_version = '>= 2.0.0'

data/build_gem_upload_to_packagecloud.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 
-# build the gem
+# build the gem,
+# oboe/c-lib version can be given as optional parameter
 if [ "$1" != "" ]; then
   OBOE_VERSION=$1 ./build_gem.sh
 else

data/examples/SDK/01_basic_tracing.rb

@@ -7,7 +7,7 @@
 # `bundle exec ruby 01_basic_tracing.rb`
 
 require 'appoptics_apm'
-unless AppopticsAPM::SDK.appoptics_ready(10_000)
+unless AppopticsAPM::SDK.appoptics_ready?(10_000)
   puts "aborting!!! Agent not ready after 10 seconds"
   exit false
 end
@@ -51,6 +51,7 @@ AppOpticsAPM::SDK.start_trace('outer_span') do
 
   AppOpticsAPM::SDK.trace('simple_span') do
     do_work
+    AppOpticsAPM::API.log_info(AppOpticsAPM.layer, { some: :fancy, hash: :to, send: 1 })
   end
 
 end

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-3.3.0
+4.0.1

data/lib/appoptics_apm.rb

@@ -8,7 +8,7 @@ begin
   require 'appoptics_apm/logger'
   require 'appoptics_apm/util'
   require 'appoptics_apm/xtrace'
-  require 'appoptics_apm/support'
+  require 'appoptics_apm/support_report'
   require 'appoptics_apm/base'
   AppOpticsAPM.loaded = false
 
@@ -49,6 +49,7 @@ begin
     # 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'
 
     # Frameworks
     require 'appoptics_apm/frameworks/rails'

data/lib/appoptics_apm/api/layerinit.rb

@@ -31,7 +31,7 @@ module AppOpticsAPM
                          'removed in a subsequent version.'
 
         saved_mode = AppOpticsAPM::Config[:tracing_mode]
-        AppOpticsAPM::Config[:tracing_mode] = :always
+        AppOpticsAPM::Config[:tracing_mode] = :enabled
         yield
       ensure
         AppOpticsAPM::Config[:tracing_mode] = saved_mode

data/lib/appoptics_apm/api/logging.rb

@@ -87,7 +87,8 @@ module AppOpticsAPM
       end
 
       ##
-      # Public: Decide whether or not to start a trace, and report an entry event
+      # Public: Start a trace depending on TransactionSettings
+      # or decide whether or not to start a trace, and report an entry event
       # appropriately.
       #
       # ==== Arguments
@@ -95,83 +96,38 @@ module AppOpticsAPM
       # * +layer+ - The layer the reported event belongs to
       # * +xtrace+ - An xtrace metadata string, or nil.  Used for cross-application tracing.
       # * +opts+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      # * +settings+ - An instance of TransactionSettings
       #
       # ==== Example
       #
       #   AppOpticsAPM::API.log_start(:layer_name, nil, { :id => @user.id })
       #
       # Returns an xtrace metadata string if we are tracing
-      def log_start(layer, xtrace = nil, opts = {})
-        return if !AppOpticsAPM.loaded || (opts.key?(:URL) && AppOpticsAPM::Util.static_asset?(opts[:URL]))
-
-        #--
-        # Is the below necessary? Only on JRuby? Could there be an existing context but not x-trace header?
-        # See discussion at:
-        # https://github.com/librato/ruby-tracelytics/pull/6/files?diff=split#r131029135
-        #
-        # Used by JRuby/Java webservers such as Tomcat
-        # AppOpticsAPM::Context.fromString(xtrace) if AppOpticsAPM.pickup_context?(xtrace)
-
-        # if AppOpticsAPM.tracing?
-        #   # Pre-existing context.  Either we inherited context from an
-        #   # incoming X-Trace request header or under JRuby, Joboe started
-        #   # tracing before the JRuby code was called (e.g. Tomcat)
-        #   AppOpticsAPM.is_continued_trace = true
-
-        #   if AppOpticsAPM.has_xtrace_header
-        #     opts[:TraceOrigin] = :continued_header
-        #   elsif AppOpticsAPM.has_incoming_context
-        #     opts[:TraceOrigin] = :continued_context
-        #   else
-        #     opts[:TraceOrigin] = :continued
-        #   end
-
-        # return log_entry(layer, opts)
-        # end
-        #++
+      #
+      def log_start(layer, xtrace = nil, opts = {}, settings = nil)
+        return unless AppOpticsAPM.loaded
+
+        # check if tracing decision is already in effect and a Context created
+        return log_entry(layer, opts) if AppOpticsAPM::Context.isValid
 
         # This is a bit ugly, but here is the best place to reset the layer_op thread local var.
-        AppOpticsAPM.layer_op = nil unless AppOpticsAPM::Context.isValid
-
-        if AppOpticsAPM.sample?(opts.merge(:xtrace => xtrace))
-          # Yes, we're sampling this request
-          # Probablistic tracing of a subset of requests based off of
-          # sample rate and sample source
-          opts[:SampleRate]        = AppOpticsAPM.sample_rate
-          opts[:SampleSource]      = AppOpticsAPM.sample_source
-          opts[:TraceOrigin]       = :always_sampled
-
-          if xtrace_v2?(xtrace)
-            # continue valid incoming xtrace
-            # use it for current context, ensuring sample bit is set
-            AppOpticsAPM::XTrace.set_sampled(xtrace)
-
-            md = AppOpticsAPM::Metadata.fromString(xtrace)
-            AppOpticsAPM::Context.fromString(xtrace)
-            log_event(layer, :entry, md.createEvent, opts)
-          else
-            # discard invalid incoming xtrace
-            # create a new context, ensuring sample bit set
-            md = AppOpticsAPM::Metadata.makeRandom(true)
-            AppOpticsAPM::Context.set(md)
-            log_event(layer, :entry, AppOpticsAPM::Event.startTrace(md), opts)
-          end
+        AppOpticsAPM.layer_op = nil
+
+        xtrace = nil unless AppOpticsAPM::XTrace.valid?(xtrace)
+
+        settings ||= AppOpticsAPM::TransactionSettings.new(nil, xtrace)
+
+        if settings.do_sample
+          opts[:SampleRate]        = settings.rate
+          opts[:SampleSource]      = settings.source
+
+          AppOpticsAPM::XTrace.set_sampled(xtrace) if xtrace
+          event = create_start_event(xtrace)
+          log_event(layer, :entry, event, opts)
         else
-          # No, we're not sampling this request
-          # set the context but don't log the event
-          if xtrace_v2?(xtrace)
-            # continue valid incoming xtrace
-            # use it for current context, ensuring sample bit is not set
-            AppOpticsAPM::XTrace.unset_sampled(xtrace)
-            AppOpticsAPM::Context.fromString(xtrace)
-          else
-            # discard invalid incoming xtrace
-            # create a new context, ensuring sample bit not set
-            md = AppOpticsAPM::Metadata.makeRandom(false)
-            AppOpticsAPM::Context.fromString(md.toString)
-          end
+          create_nontracing_context(xtrace)
+          AppOpticsAPM::Context.toString
         end
-        AppOpticsAPM::Context.toString
       end
 
       ##
@@ -187,6 +143,7 @@ module AppOpticsAPM
       #   AppOpticsAPM::API.log_end(:layer_name, { :id => @user.id })
       #
       # Returns an xtrace metadata string if we are tracing
+      #
       def log_end(layer, opts = {}, event = nil)
         return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
@@ -214,11 +171,19 @@ module AppOpticsAPM
       #   AppOpticsAPM::API.log_entry(:layer_name, { :id => @user.id })
       #
       # Returns an xtrace metadata string if we are tracing
-      def log_entry(layer, opts = {}, op = nil)
+      #
+      def log_entry(layer, opts = {}, op = nil) #, event = nil)
         return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
-        AppOpticsAPM.layer_op = (AppOpticsAPM.layer_op || []) << op.to_sym if op
-        log_event(layer, :entry, AppOpticsAPM::Context.createEvent, opts)
+        if op
+          # check if re-entry but also add op to list for log_exit
+          re_entry = AppOpticsAPM.layer_op&.last == op.to_sym
+          AppOpticsAPM.layer_op = (AppOpticsAPM.layer_op || []) << op.to_sym
+          return AppOpticsAPM::Context.toString if re_entry
+        end
+
+        event ||= AppOpticsAPM::Context.createEvent
+        log_event(layer, :entry, event, opts)
       end
 
       ##
@@ -236,6 +201,7 @@ module AppOpticsAPM
       #   AppOpticsAPM::API.log_info(:layer_name, { :id => @user.id })
       #
       # Returns an xtrace metadata string if we are tracing
+      #
       def log_info(layer, opts = {})
         return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
@@ -251,7 +217,7 @@ module AppOpticsAPM
       #
       # * +layer+ - The layer the reported event belongs to
       # * +opts+  - A hash containing key/value pairs that will be reported along with this event (optional).
-      # * +op+    - Used to avoid double tracing recursive calls, needs to be true in +log_exit+ that corresponds to a
+      # * +op+    - Used to avoid double tracing recursive calls, needs to be the same in +log_exit+ that corresponds to a
       #   +log_entry+
       #
       # ==== Example
@@ -262,7 +228,15 @@ module AppOpticsAPM
       def log_exit(layer, opts = {}, op = nil)
         return AppOpticsAPM::Context.toString unless AppOpticsAPM.tracing?
 
-        AppOpticsAPM.layer_op.pop if op && AppOpticsAPM.layer_op.is_a?(Array) && AppOpticsAPM.layer_op.last == op.to_sym
+        if op
+          if AppOpticsAPM.layer_op&.last == op.to_sym
+            AppOpticsAPM.layer_op.pop
+          else
+            AppOpticsAPM.logger.warn "[ruby/logging] op parameter of exit event doesn't correspond to an entry event op"
+          end
+          # check if the next op is the same, don't log event if so
+          return AppOpticsAPM::Context.toString if AppOpticsAPM.layer_op&.last == op.to_sym
+        end
 
         log_event(layer, :exit, AppOpticsAPM::Context.createEvent, opts)
       end
@@ -367,6 +341,34 @@ module AppOpticsAPM
         AppOpticsAPM::Context.toString
       end
 
+      def create_start_event(xtrace = nil)
+        if AppOpticsAPM::XTrace.sampled?(xtrace)
+          md = AppOpticsAPM::Metadata.fromString(xtrace)
+          AppOpticsAPM::Context.fromString(xtrace)
+          md.createEvent
+        else
+          md = AppOpticsAPM::Metadata.makeRandom(true)
+          AppOpticsAPM::Context.set(md)
+          AppOpticsAPM::Event.startTrace(md)
+        end
+      end
+
+      public
+
+      def create_nontracing_context(xtrace)
+        if AppOpticsAPM::XTrace.valid?(xtrace)
+          # continue valid incoming xtrace
+          # use it for current context, ensuring sample bit is not set
+          AppOpticsAPM::XTrace.unset_sampled(xtrace)
+          AppOpticsAPM::Context.fromString(xtrace)
+        else
+          # discard invalid incoming xtrace
+          # create a new context, ensuring sample bit not set
+          md = AppOpticsAPM::Metadata.makeRandom(false)
+          AppOpticsAPM::Context.fromString(md.toString)
+        end
+      end
+
       # need to set the context to public, otherwise the following `extends` will be private in api.rb
       public
 

data/lib/appoptics_apm/base.rb

@@ -2,8 +2,8 @@
 # All rights reserved.
 
 # Constants from liboboe
-APPOPTICS_TRACE_NEVER   = 0
-APPOPTICS_TRACE_ALWAYS  = 1
+APPOPTICS_TRACE_DISABLED   = 0
+APPOPTICS_TRACE_ENABLED  = 1
 
 # OBOE_SAMPLE_RATE_SOURCE_FILE                   = 1
 # OBOE_SAMPLE_RATE_SOURCE_DEFAULT                = 2
@@ -147,22 +147,26 @@ module AppOpticsAPMBase
     AppOpticsAPM.layer_op.last == operation.to_sym
   end
 
+  # TODO ME review use of these boolean statements
+  # ____ they should now be handled by TransactionSettings,
+  # ____ because there can be exceptions to :enabled and :disabled
+
   ##
-  # Returns true if the tracing_mode is set to always.
+  # Returns true if the tracing_mode is set to :enabled.
   # False otherwise
   #
-  def always?
+  def tracing_enabled?
     AppOpticsAPM::Config[:tracing_mode] &&
-      AppOpticsAPM::Config[:tracing_mode].to_sym == :always
+      [:enabled, :always].include?(AppOpticsAPM::Config[:tracing_mode].to_sym)
   end
 
   ##
-  # Returns true if the tracing_mode is set to never.
+  # Returns true if the tracing_mode is set to :disabled.
   # False otherwise
   #
-  def never?
+  def tracing_disabled?
     AppOpticsAPM::Config[:tracing_mode] &&
-      AppOpticsAPM::Config[:tracing_mode].to_sym == :never
+      [:disabled, :never].include?(AppOpticsAPM::Config[:tracing_mode].to_sym)
   end
 
   ##
@@ -170,7 +174,7 @@ module AppOpticsAPMBase
   # False otherwise
   #
   def tracing?
-    return false if !AppOpticsAPM.loaded || AppOpticsAPM.never?
+    return false if !AppOpticsAPM.loaded # || AppOpticsAPM.tracing_disabled?
     AppOpticsAPM::Context.isSampled
   end