skylight 4.1.1.beta → 4.2.0.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cdfdccaa0d3d3b5163035985d500bee74aa687de5c8e3e8f58e661684131d8ea
-  data.tar.gz: 85118921b59286d9417ce14b3078ce34b77c34b2bb7a103979a3b3612127ea80
+  metadata.gz: d91b4f08958f93027e62e1d08cc6047462c39c9df2c98de8e27f3dcb4d4f10ce
+  data.tar.gz: 3a35d4f4c300d77dd911d964f405d42a026c447d6dc8d1a0d69a1301f0ec5d3d
 SHA512:
-  metadata.gz: db7577c627384f1ffdb99fd4c442f00acb753cd5d612b2cb2ee58988edd7085cda9378858df850082077e26bd1cbfe4835b83f5fccc68752de2606d8fd1caf90
-  data.tar.gz: 550a3ff7eb92ae32a60bbf04286358540b387de49863a9df8b9ce5388c9e56691b24351bc5c923e2bdcb744d4a7351bb47b7251427db8b2cab6172ef0ae12e5e
+  metadata.gz: eb320617e3176912f281b45ee47f7a09b3ac7f71d2acea26505beed0c3d05910249f6ced4e4c304addfa56a9cf1cf66ef199f0af1d0e378892ef4141e4830860
+  data.tar.gz: 3a86a8b24adda0054a4c3a8945df3f97559b44a42dfab2c954a6d361cd7e2a4c23407bd6a2db01480915a690e2ba60e4c47d706c99751810879973f699054247

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-## 4.1.1-beta
+## 4.2.0-beta
+* [FEATURE] Add `Skylight.mute` and `Skylight.unmute` blocks to selectively disable and re-enable instrumentation
+* [IMPROVEMENT] Revise agent authorization strategy (fixes some issues related to activation for background jobs)
+* [IMPROVEMENT] Fix Rails 6 deprecation warnings
+
+## 4.1.2
+* [BUGFIX] Correct an issue where the delayed_job probe may not be activated on startup
+
+## 4.1.1
+* [BUGFIX] Fix Skylight installation when bundled with edge rails [Issue #132](https://github.com/skylightio/skylight-ruby/issues/132)
 * [IMPROVEMENT] Improve socket retry handling in skylightd
 
 ## 4.1.0 (June 3, 2019)

data/ext/extconf.rb

@@ -6,19 +6,8 @@ require "fileutils"
 
 $LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 
-require "skylight/version"
-
-# Don't use the gem for dev
-if File.exist?(File.expand_path("../Gemfile", __dir__))
-  # This approach won't work in production since skylight-core isn't in the skylight gem
-  $LOAD_PATH.unshift File.expand_path("../skylight-core/lib", __dir__)
-else
-  # Is there a better way to get this into lib?
-  gem "skylight-core", Skylight::VERSION.tr("-", ".")
-end
-
 require "skylight/native_ext_fetcher"
-require "skylight/core/util/platform"
+require "skylight/util/platform"
 
 # Util allowing proxying writes to multiple location
 class MultiIO
@@ -35,7 +24,7 @@ class MultiIO
   end
 end
 
-include Skylight::Core::Util
+include Skylight::Util
 
 SKYLIGHT_INSTALL_LOG = File.expand_path("install.log", __dir__)
 SKYLIGHT_REQUIRED   = ENV.key?("SKYLIGHT_REQUIRED") && ENV["SKYLIGHT_REQUIRED"] !~ /^false$/i

data/ext/libskylight.yml

@@ -1,7 +1,7 @@
-version: "4.0.0-4f6f5da"
+version: "4.0.0-d262d98"
 checksums:
-  x86-linux:         "d0c1ae51a2c4c0038df985e808f3ff8ce043e8cb0670027ef825bf9b5ae96dc8"
-  x86_64-linux:      "c5178f140882406c19700c9488150d5b891e8f47fd685f40595d1ec76c8f4667"
-  x86_64-linux-musl: "8b9d599e7000c776f5b951baf0646cacee49c326883bfd7e0e2b5a03d9deab97"
-  x86_64-darwin:     "c5611ef825fefee403b4722e87f6ef38ae802a8a7f2c702280ee880c382a7308"
-  x86_64-freebsd:    "151d374739099a04373945cb4784240437ede4aaafe0400f47317ff63693bd15"
+  x86-linux:         "2b104d93829722c841202dc770a43d65db2a96083638aea6f68310f74e051ace"
+  x86_64-linux:      "9573011a562944b869acdb8fa464108c2dff31d663ca182240377c22681c4f1e"
+  x86_64-linux-musl: "aeb0e7aaef0b6f113b80d3ee458a815e70d047e4f4722a1f57d21f292a4d11ab"
+  x86_64-darwin:     "3de86542427fa7e47a0c1d0ec44f71b2851ecb6aef9d26875d6f7dd8c536194b"
+  x86_64-freebsd:    "871c12ea4a5abada8e8ca005362ca0d2870e7d0f839b542f4780abeee042b6d1"

data/ext/skylight_native.c

@@ -334,6 +334,34 @@ trace_set_endpoint(VALUE self, VALUE endpoint) {
   return Qnil;
 }
 
+static VALUE
+trace_get_component(VALUE self) {
+  sky_trace_t* trace;
+  sky_buf_t component;
+
+  My_Struct(trace, sky_trace_t, consumed_trace_msg);
+
+  CHECK_FFI(
+      sky_trace_component(trace, &component),
+      "Trace#native_get_component");
+
+  return BUF2STR(component);
+}
+
+static VALUE
+trace_set_component(VALUE self, VALUE component) {
+  sky_trace_t* trace;
+
+  CHECK_TYPE(component, T_STRING);
+  My_Struct(trace, sky_trace_t, consumed_trace_msg);
+
+  CHECK_FFI(
+      sky_trace_set_component(trace, STR2BUF(component)),
+      "Trace#native_set_component");
+
+  return Qnil;
+}
+
 static VALUE
 trace_use_pruning(VALUE self) {
   sky_trace_t* trace;
@@ -569,6 +597,8 @@ void Init_skylight_native() {
   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);
+  rb_define_method(rb_cTrace, "native_get_component", trace_get_component, 0);
+  rb_define_method(rb_cTrace, "native_set_component", trace_set_component, 1);
   rb_define_method(rb_cTrace, "native_use_pruning", trace_use_pruning, 0);
   rb_define_method(rb_cTrace, "native_set_exception", trace_set_exception, 1);
   rb_define_method(rb_cTrace, "native_get_uuid", trace_get_uuid, 0);

data/lib/skylight/cli/doctor.rb

@@ -184,7 +184,7 @@ module Skylight
         end
 
         def mac?
-          Core::Util::Platform::OS == "darwin"
+          Util::Platform::OS == "darwin"
         end
 
         # NOTE: This check won't work correctly on Windows

data/lib/skylight/config.rb

@@ -1,7 +1,7 @@
 require "openssl"
 require "skylight/util/component"
 require "skylight/util/deploy"
-require "skylight/core/util/platform"
+require "skylight/util/platform"
 require "skylight/util/hostname"
 require "skylight/util/ssl"
 
@@ -94,7 +94,7 @@ module Skylight
           report_rails_env:           true
         )
 
-        if Core::Util::Platform::OS != "darwin"
+        unless Util::Platform::OS == "darwin"
           ret[:'daemon.ssl_cert_path'] = Util::SSL.ca_cert_file_or_default
           ret[:'daemon.ssl_cert_dir'] = Util::SSL.ca_cert_dir
         end
@@ -276,7 +276,6 @@ module Skylight
       if token
         meta = {}
         meta.merge!(deploy.to_query_hash) if deploy
-        meta[:component] = component.to_s if component
         meta[:reporting_env] = true if reporting_env?
 
         # A pipe should be a safe delimiter since it's not in the standard token
@@ -291,21 +290,24 @@ module Skylight
       @deploy ||= Util::Deploy.build(self)
     end
 
-    def component
-      @component ||= Util::Component.new(
-        get(:env),
-        get(:component) || get(:worker_component)
-      )
+    def components
+      @components ||= {
+        web: Util::Component.new(
+          get(:env),
+          Util::Component::DEFAULT_NAME
+        ),
+        worker: Util::Component.new(
+          get(:env),
+          get(:component) || get(:worker_component),
+          force_worker: true
+        )
+      }
     rescue ArgumentError => e
       raise Core::ConfigError, e.message
     end
 
-    def worker_context?
-      component.worker?
-    end
-
-    def web_context?
-      component.web?
+    def component
+      components[:web]
     end
 
     def as_json(*)

data/lib/skylight/native.rb

@@ -1,4 +1,4 @@
-require "skylight/core/util/platform"
+require "skylight/util/platform"
 
 module Skylight
   # @api private
@@ -10,14 +10,14 @@ module Skylight
   end
 
   def self.libskylight_path
-    ENV["SKYLIGHT_LIB_PATH"] || File.expand_path("../native/#{Core::Util::Platform.tuple}", __FILE__)
+    ENV["SKYLIGHT_LIB_PATH"] || File.expand_path("../native/#{Util::Platform.tuple}", __FILE__)
   end
 
   skylight_required = ENV.key?("SKYLIGHT_REQUIRED") && ENV["SKYLIGHT_REQUIRED"] !~ /^false$/i
 
   begin
     unless ENV.key?("SKYLIGHT_DISABLE_AGENT") && ENV["SKYLIGHT_DISABLE_AGENT"] !~ /^false$/i
-      lib = "#{libskylight_path}/libskylight.#{Core::Util::Platform.libext}"
+      lib = "#{libskylight_path}/libskylight.#{Util::Platform.libext}"
 
       if File.exist?(lib)
         # First attempt to require the native extension

data/lib/skylight/native_ext_fetcher.rb

@@ -5,7 +5,7 @@ require "fileutils"
 require "digest/sha2"
 require "open3"
 require "skylight/util/ssl"
-require "skylight/core/util/proxy"
+require "skylight/util/proxy"
 
 # Used from extconf.rb
 module Skylight
@@ -137,7 +137,7 @@ module Skylight
     #
     # If `ENV['HTTP_PROXY']` is set, it will be used as a proxy for this request.
     def http_get(host, port, use_ssl, path, out)
-      if (http_proxy = Core::Util::Proxy.detect_url(ENV))
+      if (http_proxy = Util::Proxy.detect_url(ENV))
         log "connecting with proxy: #{http_proxy}"
         uri = URI.parse(http_proxy)
         p_host = uri.host

data/lib/skylight/railtie.rb

@@ -35,25 +35,20 @@ module Skylight
 
       def activate?(sk_config)
         return false unless super && sk_config
-        activate_for_worker?(sk_config) || activate_for_web?(sk_config)
+        show_worker_activation_warning(sk_config)
+        true
       end
 
       # We must have an opt-in signal
-      def activate_for_worker?(sk_config)
-        return unless sk_config.worker_context?
-
+      def show_worker_activation_warning(sk_config)
         reasons = []
         reasons << "the 'active_job' probe is enabled" if sk_rails_config.probes.include?("active_job")
+        reasons << "the 'delayed_job' probe is enabled" if sk_rails_config.probes.include?("delayed_job")
         reasons << "SKYLIGHT_ENABLE_SIDEKIQ is set" if sk_config.enable_sidekiq?
 
         return if reasons.empty?
 
         sk_config.logger.warn("Activating Skylight for Background Jobs because #{reasons.to_sentence}")
-        true
-      end
-
-      def activate_for_web?(sk_config)
-        sk_config.web_context?
       end
 
       def development_warning

data/lib/skylight/trace.rb

@@ -1,7 +1,10 @@
 module Skylight
   class Trace < Core::Trace
-    def initialize(*)
+    attr_reader :component
+
+    def initialize(*, component: nil)
       super
+      self.component = component if component
       @too_many_spans = false
       native_use_pruning if use_pruning?
     end
@@ -51,5 +54,16 @@ module Skylight
       def use_pruning?
         config.get(:prune_large_traces)
       end
+
+      def resolve_component(component)
+        config.components[component].to_encoded_s
+      end
+
+      def component=(component)
+        resolve_component(component).tap do |c|
+          @component = c
+          native_set_component(c)
+        end
+      end
   end
 end

data/lib/skylight/util/component.rb

@@ -1,35 +1,19 @@
+# frozen_string_literal: true
+require "uri"
+
 module Skylight
   module Util
     class Component
       attr_accessor :environment, :name
 
       NAME_FORMAT = /\A[a-zA-Z0-9_-]+\z/
-      DEFAULT_NAME = "web".freeze
-      WORKER_NAME = "worker".freeze
-      DEFAULT_ENVIRONMENT = "production".freeze
-
-      WORKER_PROGRAM_MATCHER = Regexp.union [
-        /sidekiq$/i,
-        /backburner$/i,
-        /delayed_job$/i,
-        /que$/i,
-        /sneakers$/i,
-        /shoryuken$/i
-      ]
-
-      WORKER_RAKE_MATCHER = Regexp.union [
-        /\Aresque:/,
-        /\Abackburner:/,
-        /\Ajobs:/, # DelayedJob. can also be `rake jobs:workoff`
-        /\Aqu:/,
-        /\Aque:/,
-        /\Aqc:/,
-        /\Asneakers:/
-      ]
+      DEFAULT_NAME = "web"
+      WORKER_NAME = "worker"
+      DEFAULT_ENVIRONMENT = "production"
 
-      def initialize(environment, name)
+      def initialize(environment, name, force_worker: false)
         @environment = environment || DEFAULT_ENVIRONMENT
-        @name        = resolve_name(name)
+        @name        = resolve_name(name, force_worker)
 
         raise ArgumentError, "environment can't be blank" if @environment.empty?
         validate_string!(@environment, "environment")
@@ -40,6 +24,10 @@ module Skylight
         "#{name}:#{environment}"
       end
 
+      def to_encoded_s
+        @to_encoded_s ||= URI.encode_www_form_component(to_s)
+      end
+
       def web?
         name == DEFAULT_NAME
       end
@@ -66,42 +54,18 @@ module Skylight
           ARGV
         end
 
-        def resolve_name(given_name)
-          return DEFAULT_NAME if known_web_context?
-          return given_name if given_name
-          return WORKER_NAME if known_worker_context?
-          DEFAULT_NAME
+        def resolve_name(given_name, force_worker)
+          # don't allow workers to be called 'web'
+          return WORKER_NAME if force_worker && (given_name.nil? || given_name == DEFAULT_NAME)
+          return DEFAULT_NAME if given_name.nil?
+
+          given_name
         end
 
         def validate_string!(string, kind)
           return true if string =~ NAME_FORMAT
           raise ArgumentError, "#{kind} can only contain lowercase letters, numbers, and dashes"
         end
-
-        def known_web_context?
-          rails_server? || rack_server? || passenger? || unicorn?
-        end
-
-        def known_worker_context?
-          return true if program_name =~ WORKER_PROGRAM_MATCHER
-          program_name[/rake$/] && argv.any? { |arg| arg =~ WORKER_RAKE_MATCHER }
-        end
-
-        def rails_server?
-          defined?(Rails::Server)
-        end
-
-        def rack_server?
-          program_name[/(?<!\w)(falcon|puma|rackup|thin)$/]
-        end
-
-        def unicorn?
-          program_name[/\Aunicorn/]
-        end
-
-        def passenger?
-          program_name[/\APassenger AppPreloader/]
-        end
     end
   end
 end

data/lib/skylight/util/platform.rb

@@ -0,0 +1,78 @@
+require "rbconfig"
+
+# Used from extconf and to load libskylight
+module Skylight
+  module Util
+    module Platform
+      # Normalize the platform OS
+      OS =
+        case os = RbConfig::CONFIG["host_os"].downcase
+        when /linux/
+          # The official ruby-alpine Docker containers pre-build Ruby. As a result,
+          #   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
+          if ENV["SKYLIGHT_MUSL"] || `ldd --version 2>&1` =~ /musl/
+            "linux-musl"
+          else
+            "linux"
+          end
+        when /darwin/
+          "darwin"
+        when /freebsd/
+          "freebsd"
+        when /netbsd/
+          "netbsd"
+        when /openbsd/
+          "openbsd"
+        when /sunos|solaris/
+          "solaris"
+        when /mingw|mswin/
+          "windows"
+        else
+          os
+        end
+
+      # Normalize the platform CPU
+      ARCH =
+        case cpu = RbConfig::CONFIG["host_cpu"].downcase
+        when /amd64|x86_64/
+          "x86_64"
+        when /i?86|x86|i86pc/
+          "x86"
+        when /ppc|powerpc/
+          "powerpc"
+        when /^arm/
+          "arm"
+        else
+          cpu
+        end
+
+      LIBEXT =
+        case OS
+        when /darwin/
+          "dylib"
+        when /linux|bsd|solaris/
+          "so"
+        when /windows|cygwin/
+          "dll"
+        else
+          "so"
+        end
+
+      TUPLE = "#{ARCH}-#{OS}".freeze
+
+      def self.tuple
+        TUPLE
+      end
+
+      def self.libext
+        LIBEXT
+      end
+
+      def self.dlext
+        RbConfig::CONFIG["DLEXT"]
+      end
+    end
+  end
+end

data/lib/skylight/util/proxy.rb

@@ -0,0 +1,13 @@
+module Skylight
+  module Util
+    module Proxy
+      def self.detect_url(env)
+        u = env["HTTP_PROXY"] || env["http_proxy"]
+        if u && !u.empty?
+          u = "http://#{u}" unless u =~ %r{://}
+          u
+        end
+      end
+    end
+  end
+end

data/lib/skylight/version.rb

@@ -1,3 +1,3 @@
 module Skylight
-  VERSION = "4.1.1-beta".freeze
+  VERSION = "4.2.0-beta".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 4.1.1.beta
+  version: 4.2.0.beta
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-13 00:00:00.000000000 Z
+date: 2019-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: skylight-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.1.beta
+        version: 4.2.0.beta
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.1.beta
+        version: 4.2.0.beta
 - !ruby/object:Gem::Dependency
   name: beefcake
   requirement: !ruby/object:Gem::Requirement
@@ -207,6 +207,8 @@ files:
 - lib/skylight/util/deploy.rb
 - lib/skylight/util/hostname.rb
 - lib/skylight/util/http.rb
+- lib/skylight/util/platform.rb
+- lib/skylight/util/proxy.rb
 - lib/skylight/util/ssl.rb
 - lib/skylight/vendor/cli/highline.rb
 - lib/skylight/vendor/cli/highline/color_scheme.rb