appmap 0.92.0 → 0.93.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78d8c3cf7967b06242390e3d11ddd24c5cf29fd70244b93b2bf170323747b762
-  data.tar.gz: 10147c54915b55d8a67723d1721c31a9e809983bb9b0012cdb2f480e9dcf3695
+  metadata.gz: 837bc5a036d3217c12b40f46ed7e21406ef298b3ca5c8b712b8ce1f15707434e
+  data.tar.gz: 763d5c9abd0f8583035117a54c8a6bb0d841089c902ab2e1805ff0795f3acff1
 SHA512:
-  metadata.gz: 7ce433191ab8e3699feeb995951df0653ef9b89bb11edc7ca671b80011a2af1818e08c22eaa4f0777ec364be9e6e9d8bfec84099ff518d43768fb710e005b681
-  data.tar.gz: f0c99190697605e71658d9c3c602913954604396c7fb3cc31db09edb1b4cb8bdd1fb4f184e762ff15458b64e5078cd69ac04c324eddd0b4d83e28e3c2b324bb0
+  metadata.gz: 7812c770c07f1e00dc93e0ce4c79598c26daff3fe1d737804dcfc012d29cdefe0754cd3ff06f2810feebe1952cb2038cee2f078d486067188875ec7eb71842de
+  data.tar.gz: 73db38443e22f4a57bf8575035b4735f7fe044f57dd78f6213ac2694434487732778cb0feacb3733c0565080dd859b22dfcf651ec129b70f028a1500a9ff63ea

data/.github/workflows/main.yml

@@ -12,5 +12,5 @@ jobs:
     steps:
       - uses: actions/add-to-project@main
         with:
-          project-url: https://github.com/orgs/applandinc/projects/15
+          project-url: https://github.com/orgs/getappmap/projects/15
           github-token: ${{ secrets.ADD_TO_PROJECT_BOARD_PAT }}

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+# [0.93.0](https://github.com/getappmap/appmap-ruby/compare/v0.92.1...v0.93.0) (2022-09-22)
+
+
+### Features
+
+* Record the time spent instrumentating a function, as opposed to only the time spend executing a function ([0941b4d](https://github.com/getappmap/appmap-ruby/commit/0941b4d343b1ea2964268d3a47d8f762de00deea))
+* save elapsed_instrumentation for HTTP requests ([a32fb52](https://github.com/getappmap/appmap-ruby/commit/a32fb526a6f7b47ddc859e86a68b53b50b052061))
+* save elapsed_instrumentation for RequestListener ([5a081cc](https://github.com/getappmap/appmap-ruby/commit/5a081ccf558a4591035acc81b1717b2ccef880ee))
+* Save elapsed_instrumentation for sql_query ([40a851e](https://github.com/getappmap/appmap-ruby/commit/40a851e5d40cc5ada36ea52e32d5222da4c67d10))
+
+## [0.92.1](https://github.com/getappmap/appmap-ruby/compare/v0.92.0...v0.92.1) (2022-09-21)
+
+
+### Bug Fixes
+
+* Drop database server version ([e52f210](https://github.com/getappmap/appmap-ruby/commit/e52f210baa26be49232003c224e4ffee19be823d))
+
 # [0.92.0](https://github.com/applandinc/appmap-ruby/compare/v0.91.0...v0.92.0) (2022-09-19)
 
 

data/lib/appmap/event.rb

@@ -262,7 +262,7 @@ module AppMap
     end
 
     class MethodReturnIgnoreValue < MethodEvent
-      attr_accessor :parent_id, :elapsed
+      attr_accessor :parent_id, :elapsed, :elapsed_instrumentation
 
       class << self
         def build_from_invocation(parent_id, elapsed: nil, event: MethodReturnIgnoreValue.new)
@@ -279,6 +279,7 @@ module AppMap
         super.tap do |h|
           h[:parent_id] = parent_id
           h[:elapsed] = elapsed if elapsed
+          h[:elapsed_instrumentation] = elapsed_instrumentation if elapsed_instrumentation
         end
       end
     end

data/lib/appmap/handler/rails/request_handler.rb

@@ -10,7 +10,7 @@ module AppMap
 
       module RequestHandler
         class HTTPServerRequest < AppMap::Event::MethodEvent
-          attr_accessor :normalized_path_info, :request_method, :path_info, :params, :headers
+          attr_accessor :normalized_path_info, :request_method, :path_info, :params, :headers, :call_elapsed_instrumentation
 
           def initialize(request)
             super AppMap::Event.next_id_counter, :call, Thread.current.object_id
@@ -101,16 +101,21 @@ module AppMap
           protected
 
           def before_hook(receiver, *)
+            before_hook_start_time = AppMap::Util.gettime()
             call_event = HTTPServerRequest.new(receiver.request)
+            call_event.call_elapsed_instrumentation = (AppMap::Util.gettime() - before_hook_start_time)
             # http_server_request events are i/o and do not require a package name.
             AppMap.tracing.record_event call_event, defined_class: defined_class, method: hook_method
             call_event
           end
 
           def after_hook(receiver, call_event, elapsed, *)
+            after_hook_start_time = AppMap::Util.gettime()
             return_value = Thread.current[TEMPLATE_RENDER_VALUE]
             Thread.current[TEMPLATE_RENDER_VALUE] = nil
             return_event = HTTPServerResponse.build_from_invocation call_event.id, return_value, elapsed, receiver.response
+            return_event.elapsed_instrumentation = (AppMap::Util.gettime() - after_hook_start_time) + call_event.call_elapsed_instrumentation
+            call_event.call_elapsed_instrumentation = nil # to stay consistent with elapsed_instrumentation only being stored in return
             AppMap.tracing.record_event return_event
           end
         end
@@ -134,13 +139,16 @@ module AppMap
           end
 
           def before_hook(payload)
+            before_hook_start_time = AppMap::Util.gettime()
             @call_event = HTTPServerRequest.new payload[:request]
+            @call_event.call_elapsed_instrumentation = (AppMap::Util.gettime() - before_hook_start_time)
             AppMap.tracing.record_event @call_event
           end
 
           def after_hook(_name, started, finished, _unique_id, payload)
             return unless @request_id == payload[:request].request_id
 
+            after_hook_start_time = AppMap::Util.gettime()
             return_value = Thread.current[TEMPLATE_RENDER_VALUE]
             Thread.current[TEMPLATE_RENDER_VALUE] = nil
             return_event = HTTPServerResponse.build_from_invocation(
@@ -149,6 +157,7 @@ module AppMap
               finished - started,
               payload[:response] || payload
             )
+            return_event.elapsed_instrumentation = (AppMap::Util.gettime() - after_hook_start_time) + @call_event.call_elapsed_instrumentation
 
             AppMap.tracing.record_event return_event
             ActiveSupport::Notifications.unsubscribe(@subscriber)

data/lib/appmap/handler/rails/sql_handler.rb

@@ -2,6 +2,7 @@
 
 require 'appmap/event'
 require 'appmap/hook/method'
+require 'appmap/util'
 
 module AppMap
   module Handler
@@ -75,7 +76,6 @@ module AppMap
                 end
               end
 
-              payload[:server_version] = examiner.server_version
               payload[:database_type] = examiner.database_type.to_s
             end
 
@@ -92,6 +92,8 @@ module AppMap
 
           class SequelExaminer
             def server_version
+              # Queries the database, therefore this is pretty unsafe to do inside of a hook.
+              # As a result, this is not being used at the moment.
               Sequel::Model.db.server_version
             end
 
@@ -147,6 +149,8 @@ module AppMap
           reentry_key = "#{self.class.name}#call"
           return if Thread.current[reentry_key] == true
 
+          after_start_time = AppMap::Util.gettime()
+
           Thread.current[reentry_key] = true
           begin
             sql = payload[:sql].strip
@@ -155,7 +159,9 @@ module AppMap
 
             call = SQLCall.new(payload)
             AppMap.tracing.record_event(call)
-            AppMap.tracing.record_event(SQLReturn.new(call.id, finished - started))
+            sql_return_event = SQLReturn.new(call.id, finished - started)
+            sql_return_event.elapsed_instrumentation = AppMap::Util.gettime() - after_start_time
+            AppMap.tracing.record_event(sql_return_event)
           ensure
             Thread.current[reentry_key] = nil
           end

data/lib/appmap/hook/method/ruby2.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'appmap/util'
+
 def ruby2_keywords(*); end unless respond_to?(:ruby2_keywords, true)
 
 module AppMap
@@ -8,15 +10,19 @@ module AppMap
     # cf. https://eregon.me/blog/2019/11/10/the-delegation-challenge-of-ruby27.html
     class Method
       ruby2_keywords def call(receiver, *args, &block)
-        call_event = trace? && with_disabled_hook { before_hook receiver, *args }
+        call_event = false
+        if trace?
+          call_event, elapsed_before = with_disabled_hook { before_hook receiver, *args }
+        end
         # note we can't short-circuit directly to do_call because then the call stack
         # depth changes and eval handler doesn't work correctly
-        trace_call call_event, receiver, *args, &block
+        trace_call call_event, elapsed_before, receiver, *args, &block
       end
 
       protected
 
       def before_hook(receiver, *args)
+        before_hook_start_time = AppMap::Util.gettime()
         call_event = handle_call(receiver, args)
         if call_event
           AppMap.tracing.record_event \
@@ -25,7 +31,7 @@ module AppMap
             defined_class: defined_class,
             method: hook_method
         end
-        call_event
+        [call_event, AppMap::Util.gettime() - before_hook_start_time]
       end
 
       ruby2_keywords def do_call(receiver, *args, &block)
@@ -33,17 +39,18 @@ module AppMap
       end
 
       # rubocop:disable Metrics/MethodLength
-      ruby2_keywords def trace_call(call_event, receiver, *args, &block)
+      ruby2_keywords def trace_call(call_event, elapsed_before, receiver, *args, &block)
         return do_call(receiver, *args, &block) unless call_event
 
-        start_time = gettime
+        start_time = AppMap::Util.gettime()
         begin
           return_value = do_call(receiver, *args, &block)
         rescue # rubocop:disable Style/RescueStandardError
           exception = $ERROR_INFO
           raise
         ensure
-          with_disabled_hook { after_hook receiver, call_event, gettime - start_time, return_value, exception } \
+          after_start_time = AppMap::Util.gettime()
+          with_disabled_hook { after_hook receiver, call_event, elapsed_before, after_start_time - start_time, after_start_time, return_value, exception } \
             if call_event
         end
       end

data/lib/appmap/hook/method/ruby3.rb

@@ -1,19 +1,25 @@
 # frozen_string_literal: true
 
+require 'appmap/util'
+
 module AppMap
   class Hook
     # Delegation methods for Ruby 3.
     class Method
       def call(receiver, *args, **kwargs, &block)
-        call_event = trace? && with_disabled_hook { before_hook receiver, *args, **kwargs }
+        call_event = false
+        if trace?
+          call_event, elapsed_before = with_disabled_hook { before_hook receiver, *args, **kwargs }
+        end
         # note we can't short-circuit directly to do_call because then the call stack
         # depth changes and eval handler doesn't work correctly
-        trace_call call_event, receiver, *args, **kwargs, &block
+        trace_call call_event, elapsed_before, receiver, *args, **kwargs, &block
       end
 
       protected
 
       def before_hook(receiver, *args, **kwargs)
+        before_hook_start_time = AppMap::Util.gettime()
         args = [*args, kwargs] if !kwargs.empty? || keyrest?
         call_event = handle_call(receiver, args)
         if call_event
@@ -23,7 +29,7 @@ module AppMap
             defined_class: defined_class,
             method: hook_method
         end
-        call_event
+        [call_event, AppMap::Util.gettime() - before_hook_start_time]
       end
 
       def keyrest?
@@ -35,17 +41,18 @@ module AppMap
       end
 
       # rubocop:disable Metrics/MethodLength
-      def trace_call(call_event, receiver, *args, **kwargs, &block)
+      def trace_call(call_event, elapsed_before, receiver, *args, **kwargs, &block)
         return do_call(receiver, *args, **kwargs, &block) unless call_event
 
-        start_time = gettime
+        start_time = AppMap::Util.gettime()
         begin
           return_value = do_call(receiver, *args, **kwargs, &block)
         rescue # rubocop:disable Style/RescueStandardError
           exception = $ERROR_INFO
           raise
         ensure
-          with_disabled_hook { after_hook receiver, call_event, gettime - start_time, return_value, exception } \
+          after_start_time = AppMap::Util.gettime()
+          with_disabled_hook { after_hook receiver, call_event, elapsed_before, after_start_time - start_time, after_start_time, return_value, exception } \
             if call_event
         end
       end

data/lib/appmap/hook/method.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'appmap/util'
+
 module AppMap
   class Hook
     SIGNATURES = {}
@@ -78,10 +80,6 @@ module AppMap
         warn "#{hook_method.name} not found on #{hook_class}" if Hook::LOG
       end
 
-      def gettime
-        Process.clock_gettime Process::CLOCK_MONOTONIC
-      end
-
       def trace?
         return false unless AppMap.tracing_enabled?
         return false if Thread.current[HOOK_DISABLE_KEY]
@@ -102,8 +100,9 @@ module AppMap
         @defined_class ||= Hook.qualify_method_name(hook_method)&.first
       end
 
-      def after_hook(_receiver, call_event, elapsed, return_value, exception)
+      def after_hook(_receiver, call_event, elapsed_before, elapsed, after_start_time, return_value, exception)
         return_event = handle_return(call_event.id, elapsed, return_value, exception)
+        return_event.elapsed_instrumentation = elapsed_before + (AppMap::Util.gettime() - after_start_time)
         AppMap.tracing.record_event(return_event) if return_event
       end
 

data/lib/appmap/util.rb

@@ -86,6 +86,7 @@ module AppMap
       def sanitize_event(event, &block)
         event.delete(:thread_id)
         event.delete(:elapsed)
+        event.delete(:elapsed_instrumentation)
         delete_object_id = ->(obj) { (obj || {}).delete(:object_id) }
         delete_object_id.call(event[:receiver])
         delete_object_id.call(event[:return_value])
@@ -231,6 +232,10 @@ module AppMap
       def ruby_minor_version
         @ruby_minor_version ||= RUBY_VERSION.split('.')[0..1].join('.').to_f
       end
+
+      def gettime
+        Process.clock_gettime Process::CLOCK_MONOTONIC
+      end
     end
   end
 end

data/lib/appmap/version.rb

@@ -3,7 +3,7 @@
 module AppMap
   URL = 'https://github.com/applandinc/appmap-ruby'
 
-  VERSION = '0.92.0'
+  VERSION = '0.93.0'
 
   APPMAP_FORMAT_VERSION = '1.9.0'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appmap
 version: !ruby/object:Gem::Version
-  version: 0.92.0
+  version: 0.93.0
 platform: ruby
 authors:
 - Kevin Gilpin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -455,7 +455,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Record the operation of a Ruby program, using the AppLand 'AppMap' format.