skylight 5.1.0.beta2 → 5.2.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2408af8db40888f35f7f2ccf657d3416c920ba31083662c522b019e59e3defff
-  data.tar.gz: c5e5b186b5ceca84e4189437e1e9efd7d65658a20dcf1d0db17f0657f13f5d61
+  metadata.gz: b66ffaaf8386f9d50b7fd82087d0fb04e5326701e027f640912e16a9238908e9
+  data.tar.gz: 8318788b892615da50939c6d4e760b65be8c1842ec403a0886f0c78f99a38f36
 SHA512:
-  metadata.gz: 57fdb5863f9e7395fd507364c4be051cf9e79ff0f5a966f4c0831015d9d01d3c43e289927408102f72d1db54e8bd6b42d494fce0234ac9c8e28a178c94871013
-  data.tar.gz: 6c79d95938d6130d9dec39bae7d31b3cc3127713f07cf5818e8ce2fcb38996a01f06912c124b95390a2a11c62591bab3f3ea5999fcef328f6e48112771db567f
+  metadata.gz: b0c4222c14f45e9129a8fe0a61e1d895d2d5d1996b29879b106ffa89ee190ffc7c84d41513e56954467ad502304ac94488ce7ded24271e96630bd49e0cc4b34e
+  data.tar.gz: fd8105a613dd0b44aaa3d23580a83aa3b92ca665b08c47cadb87c87368b77834957730c5eef5a83a9794f92153e5b329301fbd6d7655c2e765dd0ebd157f8e0b

data/CHANGELOG.md

@@ -1,15 +1,23 @@
-## 5.1.0-beta2 (May 17, 2021)
+## 5.2.0-beta (7 September 2021)
 
-- [IMPROVEMENT] Avoid 'invalid option' warnings when instrumenting certain Tilt templates in Sinatra
-- [IMPROVEMENT] Decrease verbosity of source locations logs in the debug level.
+- [IMPROVEMENT] Add Rack::Builder probe to better instrument middlewares in Sinatra and other Builder-based apps
+- [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)
 
-## 5.1.0-beta (April 26, 2021)
+- [BUGFIX] Correct ruby version requirement in skylight.gemspec
+
+## 5.1.0 (May 24, 2021)
 
 - [FEATURE] Add experimental tcp-based `skylightd` (may be enabled with `SKYLIGHT_ENABLE_TCP=true`)
 
 - [IMPROVEMENT] Support aarch64-darwin targets (Apple M1)
 - [IMPROVEMENT] Support aarch64-linux-gnu targets
 - [IMPROVEMENT] Support aarch64-linux-musl targets
+- [IMPROVEMENT] Prevent large traces from shutting down the instrumenter
+- [IMPROVEMENT] Avoid 'invalid option' warnings when instrumenting certain Tilt templates in Sinatra
+- [IMPROVEMENT] Decrease verbosity of source locations logs in the debug level.
 
 - [BREAKING] Remove `SKYLIGHT_SSL_CERT_DIR` config
 - [BREAKING] Drop support for Ruby 2.5

data/ext/libskylight.yml

@@ -1,11 +1,11 @@
-# commit 8a5d5b9a48ed1f3bb75b9bb32c51c102fa1cf598
+# commit fd0d58cc393e044e5b80ab419e61ebbaec902181
 ---
-version: "5.1.0-7b3c5cf"
+version: "5.1.0-ab315e7"
 checksums:
-  x86-linux:          "51e7e54bbbfe3a8785eda6b041aa27f2bc46fd80134b82f4f4a45ac7fc3e7105"
-  x86_64-linux:       "9d0d3b94c37beacb3acb55152c614632473c5251d383aa366c443c32ba0a0e70"
-  x86_64-linux-musl:  "52ae0d56f4d545a6f455140ceb0c4616308872223334f39a73b3aeaff2fef07a"
-  x86_64-darwin:      "2839ee8576980d3de597a76b0080b6e0e6c345a90543528f72175616d9ef4be5"
-  aarch64-linux:      "9787d414fa4e52be6aa3b4aeaae45eced2c0049845bdafa584c4587ea9c69e3a"
-  aarch64-linux-musl: "66cb234ebb468277c001e74fb0bd2427b01e53147472738fc0814d0845616ecc"
-  aarch64-darwin:     "d85bd55de7ae01e11d15bcf8446c5de3801ccbbddfb7e027808cab6566b59498"
+  x86-linux:          "4ea5ab2ed7789e6d041ce4cc0384d3fbd8bb7462e8eca879d6c2b242c35eb3b4"
+  x86_64-linux:       "8edb5247e982c3571d19e7e607f01c69b5eb657ae310e3bf00e83c1330fdb794"
+  x86_64-linux-musl:  "35c4ae1c66b529750358c0acb36d33da1d3ffaf17336ff882ce6ce9a632d9be6"
+  x86_64-darwin:      "5d0b3a210931714ad17b8226aac59a39760d7fe8f86a13460dda517bc2886193"
+  aarch64-linux:      "1ce0d0f1e7bf9c6c92052080b18738c2f775a01d2004ee434cef74b557a3cafd"
+  aarch64-linux-musl: "f186576b4164d0a4135d5fde3202a3e95c38fc0ea35413288de6bb28c9fc9ac4"
+  aarch64-darwin:     "a4f7fb9e483933c194ade230381e3da2f4e6f4dee76550f6f098fc6b46967b3d"

data/lib/skylight/cli/doctor.rb

@@ -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,
@@ -69,35 +69,35 @@ module Skylight
       -"REPORT_HTTP_DISABLED" => :report_http_disabled,
       # == 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 +135,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
@@ -211,12 +211,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 +334,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 +588,7 @@ module Skylight
     end
 
     def on_heroku?
-      File.exist?(get(:'heroku.dyno_info_path'))
+      File.exist?(get(:"heroku.dyno_info_path"))
     end
 
     private

data/lib/skylight/middleware.rb

@@ -3,6 +3,8 @@ require "securerandom"
 module Skylight
   # @api private
   class Middleware
+    SKYLIGHT_REQUEST_ID = "skylight.request_id".freeze
+
     class BodyProxy
       def initialize(body, &block)
         @body = body
@@ -81,7 +83,8 @@ module Skylight
       set_request_id(env)
 
       if Skylight.tracing?
-        error "Already instrumenting. Make sure the Skylight Rack Middleware hasn't been added more than once."
+        debug "Already instrumenting. Make sure the Skylight Rack Middleware hasn't been added more than once."
+        return @app.call(env)
       end
 
       if env["REQUEST_METHOD"] == "HEAD"
@@ -108,7 +111,7 @@ module Skylight
 
     def log_context
       # Don't cache this, it will change
-      { request_id: @current_request_id, inst: Skylight.instrumenter&.uuid }
+      { request_id: current_request_id, inst: Skylight.instrumenter&.uuid }
     end
 
     # Allow for overwriting
@@ -122,8 +125,10 @@ module Skylight
 
     # Request ID code based on ActionDispatch::RequestId
     def set_request_id(env)
+      return if env[SKYLIGHT_REQUEST_ID]
+
       existing_request_id = env["action_dispatch.request_id"] || env["HTTP_X_REQUEST_ID"]
-      @current_request_id = env["skylight.request_id"] = make_request_id(existing_request_id)
+      self.current_request_id = env[SKYLIGHT_REQUEST_ID] = make_request_id(existing_request_id)
     end
 
     def make_request_id(request_id)
@@ -133,5 +138,13 @@ module Skylight
     def internal_request_id
       SecureRandom.uuid
     end
+
+    def current_request_id
+      Thread.current[SKYLIGHT_REQUEST_ID]
+    end
+
+    def current_request_id=(request_id)
+      Thread.current[SKYLIGHT_REQUEST_ID] = request_id
+    end
   end
 end

data/lib/skylight/normalizers/grape/endpoint.rb

@@ -20,7 +20,7 @@ module Skylight
 
         def get_namespace(endpoint)
           # slice off preceding slash for data continuity
-          ::Grape::Namespace.joined_space_path(endpoint.namespace_stackable(:namespace)).to_s[1..-1]
+          ::Grape::Namespace.joined_space_path(endpoint.namespace_stackable(:namespace)).to_s[1..]
         end
       end
     end

data/lib/skylight/probes/middleware.rb

@@ -25,10 +25,10 @@ module Skylight
       # for Rails <= 5.2 ActionDispatch::MiddlewareStack::Middleware
       module Instrumentation
         def build(*)
-          sk_instrument_middleware(super)
+          Instrumentation.sk_instrument_middleware(super)
         end
 
-        def sk_instrument_middleware(middleware)
+        def self.sk_instrument_middleware(middleware)
           return middleware if middleware.is_a?(Skylight::Middleware)
 
           # Not sure how this would actually happen

data/lib/skylight/probes/rack_builder.rb

@@ -0,0 +1,37 @@
+module Skylight
+  module Probes
+    module Rack
+      module Builder
+        module Instrumentation
+          def use(middleware, *args, &block)
+            if @map
+              mapping = @map
+              @map = nil
+              @use << proc { |app| generate_map(app, mapping) }
+            end
+            @use << proc do |app|
+              middleware
+                .new(app, *args, &block)
+                .tap do |middleware_instance|
+                  Skylight::Probes::Middleware::Instrumentation.sk_instrument_middleware(middleware_instance)
+                end
+            end
+          end
+          ruby2_keywords(:use) if respond_to?(:ruby2_keywords, true)
+        end
+
+        class Probe
+          def install
+            if defined?(::Rack.release) && Gem::Version.new(::Rack.release) >= ::Gem::Version.new("1.4") &&
+                 defined?(::Rack::Builder)
+              require "skylight/probes/middleware"
+              ::Rack::Builder.prepend(Instrumentation)
+            end
+          end
+        end
+      end
+    end
+
+    register(:rack_builder, "Rack::Builder", "rack/builder", Skylight::Probes::Rack::Builder::Probe.new)
+  end
+end

data/lib/skylight/probes/sinatra_add_middleware.rb

@@ -2,8 +2,8 @@ module Skylight
   module Probes
     module Sinatra
       module Instrumentation
-        def build(*)
-          use Skylight::Middleware
+        def setup_default_middleware(builder)
+          builder.use Skylight::Middleware
           super
         end
       end

data/lib/skylight/railtie.rb

@@ -99,8 +99,8 @@ module Skylight
 
       configure_logging(config, app)
 
-      config[:'daemon.sockdir_path'] ||= tmp
-      config[:'normalizers.render.view_paths'] = existent_paths(app.config.paths["app/views"]) + [Rails.root.to_s]
+      config[:"daemon.sockdir_path"] ||= tmp
+      config[:"normalizers.render.view_paths"] = existent_paths(app.config.paths["app/views"]) + [Rails.root.to_s]
 
       config[:env] ||= Rails.env.to_s if config[:report_rails_env]
 

data/lib/skylight/sinatra.rb

@@ -1,2 +1,2 @@
 require "skylight"
-Skylight.probe(:sinatra_add_middleware, :sinatra, :tilt, :sequel)
+Skylight.probe(:sinatra_add_middleware, :sinatra, :tilt, :sequel, :rack_builder)

data/lib/skylight/util/deploy.rb

@@ -52,15 +52,15 @@ module Skylight
         end
 
         def id
-          config.get(:'deploy.id') || git_sha
+          config.get(:"deploy.id") || git_sha
         end
 
         def git_sha
-          config.get(:'deploy.git_sha')
+          config.get(:"deploy.git_sha")
         end
 
         def description
-          config.get(:'deploy.description')
+          config.get(:"deploy.description")
         end
       end
 
@@ -85,7 +85,7 @@ module Skylight
         private
 
         def get_info
-          info_path = config[:'heroku.dyno_info_path']
+          info_path = config[:"heroku.dyno_info_path"]
 
           if File.exist?(info_path) && (info = JSON.parse(File.read(info_path)))
             info["release"]

data/lib/skylight/util/platform.rb

@@ -38,8 +38,8 @@ module Skylight
           "x86"
         when /ppc|powerpc/
           "powerpc"
-        when /^arm/
-          "arm"
+        when /arm64|aarch64/
+          "aarch64"
         else
           cpu
         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.1.0-beta2".freeze
+  VERSION = "5.2.0-beta".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 5.1.0.beta2
+  version: 5.2.0.beta
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.15.0
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -296,6 +296,7 @@ files:
 - lib/skylight/probes/mongo.rb
 - lib/skylight/probes/mongoid.rb
 - lib/skylight/probes/net_http.rb
+- lib/skylight/probes/rack_builder.rb
 - lib/skylight/probes/redis.rb
 - lib/skylight/probes/sequel.rb
 - lib/skylight/probes/sinatra.rb
@@ -375,7 +376,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"