skylight 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08db1b03b0415378e94cba4a1e93f3856bec795769a3bee7786942fdfdb77a30'
-  data.tar.gz: 294a813cdcf2cfc7b343f7a2c2126628101c1c1a2b320e58c5286d79a5ded016
+  metadata.gz: 55eaebadf3fb220c9b3dbccdfc9a7a24daff7eda6775b89e58ea5fe0e2a1ba56
+  data.tar.gz: 894eb4d03f6b66ca6301884c98f754f0d03dbdb416e40a662b34733e2c5c19f5
 SHA512:
-  metadata.gz: 9c5d6044ebeb3d41030716f10642a422c0e3346be27b7820edefc4e0d0abd006b773686cf9a231f7f8300c22db2dd15e76175a18340f4d86aa11170199e7d799
-  data.tar.gz: 851f31e79a7e4d0924c6c02292a1aaf84c424f72dc8f0cfd6235f570a6358d7abb855df31e24bd0dc36c5ead5efc72a4ac78591195e9cd032deddeb2a46511bd
+  metadata.gz: 9e18ee5d48433c0bdb42090e975ccffbd28b34e179a77f252048bccc27669f41b08a6648aabc55b79eac2158ee57ac74b3308f22bc8ff25e2da1d50efe552073
+  data.tar.gz: d346a3b7a24e4453324273320c8400d998302a4c658957aef9274fd40f8735c2f33f8245e6ef33ed1dbc39ac081b0fb7bee7addce81f02c4c1457257bf3cddb7

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.7.0 (April 24, 2018)
+
+* [FEATURE] New API for loading Probes. Example: `Skylight.probe(:excon')`
+* [FEATURE] New API for enabling non-default Normalizers. Example: `Skylight.enable_normalizer('active_job')`
+* [DEPRECATION] Support for Rails versions prior to 4.2
+* [DEPRECATION] Support for Tilt versions prior to 1.4.1
+* [DEPRECATION] Support for Sinatra versions prior to 1.4
+* [DEPRECATION] Support for Grape versions prior to 0.13.0
+
 ## 1.6.1 (April 12, 2018)
 
 * [IMPROVEMENT] Include endpoint name in error logging

data/lib/skylight/core.rb

@@ -1,7 +1,9 @@
 require 'skylight/version'
+require 'skylight/deprecation'
 
 # Root Skylight namespace
 module Skylight
+
   # @api private
   TRACE_ENV_KEY = 'SKYLIGHT_ENABLE_TRACE_LOGS'.freeze
 
@@ -11,6 +13,10 @@ module Skylight
   # Specifically check for Railtie since we've had at least one case of a
   #   customer having Rails defined without having all of Rails loaded.
   if defined?(Rails::Railtie)
+    if Gem::Version.new(Rails.version) < Gem::Version.new('4.2.0')
+      DEPRECATOR.deprecation_warning("Support for Rails versions before 4.2")
+    end
+
     require 'skylight/railtie'
   end
 
@@ -59,6 +65,14 @@ module Skylight
   # @api private
   DEFAULT_OPTIONS = { category: DEFAULT_CATEGORY }
 
+  def self.probe(*args)
+    Probes.probe(*args)
+  end
+
+  def self.enable_normalizer(*names)
+    Normalizers.enable(*names)
+  end
+
   # Start instrumenting
   def self.start!(*args)
     Instrumenter.start!(*args)

data/lib/skylight/deprecation.rb

@@ -0,0 +1,55 @@
+require 'active_support/deprecation'
+
+module Skylight
+  SKYLIGHT_GEM_ROOT = File.expand_path("../../..", __FILE__) + "/"
+
+  if ActiveSupport::Deprecation.respond_to?(:new)
+    class Deprecation < ActiveSupport::Deprecation
+      private
+
+        def ignored_callstack(path)
+          path.start_with?(SKYLIGHT_GEM_ROOT)
+        end
+    end
+  else
+    # Rails 3.x
+    class Deprecation
+      attr_accessor :silenced
+      attr_reader :deprecation_horizon, :gem_name
+
+      def initialize(deprecation_horizon, gem_name)
+        @deprecation_horizon = deprecation_horizon
+        @gem_name = gem_name
+      end
+
+      # Silence deprecation warnings within the block.
+      def silence
+        old_silenced, @silenced = @silenced, true
+        yield
+      ensure
+        @silenced = old_silenced
+      end
+
+      def deprecation_warning(deprecated_method_name, message = nil)
+        return if silenced
+
+        msg = "#{deprecated_method_name} is deprecated and will be removed from #{gem_name} #{deprecation_horizon}"
+        case message
+          when Symbol then msg << " (use #{message} instead)"
+          when String then msg << " (#{message})"
+        end
+
+        ActiveSupport::Deprecation.warn(msg, extract_callstack(caller))
+      end
+
+      private
+
+        def extract_callstack(callstack)
+          filtered = callstack.reject { |line| line.start_with?(SKYLIGHT_GEM_ROOT) }
+          filtered.empty? ? callstack : filtered
+        end
+    end
+  end
+
+  DEPRECATOR = Deprecation.new('2.0', 'skylight')
+end

data/lib/skylight/normalizers.rb

@@ -7,29 +7,47 @@ module Skylight
 
     DEFAULT = Default.new
 
-    def self.register(name, klass)
-      (@registry ||= {})[name] = klass
-      klass
+    def self.registry
+      @registry ||= {}
+    end
+
+    def self.register(name, klass, opts)
+      enabled = opts[:enabled] != false
+      registry[name] = [klass, enabled]
+    end
+
+    def self.enable(*names)
+      names.each do |name|
+        matches = registry.select{|n,_| n =~ /(^|\.)#{name}$/ }
+        raise ArgumentError, "no normalizers match #{name}" if matches.empty?
+        matches.each{|k,v| v[1] = true }
+      end
     end
 
     def self.build(config)
       normalizers = {}
 
-      (@registry || {}).each do |k, klass|
+      registry.each do |key, (klass, enabled)|
+        if !enabled
+          # For now we use anyway, but in 2.0 we'll stop using disabled normalizers
+          DEPRECATOR.deprecation_warning("Enabling non-default normalizers via `require`",
+            "use `Skylight.enable_normalizer('#{key}')` instead")
+        end
+
         unless klass.method_defined?(:normalize)
           # TODO: Warn
           next
         end
 
-        normalizers[k] = klass.new(config)
+        normalizers[key] = klass.new(config)
       end
 
       Container.new(normalizers)
     end
 
     class Normalizer
-      def self.register(name)
-        Normalizers.register(name, self)
+      def self.register(name, opts={})
+        Normalizers.register(name, self, opts)
       end
 
       attr_reader :config
@@ -47,6 +65,7 @@ module Skylight
       end
     end
 
+    # FIXME: Move this elsewhere
     # Base Normalizer for Rails rendering
     class RenderNormalizer < Normalizer
       include Util::AllocationFree

data/lib/skylight/normalizers/active_job/enqueue_at.rb

@@ -2,7 +2,7 @@ module Skylight
   module Normalizers
     module ActiveJob
       class EnqueueAt < Normalizer
-        register "enqueue_at.active_job"
+        register "enqueue_at.active_job", enabled: false
 
         CAT = "other.job.enqueue_at".freeze
 

data/lib/skylight/probes.rb

@@ -1,10 +1,13 @@
+require 'pathname'
+
 module Skylight
   # @api private
   module Probes
     class ProbeRegistration
-      attr_reader :klass_name, :require_paths, :probe
+      attr_reader :name, :klass_name, :require_paths, :probe
 
-      def initialize(klass_name, require_paths, probe)
+      def initialize(name, klass_name, require_paths, probe)
+        @name = name
         @klass_name = klass_name
         @require_paths = Array(require_paths)
         @probe = probe
@@ -15,6 +18,34 @@ module Skylight
       end
     end
 
+    def self.available
+      unless @available
+        root = Pathname.new(File.expand_path("../probes", __FILE__))
+        @available = {}
+        Dir["#{root}/**/*.rb"].each do |f|
+          name = Pathname.new(f).relative_path_from(root).sub_ext('').to_s
+          @available[name] = "skylight/probes/#{name}"
+        end
+      end
+      @available
+    end
+
+    def self.probe(*probes)
+      unknown = probes.map(&:to_s) - available.keys
+      unless unknown.empty?
+        raise ArgumentError, "unknown probes: #{unknown.join(', ')}"
+      end
+
+      probes.each do |p|
+        begin
+          @via_api = true
+          require available[p.to_s]
+        ensure
+          @via_api = false
+        end
+      end
+    end
+
     def self.require_hooks
       @require_hooks ||= {}
     end
@@ -27,8 +58,13 @@ module Skylight
       !!Skylight::Util::Inflector.safe_constantize(klass_name)
     end
 
-    def self.register(*args)
-      registration = ProbeRegistration.new(*args)
+    def self.register(name, *args)
+      unless @via_api
+        DEPRECATOR.deprecation_warning("Enabling probes via `require` alone",
+                                        "use `Skylight.probe(:#{name})` instead")
+      end
+
+      registration = ProbeRegistration.new(name, *args)
 
       if is_available?(registration.klass_name)
         installed[registration.klass_name] = registration

data/lib/skylight/probes/action_controller.rb

@@ -59,6 +59,6 @@ module Skylight
       end
     end
 
-    register("ActionController::Instrumentation", "action_controller/metal/instrumentation", ActionController::Probe.new)
+    register(:action_controller, "ActionController::Instrumentation", "action_controller/metal/instrumentation", ActionController::Probe.new)
   end
 end

data/lib/skylight/probes/action_view.rb

@@ -38,6 +38,6 @@ module Skylight
       end
     end
 
-    register("ActionView::TemplateRenderer", "action_view", ActionView::Probe.new)
+    register(:action_view, "ActionView::TemplateRenderer", "action_view", ActionView::Probe.new)
   end
 end

data/lib/skylight/probes/active_model_serializers.rb

@@ -50,6 +50,6 @@ module Skylight
       end
     end
 
-    register("ActiveModel::Serializer", "active_model/serializer", ActiveModelSerializers::Probe.new)
+    register(:active_model_serializers, "ActiveModel::Serializer", "active_model/serializer", ActiveModelSerializers::Probe.new)
   end
 end

data/lib/skylight/probes/elasticsearch.rb

@@ -32,6 +32,6 @@ module Skylight
       end
     end
 
-    register("Elasticsearch", "elasticsearch", Elasticsearch::Probe.new)
+    register(:elasticsearch, "Elasticsearch", "elasticsearch", Elasticsearch::Probe.new)
   end
 end

data/lib/skylight/probes/excon.rb

@@ -21,6 +21,6 @@ module Skylight
       end
     end
 
-    register("Excon", "excon", Excon::Probe.new)
+    register(:excon, "Excon", "excon", Excon::Probe.new)
   end
 end

data/lib/skylight/probes/faraday.rb

@@ -17,6 +17,6 @@ module Skylight
       end
     end
 
-    register("Faraday", "faraday", Faraday::Probe.new)
+    register(:faraday, "Faraday", "faraday", Faraday::Probe.new)
   end
 end

data/lib/skylight/probes/grape.rb

@@ -5,11 +5,13 @@ module Skylight
         def install
           version = Gem::Version.new(::Grape::VERSION)
 
-          if version > Gem::Version.new("0.12.1")
+          if version >= Gem::Version.new("0.13.0")
             # AS::N is built in to newer versions
             return
           end
 
+          Skylight::DEPRECATOR.deprecation_warning("Support for Grape versions before 0.13.0")
+
           if version < Gem::Version.new("0.10.0")
             # Using $stderr here isn't great, but we don't have a logger accessible
             $stderr.puts "[SKYLIGHT] [#{Skylight::VERSION}] The Grape probe only works with version 0.10.0+ " \
@@ -81,6 +83,6 @@ module Skylight
       end
     end
 
-    register("Grape::Endpoint", "grape/endpoint", Grape::Probe.new)
+    register(:grape, "Grape::Endpoint", "grape/endpoint", Grape::Probe.new)
   end
 end

data/lib/skylight/probes/httpclient.rb

@@ -41,6 +41,6 @@ module Skylight
       end # class Probe
     end # module Probes::HTTPClient
 
-    register("HTTPClient", "httpclient", HTTPClient::Probe.new)
+    register(:httpclient, "HTTPClient", "httpclient", HTTPClient::Probe.new)
   end
 end

data/lib/skylight/probes/middleware.rb

@@ -74,6 +74,6 @@ module Skylight
       end
     end
 
-    register("ActionDispatch::MiddlewareStack::Middleware", "actionpack/action_dispatch", Middleware::Probe.new)
+    register(:middleware, "ActionDispatch::MiddlewareStack::Middleware", "actionpack/action_dispatch", Middleware::Probe.new)
   end
 end

data/lib/skylight/probes/mongo.rb

@@ -156,6 +156,6 @@ module Skylight
       end
     end
 
-    register("Mongo", "mongo", Mongo::Probe.new)
+    register(:mongo, "Mongo", "mongo", Mongo::Probe.new)
   end
 end

data/lib/skylight/probes/mongoid.rb

@@ -8,14 +8,14 @@ module Skylight
           version = Gem::Version.new(::Mongoid::VERSION)
 
           if version < Gem::Version.new("5.0")
-            require 'skylight/probes/moped'
+            Skylight.probe(:moped)
           else
-            require 'skylight/probes/mongo'
+            Skylight.probe(:mongo)
           end
         end
       end
     end
 
-    register("Mongoid", "mongoid", Mongoid::Probe.new)
+    register(:mongoid, "Mongoid", "mongoid", Mongoid::Probe.new)
   end
 end

data/lib/skylight/probes/moped.rb

@@ -34,6 +34,6 @@ module Skylight
       end
     end
 
-    register("Moped", "moped", Moped::Probe.new)
+    register(:moped, "Moped", "moped", Moped::Probe.new)
   end
 end

data/lib/skylight/probes/net_http.rb

@@ -53,6 +53,6 @@ module Skylight
       end
     end
 
-    register("Net::HTTP", "net/http", NetHTTP::Probe.new)
+    register(:net_http, "Net::HTTP", "net/http", NetHTTP::Probe.new)
   end
 end

data/lib/skylight/probes/redis.rb

@@ -66,6 +66,6 @@ module Skylight
       end
     end
 
-    register("Redis", "redis", Redis::Probe.new)
+    register(:redis, "Redis", "redis", Redis::Probe.new)
   end
 end

data/lib/skylight/probes/sequel.rb

@@ -4,6 +4,10 @@ module Skylight
     module Sequel
       class Probe
         def install
+          if Gem::Version.new(::Sequel.version) < Gem::Version.new('4.0')
+            Skylight::DEPRECATOR.deprecation_warning("Support for Sequel versions before 4.0")
+          end
+
           require 'sequel/database/logging'
 
           method_name = ::Sequel::Database.method_defined?(:log_connection_yield) ? 'log_connection_yield' : 'log_yield'
@@ -28,6 +32,6 @@ module Skylight
       end
     end
 
-    register("Sequel", "sequel", Sequel::Probe.new)
+    register(:sequel, "Sequel", "sequel", Sequel::Probe.new)
   end
 end

data/lib/skylight/probes/sinatra.rb

@@ -71,6 +71,6 @@ module Skylight
       end
     end
 
-    register("Sinatra::Base", "sinatra/base", Sinatra::Probe.new)
+    register(:sinatra, "Sinatra::Base", "sinatra/base", Sinatra::Probe.new)
   end
 end

data/lib/skylight/probes/tilt.rb

@@ -4,6 +4,10 @@ module Skylight
     module Tilt
       class Probe
         def install
+          if Gem::Version.new(::Tilt::VERSION) < Gem::Version.new('1.4.1')
+            Skylight::DEPRECATOR.deprecation_warning("Support for Tilt versions before 1.4.1")
+          end
+
           ::Tilt::Template.class_eval do
             alias render_without_sk render
 
@@ -22,6 +26,6 @@ module Skylight
       end
     end
 
-    register("Tilt::Template", "tilt/template", Tilt::Probe.new)
+    register(:tilt, "Tilt::Template", "tilt/template", Tilt::Probe.new)
   end
 end

data/lib/skylight/railtie.rb

@@ -125,9 +125,8 @@ module Skylight
     end
 
     def load_probes
-      probes = config.skylight.probes || []
-      probes.each do |p|
-        require "skylight/probes/#{p}"
+      if probes = config.skylight.probes
+        Skylight.probe(*probes)
       end
     end
 

data/lib/skylight/sinatra.rb

@@ -1,4 +1,7 @@
 require 'skylight'
-require 'skylight/probes/sinatra'
-require 'skylight/probes/tilt'
-require 'skylight/probes/sequel'
+
+if Gem::Version(Sinatra::VERSION) < Gem::Version('1.4')
+  Skylight::DEPRECATOR.deprecation_warning("Support for Sinatra versions before 1.4")
+end
+
+Skylight.probe(:sinatra, :tilt, :sequel)

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '1.6.1'
+  VERSION = '1.7.0'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -67,6 +67,7 @@ files:
 - lib/skylight/config.rb
 - lib/skylight/core.rb
 - lib/skylight/data/cacert.pem
+- lib/skylight/deprecation.rb
 - lib/skylight/formatters/http.rb
 - lib/skylight/gc.rb
 - lib/skylight/helpers.rb