skylight 4.1.2 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 134531d673ae33832e5440d2ef1d5afe6eb9ff96e292409fd44db5ead29abf0d
-  data.tar.gz: da2318898d8c94a8aaec66fb3ea6300c1e7c41fa6257aca0cbf1c0b4562ecfde
+  metadata.gz: 9ec54d064a7d0ee23b34d01446857ce5d5d01e70820d7b95d325065d7c34682e
+  data.tar.gz: 78b4328f0daa411f6927a48d81a23484e378ee9bdc56fd320c8bce502392c41b
 SHA512:
-  metadata.gz: 64f1827700b7bf7d916cbcfff72c9025d71eb94dab81ecd8ad09031f4e6ba6dd2fcee6e9e5c0d762ff83816df82073cbeb6598916e4be3192e44f9f01445c913
-  data.tar.gz: 2c57c2acd3b754bd88f1155fed8e93c1a978f8d1d9c2a032cacc92e4338f89e2d19437f1e6c36cf5b9e87664d763e43fe6c260cd34e3fd27bbd486918629be1c
+  metadata.gz: 7e91e0f540bb96cfb27255858839b0fb458a89b79558977bd71f0023eeef4eaf41423aa5f6ee4debfaf6b558936e0fd22d72ef5022cb6c1009332265f2ab6ca3
+  data.tar.gz: 37d172168416b3926627ddb481b2fdbf16131c38feb09fd401c0428cb1251cf36f1070a69c4334bc7c00d6fef09319922fd551221e3131fa1c2eebe438e4bba3

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 4.2.0
+* [FEATURE] Add GraphQL probe
+* [FEATURE] Optionally add Rack mount point to Sinatra endpoint names
+* [FEATURE] Add `Skylight.mute` and `Skylight.unmute` blocks to selectively disable and re-enable
+* [IMPROVEMENT] Shut down the native instrumenter when the remote daemon is unreachable
+instrumentation
+* [IMPROVEMENT] Revise agent authorization strategy (fixes some issues related to activation for background jobs)
+* [IMPROVEMENT] Fix Rails 6 deprecation warnings
+* [BUGFIX] Skip the Sidekiq probe if Sidekiq is not present
+
 ## 4.1.2
 * [BUGFIX] Correct an issue where the delayed_job probe may not be activated on startup
 

data/ext/libskylight.yml

@@ -1,7 +1,7 @@
-version: "4.0.0-4f6f5da"
+version: "4.1.0-46806f5"
 checksums:
-  x86-linux:         "d0c1ae51a2c4c0038df985e808f3ff8ce043e8cb0670027ef825bf9b5ae96dc8"
-  x86_64-linux:      "c5178f140882406c19700c9488150d5b891e8f47fd685f40595d1ec76c8f4667"
-  x86_64-linux-musl: "8b9d599e7000c776f5b951baf0646cacee49c326883bfd7e0e2b5a03d9deab97"
-  x86_64-darwin:     "c5611ef825fefee403b4722e87f6ef38ae802a8a7f2c702280ee880c382a7308"
-  x86_64-freebsd:    "151d374739099a04373945cb4784240437ede4aaafe0400f47317ff63693bd15"
+  x86-linux:         "4054632757516aa44e812860601fcb7f21c8c5d412b2d585868b46c7a8e3cae6"
+  x86_64-linux:      "4675694fba4448ba14787551237bd4e388443895d5c9e5d8a71c550eccd203db"
+  x86_64-linux-musl: "7a81880830d0a409a6f0f39ff42f90a1422542b05384e2480ae05515f6b5f831"
+  x86_64-darwin:     "84eef6c330818c2bad1628ff189b9cb88275c9d72a28afac88a0d054d8002230"
+  x86_64-freebsd:    "a86a52203fab4f9a56ad91d5700e14823e6e997b4df1bcb3ae2d9e4296c50b1f"

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/config.rb

@@ -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/errors.rb

@@ -51,5 +51,8 @@ module Skylight
 
     # E0004
     register(4, "SqlLex", "Failed to lex SQL query.")
+
+    # E0005
+    register(5, "InstrumenterUnrecoverable", "Instrumenter is not running.")
   end
 end

data/lib/skylight/instrumenter.rb

@@ -27,5 +27,10 @@ module Skylight
       end
       nil
     end
+
+    def handle_instrumenter_error(trace, e)
+      poison! if e.is_a?(Skylight::InstrumenterUnrecoverableError)
+      super
+    end
   end
 end

data/lib/skylight/railtie.rb

@@ -35,13 +35,12 @@ 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")
@@ -50,11 +49,6 @@ module Skylight
         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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.2.0
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-27 00:00:00.000000000 Z
+date: 2019-10-30 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.2
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.1.2
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: beefcake
   requirement: !ruby/object:Gem::Requirement
@@ -269,7 +269,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Skylight is a smart profiler for Rails, Sinatra, and other Ruby apps.