appoptics_apm 4.2.7 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d859819610b985d65fe379af2f65e3ffec0627acff6dd9be4e243597f8e0574
-  data.tar.gz: 5ec8816746382d1a301c81e450cdf63a53f8b77bff6a3495187c6806d43bf01f
+  metadata.gz: 170c3e8f35f9e439942788b3a801282c4a1deaee3090e8957bc76bdf9a209915
+  data.tar.gz: 4e23ef886ee0f9358dfba882bc35e0258b229b0c5fa617055345216e85376999
 SHA512:
-  metadata.gz: f2d1084a46dda8a0d2cb0a7f3f931125d81ad89caa85cce06bf50c19de9a286c819730f03844a882bcc433217cfe55ec8511b52618468c92160fd1e09dd669ed
-  data.tar.gz: f4e3043a915cdd562de21dc881ae2bf54c8b2dd48fb95d6c4e5a86d039dc0070f6a9c970fb252f096ce32fc15161ada8a44aa0060c38688972740646a1065628
+  metadata.gz: 2fa70bacf8b44352826eb859bd687385a801fb1ea3c3289f8c7e79cff251ec6e05bbeb6510780af9b61a25376c171265a4308118da84c975a7a3d6a8ac803f3a
+  data.tar.gz: 763038da0e769d87d450d356fb517db8e908d337c0c989a9ae91a278fe7d42f09355b9c06a2f394dd5a30c0ff513587aeb65db24fcc828b186baacc629700470

data/.travis.yml

@@ -11,9 +11,9 @@ env:
   - DBTYPE=mysql
 
 rvm:
-  - 2.5.1
-  - 2.4.4
-  - 2.3.6
+  - 2.5.3
+  - 2.4.5
+  - 2.3.8
 #  - jruby-9.0.5.0
 
 gemfile:
@@ -23,7 +23,7 @@ gemfile:
   - gemfiles/instrumentation_mocked_oldgems.gemfile
   - gemfiles/frameworks.gemfile
   - gemfiles/rails52.gemfile
-#  - gemfiles/rails51.gemfile
+  - gemfiles/rails51.gemfile
   - gemfiles/rails42.gemfile
 ##  - gemfiles/rails32.gemfile # We currently are not supporting Rails 3.2
   - gemfiles/delayed_job.gemfile
@@ -31,9 +31,9 @@ gemfile:
 
 matrix:
   exclude:
-    - rvm: 2.5.1
+    - rvm: 2.5.3
       env: DBTYPE=mysql
-    - rvm: 2.4.4
+    - rvm: 2.4.5
       env: DBTYPE=mysql
 
     - gemfile: gemfiles/unit.gemfile
@@ -72,10 +72,10 @@ matrix:
 
     # Rails 3.2 is not compatible with Ruby >= 2.4
     # We currently are not supporting Rails 3.2
-    - rvm: 2.5.1
-      gemfile: gemfiles/rails32.gemfile
-    - rvm: 2.4.4
-      gemfile: gemfiles/rails32.gemfile
+#    - rvm: 2.5.1
+#      gemfile: gemfiles/rails32.gemfile
+#    - rvm: 2.4.4
+#      gemfile: gemfiles/rails32.gemfile
 
 #    - rvm: jruby-9.0.5.0
 #      gemfile: gemfiles/delayed_job.gemfile

data/Rakefile

@@ -96,7 +96,7 @@ task :fetch_ext_deps do
   open(remote_file, 'rb') do |rf|
     content = rf.read
     File.open(local_file, 'wb') { |f| f.puts content }
-    puts "C-Lib VERSION: #{content}"
+    puts "!!!!!!! C-Lib VERSION: #{content.strip} !!!!!!!!"
   end
 
   # oboe and bson header files

data/appoptics_apm.gemspec

@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
     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')
   end

data/ext/oboe_metal/extconf.rb

@@ -62,6 +62,7 @@ while retries > 0
       $stderr.puts 'Download of the c-extension for the appoptics_apm gem failed.'
       $stderr.puts 'appoptics_apm will not instrument the code. No tracing will occur.'
       $stderr.puts 'Contact support@appoptics.com if the problem persists.'
+      $stderr.puts "error:\n#{e.message}"
       $stderr.puts '==================================================================='
       create_makefile('oboe_noop', 'noop')
     end

data/ext/oboe_metal/src/VERSION

@@ -1 +1 @@
-3.1.4
+3.2.0

data/lib/appoptics_apm/api/logging.rb

@@ -76,6 +76,7 @@ module AppOpticsAPM
           return AppOpticsAPM::Context.toString
         end
 
+        exception.message << exception.class.name if exception.message.length < 4
         opts.merge!(:Spec => 'error',
                     :ErrorClass => exception.class.name,
                     :ErrorMsg => exception.message)

data/lib/appoptics_apm/api/metrics.rb

@@ -23,7 +23,7 @@ module  AppOpticsAPM
         yield
       ensure
         duration =(1000 * 1000 * (Time.now - start)).round(0)
-        transaction_name = determine_transaction_name(span)
+        transaction_name = determine_transaction_name(span, kvs)
         kvs[:TransactionName] = AppOpticsAPM::Span.createSpan(transaction_name, nil, duration)
         AppOpticsAPM.transaction_name = nil
       end
@@ -31,16 +31,23 @@ module  AppOpticsAPM
       private
 
       ##
-      # Determine the transaction name to be set on the trace
+      # Determine the transaction name to be set on the trace.
       #
       # === Argument:
-      # * +opts+ (hash) the value of :TransactionName will be set as custom transaction name
+      # * +span+ the name of the current span (used to construct a transaction name if none is defined)
+      # * +kvs+ (hash, optional) the hash that may have values for 'Controller' and 'Action'
       #
       # === Returns:
-      # (string) the current transaction name
+      # (string) the determined transaction name
       #
-      def determine_transaction_name(span)
-        AppOpticsAPM.transaction_name || AppOpticsAPM::SDK.set_transaction_name("custom-#{span}")
+      def determine_transaction_name(span, kvs = {})
+        if AppOpticsAPM.transaction_name
+          AppOpticsAPM.transaction_name
+        elsif kvs['Controller'] && kvs['Action']
+          [kvs['Controller'], kvs['Action']].join('.')
+        else
+          "custom-#{span}"
+        end
       end
 
     end

data/lib/appoptics_apm/config.rb

@@ -14,7 +14,7 @@ module AppOpticsAPM
     @@instrumentation = [:action_controller, :action_controller_api, :action_view,
                          :active_record, :bunnyclient, :bunnyconsumer, :cassandra, :curb,
                          :dalli, :delayed_jobclient, :delayed_jobworker,
-                         :em_http_request, :excon, :faraday, :grape,
+                         :em_http_request, :excon, :faraday, :grpc_client, :grape,
                          :httpclient, :nethttp, :memcached, :mongo, :moped, :rack, :redis,
                          :resqueclient, :resqueworker, :rest_client,
                          :sequel, :sidekiqclient, :sidekiqworker, :typhoeus]

data/lib/appoptics_apm/frameworks/grape.rb

@@ -60,7 +60,7 @@ module AppOpticsAPM
 
             # Since Grape uses throw/catch and not Exceptions, we have to create an exception here
             exception = GrapeError.new(error[:message] ? error[:message] : "No message given.")
-            exception.set_backtrace(::AppOpticsAPM::API.backtrace) if AppOpticsAPM::Config[:grape][:collect_backtraces]
+            exception.set_backtrace(::AppOpticsAPM::API.backtrace)
 
             ::AppOpticsAPM::API.log_exception('rack', exception )
 

data/lib/appoptics_apm/inst/grpc_client.rb

@@ -0,0 +1,161 @@
+# Copyright (c) 2018 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module GRPC
+
+    module ActiveCall
+      if defined? ::GRPC
+        StatusCodes = {}
+        ::GRPC::Core::StatusCodes.constants.each { |code| StatusCodes[::GRPC::Core::StatusCodes.const_get(code)] = code }
+      end
+
+      def self.included(klass)
+        ::AppOpticsAPM::Util.method_alias(klass, :request_response, ::GRPC::ActiveCall)
+        ::AppOpticsAPM::Util.method_alias(klass, :client_streamer, ::GRPC::ActiveCall)
+        ::AppOpticsAPM::Util.method_alias(klass, :server_streamer, ::GRPC::ActiveCall)
+        ::AppOpticsAPM::Util.method_alias(klass, :bidi_streamer, ::GRPC::ActiveCall)
+      end
+
+      def grpc_tags(method_type, method)
+        tags = { 'Spec' => 'rsc',
+                 'RemoteURL' => "grpc://#{peer}#{method}",
+                 'GRPCMethodType' => method_type,
+                 'IsService' => 'True'
+        }
+        tags['Backtrace'] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:grpc_client][:collect_backtraces]
+        tags
+      end
+
+      def request_response_with_appoptics(req, metadata: {})
+        unary_response(req, type: 'UNARY', metadata: metadata, without: :request_response_without_appoptics)
+      end
+
+      def client_streamer_with_appoptics(req, metadata: {})
+        unary_response(req, type: 'CLIENT_STREAMING', metadata: metadata, without: :client_streamer_without_appoptics)
+      end
+
+      def server_streamer_with_appoptics(req, metadata: {}, &blk)
+        @tags = grpc_tags('SERVER_STREAMING', metadata[:method] || metadata_to_send[:method])
+        AppOpticsAPM::API.log_entry('grpc_client', @tags)
+        metadata['x-trace'] = AppOpticsAPM::Context.toString
+        AppOpticsAPM::SDK.set_transaction_name(metadata[:method]) if AppOpticsAPM.transaction_name.nil?
+
+        patch_receive_and_check_status # need to patch this so that log_exit can be called after the enum is consumed
+
+        response = server_streamer_without_appoptics(req, metadata: metadata)
+        block_given? ? response.each { |r| yield r } : response
+      rescue => e
+        # this check is needed because the exception may have been logged in patch_receive_and_check_status
+        unless e.instance_variable_get(:@exn_logged)
+          context_from_incoming
+          AppOpticsAPM::API.log_exception('grpc_client', e)
+          AppOpticsAPM::API.log_exit('grpc_client', exit_tags(@tags))
+        end
+        raise e
+      end
+
+      def bidi_streamer_with_appoptics(req, metadata: {}, &blk)
+        @tags = grpc_tags('BIDI_STREAMING', metadata[:method] || metadata_to_send[:method])
+        AppOpticsAPM::API.log_entry('grpc_client', @tags)
+        metadata['x-trace'] = AppOpticsAPM::Context.toString
+        AppOpticsAPM::SDK.set_transaction_name(metadata[:method]) if AppOpticsAPM.transaction_name.nil?
+
+        patch_set_input_stream_done
+
+        response = bidi_streamer_without_appoptics(req, metadata: metadata)
+        block_given? ? response.each { |r| yield r } : response
+      rescue => e
+        unless e.instance_variable_get(:@exn_logged)
+          context_from_incoming
+          AppOpticsAPM::API.log_exception('grpc_client', e)
+          AppOpticsAPM::API.log_exit('grpc_client', exit_tags(@tags))
+        end
+        raise e
+      end
+
+      private
+
+      def unary_response(req, type: , metadata: , without:)
+        tags = grpc_tags(type, metadata[:method] || metadata_to_send[:method])
+        AppOpticsAPM::SDK.trace('grpc_client', tags) do
+          metadata['x-trace'] = AppOpticsAPM::Context.toString
+          AppOpticsAPM::SDK.set_transaction_name(metadata[:method]) if AppOpticsAPM.transaction_name.nil?
+          begin
+            send(without, req, metadata: metadata)
+          ensure
+            exit_tags(tags)
+            context_from_incoming
+          end
+        end
+      end
+
+      def patch_receive_and_check_status
+        def self.receive_and_check_status # need to patch this so that log_exit can be called after the enum is consumed
+          super
+          context_from_incoming
+        rescue => e
+          context_from_incoming
+          AppOpticsAPM::API.log_exception('grpc_client', e)
+          raise e
+        ensure
+          AppOpticsAPM::API.log_exit('grpc_client', exit_tags(@tags))
+        end
+      end
+
+      def patch_set_input_stream_done
+        # need to patch this instance method so that log_exit can be called after the enum is consumed
+        def self.set_input_stream_done
+          return if status.nil?
+          context_from_incoming
+          if status.code > 0
+            AppOpticsAPM::API.log_exception('grpc_client', $!)
+          end
+          AppOpticsAPM::API.log_exit('grpc_client', exit_tags(@tags))
+          super
+        end
+      end
+
+      def context_from_incoming
+        xtrace ||= @call.trailing_metadata['x-trace'] if @call.trailing_metadata && @call.trailing_metadata['x-trace']
+        xtrace ||= @call.metadata['x-trace'] if @call.metadata && @call.metadata['x-trace']
+        AppOpticsAPM::Context.fromString(xtrace) if xtrace
+      end
+
+      def exit_tags(tags)
+        # we need to translate the status.code, it is not the status.details we want, they are not matching 1:1
+        tags['GRPCStatus'] ||= @call.status ? StatusCodes[@call.status.code].to_s : 'UNKNOWN'
+        tags.delete('Backtrace')
+        tags
+      end
+    end
+
+  end
+end
+
+if defined?(::GRPC) && AppOpticsAPM::Config[:grpc_client][:enabled]
+  AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting GRPC' if AppOpticsAPM::Config[:verbose]
+
+  # Client side is instrumented in ActiveCall and ClientStub
+  ::AppOpticsAPM::Util.send_include(::GRPC::ActiveCall, ::AppOpticsAPM::GRPC::ActiveCall)
+
+  GRPC_ClientStub_ops = [:request_response, :client_streamer, :server_streamer, :bidi_streamer]
+  module GRPC
+    class ClientStub
+      GRPC_ClientStub_ops.reject { |m| !method_defined?(m) }.each do |m|
+        define_method("#{m}_with_appoptics") do |method, req, marshal, unmarshal, deadline: nil,
+            return_op: false, parent: nil,
+            credentials: nil, metadata: {}, &blk|
+
+          metadata[:method] = method
+          return send("#{m}_without_appoptics", method, req, marshal, unmarshal, deadline: deadline,
+                      return_op: return_op, parent: parent,
+                      credentials: credentials, metadata: metadata, &blk)
+        end
+
+        ::AppOpticsAPM::Util.method_alias(::GRPC::ClientStub, m)
+      end
+
+    end
+  end
+end

data/lib/appoptics_apm/inst/rack.rb

@@ -174,7 +174,7 @@ if AppOpticsAPM.loaded
       def transaction_name(env)
         if AppOpticsAPM.transaction_name
           AppOpticsAPM.transaction_name
-        elsif env['appoptics_apm.controller'] || env['appoptics_apm.action']
+        elsif env['appoptics_apm.controller'] && env['appoptics_apm.action']
           [env['appoptics_apm.controller'], env['appoptics_apm.action']].join('.')
         end
       end

data/lib/appoptics_apm/inst/typhoeus.rb

@@ -29,7 +29,7 @@ module AppOpticsAPM
 
           if response.code == 0
             exception = TyphoeusError.new(response.return_message)
-            exception.set_backtrace(AppOpticsAPM::API.backtrace) if AppOpticsAPM::Config[:typhoeus][:collect_backtraces]
+            exception.set_backtrace(AppOpticsAPM::API.backtrace)
             AppOpticsAPM::API.log_exception(:typhoeus, exception)
           end
 

data/lib/appoptics_apm/sdk.rb

@@ -173,22 +173,16 @@ module AppOpticsAPM
         return yield unless AppOpticsAPM.loaded
 
         if AppOpticsAPM::Context.isValid # not an entry span!
-          result = trace(span) { yield }
+          result = trace(span, opts) { yield }
           target['X-Trace'] = AppOpticsAPM::Context.toString
           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
-
+        transaction_name_from_opts(opts)
 
         AppOpticsAPM::API.log_start(span, xtrace, opts)
-        exit_evt = AppOpticsAPM::Context.createEvent
+        # AppOpticsAPM::Event.startTrace creates an Event without an Edge
+        exit_evt = AppOpticsAPM::Event.startTrace(AppOpticsAPM::Context.get)
         result = begin
           AppOpticsAPM::API.send_metrics(span, opts) do
             target['X-Trace'] = AppOpticsAPM::EventUtil.metadataString(exit_evt)
@@ -308,6 +302,21 @@ module AppOpticsAPM
         # OBOE_SERVER_RESPONSE_CONNECT_ERROR 5
         AppopticsAPM::Context.isReady(wait_milliseconds) == 1
       end
+
+      private
+      # private method
+      #
+      # This should only be called at the beginning of a transaction,
+      # when AppOpticsAPM.transaction_name needs to be set to nil
+      # or whatever is provided in the opts
+      def transaction_name_from_opts(opts)
+        # :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
+
+        AppOpticsAPM.transaction_name = transaction_name
+      end
     end
 
     extend Tracing

data/lib/appoptics_apm/util.rb

@@ -183,7 +183,10 @@ module AppOpticsAPM
       # This legacy version of build_init_report is used for apps without Bundler.
       #
       # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/AbcSize
+      #
+      # @deprecated Please use {#build_init_report} instead
       def legacy_build_init_report
+        AppOpticsAPM.logger.warn '[appoptics_apm/warn] Oboe::API will be deprecated in a future version.'
         platform_info = {}
 
         begin

data/lib/appoptics_apm/version.rb

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

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

@@ -176,6 +176,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:em_http_request][:enabled] = false
   AppOpticsAPM::Config[:excon][:enabled] = true
   AppOpticsAPM::Config[:faraday][:enabled] = true
+  AppOpticsAPM::Config[:grpc_client][:enabled] = true
   AppOpticsAPM::Config[:grape][:enabled] = true
   AppOpticsAPM::Config[:httpclient][:enabled] = true
   AppOpticsAPM::Config[:memcached][:enabled] = true
@@ -236,6 +237,7 @@ if defined?(AppOpticsAPM::Config)
   AppOpticsAPM::Config[:excon][:collect_backtraces] = true
   AppOpticsAPM::Config[:faraday][:collect_backtraces] = false
   AppOpticsAPM::Config[:grape][:collect_backtraces] = true
+  AppOpticsAPM::Config[:grpc_client][:collect_backtraces] = false
   AppOpticsAPM::Config[:httpclient][:collect_backtraces] = true
   AppOpticsAPM::Config[:memcached][:collect_backtraces] = false
   AppOpticsAPM::Config[:mongo][:collect_backtraces] = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appoptics_apm
 version: !ruby/object:Gem::Version
-  version: 4.2.7
+  version: 4.3.0
 platform: ruby
 authors:
 - Maia Engeli
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -102,6 +102,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest-hooks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 description: The AppOpticsAPM gem provides performance instrumentation for MRI Ruby
   and related frameworks.
 email: support@appoptics.com
@@ -178,6 +192,7 @@ files:
 - lib/appoptics_apm/inst/em-http-request.rb
 - lib/appoptics_apm/inst/excon.rb
 - lib/appoptics_apm/inst/faraday.rb
+- lib/appoptics_apm/inst/grpc_client.rb
 - lib/appoptics_apm/inst/http.rb
 - lib/appoptics_apm/inst/httpclient.rb
 - lib/appoptics_apm/inst/memcached.rb