skylight 5.3.2 → 5.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f70688b41eae2aba12100dfdc0fa2376de752498b870b951a215779dfab6f402
-  data.tar.gz: 07141a17727dd08c96059361ce86168ac45a34ff222ef8ebb77aa29ad6effce9
+  metadata.gz: eff8fe1dc5d710696a97b5e2a3cfe53eba04e34a9ded8c9b550bc82538b6dfbb
+  data.tar.gz: a1236552d1cee17eaf0c0aee7371e7f6f201ab6810c4721a7ac67dcfe1f70177
 SHA512:
-  metadata.gz: 4cae620358ed7fa0eabad6464346899217813cdccacc68980a0abd6a4b31c0416b0b65b0d66b6cf7f7746f73ca0ff00e689b72011990d1482c012b22b8f5fdb5
-  data.tar.gz: 75cfe4636a13c3fa194788f5153b114c816b249c2f57e3a7358df44a9fef4818fa452fe02268f4a01c4b4a7703bacff5394dd256c194de1c586cd5a38802c3e2
+  metadata.gz: e7a91c535de86e475c325c9a287c92754603e186e583691f4db240557a1d3fc9393ea0180c0e18273e86350c16562097b6040d709f91692340788b13c605a858
+  data.tar.gz: c0bbf8d365bf386a7e1a0ae858b8007cb4046416e91b69862b250c21938a72b725ad0b0f5f0d25ffc73fc4fb435dff705bcb50c00c416fcdf0bb58e9dbcf8cfc

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 5.3.4 (October 17, 2022)
+
+- [BUGFIX] Fix a middleware response method that was incompatible with Puma >= 6.
+- [IMPROVEMENT] Improved support for Redis v5
+
+## 5.3.3 (July 13, 2022)
+
+- [IMPROVEMENT] Track the original class/method name for Sidekiq delayed object proxies
+- [BUGFIX] Fix `mongoid` probe not activating correctly
+- [BUGFIX] Fix `mongo` probe not instrumenting clients created before Skylight initialization
+
 ## 5.3.2 (April 6, 2022)
 
 - [BUGFIX] Fix case-sensitivity issue when computing relative paths

data/ext/extconf.rb

@@ -43,19 +43,19 @@ end
 include Skylight::Util
 
 SKYLIGHT_INSTALL_LOG = File.expand_path("install.log", __dir__)
-SKYLIGHT_REQUIRED = ENV.key?("SKYLIGHT_REQUIRED") && ENV["SKYLIGHT_REQUIRED"] !~ /^false$/i
-SKYLIGHT_FETCH_LIB = !ENV.key?("SKYLIGHT_FETCH_LIB") || ENV["SKYLIGHT_FETCH_LIB"] !~ /^false$/i
+SKYLIGHT_REQUIRED = ENV.key?("SKYLIGHT_REQUIRED") && ENV.fetch("SKYLIGHT_REQUIRED", nil) !~ /^false$/i
+SKYLIGHT_FETCH_LIB = !ENV.key?("SKYLIGHT_FETCH_LIB") || ENV.fetch("SKYLIGHT_FETCH_LIB", nil) !~ /^false$/i
 
 # Directory where skylight.h exists
-SKYLIGHT_HDR_PATH = ENV["SKYLIGHT_HDR_PATH"] || ENV["SKYLIGHT_LIB_PATH"] || "."
+SKYLIGHT_HDR_PATH = ENV.fetch("SKYLIGHT_HDR_PATH") { ENV.fetch("SKYLIGHT_LIB_PATH", ".") }
 SKYLIGHT_LIB_PATH =
-  ENV["SKYLIGHT_LIB_PATH"] || File.expand_path("../../lib/skylight/native/#{Platform.tuple}", __FILE__)
+  ENV.fetch("SKYLIGHT_LIB_PATH") { File.expand_path("../../lib/skylight/native/#{Platform.tuple}", __FILE__) }
 
-SKYLIGHT_SOURCE_URL = ENV["SKYLIGHT_SOURCE_URL"]
-SKYLIGHT_VERSION = ENV["SKYLIGHT_VERSION"]
-SKYLIGHT_CHECKSUM = ENV["SKYLIGHT_CHECKSUM"]
+SKYLIGHT_SOURCE_URL = ENV.fetch("SKYLIGHT_SOURCE_URL", nil)
+SKYLIGHT_VERSION = ENV.fetch("SKYLIGHT_VERSION", nil)
+SKYLIGHT_CHECKSUM = ENV.fetch("SKYLIGHT_CHECKSUM", nil)
 
-SKYLIGHT_EXT_STRICT = ENV.key?("SKYLIGHT_EXT_STRICT") && ENV["SKYLIGHT_EXT_STRICT"] =~ /^true$/i
+SKYLIGHT_EXT_STRICT = ENV.key?("SKYLIGHT_EXT_STRICT") && ENV.fetch("SKYLIGHT_EXT_STRICT", nil) =~ /^true$/i
 
 # Setup logger
 LOG = Logger.new(MultiIO.new($stdout, File.open(SKYLIGHT_INSTALL_LOG, "a")))

data/lib/skylight/middleware.rb

@@ -13,7 +13,7 @@ module Skylight
       end
 
       def respond_to_missing?(name, include_all = false)
-        return false if name.to_s !~ /^to_ary$/
+        return false if name.to_s =~ /^to_ary$/
 
         @body.respond_to?(name, include_all)
       end

data/lib/skylight/native.rb

@@ -59,13 +59,13 @@ module Skylight
   end
 
   def self.libskylight_path
-    ENV["SKYLIGHT_LIB_PATH"] || File.expand_path("../native/#{Util::Platform.tuple}", __FILE__)
+    ENV.fetch("SKYLIGHT_LIB_PATH") { File.expand_path("../native/#{Util::Platform.tuple}", __FILE__) }
   end
 
-  skylight_required = ENV.key?("SKYLIGHT_REQUIRED") && ENV["SKYLIGHT_REQUIRED"] !~ /^false$/i
+  skylight_required = ENV.key?("SKYLIGHT_REQUIRED") && ENV.fetch("SKYLIGHT_REQUIRED", nil) !~ /^false$/i
 
   begin
-    unless ENV.key?("SKYLIGHT_DISABLE_AGENT") && ENV["SKYLIGHT_DISABLE_AGENT"] !~ /^false$/i
+    unless ENV.key?("SKYLIGHT_DISABLE_AGENT") && ENV.fetch("SKYLIGHT_DISABLE_AGENT", nil) !~ /^false$/i
       lib = "#{libskylight_path}/libskylight.#{Util::Platform.libext}"
 
       if File.exist?(lib)

data/lib/skylight/probes/mongo.rb

@@ -5,7 +5,20 @@ module Skylight
 
       class Probe
         def install
-          ::Mongo::Monitoring::Global.subscribe(::Mongo::Monitoring::COMMAND, Subscriber.new)
+          subscriber = Subscriber.new
+
+          # From the mongo driver:
+          #
+          # > Global subscriptions must be established prior to creating
+          # > clients. When a client is constructed it copies subscribers from
+          # > the Global module; subsequent subscriptions or unsubscriptions
+          # > on the Global module have no effect on already created clients.
+          #
+          # So, for existing clients created before the Skylight initializer
+          # runs, we'll have to subscribe to those individually.
+          ::Mongoid::Clients.clients.each { |_name, client| client.subscribe(::Mongo::Monitoring::COMMAND, subscriber) }
+
+          ::Mongo::Monitoring::Global.subscribe(::Mongo::Monitoring::COMMAND, subscriber)
         end
       end
 

data/lib/skylight/probes/mongoid.rb

@@ -1,13 +1,6 @@
-module Skylight
-  module Probes
-    module Mongoid
-      class Probe
-        def install
-          Skylight::Probes.probe(:mongo)
-        end
-      end
-    end
-
-    register(:mongoid, "Mongoid", "mongoid", Mongoid::Probe.new)
-  end
-end
+# Older versions of the mongoid uses the moped under-the-hood, while newer
+# verions uses the official driver. It used to be that the the mongoid probe
+# exists to detect and enable either one of those underlying probes, but at
+# this point we no longer support moped, so this is now just an alias for the
+# mongo probe.
+require_relative "mongo"

data/lib/skylight/probes/redis.rb

@@ -20,6 +20,18 @@ module Skylight
         end
       end
 
+      module ClientInstrumentationV5
+        def call_v(command)
+          command_name = command[0]
+
+          return super if command_name == :auth
+
+          opts = { category: "db.redis.command", title: command_name.upcase.to_s, internal: true }
+
+          Skylight.instrument(opts) { super }
+        end
+      end
+
       module Instrumentation
         def pipelined(*)
           Skylight.instrument(PIPELINED_OPTS) { super }
@@ -40,7 +52,12 @@ module Skylight
             return
           end
 
-          ::Redis::Client.prepend(ClientInstrumentation)
+          if ::Redis::Client.method_defined?(:call_v)
+            ::Redis::Client.prepend(ClientInstrumentationV5)
+          else
+            ::Redis::Client.prepend(ClientInstrumentation)
+          end
+
           ::Redis.prepend(Instrumentation)
         end
       end

data/lib/skylight/railtie.rb

@@ -153,7 +153,7 @@ module Skylight
       return false unless sk_config
 
       key = "SKYLIGHT_ENABLED"
-      activate = ENV.key?(key) ? ENV[key] !~ /^false$/i : environments.include?(Rails.env.to_s)
+      activate = ENV.key?(key) ? ENV.fetch(key, nil) !~ /^false$/i : environments.include?(Rails.env.to_s)
 
       show_worker_activation_warning(sk_config) if activate
 

data/lib/skylight/sidekiq.rb

@@ -21,7 +21,7 @@ module Skylight
 
       def call(worker, job, queue)
         t { "Sidekiq middleware beginning trace" }
-        title = job["wrapped"] || job["class"]
+        title = job["display_class"] || job["wrapped"] || job["class"]
 
         # TODO: Using hints here would be ideal but requires further refactoring
         meta =

data/lib/skylight/user_config.rb

@@ -18,7 +18,9 @@ module Skylight
         @config[:user_config_path] ||
           begin
             require "etc"
-            home_dir = ENV["HOME"] || Etc.getpwuid.dir || (ENV["USER"] && File.expand_path("~#{ENV["USER"]}"))
+            home_dir =
+              ENV.fetch("HOME", nil) || Etc.getpwuid.dir ||
+                (ENV.fetch("USER", nil) && File.expand_path("~#{ENV.fetch("USER", nil)}"))
             if home_dir
               File.join(home_dir, ".skylight")
             else
@@ -31,7 +33,7 @@ module Skylight
     end
 
     def disable_dev_warning?
-      disable_dev_warning || ENV["SKYLIGHT_DISABLE_DEV_WARNING"] =~ /^true$/i
+      disable_dev_warning || ENV.fetch("SKYLIGHT_DISABLE_DEV_WARNING", nil) =~ /^true$/i
     end
 
     def disable_env_warning?

data/lib/skylight/util/platform.rb

@@ -12,7 +12,7 @@ module Skylight
           #   Ruby doesn't know that it's on a musl-based platform. `ldd` is the
           #   only reliable way to detect musl that we've found.
           # See https://github.com/skylightio/skylight-ruby/issues/92
-          ENV["SKYLIGHT_MUSL"] || `ldd --version 2>&1` =~ /musl/ ? "linux-musl" : "linux"
+          ENV.fetch("SKYLIGHT_MUSL") { `ldd --version 2>&1` =~ /musl/ } ? "linux-musl" : "linux"
         when /darwin/
           "darwin"
         when /freebsd/

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.3.2".freeze
+  VERSION = "5.3.4".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 5.3.2
+  version: 5.3.4
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2022-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.1
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.31.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.31.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement