skylight 5.1.1 → 5.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2881749e5739ff283ad0f62f4db4c22697a6ee17a9f0f47f80839591f49e104c
-  data.tar.gz: 8c8b28c31dc351e9a2c3e847907f90917aede27e6cef2c0881392769c9b5510d
+  metadata.gz: f3b769eb5f54b2400e4e2ba1678a5e45e1bdf3aff9dc205274387317035e606b
+  data.tar.gz: 1bf4191e377224dfb2c5e064dc6391462c2005a6bf3c8cc658feaa6b6d67e002
 SHA512:
-  metadata.gz: ee70e27064ac11830d29ee7fdf52886a0b776afe3e36aec79e5c2da40e6a0fe09f40ff46d4e7c5947587bd94428bf3b1dd40274fdc4fdbc93836aabedf0b5f1d
-  data.tar.gz: c3441c25d153055d0461b23c01416bf773c612c3af607dd8b9cf142491f5237b205e4da5ab1edcf653327199cdcbceba3170a4c101560dc875d991b6945a98c2
+  metadata.gz: 830f58c5a32ffaf48584fe0769508451e2b0719fb0fc3ed9c3c13a031fff5706e94485a9bf11dacbf0c9b48e95cfd4df07d875eb097c54e90fcf018858eca133
+  data.tar.gz: 1bcdb766cbb4040a9f0734ebeb2a727ddc665bef8c58842b69a48dc33a965b0985ae4dd38cea714f2acca4ab12b79a55c37b5c1bba43985541c68ff80687d7f9

data/CHANGELOG.md

@@ -1,8 +1,37 @@
+## 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
+
+## 5.3.1 (February 28, 2022)
+
+- [BUGFIX] Fix Elasticsearch integration for gem versions >= 8.
+
+## 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
+
 ## 5.1.1 (May 27, 2021)
 
 - [BUGFIX] Correct ruby version requirement in skylight.gemspec
 
-## 5.1.0 (May 24, 2021)
+## 5.1.0 (May 24, 2021) [YANKED]
 
 - [FEATURE] Add experimental tcp-based `skylightd` (may be enabled with `SKYLIGHT_ENABLE_TCP=true`)
 

data/ERRORS.md

@@ -2,4 +2,7 @@ E0001 - Spans were closed out of order
 E0002 - Exceeded the number of unique span descriptions
 E0003 - Exceeded maximum number of spans
 E0004 - Failed to lex SQL query
+E0005 - Instrumenter is not running
+E0006 - Invalid UTF-8
+E0007 - Failed to connect to gRPC server
 E9999 - Unknown

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)
@@ -27,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/ext/libskylight.yml

@@ -1,11 +1,9 @@
-# commit b6bb0714913a5be54f4eac717d5096dc7ba5f3eb
----
-version: "5.1.0-0d59831"
+version: "5.1.0-cd7d6af"
 checksums:
-  x86-linux:          "e15fff9269f5451302aaee56b4d4631c86f979298bc22536f28f884c170c127f"
-  x86_64-linux:       "be95b9c91dffb0133b57183d160cad700213703a87f52488cf114a4fff92ff4d"
-  x86_64-linux-musl:  "945ebefa0384e23121bc1674f0eda0600aef204599e5819bdbecd6d62252b769"
-  x86_64-darwin:      "d98ee1d331394ac43bd37f2d3d5d591a41d912dfa2c3e5d0b21d97f7a5198cf1"
-  aarch64-linux:      "b6add5dda52a2cae4b5e3899a5e0c938049385443d82acbd1a8a2fb0d8502933"
-  aarch64-linux-musl: "667030ade09a69a664380262ec1e6ceeb77f49585201e670528f4cd52d3def86"
-  aarch64-darwin:     "d3225034d18d99e358ace24cf951468feaf3b83f0b33e32965bc2139e0300505"
+  x86-linux:          "921381c014b87e67fa2049e9891377f737b5abb10963228ddcd65caede7b58d2"
+  x86_64-linux:       "e89f0ec3f39ecca060b757fcd1b9d8f38e5846f65579785454bb69a968e8528f"
+  x86_64-linux-musl:  "78239bc7581c124c2a00cfbc42ec6cf73e7ed280ed1a27d85bb915531a683f1a"
+  x86_64-darwin:      "faa7363ada4bf476511f6700856fd91b9d61fed055297417ce41d83aa11fe07c"
+  aarch64-linux:      "e172515a6f7923552e842d21319b3630bdc6e264b6a434b43d2db682dcde18cc"
+  aarch64-linux-musl: "1665adf149bd2c12e409f387de5d796ef9e55d4cfd9a886f69c42cab59a51926"
+  aarch64-darwin:     "027bec103668e89f318b55ddc2a48ca5c84c7a6dcd1dd273cc9b7b46d918ef12"

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
@@ -119,7 +119,7 @@ module Skylight
             end
           config.logger = logger
 
-          config.set(:'daemon.lazy_start', false)
+          config.set(:"daemon.lazy_start", false)
 
           started = Skylight.start!(config)
 

data/lib/skylight/config.rb

@@ -32,9 +32,9 @@ module Skylight
       -"COMPONENT" => :component,
       -"REPORT_RAILS_ENV" => :report_rails_env,
       # == Deploy settings ==
-      -"DEPLOY_ID" => :'deploy.id',
-      -"DEPLOY_GIT_SHA" => :'deploy.git_sha',
-      -"DEPLOY_DESCRIPTION" => :'deploy.description',
+      -"DEPLOY_ID" => :"deploy.id",
+      -"DEPLOY_GIT_SHA" => :"deploy.git_sha",
+      -"DEPLOY_DESCRIPTION" => :"deploy.description",
       # == Logging ==
       -"LOG_FILE" => :log_file,
       -"LOG_LEVEL" => :log_level,
@@ -67,37 +67,39 @@ module Skylight
       -"REPORT_HTTP_CONNECT_TIMEOUT" => :report_http_connect_timeout,
       -"REPORT_HTTP_READ_TIMEOUT" => :report_http_read_timeout,
       -"REPORT_HTTP_DISABLED" => :report_http_disabled,
+      -"REPORT_USE_GRPC" => :report_use_grpc,
+      -"REPORT_GRPC_URL" => :report_grpc_url,
       # == Native agent settings ==
       #
-      -"LAZY_START" => :'daemon.lazy_start',
-      -"DAEMON_EXEC_PATH" => :'daemon.exec_path',
-      -"DAEMON_LIB_PATH" => :'daemon.lib_path',
-      -"PIDFILE_PATH" => :'daemon.pidfile_path',
-      -"SOCKDIR_PATH" => :'daemon.sockdir_path',
-      -"BATCH_QUEUE_DEPTH" => :'daemon.batch_queue_depth',
-      -"BATCH_SAMPLE_SIZE" => :'daemon.batch_sample_size',
-      -"BATCH_FLUSH_INTERVAL" => :'daemon.batch_flush_interval',
-      -"DAEMON_TICK_INTERVAL" => :'daemon.tick_interval',
-      -"DAEMON_LOCK_CHECK_INTERVAL" => :'daemon.lock_check_interval',
-      -"DAEMON_INACTIVITY_TIMEOUT" => :'daemon.inactivity_timeout',
-      -"CLIENT_MAX_TRIES" => :'daemon.max_connect_tries',
-      -"CLIENT_CONN_TRY_WIN" => :'daemon.connect_try_window',
-      -"MAX_PRESPAWN_JITTER" => :'daemon.max_prespawn_jitter',
-      -"DAEMON_WAIT_TIMEOUT" => :'daemon.wait_timeout',
-      -"CLIENT_CHECK_INTERVAL" => :'daemon.client_check_interval',
-      -"CLIENT_QUEUE_DEPTH" => :'daemon.client_queue_depth',
-      -"CLIENT_WRITE_TIMEOUT" => :'daemon.client_write_timeout',
-      -"SSL_CERT_PATH" => :'daemon.ssl_cert_path',
-      -"ENABLE_TCP" => :'daemon.enable_tcp',
-      -"TCP_PORT" => :'daemon.tcp_port',
+      -"LAZY_START" => :"daemon.lazy_start",
+      -"DAEMON_EXEC_PATH" => :"daemon.exec_path",
+      -"DAEMON_LIB_PATH" => :"daemon.lib_path",
+      -"PIDFILE_PATH" => :"daemon.pidfile_path",
+      -"SOCKDIR_PATH" => :"daemon.sockdir_path",
+      -"BATCH_QUEUE_DEPTH" => :"daemon.batch_queue_depth",
+      -"BATCH_SAMPLE_SIZE" => :"daemon.batch_sample_size",
+      -"BATCH_FLUSH_INTERVAL" => :"daemon.batch_flush_interval",
+      -"DAEMON_TICK_INTERVAL" => :"daemon.tick_interval",
+      -"DAEMON_LOCK_CHECK_INTERVAL" => :"daemon.lock_check_interval",
+      -"DAEMON_INACTIVITY_TIMEOUT" => :"daemon.inactivity_timeout",
+      -"CLIENT_MAX_TRIES" => :"daemon.max_connect_tries",
+      -"CLIENT_CONN_TRY_WIN" => :"daemon.connect_try_window",
+      -"MAX_PRESPAWN_JITTER" => :"daemon.max_prespawn_jitter",
+      -"DAEMON_WAIT_TIMEOUT" => :"daemon.wait_timeout",
+      -"CLIENT_CHECK_INTERVAL" => :"daemon.client_check_interval",
+      -"CLIENT_QUEUE_DEPTH" => :"daemon.client_queue_depth",
+      -"CLIENT_WRITE_TIMEOUT" => :"daemon.client_write_timeout",
+      -"SSL_CERT_PATH" => :"daemon.ssl_cert_path",
+      -"ENABLE_TCP" => :"daemon.enable_tcp",
+      -"TCP_PORT" => :"daemon.tcp_port",
       # == Legacy env vars ==
       #
-      -"AGENT_LOCKFILE" => :'agent.lockfile',
-      -"AGENT_SOCKFILE_PATH" => :'agent.sockfile_path',
+      -"AGENT_LOCKFILE" => :"agent.lockfile",
+      -"AGENT_SOCKFILE_PATH" => :"agent.sockfile_path",
       # == User config settings ==
       -"USER_CONFIG_PATH" => :user_config_path,
       # == Heroku settings ==
-      -"HEROKU_DYNO_INFO_PATH" => :'heroku.dyno_info_path',
+      -"HEROKU_DYNO_INFO_PATH" => :"heroku.dyno_info_path",
       # == Source Location ==
       -"SOURCE_LOCATION_IGNORED_GEMS" => :source_location_ignored_gems,
       -"SOURCE_LOCATION_CACHE_SIZE" => :source_location_cache_size
@@ -135,22 +137,22 @@ module Skylight
             sinatra_route_prefixes: false,
             enable_source_locations: true,
             # Deploys
-            'heroku.dyno_info_path': -"/etc/heroku/dyno",
+            "heroku.dyno_info_path": -"/etc/heroku/dyno",
             report_rails_env: true,
             # Daemon
-            'daemon.lazy_start': true,
+            "daemon.lazy_start": true,
             hostname: Util::Hostname.default_hostname,
             report_max_spans_exceeded: false,
             prune_large_traces: true
           }
 
-          ret[:'daemon.ssl_cert_path'] = Util::SSL.ca_cert_file_or_default unless Util::Platform::OS == -"darwin"
+          ret[:"daemon.ssl_cert_path"] = Util::SSL.ca_cert_file_or_default unless Util::Platform::OS == -"darwin"
 
           if Skylight.native?
             native_path = Skylight.libskylight_path
 
-            ret[:'daemon.lib_path'] = native_path
-            ret[:'daemon.exec_path'] = File.join(native_path, "skylightd")
+            ret[:"daemon.lib_path"] = native_path
+            ret[:"daemon.exec_path"] = File.join(native_path, "skylightd")
           end
 
           ret
@@ -184,6 +186,8 @@ module Skylight
           report_http_connect_timeout
           report_http_read_timeout
           report_http_disabled
+          report_use_grpc
+          report_grpc_url
           daemon.lazy_start
           daemon.exec_path
           daemon.lib_path
@@ -211,12 +215,12 @@ module Skylight
 
     # Maps legacy config keys to new config keys
     def self.legacy_keys
-      @legacy_keys ||= { 'agent.sockfile_path': :'daemon.sockdir_path', 'agent.lockfile': :'daemon.pidfile_path' }
+      @legacy_keys ||= { "agent.sockfile_path": :"daemon.sockdir_path", "agent.lockfile": :"daemon.pidfile_path" }
     end
 
     def self.validators
       @validators ||=
-        { 'agent.interval': [->(v, _c) { v.is_a?(Integer) && v > 0 }, "must be an integer greater than 0"] }
+        { "agent.interval": [->(v, _c) { v.is_a?(Integer) && v > 0 }, "must be an integer greater than 0"] }
     end
 
     # @api private
@@ -334,8 +338,8 @@ module Skylight
       # TODO: Move this out of the validate! method: https://github.com/tildeio/direwolf-agent/issues/273
       # FIXME: Why not set the sockdir_path and pidfile_path explicitly?
       # That way we don't have to keep this in sync with the Rust repo.
-      sockdir_path = File.expand_path(self[:'daemon.sockdir_path'] || ".", root)
-      pidfile_path = File.expand_path(self[:'daemon.pidfile_path'] || "skylight.pid", sockdir_path)
+      sockdir_path = File.expand_path(self[:"daemon.sockdir_path"] || ".", root)
+      pidfile_path = File.expand_path(self[:"daemon.pidfile_path"] || "skylight.pid", sockdir_path)
 
       check_file_permissions(pidfile_path, "daemon.pidfile_path or daemon.sockdir_path")
       check_sockdir_permissions(sockdir_path)
@@ -588,7 +592,7 @@ module Skylight
     end
 
     def on_heroku?
-      File.exist?(get(:'heroku.dyno_info_path'))
+      File.exist?(get(:"heroku.dyno_info_path"))
     end
 
     private
@@ -655,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?