appoptics_apm 4.2.3 → 4.2.4

data/lib/appoptics_apm/frameworks/rails/inst/connection_adapters/utils.rb

@@ -53,10 +53,6 @@ module AppOpticsAPM
             name == 'ActiveRecord::SchemaMigration Load'
         end
 
-        # def cfg
-        #   @config
-        # end
-
         def execute_with_appoptics(sql, name = nil)
           if AppOpticsAPM.tracing? && !ignore_payload?(name)
 
@@ -118,11 +114,7 @@ module AppOpticsAPM
         end
 
         def begin_db_transaction_with_appoptics
-          if AppOpticsAPM.tracing?
-            AppOpticsAPM::API.trace('activerecord', { :Query => 'BEGIN', :Flavor => :mysql }, :ar_started) do
-              begin_db_transaction_without_appoptics
-            end
-          else
+          AppOpticsAPM::API.trace('activerecord', { :Query => 'BEGIN', :Flavor => :mysql }, :ar_started) do
             begin_db_transaction_without_appoptics
           end
         end

data/lib/appoptics_apm/frameworks/rails/inst/connection_adapters/utils5x.rb

@@ -61,7 +61,7 @@ module AppOpticsAPM
         end
 
         def exec_query_with_appoptics(sql, name = nil, binds = [], prepare: false)
-          if AppOpticsAPM.tracing? && AppOpticsAPM.layer_op != :ar_started && !ignore_payload?(name)
+          if AppOpticsAPM.tracing? && !AppOpticsAPM.tracing_layer_op?(:ar_started) && !ignore_payload?(name)
 
             opts = extract_trace_details(sql, name, binds)
             AppOpticsAPM::API.trace('activerecord', opts) do

data/lib/appoptics_apm/frameworks/sinatra.rb

@@ -23,12 +23,15 @@ module AppOpticsAPM
         env['appoptics_apm.action']     = report_kvs[:Action]
 
         response
+      rescue => e
+        ::AppOpticsAPM::API.log_exception('sinatra', e)
+        raise e
       ensure
         ::AppOpticsAPM::API.log_exit('sinatra', report_kvs)
       end
 
       def handle_exception_with_appoptics(boom)
-        AppOpticsAPM::API.log_exception(nil, boom)
+        AppOpticsAPM::API.log_exception(:sinatra, boom)
         handle_exception_without_appoptics(boom)
       end
 

data/lib/appoptics_apm/inst/bunny-client.rb

@@ -32,7 +32,7 @@ module AppOpticsAPM
 
           delete_without_appoptics(opts)
         rescue => e
-          AppOpticsAPM::API.log_exception(nil, e)
+          AppOpticsAPM::API.log_exception(:'rabbitmq-client', e)
           raise e
         ensure
           AppOpticsAPM::API.log_exit(:'rabbitmq-client', kvs)
@@ -48,20 +48,18 @@ module AppOpticsAPM
       end
 
       def collect_channel_kvs
-        begin
-          kvs = {}
-          kvs[:Spec] = :pushq
-          kvs[:Flavor] = :rabbitmq
-          kvs[:RemoteHost] = @connection.host
-          kvs[:RemotePort] = @connection.port.to_i
-          kvs[:VirtualHost] = @connection.vhost
-          kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:bunnyclient][:collect_backtraces]
-          kvs
-        rescue => e
-          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
-        ensure
-          return kvs
-        end
+        kvs = {}
+        kvs[:Spec] = :pushq
+        kvs[:Flavor] = :rabbitmq
+        kvs[:RemoteHost] = @connection.host
+        kvs[:RemotePort] = @connection.port.to_i
+        kvs[:VirtualHost] = @connection.vhost
+        kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:bunnyclient][:collect_backtraces]
+        kvs
+      rescue => e
+        AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+      ensure
+        return kvs
       end
 
       def basic_publish_with_appoptics(payload, exchange, routing_key, opts = {})
@@ -91,7 +89,7 @@ module AppOpticsAPM
 
           basic_publish_without_appoptics(payload, exchange, routing_key, opts)
         rescue => e
-          AppOpticsAPM::API.log_exception(nil, e)
+          AppOpticsAPM::API.log_exception(:'rabbitmq-client', e)
           raise e
         ensure
           AppOpticsAPM::API.log_exit(:'rabbitmq-client', kvs)
@@ -112,7 +110,7 @@ module AppOpticsAPM
           kvs[:Queue] = result.name
           result
         rescue => e
-          AppOpticsAPM::API.log_exception(nil, e)
+          AppOpticsAPM::API.log_exception(:'rabbitmq-client', e)
           raise e
         ensure
           AppOpticsAPM::API.log_exit(:'rabbitmq-client', kvs)
@@ -131,7 +129,7 @@ module AppOpticsAPM
 
           wait_for_confirms_without_appoptics
         rescue => e
-          AppOpticsAPM::API.log_exception(nil, e)
+          AppOpticsAPM::API.log_exception(:'rabbitmq-client', e)
           raise e
         ensure
           AppOpticsAPM::API.log_exit(:'rabbitmq-client', kvs)

data/lib/appoptics_apm/inst/memcached.rb

@@ -58,19 +58,15 @@ module AppOpticsAPM
           layer_kvs[:KVOp] = :get_multi
 
           AppOpticsAPM::API.trace(:memcache, layer_kvs || {}, :get_multi) do
-            begin
-              info_kvs = {}
-              info_kvs[:KVKeyCount] = keys.flatten.length
+            info_kvs = {}
+            info_kvs[:KVKeyCount] = keys.flatten.length
 
-              values = get_multi_without_appoptics(keys, raw)
+            values = get_multi_without_appoptics(keys, raw)
 
-              info_kvs[:KVHitCount] = values.length
-              info_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:memcached][:collect_backtraces]
+            info_kvs[:KVHitCount] = values.length
+            info_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:memcached][:collect_backtraces]
 
-              AppOpticsAPM::API.log(:memcache, :info, info_kvs)
-            rescue
-              values = get_multi_without_appoptics(keys, raw)
-            end
+            AppOpticsAPM::API.log(:memcache, :info, info_kvs)
             values
           end
         else

data/lib/appoptics_apm/inst/moped.rb

@@ -256,7 +256,7 @@ module AppOpticsAPM
       end
 
       def update_with_appoptics(change, flags = nil)
-        if AppOpticsAPM.tracing? && !AppOpticsAPM.tracing_layer_op?([:update_all, :upsert])
+        if AppOpticsAPM.tracing? && !AppOpticsAPM.tracing_layer_op?(:update_all) && !AppOpticsAPM.tracing_layer_op?(:upsert)
           begin
             report_kvs = extract_trace_details(:update)
             report_kvs[:Flags] = flags.to_s if flags

data/lib/appoptics_apm/inst/rack.rb

@@ -137,11 +137,9 @@ if AppOpticsAPM.loaded
         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
+        # 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)
 
         [status, headers, response]
       rescue Exception => e
@@ -150,11 +148,9 @@ if AppOpticsAPM.loaded
         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
+        # 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)
 
         raise
       end
@@ -163,14 +159,16 @@ if AppOpticsAPM.loaded
       def send_metrics(env, req, req_url, start, status)
         return if ::AppOpticsAPM::Util.static_asset?(env['PATH_INFO'])
 
-        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) || ''
+        AppOpticsAPM::Span.createHttpSpan(transaction_name(env), req_url, domain(req), duration, status, req.request_method, error) || ''
+      end
+
+      def domain(req)
+        if AppOpticsAPM::Config['transaction_name']['prepend_domain']
+          [80, 443].include?(req.port) ? req.host : "#{req.host}:#{req.port}"
+        end
       end
 
       def transaction_name(env)

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

@@ -8,7 +8,7 @@ module AppOpticsAPM
         # Attempt to collect up pertinent info.  If we hit something unexpected,
         # keep calm and instrument on.
         report_kvs = {}
-        worker, msg, queue = args
+        _worker, msg, queue = args
 
         # Background Job Spec KVs
         report_kvs[:Spec]       = :job

data/lib/appoptics_apm/inst/typhoeus.rb

@@ -1,5 +1,6 @@
 # Copyright (c) 2016 SolarWinds, LLC.
 # All rights reserved.
+class TyphoeusError < StandardError; end
 
 module AppOpticsAPM
   module Inst
@@ -27,8 +28,9 @@ module AppOpticsAPM
           response = run_without_appoptics
 
           if response.code == 0
-            AppOpticsAPM::API.log(:typhoeus, :error, { :ErrorClass => response.return_code,
-                                                    :ErrorMsg => response.return_message })
+            exception = TyphoeusError.new(response.return_message)
+            exception.set_backtrace(AppOpticsAPM::API.backtrace) if AppOpticsAPM::Config[:typhoeus][:collect_backtraces]
+            AppOpticsAPM::API.log_exception(:typhoeus, exception)
           end
 
           kvs = {}

data/lib/appoptics_apm/loading.rb

@@ -58,7 +58,7 @@ end
 
 AppOpticsAPM::Loading.require_api
 
-# Auto-start the Reporter unless we running Unicorn on Heroku
+# Auto-start the Reporter unless we are running Unicorn on Heroku
 # In that case, we start the reporters after fork
 unless AppOpticsAPM.heroku? && AppOpticsAPM.forking_webserver?
   AppOpticsAPM::Reporter.start if AppOpticsAPM.loaded

data/lib/appoptics_apm/sdk.rb

@@ -13,14 +13,15 @@ module AppOpticsAPM
     # broken traces in case of exceptions.
     #
     # Some optional keys that can be used in the +opts+ hash:
-    # * +:TransactionName+ - this will show up in the transactions column in the traces dashboard
-    # * +:Controller+ - if present will be combined with +Action+ and show up as transaction in the traces dashboard
-    # * +:Action+ - if present will be combined with +Controller+ and show up as transaction in the traces dashboard
-    # * +:HTTP-Host+ - domain portion of URL
-    # * +:URL+ - request URI
+    # * +:Controller+
+    # * +:Action+
+    # * +:HTTP-Host+
+    # * +:URL+
     # * +:Method+
     #
-    # Invalid keys: +:Label+, +:Layer+, +:Edge+, +:Timestamp+, +:Timestamp_u+
+    # as well as custom keys. The information will show up in the raw data view of a span.
+    #
+    # Invalid keys: +:Label+, +:Layer+, +:Edge+, +:Timestamp+, +:Timestamp_u+, +:TransactionName+ (allowed in start_trace)
     #
     # The methods are exposed as singleton methods for AppOpticsAPM::SDK.
     #
@@ -29,7 +30,7 @@ module AppOpticsAPM
     # * +AppOpticsAPM::SDK.get_transaction_name+
     # * +AppOpticsAPM::SDK.set_transaction_name+
     # * +AppOpticsAPM::SDK.start_trace+
-    # * +AppOpticsAPM::SDK.start_trace_sith_target+
+    # * +AppOpticsAPM::SDK.start_trace_with_target+
     # * +AppOpticsAPM::SDK.trace+
     # * +AppOpticsAPM::SDK.tracing?+
     #
@@ -74,14 +75,10 @@ module AppOpticsAPM
       #
       # === Example:
       #
-      #   def computation(n)
-      #     fib(n)
-      #     raise Exception.new
-      #   end
-      #
       #   def computation_with_appoptics(n)
-      #     trace('fib', { :number => n }, :fib) do
-      #       computation(n)
+      #     AppOpticsAPM::SDK.trace('computation', { :number => n }, :computation) do
+      #       return n if n == 0
+      #       n + computation_with_appoptics(n-1)
       #     end
       #   end
       #
@@ -91,7 +88,10 @@ module AppOpticsAPM
       # * The result of the block.
       #
       def trace(span, opts = {}, protect_op = nil)
-        return yield if !AppOpticsAPM.loaded || !AppOpticsAPM.tracing? || (protect_op && AppOpticsAPM.layer_op == protect_op.to_sym)
+        return yield if !AppOpticsAPM.loaded || !AppOpticsAPM.tracing? || AppOpticsAPM.tracing_layer_op?(protect_op)
+
+        opts.delete(:TransactionName)
+        opts.delete('TransactionName')
 
         AppOpticsAPM::API.log_entry(span, opts, protect_op)
         begin
@@ -118,6 +118,7 @@ module AppOpticsAPM
       # * +span+   - Name for the span to be used as label in the trace view.
       # * +xtrace+ - (optional) incoming X-Trace identifier to be continued.
       # * +opts+   - (optional) hash containing key/value pairs that will be reported with this span.
+      #   The value of :TransactionName will set the transaction_name.
       #
       # === Example:
       #
@@ -135,28 +136,7 @@ module AppOpticsAPM
       # * The result of the block.
       #
       def start_trace(span, xtrace = nil, opts = {})
-        return yield unless AppOpticsAPM.loaded
-
-        # in case it is not an entry span!
-        return trace(span, opts) { yield } if AppOpticsAPM::Context.isValid
-
-        AppOpticsAPM::API.log_start(span, xtrace, opts)
-
-        # send_metrics deals with the logic for setting AppOpticsAPM.transaction_name
-        # and ensures that metrics are sent
-        # log_end includes sending the transaction_name
-        result = AppOpticsAPM::API.send_metrics(span, opts) do
-          begin
-            yield
-          rescue Exception => e # rescue everything ok, since we are raising
-            AppOpticsAPM::API.log_exception(span, e)
-            e.instance_variable_set(:@xtrace, AppOpticsAPM::API.log_end(span))
-            raise
-          end
-        end
-        AppOpticsAPM::API.log_end(span)
-
-        result
+        start_trace_with_target(span, xtrace, {}, opts) { yield }
       end
 
       # Collect metrics, trace a given block of code, and assign trace info to target.
@@ -198,20 +178,30 @@ module AppOpticsAPM
           return result
         end
 
+        # :TransactionName and 'TransactionName' need to be removed from opts
+        # :TransactionName should only be sent after it is set by send_metrics
+        transaction_name = opts.delete('TransactionName')
+        transaction_name = opts.delete(:TransactionName) || transaction_name
+        # This is the beginning of a transaction, therefore AppOpticsAPM.transaction_name
+        # needs to be set to nil or whatever is provided in the opts
+        AppOpticsAPM.transaction_name = transaction_name
+
+
         AppOpticsAPM::API.log_start(span, xtrace, opts)
         exit_evt = AppOpticsAPM::Context.createEvent
-        result = AppOpticsAPM::API.send_metrics(span, opts) do
-          begin
-            target['X-Trace'] = AppOpticsAPM::EventUtil.metadataString(exit_evt) if AppOpticsAPM.tracing?
+        result = begin
+          AppOpticsAPM::API.send_metrics(span, opts) do
+            target['X-Trace'] = AppOpticsAPM::EventUtil.metadataString(exit_evt)
             yield
-          rescue Exception => e
-            AppOpticsAPM::API.log_exception(span, e)
-            exit_evt.addEdge(AppOpticsAPM::Context.get)
-            xtrace = AppOpticsAPM::API.log_end(span, opts, exit_evt)
-            e.instance_variable_set(:@xtrace, xtrace)
-            raise
           end
+        rescue Exception => e
+          AppOpticsAPM::API.log_exception(span, e)
+          exit_evt.addEdge(AppOpticsAPM::Context.get)
+          xtrace = AppOpticsAPM::API.log_end(span, opts, exit_evt)
+          e.instance_variable_set(:@xtrace, xtrace)
+          raise
         end
+
         exit_evt.addEdge(AppOpticsAPM::Context.get)
         AppOpticsAPM::API.log_end(span, opts, exit_evt)
 
@@ -229,7 +219,8 @@ module AppOpticsAPM
       # argument won't change the current transaction name.
       #
       # The configuration +AppOpticsAPM.Config+['transaction_name']+['prepend_domain']+ can be set to
-      # true to have the domain name prepended to the transaction name. This is a global setting.
+      # true to have the domain name prepended to the transaction name when an event or a metric are
+      # logged. This is a global setting.
       #
       # === Argument:
       #
@@ -268,7 +259,7 @@ module AppOpticsAPM
       # This is provided for testing
       #
       # === Returns:
-      # * (String or nil) the current transaction name
+      # * (String or nil) the current transaction name (without domain prepended)
       #
       def get_transaction_name
         AppOpticsAPM.transaction_name
@@ -277,7 +268,7 @@ module AppOpticsAPM
       # Determine if this transaction is being traced.
       #
       # Tracing puts some extra load on a system, therefor not all transaction are traced.
-      # The `tracing?` method helps to determine this so that extra work can be avoided when not tracing.
+      # The +tracing?+ method helps to determine this so that extra work can be avoided when not tracing.
       #
       # === Example:
       #
@@ -308,7 +299,14 @@ module AppOpticsAPM
       #   end
       #
       def appoptics_ready?(wait_milliseconds = 3000)
-        AppopticsAPM::Context.isReady(wait_milliseconds)
+        # These codes are returned by isReady:
+        # OBOE_SERVER_RESPONSE_UNKNOWN 0
+        # OBOE_SERVER_RESPONSE_OK 1
+        # OBOE_SERVER_RESPONSE_TRY_LATER 2
+        # OBOE_SERVER_RESPONSE_LIMIT_EXCEEDED 3
+        # OBOE_SERVER_RESPONSE_INVALID_API_KEY 4
+        # OBOE_SERVER_RESPONSE_CONNECT_ERROR 5
+        AppopticsAPM::Context.isReady(wait_milliseconds) == 1
       end
     end
 

data/lib/appoptics_apm/version.rb

@@ -8,7 +8,7 @@ module AppOpticsAPM
   module Version
     MAJOR = 4
     MINOR = 2
-    PATCH = 3
+    PATCH = 4
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

data/lib/appoptics_apm/xtrace.rb

@@ -30,7 +30,7 @@ module AppOpticsAPM
       end
 
       def sampled?(xtrace)
-        xtrace[59].to_i & 1 == 1
+        valid?(xtrace) && xtrace[59].to_i & 1 == 1
       end
 
       def set_sampled(xtrace)

data/lib/oboe_metal.rb

@@ -21,25 +21,27 @@ module AppOpticsAPM
         return unless AppOpticsAPM.loaded
 
         begin
-          protocol = ENV.key?('APPOPTICS_GEM_TEST') ? 'file' :
-                       ENV['TRACELYTICS_REPORTER'] || 'ssl'
+          options = []
 
-          case protocol
+          ENV['APPOPTICS_REPORTER'] = 'file' if ENV.key?('APPOPTICS_GEM_TEST')
+
+          case ENV['APPOPTICS_REPORTER']
           when 'file'
-            options = "file=#{TRACE_FILE}"
+            ENV['APPOPTICS_REPORTER_FILE'] = TRACE_FILE
           when 'udp'
-            options = "addr=#{AppOpticsAPM::Config[:reporter_host]},port=#{AppOpticsAPM::Config[:reporter_port]}"
-          else
-            if ENV['APPOPTICS_SERVICE_KEY'].to_s == ''
+            ENV['APPOPTICS_REPORTER_UDP'] = "#{AppOpticsAPM::Config[:reporter_host]}:#{AppOpticsAPM::Config[:reporter_port]}"
+          else # default is ssl, service_key is mandatory
+            if AppOpticsAPM::Config[:service_key].to_s == '' && ENV['APPOPTICS_SERVICE_KEY'].to_s == ''
               AppOpticsAPM.logger.warn "[appoptics_apm/warn] APPOPTICS_SERVICE_KEY not set. Cannot submit data."
               AppOpticsAPM.loaded = false
               return
             end
-            # ssl reporter requires the service key passed in as arg "cid"
-            options = "cid=#{ENV['APPOPTICS_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
-
-          AppOpticsAPM.reporter = Oboe_metal::Reporter.new(protocol, options)
+          AppOpticsAPM.reporter = Oboe_metal::Reporter.new(*options)
 
           # Only report __Init from here if we are not instrumenting a framework.
           # Otherwise, frameworks will handle reporting __Init after full initialization