appmap 0.78.0 → 0.80.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dce970e998105e2e322410b204af7a0ff48790cd177225468e9b49c75651fdb
-  data.tar.gz: d93b8f4f0690bf5ade69b2c08e4354d3043567fc4bf6018d6e68084eece08be9
+  metadata.gz: de1e5a636c3d6e807f11c54a29563e338804f3d101dc4779229596455cd60682
+  data.tar.gz: cf2aba805fdb427da2a642826f490b0002eb1892dd57a07693b119582a8cd7e1
 SHA512:
-  metadata.gz: bea7fecb6bbae7feb68fa649ecba6276b3d497312ff99054c527d2f74117b584dd7119fa8e4a346b0091089786e90a0a2f2f375f1bc94a0e5437dfa8cff99e20
-  data.tar.gz: 913ab70d04467c584ecf5edfe4c8d60807974cf3d01eb9f2107ceaaa8677c157dc3b0e4130b6e90dcdaba3ba055b4a5268b40e94d0054eb6c41d1146205b0eff
+  metadata.gz: 6056dda497e69c32a6e7550c76b4b4e40a5cd5405d7244748af4f5f34ed7d6790eafa206470ac8c9a98019fec802944b4cec0cc274451028cf2c5d6f405bd626
+  data.tar.gz: '039ef96a6ae64cf641e58fb364a2777a65dc507ded48027752ca766c65204659b844cb6408d17a077947968d1fbf006f7c9b29e2fdfe03fc392d90c4495361ff'

data/.travis.yml

@@ -1,5 +1,8 @@
 language: ruby
 dist: bionic
+cache:
+- bundle
+- yarn
 
 # NB: if you update the ruby versions here, you also need to update
 # them in the Rakefile.
@@ -9,25 +12,10 @@ rbenv:
 - 3.0
 - 3.1
 
-addons:
-  apt:
-    packages:
-      # https://docs.travis-ci.com/user/docker/#installing-a-newer-docker-version
-      - docker-ce
-
 services:
-- docker
+- postgresql
 
 before_install:
-  - sudo apt-get update && sudo apt-get install apt-transport-https ca-certificates -y && sudo update-ca-certificates
-  # see https://blog.travis-ci.com/docker-rate-limits 
-  # and also https://www.docker.com/blog/what-you-need-to-know-about-upcoming-docker-hub-rate-limiting/
-  # if we do not use authorized account, 
-  # the pulls-per-IP quota is shared with other Travis users
-  - >
-    if [ ! -z "$DOCKERHUB_PASSWORD" ] && [ ! -z "$DOCKERHUB_USERNAME" ]; then
-      echo "$DOCKERHUB_PASSWORD" | docker login -u "$DOCKERHUB_USERNAME" --password-stdin  ;
-    fi
   - |
     nvm install --lts \
       && nvm use --lts \

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [0.80.1](https://github.com/applandinc/appmap-ruby/compare/v0.80.0...v0.80.1) (2022-04-08)
+
+
+### Bug Fixes
+
+* Don't call #size on complex objects ([3f19d1e](https://github.com/applandinc/appmap-ruby/commit/3f19d1e67288379570dfa14d8758a0624d2c6c34))
+
+# [0.80.0](https://github.com/applandinc/appmap-ruby/compare/v0.79.0...v0.80.0) (2022-04-08)
+
+
+### Bug Fixes
+
+* Don't record SQL within an existing event ([ff37a69](https://github.com/applandinc/appmap-ruby/commit/ff37a69af1af02263df216e49aea0d0954b93925))
+
+
+### Features
+
+* Env var to EXPLAIN queries ([740be75](https://github.com/applandinc/appmap-ruby/commit/740be75c2bc59e343d67ecf86b7715e61cddadba))
+* Optionally record parameter schema ([b7f41b1](https://github.com/applandinc/appmap-ruby/commit/b7f41b15a4556a0ce78650a6a77301d365632bb8))
+* query_plan is available whether a current transaction exists or not ([6edf774](https://github.com/applandinc/appmap-ruby/commit/6edf774fea858d825c4b971be2c4c15db1652446))
+* Record parameter and return value size ([6e69754](https://github.com/applandinc/appmap-ruby/commit/6e697543cb421378832492e286f972dc4cb1e1aa))
+* Save render return value to a thread-local ([f9d1e3f](https://github.com/applandinc/appmap-ruby/commit/f9d1e3f0aa9972482ff77233d38220104515b1d6))
+
+# [0.79.0](https://github.com/applandinc/appmap-ruby/compare/v0.78.0...v0.79.0) (2022-04-06)
+
+
+### Features
+
+* Use a more unique test database name ([0eed036](https://github.com/applandinc/appmap-ruby/commit/0eed036460f0384698ff91c1112a4a9c3214f7f4))
+
 # [0.78.0](https://github.com/applandinc/appmap-ruby/compare/v0.77.4...v0.78.0) (2022-04-04)
 
 

data/README.md

@@ -28,7 +28,7 @@ Visit the [AppMap for Ruby](https://appland.com/docs/reference/appmap-ruby.html)
 
 **Configuration**
 
-*appmap.yml* is loaded into an `AppMap::Config`. 
+*appmap.yml* is loaded into an `AppMap::Config`.
 
 **Hooking**
 
@@ -39,7 +39,7 @@ method with calls that record the parameters and return value.
 **Builtins**
 
 `Hook` begins by iterating over builtin classes and modules defined in the `Config`. Builtins include code
-like `openssl` and `net/http`. This code is not dependent on any external libraries being present, and 
+like `openssl` and `net/http`. This code is not dependent on any external libraries being present, and
 `appmap` cannot guarantee that it will be loaded before builtins. Therefore, it's necessary to require it and
 hook it by looking up the classes and modules as constants in the `Object` namespace.
 
@@ -81,50 +81,20 @@ The fixture apps in `test/fixtures` are plain Ruby projects that exercise the ba
 
 The fixture apps in `spec/fixtures` are simple Rack, Rails5, and Rails6 apps.
 You can use them to interactively develop and test the recording features of the `appmap` gem.
-These fixture apps are more sophisticated than `test/fixtures`, because they include additional 
-resources such as a PostgreSQL database.
+These fixture apps are more sophisticated than `test/fixtures`, because they include additional
+resources such as a PostgreSQL database. Still, you can simply enter the fixture directory and `bundle`.
 
-To build the fixture container images, first run:
+If you don't have PostgreSQL on the local (default) socket, you can export `DATABASE_URL` to
+point to the database server you want to use. 
 
-```sh-session
-$ bundle exec rake build:fixtures:all
-```
-
-This will build the `appmap.gem`, along with a Docker image for each fixture app.
-
-Then move to the directory of the fixture you want to use, and provision the environment.
-In this example, we use Ruby 2.6.
-
-```sh-session
-$ export RUBY_VERSION=2.6
-$ docker-compose up -d pg
-$ sleep 10s # Or some reasonable amount of time
-$ docker-compose run --rm app ./create_app
-```
+You can launch a database like this:
 
-Now you can start a development container.
-
-```sh-session
-$ docker-compose run --rm -v $PWD:/app -v $PWD/../../..:/src/appmap-ruby app bash
-Starting rails_users_app_pg_1 ... done
-root@6fab5f89125f:/app# cd /src/appmap-ruby
-root@6fab5f89125f:/src/appmap-ruby# rm ext/appmap/*.so ext/appmap/*.o
-root@6fab5f89125f:/src/appmap-ruby# bundle
-root@6fab5f89125f:/src/appmap-ruby# bundle exec rake compile
-root@6fab5f89125f:/src/appmap-ruby# cd /src/app
-root@6fab5f89125f:/src/app# bundle config local.appmap /src/appmap-ruby
-root@6fab5f89125f:/src/app# bundle
 ```
-
-At this point, the bundle is built with the `appmap` gem located  in `/src/appmap`, which is volume-mounted from the host.
-So you can edit the fixture code and the appmap code and run test commands such as `rspec` in the container.
-For example:
-
-```sh-session
-root@6fab5f89125f:/src/app# APPMAP=true bundle exec rspec
-Configuring AppMap from path appmap.yml
-....
-
-Finished in 0.07357 seconds (files took 2.1 seconds to load)
-4 examples, 0 failures
+➜ docker-compose -p appmap-ruby up -d
+... stuff
+➜ docker-compose ps pg  
+      Name                    Command                 State                Ports         
+-----------------------------------------------------------------------------------------
+appmap-ruby_pg_1   docker-entrypoint.sh postgres   Up (healthy)   0.0.0.0:59134->5432/tcp
+➜ export DATABASE_URL=postgres://postgres@localhost:59134
 ```

data/README_CI.md

@@ -4,13 +4,6 @@
 * `GEM_HOST_API_KEY`: rubygems API key
 * `GEM_ALTERNATIVE_NAME` (optional): used for testing of CI flows, 
 to avoid publication of test releases under official package name
-* `DOCKERHUB\_USERNAME`, `DOCKERHUB_PASSWORD`: optional dockerhub credentials, 
-to avoid throttling of dockerhub anonymous pulls
-
-Note: for security reasons, it's better to use dedicated (not personal) 
-Dockerhub account, 
-and also use [access tokens](https://docs.docker.com/docker-hub/access-tokens/) 
-instead of primary password
 
 # Release command
 

data/Rakefile

@@ -1,26 +1,8 @@
 $: << File.join(__dir__, 'lib')
-require 'appmap/version'
-GEM_VERSION = AppMap::VERSION
-
-# Make sure the local version is not behind the one on
-# rubygems.org (it's ok if they're the same).
-#
-# If it is behind, the fixture images won't get updated with the gem
-# built from the local source, so you'll wind up testing the rubygems
-# version instead.
-unless ENV['SKIP_VERSION_CHECK']
-  require 'json'
-  require 'net/http'
-  rubygems_version = JSON.parse(Net::HTTP.get(URI.parse('https://rubygems.org/api/v1/gems/appmap.json')))['version']
-  if Gem::Version.new(GEM_VERSION) < Gem::Version.new(rubygems_version)
-    raise "#{GEM_VERSION} < #{rubygems_version}. Rebase to avoid build issues."
-  end
-end
 
+require 'rspec/core/rake_task'
 require 'rake/testtask'
 require 'rdoc/task'
-
-require 'open3'
 require 'rake/extensiontask'
 
 desc 'build the native extension'
@@ -28,138 +10,20 @@ Rake::ExtensionTask.new("appmap") do |ext|
   ext.lib_dir = "lib/appmap"
 end
 
-RUBY_VERSIONS=%w[2.6 2.7 3.0 3.1].select do |version|
-  travis_ruby_version = ENV['TRAVIS_RUBY_VERSION']
-  next true unless travis_ruby_version
-
-  if travis_ruby_version.index(version) == 0
-    warn "Testing Ruby version #{version}, since it matches TRAVIS_RUBY_VERSION=#{travis_ruby_version}"
-    next true
-  end
-
-  false
-end
-FIXTURE_APPS=[:rack_users_app, :rails6_users_app, :rails5_users_app, :rails7_users_app => {:ruby_version => '>= 2.7'}]
-
-def run_cmd(*cmd)
-  $stderr.puts "Running: #{cmd}"
-  out, s = Open3.capture2e(*cmd)
-  unless s.success?
-    $stderr.puts <<-END
-      Command failed:
-      <<< Output:
-      #{out}
-      >>> End of output
-    END
-    raise 'Docker build failed'
-  end
-end
-
-def build_base_image(ruby_version)
-  run_cmd "docker build" \
-         " --build-arg RUBY_VERSION=#{ruby_version}"    \
-         " --build-arg GEM_VERSION=#{GEM_VERSION}"      \
-         " -t appmap:#{GEM_VERSION} -f Dockerfile.appmap ."
-end
-
-def build_app_image(app, ruby_version)
-  Dir.chdir "spec/fixtures/#{app}" do
-    env = {"RUBY_VERSION" => ruby_version, "GEM_VERSION" => GEM_VERSION}
-    run_cmd(env,
-      "docker-compose build" \
-      " --build-arg RUBY_VERSION=#{ruby_version}" \
-      " --build-arg GEM_VERSION=#{GEM_VERSION}"  ) 
-  end
-end
-
 desc 'Install non-Ruby dependencies'
 task :install do
   system 'yarn install' or raise 'yarn install failed'
 end
 
-namespace :build do
-  namespace :base do
-    RUBY_VERSIONS.each do |ruby_version|
-      desc ruby_version
-      task ruby_version do
-        run_system = ->(cmd) { system(cmd) or raise "Command failed: #{cmd}" }
-
-        run_system.call 'mkdir -p pkg'
-        run_system.call "gem build appmap.gemspec --output pkg/appmap-#{GEM_VERSION}.gem"
-        build_base_image(ruby_version)
-      end.tap do |t|
-        desc "Build all images"
-        task all: t
-      end
-    end
-  end
-
-  namespace :fixtures do
-    RUBY_VERSIONS.each do |ruby_version|
-      namespace ruby_version do
-        desc "build:fixtures:#{ruby_version}"
-        FIXTURE_APPS.each do |app_spec|
-          app = if app_spec.instance_of?(Hash)
-            app_spec = app_spec.flatten
-            version_rqt = Gem::Requirement.create(app_spec[1][:ruby_version])
-            next unless version_rqt =~ (Gem::Version.new(ruby_version))
-            app = app_spec[0]
-          else
-            app = app_spec
-          end.to_s
-
-
-          desc app
-          task app => ["base:#{ruby_version}"] do
-            build_app_image(app, ruby_version)
-          end.tap do |t|
-            desc "Build all fixture images for #{ruby_version}"
-            task all: t
-          end
-        end
-      end
-
-      desc "Build all fixture images"
-      task all: ["#{ruby_version}:all"]
-    end
-  end
-
-  task all: ["fixtures:all"]
-end
-
-def run_specs(ruby_version, task_args)
-  require 'rspec/core/rake_task'
-  require 'climate_control'
-  # Define an rspec rake task for the specified Ruby version. It's hidden (i.e. doesn't have a
-  # description), because it's not intended to be invoked directly
-  RSpec::Core::RakeTask.new("rspec_#{ruby_version}", [:specs]) do |task, args|
-    task.exclude_pattern = 'spec/fixtures/**/*_spec.rb'
-    task.rspec_opts = '-f doc'
-    if args.count > 0
-      # There doesn't appear to be a value for +pattern+ that will
-      # cause it to be ignored. Setting it to '' or +nil+ causes an
-      # empty argument to get passed to rspec, which confuses it.
-      task.pattern = 'never match this'
-      task.rspec_opts += " " + args.to_a.join(' ')
-    end
-  end
-
-  # Set up the environment, then execute the rspec task we
-  # created above.
-  ClimateControl.modify(RUBY_VERSION: ruby_version) do
-    Rake::Task["rspec_#{ruby_version}"].execute(task_args)
-  end
-end
-
-namespace :spec do
-  RUBY_VERSIONS.each do |ruby_version|
-    desc ruby_version
-    task ruby_version, [:specs] => ["install", "compile", "build:fixtures:#{ruby_version}:all"] do |_, task_args|
-      run_specs(ruby_version, task_args)
-    end.tap do |t|
-      desc "Run all specs"
-      task :all, [:specs] => t
-    end
+RSpec::Core::RakeTask.new spec: %i[compile install] do |task, args|
+  task.exclude_pattern = 'spec/fixtures/**/*_spec.rb'
+  task.rspec_opts = '-f doc'
+  if args.count > 0
+    # There doesn't appear to be a value for +pattern+ that will
+    # cause it to be ignored. Setting it to '' or +nil+ causes an
+    # empty argument to get passed to rspec, which confuses it.
+    task.pattern = 'never match this'
+    task.rspec_opts += [nil, *args].join(' ')
   end
 end
 
@@ -169,14 +33,12 @@ Rake::RDocTask.new do |rd|
   rd.title = 'AppMap'
 end
 
-Rake::TestTask.new(minitest: 'compile') do |t|
+Rake::TestTask.new(minitest: :compile) do |t|
   t.libs << 'test'
   t.libs << 'lib'
   t.test_files = FileList['test/*_test.rb']
 end
 
-task spec: %i[spec:all]
-
-task test: %i[spec:all minitest]
+task test: %i[spec minitest]
 
 task default: :test

data/appmap.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'appmap/version'
 
 Gem::Specification.new do |spec|
-  # ability to parameterize gem name is added intentionally, 
+  # ability to parameterize gem name is added intentionally,
   # to support the possibility of unofficial releases, e.g. during CI tests
   spec.name          = (ENV['GEM_ALTERNATIVE_NAME'].to_s.empty? ? 'appmap' : ENV["GEM_ALTERNATIVE_NAME"] )
   spec.version       = AppMap::VERSION
@@ -32,7 +32,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'reverse_markdown'
 
   spec.add_development_dependency 'bundler', '>= 1.16'
-  spec.add_development_dependency 'minitest', '~> 5.14'
+  spec.add_development_dependency 'minitest', '~> 5.15'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rdoc'
@@ -48,5 +48,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webdrivers', '~> 4.0'
   spec.add_development_dependency 'timecop'
   spec.add_development_dependency 'hashie'
+  spec.add_development_dependency 'random-port', '~> 0.5.1'
   spec.add_development_dependency 'webrick'
 end

data/docker-compose.yml

@@ -0,0 +1,10 @@
+version: "3"
+services:
+  pg:
+    build:
+      context: .
+      dockerfile: Dockerfile.pg
+    ports:
+      - "5432"
+    environment:
+      POSTGRES_HOST_AUTH_METHOD: trust

data/lib/appmap/agent.rb

@@ -100,5 +100,13 @@ module AppMap
       @metadata ||= Metadata.detect.freeze
       Util.deep_dup(@metadata)
     end
+
+    def parameter_schema?
+      ENV['APPMAP_PARAMETER_SCHEMA'] == 'true'
+    end
+
+    def explain_queries?
+      ENV['APPMAP_EXPLAIN_QUERIES'] == 'true'
+    end
   end
 end

data/lib/appmap/event.rb

@@ -60,16 +60,25 @@ module AppMap
           final ? value_string : encode_display_string(value_string)
         end
 
-        def object_properties(hash_like)
-          hash = hash_like.to_h
-          hash.keys.map do |key|
-            {
-              name: key,
-              class: hash[key].class.name,
-            }
+        def add_size(param, value)
+          # Don't risk calling #size on things like data-access objects, which can and will issue queries for this information.
+          if value.is_a?(Array) || value.is_a?(Hash)
+            param[:size] = value.size
+          end
+        end
+
+        def add_schema(param, value)
+          begin
+            if value.respond_to?(:keys)
+              param[:properties] = value.keys.map { |key| { name: key, class: best_class_name(value[key]) } }
+            elsif value.respond_to?(:first) && value.first
+              if value.first != value
+                add_schema param, value.first
+              end
+            end
+          rescue
+            warn "Error in add_schema(#{value.class})", $!
           end
-        rescue
-          nil
         end
 
         # Heuristic for dynamically defined class whose name can be nil
@@ -221,7 +230,9 @@ module AppMap
                 object_id: value.__id__,
                 value: display_string(value),
                 kind: param_type
-              }
+              }.tap do |param|
+                add_size param, value
+              end
             end
             event.receiver = {
               class: best_class_name(receiver),
@@ -276,7 +287,7 @@ module AppMap
       attr_accessor :return_value, :exceptions
 
       class << self
-        def build_from_invocation(parent_id, return_value, exception, elapsed: nil, event: MethodReturn.new)
+        def build_from_invocation(parent_id, return_value, exception, elapsed: nil, event: MethodReturn.new, parameter_schema: false)
           event ||= MethodReturn.new
           event.tap do |_|
             if return_value
@@ -284,7 +295,10 @@ module AppMap
                 class: best_class_name(return_value),
                 value: display_string(return_value),
                 object_id: return_value.__id__
-              }
+              }.tap do |param|
+                add_size param, return_value
+                add_schema param, return_value if parameter_schema && !exception
+              end
             end
             if exception
               next_exception = exception

data/lib/appmap/gem_hooks/actionpack.yml

@@ -43,3 +43,9 @@
   - ActionController::Instrumentation#redirect_to
   label: mvc.controller
   require_name: action_controller
+- methods:
+  - AbstractController::Rendering#render_to_body
+  - ActionController::Renderers#render_to_body
+  label: mvc.render
+  handler_class: AppMap::Handler::Rails::RenderHandler
+  require_name: action_controller

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

@@ -0,0 +1,29 @@
+require 'appmap/handler/function'
+
+module AppMap
+  module Handler
+    module Rails
+      class RenderHandler < AppMap::Handler::Function
+        def handle_call(receiver, args)
+          options, _ = args
+          # TODO: :file, :xml
+          # https://guides.rubyonrails.org/v5.1/layouts_and_rendering.html
+          if options[:json]
+            Thread.current[TEMPLATE_RENDER_FORMAT] = :json
+          end
+
+          super
+        end
+
+        def handle_return(call_event_id, elapsed, return_value, exception)
+          if Thread.current[TEMPLATE_RENDER_FORMAT] == :json
+            Thread.current[TEMPLATE_RENDER_VALUE] = JSON.parse(return_value) rescue nil
+          end
+          Thread.current[TEMPLATE_RENDER_FORMAT] = nil
+
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -7,6 +7,7 @@ require 'appmap/util'
 module AppMap
   module Handler
     module Rails
+
       module RequestHandler
         class HTTPServerRequest < AppMap::Event::MethodEvent
           attr_accessor :normalized_path_info, :request_method, :path_info, :params, :headers
@@ -46,8 +47,7 @@ module AppMap
                     value: self.class.display_string(val),
                     object_id: val.__id__,
                   }.tap do |message|
-                    properties = object_properties(val)
-                    message[:properties] = properties if properties
+                    AppMap::Event::MethodEvent.add_schema message, val
                   end
                 end
               end
@@ -67,16 +67,16 @@ module AppMap
           end
         end
 
-        class HTTPServerResponse < AppMap::Event::MethodReturnIgnoreValue
+        class HTTPServerResponse < AppMap::Event::MethodReturn
           attr_accessor :status, :headers
 
-          def initialize(response, parent_id, elapsed)
-            super AppMap::Event.next_id_counter, :return, Thread.current.object_id
-
-            self.status = response.status
-            self.parent_id = parent_id
-            self.elapsed = elapsed
-            self.headers = response.headers.dup
+          class << self
+            def build_from_invocation(parent_id, return_value, elapsed, response, event: HTTPServerResponse.new)
+              event ||= HTTPServerResponse.new
+              event.status = response.status
+              event.headers = response.headers.dup
+              AppMap::Event::MethodReturn.build_from_invocation parent_id, return_value, nil, elapsed: elapsed, event: event, parameter_schema: true
+            end
           end
 
           def to_h
@@ -108,7 +108,9 @@ module AppMap
           end
 
           def after_hook(receiver, call_event, elapsed, *)
-            return_event = HTTPServerResponse.new receiver.response, call_event.id, elapsed
+            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
             AppMap.tracing.record_event return_event
           end
         end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'appmap/event'
+require 'appmap/hook/method'
 
 module AppMap
   module Handler
@@ -21,6 +22,7 @@ module AppMap
                 sql: payload[:sql],
                 database_type: payload[:database_type]
               }.tap do |sql_query|
+                sql_query[:query_plan] = payload[:query_plan] if payload[:query_plan]
                 %i[server_version].each do |attribute|
                   sql_query[attribute] = payload[attribute] if payload[attribute]
                 end
@@ -43,6 +45,36 @@ module AppMap
             def examine(payload, sql:)
               return unless (examiner = build_examiner)
 
+              in_transaction = examiner.in_transaction?
+
+              if AppMap.explain_queries? && examiner.database_type == :postgres
+                if sql =~ /\A(SELECT|INSERT|UPDATE|DELETE|WITH)/i
+                  savepoint_established = \
+                    begin
+                      tx_query = in_transaction ? 'SAVEPOINT appmap_sql_examiner' : 'BEGIN TRANSACTION'
+                      examiner.execute_query tx_query
+                      true
+                    rescue
+                      # Probably: Sequel::DatabaseError: PG::InFailedSqlTransaction
+                      warn $!
+                      false
+                    end
+
+                  if savepoint_established
+                    plan = nil
+                    begin
+                      plan = examiner.execute_query(%(EXPLAIN #{sql}))
+                      payload[:query_plan] = plan.map { |line| line[:'QUERY PLAN'] }.join("\n")
+                    rescue
+                      warn "(appmap) Error explaining query: #{$!}"
+                    ensure
+                      tx_query = in_transaction ? 'ROLLBACK TO SAVEPOINT appmap_sql_examiner' : 'ROLLBACK'
+                      examiner.execute_query tx_query
+                    end
+                  end
+                end
+              end
+
               payload[:server_version] = examiner.server_version
               payload[:database_type] = examiner.database_type.to_s
             end
@@ -67,6 +99,10 @@ module AppMap
               Sequel::Model.db.database_type.to_sym
             end
 
+            def in_transaction?
+              Sequel::Model.db.in_transaction?
+            end
+
             def execute_query(sql)
               Sequel::Model.db[sql].all
             end
@@ -93,8 +129,12 @@ module AppMap
               type
             end
 
+            def in_transaction?
+              ActiveRecord::Base.connection.open_transactions > 0
+            end
+
             def execute_query(sql)
-              ActiveRecord::Base.connection.execute(sql).inject([]) { |memo, r| memo << r; memo }
+              ActiveRecord::Base.connection.execute(sql).to_a
             end
           end
         end
@@ -102,6 +142,8 @@ module AppMap
         def call(_, started, finished, _, payload) # (name, started, finished, unique_id, payload)
           return if AppMap.tracing.empty?
 
+          return if Thread.current[AppMap::Hook::Method::HOOK_DISABLE_KEY] == true
+
           reentry_key = "#{self.class.name}#call"
           return if Thread.current[reentry_key] == true