skylight 5.2.0.beta2 → 5.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99481f50c8e9caf68288746feb32c93d2a969c0770c573ea6a4f5339deca7a8e
-  data.tar.gz: f39c3462788ebd87ec29c56c3863efac94bf9be18f023c93540d4af96228ba18
+  metadata.gz: 25e5b7ab0cc3d787b7192d6ec29ea90ce7c1088f13660d58601cc00d30a88b27
+  data.tar.gz: a171ca96752f9e2f6cf02a6fc18a3a64b7fa4c280d9d2c2428d489c6a3b46d85
 SHA512:
-  metadata.gz: 8ea1d4c80b043c085f612cbee130f10079b0a9f24392552a4a14b3fcd327831f8ca61d19fee4570d1a04d7289e18d431ff5f9ed5a8d567eb69afa7fd6f6d9fea
-  data.tar.gz: cc73adc6a339389ecfeca93f7a91496958f6769c24bea6d29dad2885800c8b5f3273635522450f56c6de3f53f42045219e32e054edc80620a5abe1cde779f682
+  metadata.gz: a388dd96bd6253ae8db5b5dae947be514888714bdcd0d4a91d0a3e4d15b33c826da018637ce24e2341eeaab917ab6b84671eae481d872a99dc1bc7c8c2dbc400
+  data.tar.gz: 41bcd860d6ae637670cc0b0abde0a4b9e4970cecfc19fab781fa15cdee24d73bcc2fec62dfa984f24568fc27d1b7379ff2791a5f49a4e7107992f620ab7a45cb

data/CHANGELOG.md

@@ -1,14 +1,21 @@
-## 5.2.0-beta2 (10 November 2021)
+## 5.3.1 (February 28, 2022)
 
-- [FEATURE] Experimental gRPC transport
-- [IMPROVEMENT] Internal native client refactors
-- [BUGFIX] Fix some internal errors related to Rails 7 alpha
+- [BUGFIX] Fix Elasticsearch integration for gem versions >= 8.
+
+## 5.3.0 (February, 9, 2022)
 
-## 5.2.0-beta (7 September 2021)
+- [FEATURE] Support for Rails 7's `load_async`.
+- [IMPROVEMENT] `skylight doctor` now checks glibc compatibility.
+- [BUGFIX] Fix an issue where `skylight doctor` wouldn't correctly log installation errors.
 
+## 5.2.0 (February 3, 2022)
+
+- [FEATURE] Experimental gRPC transport
+- [IMPROVEMENT] Internal native client refactors
 - [IMPROVEMENT] Add Rack::Builder probe to better instrument middlewares in Sinatra and other Builder-based apps
+- [BUGFIX] Fix some internal errors related to Rails 7
 - [BUGFIX] Fix an issue in which trace logging could output the incorrect request ID.
-- [BUGFIX] fix native extension configuration for arm64 hosts
+- [BUGFIX] Fix native extension configuration for arm64 hosts
 
 ## 5.1.1 (May 27, 2021)
 

data/ext/extconf.rb

@@ -9,6 +9,22 @@ $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 require "skylight/native_ext_fetcher"
 require "skylight/util/platform"
 
+GLIBC_MIN = 2.23
+GLIBC_V4_MIN = 2.15
+
+ldd_output =
+  begin
+    `ldd --version`
+  rescue Errno::ENOENT
+    nil
+  end
+
+if ldd_output =~ /GLIBC (\d+(\.\d+)+)/ && ($1.to_f < GLIBC_MIN)
+  message = "glibc #{GLIBC_MIN}+ is required but you have #{$1} installed."
+  message << "\nYou may be able to use Skylight v4 instead." if $1.to_f >= GLIBC_V4_MIN
+  fail message
+end
+
 # Util allowing proxying writes to multiple location
 class MultiIO
   def initialize(*targets)

data/ext/libskylight.yml

@@ -1,9 +1,9 @@
-version: "5.1.0-f504521"
+version: "5.1.0-6812c12"
 checksums:
-  x86-linux:          "46bdaaf5a0b2605e1bf581756317dcac7cd6db66bda1b2994dd8de5f933f752e"
-  x86_64-linux:       "300e3d2e770c2cefdb43bde6d6538bde69c18ec9c6b50210f24959a8efcd8749"
-  x86_64-linux-musl:  "9f790db33f2c4f6c68ecb2d4719c881e3cf3634ac3718db4c108994d6c55f6a8"
-  x86_64-darwin:      "90c4ff6650350f084495cc031bb70ae1ef7a4934712a0c97dcdbfc6ce418342c"
-  aarch64-linux:      "f5437881ecb6ac59af1e8c89e19e68baf52730088efd030855b2e40bc714a2ba"
-  aarch64-linux-musl: "d52bac0d1a0d965940ded2168acb72d2c23b060eb1bac9983763cc8b7cada8ba"
-  aarch64-darwin:     "b92c85242b94e7eb71680de41a504a22e9dba145408bdd810757e693e065456d"
+  x86-linux:          "d3acbbcd14209e8564226e005db2163b7d1ae49133eb250a7901ff2687abe330"
+  x86_64-linux:       "dfb1062572780285795eef2e99d32ff3ad6be1c944c1a6add442488f7a4a9b22"
+  x86_64-linux-musl:  "af09469f20c666a15ccbb910d8906c6a69a99f87f69db6cbba41908baf3fcef2"
+  x86_64-darwin:      "eb4cb7b9301e0b1f88623203a4476bdabf299ec62556dc40bedda78c5eeb1437"
+  aarch64-linux:      "3d5e8743c4dfdde5be3b6162c75b0351ff0be5658819c1fec9f3a936c4c81a32"
+  aarch64-linux-musl: "30705f76e333f4883a9481a34bc2dfeb7e9fd6f98c0cf8afbe63f232f3ceb1e5"
+  aarch64-darwin:     "9f8ffc752b0e17bde587e5a5510b17554096b2b65fa2e19203ff1ee3a3145b1d"

data/ext/skylight_native.c

@@ -520,6 +520,7 @@ void Init_skylight_native() {
 
   rb_cTrace = rb_const_get(rb_mSkylight, rb_intern("Trace"));
   rb_define_singleton_method(rb_cTrace, "native_new", trace_new, 4);
+  rb_undef_alloc_func(rb_cTrace);
   rb_define_method(rb_cTrace, "native_get_started_at", trace_get_started_at, 0);
   rb_define_method(rb_cTrace, "native_get_endpoint", trace_get_endpoint, 0);
   rb_define_method(rb_cTrace, "native_set_endpoint", trace_set_endpoint, 1);
@@ -540,6 +541,7 @@ void Init_skylight_native() {
 
   rb_cInstrumenter = rb_const_get(rb_mSkylight, rb_intern("Instrumenter"));
   rb_define_singleton_method(rb_cInstrumenter, "native_new", instrumenter_new, 2);
+  rb_undef_alloc_func(rb_cInstrumenter);
   rb_define_method(rb_cInstrumenter, "native_start", instrumenter_start, 0);
   rb_define_method(rb_cInstrumenter, "native_stop", instrumenter_stop, 0);
   rb_define_method(rb_cInstrumenter, "native_submit_trace", instrumenter_submit_trace, 1);

data/lib/skylight/cli/doctor.rb

@@ -65,7 +65,7 @@ module Skylight
             say "Unable to load native extension", :yellow
 
             indent do
-              install_log = File.expand_path("../../ext/install.log", __dir__)
+              install_log = File.expand_path("../../../ext/install.log", __dir__)
               if File.exist?(install_log)
                 File.readlines(install_log).each { |line| say line, :red }
               else

data/lib/skylight/config.rb

@@ -659,7 +659,7 @@ module Skylight
         corrected_config = res.corrected_config
 
         # Use defaults if no corrected config is available. This will happen if the request failed.
-        corrected_config ||= SERVER_VALIDATE.map { |k| [k, self.class.default_values.fetch(k)] }.to_h
+        corrected_config ||= SERVER_VALIDATE.to_h { |k| [k, self.class.default_values.fetch(k)] }
 
         config_to_update = corrected_config.reject { |k, v| get(k) == v }
         unless config_to_update.empty?

data/lib/skylight/instrumenter.rb

@@ -36,7 +36,7 @@ module Skylight
       end
     end
 
-    attr_reader :uuid, :config, :gc, :extensions
+    attr_reader :uuid, :config, :gc, :extensions, :subscriber
 
     def self.native_new(_uuid, _config_env)
       raise "not implemented"

data/lib/skylight/normalizers/active_record/sql.rb

@@ -7,6 +7,14 @@ module Skylight
       class SQL < Skylight::Normalizers::SQL
         register "sql.active_record"
       end
+
+      class FutureResult < Normalizer
+        register "future_result.active_record"
+
+        def normalize(_trace, _name, payload)
+          ["db.future_result", "Async #{payload[:args][1] || "Query"}"]
+        end
+      end
     end
   end
 end

data/lib/skylight/normalizers/sql.rb

@@ -14,14 +14,10 @@ module Skylight
       # @option payload [String] [:name] The SQL operation
       # @option payload [Hash] [:binds] The bound parameters
       # @return [Array]
-      def normalize(_trace, name, payload)
-        case payload[:name]
-        when "SCHEMA", "CACHE"
-          return :skip
-        else
-          name = CAT
-          title = payload[:name] || "SQL"
-        end
+      def normalize(_trace, _name, payload)
+        return :skip if payload[:name] == "SCHEMA" || payload[:name] == "CACHE"
+
+        title = payload[:name] || "SQL"
 
         # We can only handle UTF-8 encoded strings.
         # (Construction method here avoids extra allocations)
@@ -38,7 +34,7 @@ module Skylight
           sql = nil
         end
 
-        [name, title, sql]
+        [CAT, title, sql]
       end
     end
   end

data/lib/skylight/probes/active_record_async.rb

@@ -0,0 +1,96 @@
+module Skylight
+  module Probes
+    module ActiveRecord
+      module FutureResult
+        # Applied to ActiveSupport::Notifications::Event
+        module AsyncEventExtensions
+          # Notify Skylight that the event has started
+          def __sk_start!
+            subscriber = Skylight.instrumenter.subscriber
+            subscriber.start(name, nil, payload)
+            trace = Skylight.instrumenter.current_trace
+
+            # Set a finisher to end the event
+            @__sk_finisher = ->(name, payload) do
+              subscriber.with_trace(trace) { subscriber.finish(name, nil, payload) }
+            end
+
+            # End it immediately if we've actually already ended
+            __sk_finish! if @end
+          rescue StandardError => e
+            Skylight.error("Unable to start event for FutureResult: #{e}")
+          end
+
+          # Notify Skylight that the event has finished
+          def __sk_finish!
+            return unless @__sk_finisher
+
+            @__sk_finisher.call(name, payload)
+            @__sk_finisher = nil
+          rescue StandardError => e
+            Skylight.error("Unable to finish event for FutureResult: #{e}")
+          end
+
+          # When the event is marked as finish make sure we notify Skylight
+          def finish!
+            super
+            __sk_finish!
+          end
+        end
+
+        # Applied to FutureResult
+        module Instrumentation
+          def result(*, **)
+            # This instruments the whole FutureResult so that we know when we were executing (potenially) async.
+            ActiveSupport::Notifications.instrument("future_result.active_record", { args: @args, kwargs: @kwargs }) do
+              super
+            end
+          end
+
+          private
+
+          def execute_or_wait(*, **)
+            # At this point we're actually waiting for the query to have finished executing.
+
+            begin
+              # If the query has already started async, the @event_buffer will be defined.
+              # We grab the events (currently only the SQL queries), extend them with our
+              # special methods and notify Skylight.
+              # We act as if the event has just stared, though the query may already have been
+              # running. This means we're essentially just logging blocking time right now.
+
+              # Dup here just in case more get added somehow during the super call
+              events = @event_buffer&.instance_variable_get(:@events).dup
+
+              events&.each do |event|
+                event.singleton_class.prepend(AsyncEventExtensions)
+                event.__sk_start!
+              end
+            rescue StandardError => e
+              Skylight.error("Unable to start events for FutureResult: #{e}")
+            end
+
+            super
+          ensure
+            # Once we've actually got a result, we mark each one as finished.
+            # Note that it may have already finished, but if it didn't we need to say so now.
+            events&.reverse_each(&:__sk_finish!)
+          end
+        end
+
+        class Probe
+          def install
+            ::ActiveRecord::FutureResult.prepend(Instrumentation)
+          end
+        end
+      end
+    end
+
+    register(
+      :active_record_async,
+      "ActiveRecord::FutureResult",
+      "active_record/future_result",
+      ActiveRecord::FutureResult::Probe.new
+    )
+  end
+end

data/lib/skylight/probes/elasticsearch.rb

@@ -3,8 +3,17 @@ module Skylight
     module Elasticsearch
       class Probe
         def install
+          const =
+            if defined?(::Elasticsearch::Transport::Transport::Base)
+              ::Elasticsearch::Transport::Transport::Base
+            elsif defined?(::Elastic::Transport::Transport::Base)
+              ::Elastic::Transport::Transport::Base
+            else
+              return false
+            end
+
           # Prepending doesn't work here since this a module that's already been included
-          ::Elasticsearch::Transport::Transport::Base.class_eval do
+          const.class_eval do
             alias_method :perform_request_without_sk, :perform_request
             def perform_request(method, path, *args, &block)
               ActiveSupport::Notifications.instrument(

data/lib/skylight/railtie.rb

@@ -16,7 +16,15 @@ module Skylight
     #   net_http, action_controller, action_dispatch, action_view, and middleware are on by default
     #   See https://www.skylight.io/support/getting-more-from-skylight#available-instrumentation-options
     #   for a full list.
-    config.skylight.probes = %w[net_http action_controller action_dispatch action_view middleware active_job_enqueue]
+    config.skylight.probes = %w[
+      net_http
+      action_controller
+      action_dispatch
+      action_view
+      middleware
+      active_job_enqueue
+      active_record_async
+    ]
 
     # The position in the middleware stack to place Skylight
     # Default is first, but can be `{ after: Middleware::Name }` or `{ before: Middleware::Name }`

data/lib/skylight/subscriber.rb

@@ -36,16 +36,30 @@ module Skylight
       end
     end
 
+    # cargo-culted from Rails's ConnectionAdapter
+    EXCEPTION_NEVER = { Exception => :never }.freeze # :nodoc:
+    EXCEPTION_IMMEDIATE = { Exception => :immediate }.freeze # :nodoc:
+    private_constant :EXCEPTION_NEVER, :EXCEPTION_IMMEDIATE
+    def with_trace(trace, &block) # :nodoc:
+      Thread.handle_interrupt(EXCEPTION_NEVER) do
+        previous_trace = @trace
+        @trace = trace
+        Thread.handle_interrupt(EXCEPTION_IMMEDIATE, &block)
+      ensure
+        @trace = previous_trace
+      end
+    end
+
     def start(name, _id, payload)
       return if @instrumenter.disabled?
-      return unless (trace = @instrumenter.current_trace)
+      return unless (trace = current_trace)
 
       _start(trace, name, payload)
     end
 
     def finish(name, _id, payload)
       return if @instrumenter.disabled?
-      return unless (trace = @instrumenter.current_trace)
+      return unless (trace = current_trace)
 
       while (curr = trace.notifications.pop)
         next unless curr.name == name
@@ -70,8 +84,16 @@ module Skylight
       # Ignored for now because nothing in rails uses it
     end
 
+    def publish_event(event)
+      # Ignored for now because only ActiveRecord::FutureResult uses it and we handle that with probes
+    end
+
     private
 
+    def current_trace
+      @trace || @instrumenter.current_trace
+    end
+
     def normalize(*args)
       @normalizers.normalize(*args)
     end

data/lib/skylight/test.rb

@@ -25,10 +25,6 @@ module Skylight
                   "Mocked Instrumenter"
                 end
 
-                def self.native_new(*)
-                  allocate
-                end
-
                 def native_start
                   true
                 end
@@ -47,7 +43,7 @@ module Skylight
               :Trace,
               Class.new(OriginalTrace) do
                 def self.native_new(start, _uuid, endpoint, meta)
-                  inst = allocate
+                  inst = super
                   inst.instance_variable_set(:@start, start)
                   inst.instance_variable_set(:@endpoint, endpoint)
                   inst.instance_variable_set(:@starting_endpoint, endpoint)

data/lib/skylight/version.rb

@@ -3,5 +3,5 @@ module Skylight
   # for compatibility with semver when it is parsed by the rust agent.
   # This string will be transformed in the gemspec to "5.0.0.alpha"
   # to conform with rubygems.
-  VERSION = "5.2.0-beta2".freeze
+  VERSION = "5.3.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 5.2.0.beta2
+  version: 5.3.1
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-11 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: 1.25.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.21.0
+        version: 1.25.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -285,6 +285,7 @@ files:
 - lib/skylight/probes/active_job.rb
 - lib/skylight/probes/active_job_enqueue.rb
 - lib/skylight/probes/active_model_serializers.rb
+- lib/skylight/probes/active_record_async.rb
 - lib/skylight/probes/delayed_job.rb
 - lib/skylight/probes/elasticsearch.rb
 - lib/skylight/probes/excon.rb
@@ -367,7 +368,8 @@ files:
 homepage: https://www.skylight.io
 licenses:
 - Nonstandard
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -379,11 +381,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Skylight is a smart profiler for Rails, Sinatra, and other Ruby apps.