skylight 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc19196b2920db75b79fae6c65192174b3493387acf49ac77a6217b3790ba04e
-  data.tar.gz: da0c089c1fbc0531e9a8f1753e64cfdd79792edb50c36778e4862d0b27598c21
+  metadata.gz: ab247cb921b7d63dec0fc2fd7c6987a862986953f06765ae3472f59fb3c5ccbd
+  data.tar.gz: da9348e64a843ee5547808ead23c14b904d61c18431eebbf60e8aa36f41db2ef
 SHA512:
-  metadata.gz: 426d918a456c5c47442534b3c7f51d2f36d05425077930b167383954fcea702d3be0abdf67acada63a1272dbcfe31c7632ac24c1dc8ffb579a7ca431f43b6412
-  data.tar.gz: 31c169c52f43217b53d361b18327311915ad70b09bdb35354816eec1ed3b341611cb02f0bd40566a9641122e8d75974d487ecb43eb8ee1086b1e132fda37fd14
+  metadata.gz: db622c8b9bcada4c1806d4891632587510e4ee06bee1ddc265d29bbf816aef404e403a8b5e1aa584342f1867089aba945de6de3dd3d8c13d38c97e3fce526be9
+  data.tar.gz: 79445c8d91cda531854c1e7ae9799be4b78e921fe7c4588a1bc4e1c5292546d34ac237c35d973759e9a6bc071bbe7fcd567079c71d8c462d76e93ba0becdf684

data/CHANGELOG.md

@@ -1,11 +1,17 @@
-## 5.2.0
+## 5.3.0 (February, 9, 2022)
+
+- [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/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/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/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/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".freeze
+  VERSION = "5.3.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-03 00:00:00.000000000 Z
+date: 2022-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -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