appoptics_apm 4.1.2 → 4.2.0

data/lib/appoptics_apm/inst/rack.rb

@@ -26,6 +26,26 @@ if AppOpticsAPM.loaded
         @app = app
       end
 
+      def call(env)
+        # 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 avoid tracing rack more than once and
+        # instead start instrumenting from the first rack pass.
+        return call_app(env) if AppOpticsAPM.tracing? && AppOpticsAPM.layer == :rack
+
+        # if we already have a context, we don't want to send metrics in the end
+        return sampling_call(env) if AppOpticsAPM::Context.isValid
+
+        # else we also send metrics
+        metrics_sampling_call(env)
+      end
+
+      def self.noop?
+        false
+      end
+
+      private
+
       def collect(req, env)
         report_kvs = {}
 
@@ -61,92 +81,105 @@ if AppOpticsAPM.loaded
         report_kvs
       end
 
-      def call(env)
-        start = Time.now
-        status = 500
-        req = ::Rack::Request.new(env)
-        req_url = req.url   # saving it here because rails3.2 overrides it when there is a 500 error
-
-        # 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 avoid tracing rack more than once and
-        # instead start instrumenting from the first rack pass.
-        if AppOpticsAPM.tracing? && AppOpticsAPM.layer == :rack
-          AppOpticsAPM.logger.debug "[appoptics_apm/rack] Rack skipped!"
-          return @app.call(env)
-        end
-
-        begin
-          report_kvs = {}
+      def call_app(env)
+        AppOpticsAPM.logger.debug "[appoptics_apm/rack] Rack skipped!"
+        @app.call(env)
+      end
 
-          report_kvs[:URL] = AppOpticsAPM::Config[:rack][:log_args] ? ::CGI.unescape(req.fullpath) : ::CGI.unescape(req.path)
+      # in this case we have an existing context
+      def sampling_call(env)
+        req = ::Rack::Request.new(env)
+        report_kvs = {}
+        report_kvs[:URL] = AppOpticsAPM::Config[:rack][:log_args] ? ::CGI.unescape(req.fullpath) : ::CGI.unescape(req.path)
 
-          # Check for and validate X-Trace request header to pick up tracing context
-          xtrace = env.is_a?(Hash) ? env['HTTP_X_TRACE'] : nil
-          xtrace_header = AppOpticsAPM::XTrace.valid?(xtrace) ? xtrace : nil
+        AppOpticsAPM::API.trace(:rack, report_kvs) do
+          report_kvs = collect(req, env)
 
-          # Under JRuby, JAppOpticsAPM may have already started a trace.  Make note of this
-          # if so and don't clear context on log_end (see appoptics_apm/api/logging.rb)
-          AppOpticsAPM.has_incoming_context = AppOpticsAPM.tracing?
-          AppOpticsAPM.has_xtrace_header = xtrace_header
-          AppOpticsAPM.is_continued_trace = AppOpticsAPM.has_incoming_context || AppOpticsAPM.has_xtrace_header
+          # We log an info event with the HTTP KVs found in AppOpticsAPM::Rack.collect
+          # This is done here so in the case of stacks that try/catch/abort
+          # (looking at you Grape) we're sure the KVs get reported now as
+          # this code may not be returned to later.
+          AppOpticsAPM::API.log_info(:rack, report_kvs)
+          @app.call(env)
+        end
+      end
 
-          xtrace = AppOpticsAPM::API.log_start(:rack, xtrace_header, report_kvs)
+      def metrics_sampling_call(env)
+        start = Time.now
+        AppOpticsAPM.transaction_name = nil
+        req = ::Rack::Request.new(env)
+        req_url = req.url   # saving it here because rails3.2 overrides it when there is a 500 error
 
-          # We only trace a subset of requests based off of sample rate so if
-          # AppOpticsAPM::API.log_start really did start a trace, we act accordingly here.
-          if AppOpticsAPM.tracing?
-            report_kvs = collect(req, env)
+        report_kvs = {}
+        report_kvs[:URL] = AppOpticsAPM::Config[:rack][:log_args] ? ::CGI.unescape(req.fullpath) : ::CGI.unescape(req.path)
+
+        # Check for and validate X-Trace request header to pick up tracing context
+        xtrace = env.is_a?(Hash) ? env['HTTP_X_TRACE'] : nil
+        xtrace = AppOpticsAPM::XTrace.valid?(xtrace) ? xtrace : nil
+
+        # TODO JRUBY
+        # Under JRuby, JAppOpticsAPM may have already started a trace.  Make note of this
+        # if so and don't clear context on log_end (see appoptics_apm/api/logging.rb)
+        # AppOpticsAPM.has_incoming_context = AppOpticsAPM.tracing?
+        # AppOpticsAPM.has_xtrace_header = xtrace
+        # AppOpticsAPM.is_continued_trace = AppOpticsAPM.has_incoming_context || AppOpticsAPM.has_xtrace_header
+
+        AppOpticsAPM::API.log_start(:rack, xtrace, report_kvs) unless ::AppOpticsAPM::Util.static_asset?(env['PATH_INFO'])
+
+        # We log an info event with the HTTP KVs found in AppOpticsAPM::Rack.collect
+        # This is done here so in the case of stacks that try/catch/abort
+        # (looking at you Grape) we're sure the KVs get reported now as
+        # this code may not be returned to later.
+        AppOpticsAPM::API.log_info(:rack, collect(req, env))
+
+        status, headers, response = @app.call(env)
+        confirmed_transaction_name = send_metrics(env, req, req_url, start, status)
+        xtrace = AppOpticsAPM::API.log_end(:rack, :Status => status, :TransactionName => confirmed_transaction_name)
+
+        if headers && AppOpticsAPM::XTrace.valid?(xtrace)
+          # TODO revisit this JRUBY condition
+          # headers['X-Trace'] = xtrace if headers.is_a?(Hash) unless defined?(JRUBY_VERSION) && AppOpticsAPM.is_continued_trace?
+          headers['X-Trace'] = xtrace if headers.is_a?(Hash) unless defined?(JRUBY_VERSION) && AppOpticsAPM.is_continued_trace?
+        end
 
-            # We log an info event with the HTTP KVs found in AppOpticsAPM::Rack.collect
-            # This is done here so in the case of stacks that try/catch/abort
-            # (looking at you Grape) we're sure the KVs get reported now as
-            # this code may not be returned to later.
-            AppOpticsAPM::API.log_info(:rack, report_kvs)
+        [status, headers, response]
+      rescue Exception => e
+        # it is ok to rescue Exception here because we are reraising it (we just need a chance to log_end)
+        AppOpticsAPM::API.log_exception(:rack, e)
+        confirmed_transaction_name ||= send_metrics(env, req, req_url, start, status)
+        xtrace = AppOpticsAPM::API.log_end(:rack, :Status => status, :TransactionName => confirmed_transaction_name)
+
+        if headers && AppOpticsAPM::XTrace.valid?(xtrace)
+          # TODO revisit this JRUBY condition
+          # headers['X-Trace'] = xtrace if headers.is_a?(Hash) unless defined?(JRUBY_VERSION) && AppOpticsAPM.is_continued_trace?
+          headers['X-Trace'] = xtrace if headers.is_a?(Hash) unless defined?(JRUBY_VERSION) && AppOpticsAPM.is_continued_trace?
+        end
 
-            status, headers, response = @app.call(env)
+        raise
+      end
 
-            xtrace = AppOpticsAPM::API.log_end(:rack, :Status => status)
 
-          else
-            status, headers, response = @app.call(env)
-          end
+      def send_metrics(env, req, req_url, start, status)
+        return if ::AppOpticsAPM::Util.static_asset?(env['PATH_INFO'])
 
-          [status, headers, response]
-        rescue Exception => e
-          # it is ok to rescue Exception here because we are reraising it (we just need a chance to log_end)
-          if AppOpticsAPM.tracing?
-            AppOpticsAPM::API.log_exception(:rack, e)
-            xtrace = AppOpticsAPM::API.log_end(:rack, :Status => 500, 'TransactionName' => transaction_name(env))
-          end
-          raise
-        ensure
-          if headers && AppOpticsAPM::XTrace.valid?(xtrace)
-            unless defined?(JRUBY_VERSION) && AppOpticsAPM.is_continued_trace?
-              headers['X-Trace'] = xtrace if headers.is_a?(Hash)
-            end
-          end
-        end
-      ensure
-        unless ::AppOpticsAPM::Util.static_asset?(env['PATH_INFO'])
-          status = status.to_i
-          error = status.between?(500,599) ? 1 : 0
-          duration =(1000 * 1000 * (Time.now - start)).round(0)
-          AppOpticsAPM::Span.createHttpSpan(transaction_name(env), req_url, duration, status, req.request_method, error)
+        domain = nil
+        if AppOpticsAPM::Config['transaction_name']['prepend_domain']
+          domain = [80, 443].include?(req.port) ? req.host : "#{req.host}:#{req.port}"
         end
+        status = status.to_i
+        error = status.between?(500,599) ? 1 : 0
+        duration =(1000 * 1000 * (Time.now - start)).round(0)
+        AppOpticsAPM::Span.createHttpSpan(transaction_name(env), req_url, domain, duration, status, req.request_method, error) || ''
       end
 
-      def self.noop?
-        false
-      end
-
-      private
-
       def transaction_name(env)
-        if env['appoptics_apm.controller'] || env['appoptics_apm.action']
+        if AppOpticsAPM.transaction_name
+          AppOpticsAPM.transaction_name
+        elsif env['appoptics_apm.controller'] || env['appoptics_apm.action']
           [env['appoptics_apm.controller'], env['appoptics_apm.action']].join('.')
         end
       end
+
     end
   end
 else

data/lib/appoptics_apm/noop/README.md

@@ -0,0 +1,9 @@
+Here we can define modules and classes for noop mode.
+
+Instead of polluting code with AppOpticsAPM.loaded conditionals
+
+we load these classes when in noop mode and they expose noop behavior.
+
+so far only one class is needed:
+
+- AppOpticsAPM::Context  and its toString() method from oboe

data/lib/appoptics_apm/noop/context.rb

@@ -0,0 +1,19 @@
+####
+# noop version of AppOpticsAPM::Context
+#
+#
+
+module AppOpticsAPM
+  module Context
+
+    ##
+    # noop version of toString
+    # toString would return the current context (xtrace) as string
+    #
+    # the noop version returns an empty string
+    #
+    def self.toString
+      ''
+    end
+  end
+end

data/lib/appoptics_apm/support.rb

@@ -81,28 +81,27 @@ module AppOpticsAPM
       AppOpticsAPM.logger.warn 'No ActiveRecord'
     end
 
-    AppOpticsAPM.logger.warn '********************************************************'
-    AppOpticsAPM.logger.warn '* AppOpticsAPM Libraries'
-    AppOpticsAPM.logger.warn '********************************************************'
-    files = []
-    ['/usr/lib/liboboe*', '/usr/lib64/liboboe*'].each do |d|
-      files = Dir.glob(d)
-      break if !files.empty?
-    end
-    if files.empty?
-      AppOpticsAPM.logger.warn 'Error: No liboboe libs!'
-    else
-      files.each { |f|
-        AppOpticsAPM.logger.warn f
-      }
-    end
+    # TODO we don't have libs in /usr/lib anymore, is this still needed???
+    # AppOpticsAPM.logger.warn '********************************************************'
+    # AppOpticsAPM.logger.warn '* AppOpticsAPM Libraries'
+    # AppOpticsAPM.logger.warn '********************************************************'
+    # files = []
+    # ['/usr/lib/liboboe*', '/usr/lib64/liboboe*'].each do |d|
+    #   files = Dir.glob(d)
+    #   break if !files.empty?
+    # end
+    # if files.empty?
+    #   AppOpticsAPM.logger.warn 'Error: No liboboe libs!'
+    # else
+    #   files.each { |f|
+    #     AppOpticsAPM.logger.warn f
+    #   }
+    # end
 
     AppOpticsAPM.logger.warn '********************************************************'
     AppOpticsAPM.logger.warn '* AppOpticsAPM::Config Values'
     AppOpticsAPM.logger.warn '********************************************************'
-    AppOpticsAPM::Config.config.each { |k,v|
-      AppOpticsAPM.logger.warn "#{k}: #{v}"
-    }
+    AppOpticsAPM::Config.print_config
 
     AppOpticsAPM.logger.warn '********************************************************'
     AppOpticsAPM.logger.warn '* OS, Platform + Env'

data/lib/appoptics_apm/version.rb

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

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

@@ -21,7 +21,15 @@ if defined?(AppOpticsAPM::Config)
   # Verbose output of instrumentation initialization
   #
   AppOpticsAPM::Config[:verbose] = ENV.key?('APPOPTICS_GEM_VERBOSE') && ENV['APPOPTICS_GEM_VERBOSE'] == 'true' ? true : false
+
+  #
+  # 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 decducted by the instrumentation
+  # or implicitly set.
   #
+  AppOpticsAPM::Config[:transaction_name][:prepend_domain] = false
 
   #
   # Sanitize SQL Statements

data/run_tests_docker.rb

@@ -7,10 +7,6 @@
 
 # `docker build -f Dockerfile -t ruby_appoptics .`
 # (docker-compose will build it too if missing)
-#
-# `docker-compose up -d`
-# or to rebuild ruby_appoptics
-# `docker-compose up --build -d`
 
 require 'yaml'
 travis = YAML.load_file('.travis.yml')
@@ -34,5 +30,3 @@ matrix.each do |args|
   `docker-compose run --rm --service-ports ruby_appoptics_apm /code/ruby-appoptics_apm/ruby_setup.sh #{args['rvm']} #{args['gemfile']} #{args['env']}`
   puts "docker-compose run --rm --service-ports ruby_appoptics_apm /code/ruby-appoptics_apm/ruby_setup.sh #{args['rvm']} #{args['gemfile']} #{args['env']}"
 end
-
-# `docker-compose down --rmi all`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -133,6 +133,14 @@ files:
 - build_gems.sh
 - config/initializers/.keep
 - docker-compose.yml
+- examples/DNT.md
+- examples/carrying_context.rb
+- examples/instrumenting_metal_controller.rb
+- examples/puma_on_heroku_config.rb
+- examples/tracing_async_threads.rb
+- examples/tracing_background_jobs.rb
+- examples/tracing_forked_processes.rb
+- examples/unicorn_on_heroku_config.rb
 - ext/oboe_metal/extconf.rb
 - ext/oboe_metal/lib/.keep
 - ext/oboe_metal/noop/noop.c
@@ -204,6 +212,8 @@ files:
 - 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/ruby.rb
 - lib/appoptics_apm/support.rb
 - lib/appoptics_apm/test.rb