skylight-core 3.1.5 → 4.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1bff6f694c07d0d3b51b9c6e204c0b8a773975f400bd0267b7bdcd8196f26f3
-  data.tar.gz: 1187010fff1083dbfab549871ff5d69f68227e3dc6dc94e66f0807cfeff3b2a0
+  metadata.gz: ed175a550ab9f4dfeecf785242272a6415e1bc9b6a723f3d5df527bc806c020c
+  data.tar.gz: dc65a9796aaafef2b25ab8f8aa2bc065b69653fa8f03f7696c08c3b78c26d7e1
 SHA512:
-  metadata.gz: 037f6038e8f7c9608b1a0096cd63708c331f90340e50de56a6975909b49dc71daf5c6f334716e5ed345114aa1db8e1c8c42e43784d34c150215610b6a48e4dc6
-  data.tar.gz: 19d2b4f48531891e4924522fd5df46a5d7a6abb021768f4b8d3ac5d2810252387f03b712573b0ded27af1f3447280aba7910fb4acf1e2a259c57a557d728e6e1
+  metadata.gz: 5316aa9d177e810193ae1ed0c93c0ea8e307ed1cace0891083a797d260dd650a03a1afc6a287495b2a706a409a5c03543d22edc38cc0562667a87111d00f74ce
+  data.tar.gz: 0524413c1fd1b13334ec6faa1b8372200c71b7a049d0c6aed4371e0220b5331c7a286333d3b48a348a064d43400e09650ca42b02a91fe5c3135760d017bf08c0

data/lib/skylight/core/config.rb

@@ -1,11 +1,10 @@
-require 'yaml'
-require 'fileutils'
-require 'thread'
-require 'erb'
-require 'json'
-require 'skylight/core/util/logging'
-require 'skylight/core/util/proxy'
-require 'skylight/core/errors'
+require "yaml"
+require "fileutils"
+require "erb"
+require "json"
+require "skylight/core/util/logging"
+require "skylight/core/util/proxy"
+require "skylight/core/errors"
 
 module Skylight::Core
   class Config
@@ -14,30 +13,32 @@ module Skylight::Core
     # @api private
     MUTEX = Mutex.new
 
+    # rubocop:disable Style/SingleLineMethods, Layout/EmptyLineBetweenDefs
     def self.log_name; "Skylight" end
     def self.service_name; log_name end
     def self.support_email; "support@skylight.io" end
     def self.env_matcher; /^(?:SK|SKYLIGHT)_(.+)$/ end
     def self.env_prefix; "SKYLIGHT_" end
+    # rubocop:enable Style/SingleLineMethods, Layout/EmptyLineBetweenDefs
 
     # Map environment variable keys with Skylight configuration keys
     def self.env_to_key
       {
         # == Logging ==
-        'LOG_FILE'       => :log_file,
-        'LOG_LEVEL'      => :log_level,
-        'ALERT_LOG_FILE' => :alert_log_file,
-        'LOG_SQL_PARSE_ERRORS' => :log_sql_parse_errors,
+        "LOG_FILE"       => :log_file,
+        "LOG_LEVEL"      => :log_level,
+        "ALERT_LOG_FILE" => :alert_log_file,
+        "LOG_SQL_PARSE_ERRORS" => :log_sql_parse_errors,
 
         # == Proxy ==
-        'PROXY_URL' => :proxy_url,
+        "PROXY_URL" => :proxy_url,
 
         # == Instrumenter ==
         "ENABLE_SEGMENTS" => :enable_segments,
         "ENABLE_SIDEKIQ" => :enable_sidekiq,
 
         # == User config settings ==
-        "USER_CONFIG_PATH" => :'user_config_path',
+        "USER_CONFIG_PATH" => :user_config_path,
 
         # == Heroku settings ==
         "HEROKU_DYNO_INFO_PATH" => :'heroku.dyno_info_path'
@@ -47,13 +48,13 @@ module Skylight::Core
     # Default values for Skylight configuration keys
     def self.default_values
       {
-        :log_file             => '-'.freeze,
-        :log_level            => 'INFO'.freeze,
-        :alert_log_file       => '-'.freeze,
-        :log_sql_parse_errors => true,
-        :enable_segments      => true,
-        :enable_sidekiq       => false,
-        :'heroku.dyno_info_path' => '/etc/heroku/dyno'
+        log_file:                 "-".freeze,
+        log_level:                "INFO".freeze,
+        alert_log_file:           "-".freeze,
+        log_sql_parse_errors:     true,
+        enable_segments:          true,
+        enable_sidekiq:           false,
+        'heroku.dyno_info_path':  "/etc/heroku/dyno"
       }
     end
 
@@ -69,10 +70,10 @@ module Skylight::Core
     end
 
     def self.native_env_keys
-      [
-        :version,
-        :root,
-        :proxy_url
+      %i[
+        version
+        root
+        proxy_url
       ]
     end
 
@@ -94,7 +95,7 @@ module Skylight::Core
     def initialize(*args)
       attrs = {}
 
-      if Hash === args.last
+      if args.last.is_a?(Hash)
         attrs = args.pop.dup
       end
 
@@ -106,7 +107,7 @@ module Skylight::Core
 
       p = attrs.delete(:priority)
 
-      if @environment = args[0]
+      if (@environment = args[0])
         @regexp = /^#{Regexp.escape(@environment)}\.(.+)$/
       end
 
@@ -122,16 +123,14 @@ module Skylight::Core
     end
 
     def self.load(opts = {}, env = ENV)
-      attrs   = {}
-      version = nil
-
+      attrs = {}
       path = opts.delete(:file)
       environment = opts.delete(:environment)
 
       if path
         error = nil
         begin
-          attrs = YAML.load(ERB.new(File.read(path)).result)
+          attrs = YAML.safe_load(ERB.new(File.read(path)).result)
           error = "empty file" unless attrs
           error = "invalid format" if attrs && !attrs.is_a?(Hash)
         rescue Exception => e
@@ -139,8 +138,6 @@ module Skylight::Core
         end
 
         raise ConfigError, "could not load config file; msg=#{error}" if error
-
-        version = File.mtime(path).to_i
       end
 
       if env
@@ -168,24 +165,23 @@ module Skylight::Core
       return ret unless env
 
       # Only set if it exists, we don't want to set to a nil value
-      if proxy_url = Util::Proxy.detect_url(env)
+      if (proxy_url = Util::Proxy.detect_url(env))
         ret[:proxy_url] = proxy_url
       end
 
       env.each do |k, val|
         next unless k =~ env_matcher
-
-        if key = env_to_key[$1]
-          ret[key] =
-            case val
-            when /^false$/i      then false
-            when /^true$/i       then true
-            when /^(nil|null)$/i then nil
-            when /^\d+$/         then val.to_i
-            when /^\d+\.\d+$/    then val.to_f
-            else val
-            end
-        end
+        next unless (key = env_to_key[$1])
+
+        ret[key] =
+          case val
+          when /^false$/i      then false
+          when /^true$/i       then true
+          when /^(nil|null)$/i then nil
+          when /^\d+$/         then val.to_i
+          when /^\d+\.\d+$/    then val.to_f
+          else val
+          end
       end
 
       ret
@@ -228,7 +224,7 @@ module Skylight::Core
     end
 
     def check_logfile_permissions(log_file, key)
-      return if log_file == '-' # STDOUT
+      return if log_file == "-" # STDOUT
       log_file = File.expand_path(log_file, root)
       check_file_permissions(log_file, key)
     end
@@ -238,7 +234,7 @@ module Skylight::Core
       @priority.key?(key) || @values.key?(key)
     end
 
-    def get(key, default = nil, &blk)
+    def get(key, default = nil)
       key = self.class.remap_key(key)
 
       return @priority[key] if @priority.key?(key)
@@ -247,8 +243,8 @@ module Skylight::Core
 
       if default
         return default
-      elsif blk
-        return blk.call(key)
+      elsif block_given?
+        return yield key
       end
 
       nil
@@ -258,17 +254,17 @@ module Skylight::Core
 
     def set(key, val, scope = nil)
       if scope
-        key = [scope, key].join('.')
+        key = [scope, key].join(".")
       end
 
-      if Hash === val
+      if val.is_a?(Hash)
         val.each do |k, v|
           set(k, v, key)
         end
       else
         k = self.class.remap_key(key)
 
-        if validator = self.class.validators[k]
+        if (validator = self.class.validators[k])
           blk, msg = validator
 
           unless blk.call(val, self)
@@ -288,8 +284,8 @@ module Skylight::Core
 
     alias []= set
 
-    def send_or_get(v)
-      respond_to?(v) ? send(v) : get(v)
+    def send_or_get(val)
+      respond_to?(val) ? send(val) : get(val)
     end
 
     def duration_ms(key, default = nil)
@@ -310,13 +306,17 @@ module Skylight::Core
       end
     end
 
-    def to_json
-      JSON.generate(
+    def to_json(*)
+      JSON.generate(as_json)
+    end
+
+    def as_json(*)
+      {
         config: {
           priority: @priority,
           values:   @values
         }
-      )
+      }
     end
 
     def to_native_env
@@ -333,7 +333,7 @@ module Skylight::Core
       ret
     end
 
-    def write(path)
+    def write(_path)
       raise "not implemented"
     end
 
@@ -349,7 +349,7 @@ module Skylight::Core
 
     # @api private
     def gc
-      @gc ||= GC.new(self, get('gc.profiler', VM::GC.new))
+      @gc ||= GC.new(self, get("gc.profiler", VM::GC.new))
     end
 
     # @api private
@@ -381,15 +381,13 @@ module Skylight::Core
         end
     end
 
-    def logger=(logger)
-      @logger = logger
-    end
+    attr_writer :logger
 
     def alert_logger
       @alert_logger ||= MUTEX.synchronize do
-        unless l = @alert_logger
+        unless (l = @alert_logger)
           out = get(:alert_log_file)
-          out = Util::AlertLogger.new(load_logger) if out == '-'
+          out = Util::AlertLogger.new(load_logger) if out == "-"
 
           l = create_logger(out)
           l.level = Logger::DEBUG
@@ -399,9 +397,7 @@ module Skylight::Core
       end
     end
 
-    def alert_logger=(logger)
-      @alert_logger = logger
-    end
+    attr_writer :alert_logger
 
     def enable_segments?
       !!get(:enable_segments)
@@ -419,56 +415,55 @@ module Skylight::Core
       File.exist?(get(:'heroku.dyno_info_path'))
     end
 
-  private
+    private
 
-    def create_logger(out)
-      l = begin
-        if out.is_a?(String)
-          out = File.expand_path(out, root)
-          # May be redundant since we also do this in the permissions check
-          FileUtils.mkdir_p(File.dirname(out))
-        end
+      def create_logger(out)
+        l = begin
+          if out.is_a?(String)
+            out = File.expand_path(out, root)
+            # May be redundant since we also do this in the permissions check
+            FileUtils.mkdir_p(File.dirname(out))
+          end
 
-        Logger.new(out)
-      rescue
-        Logger.new(STDOUT)
+          Logger.new(out)
+        rescue
+          Logger.new(STDOUT)
+        end
+        l.progname = self.class.log_name
+        l
       end
-      l.progname = self.class.log_name
-      l
-    end
 
-    def load_logger
-      unless l = @logger
-        out = get(:log_file)
-        out = STDOUT if out == '-'
+      def load_logger
+        unless (l = @logger)
+          out = get(:log_file)
+          out = STDOUT if out == "-"
 
-        l = create_logger(out)
-        if trace?
-          l.level = Logger::DEBUG
-        else
+          l = create_logger(out)
           l.level =
-            case get(:log_level)
-            when /^debug$/i then Logger::DEBUG
-            when /^info$/i  then Logger::INFO
-            when /^warn$/i  then Logger::WARN
-            when /^error$/i then Logger::ERROR
-            when /^fatal$/i then Logger::FATAL
-            else Logger::ERROR
+            if trace?
+              Logger::DEBUG
+            else
+              case get(:log_level)
+              when /^debug$/i then Logger::DEBUG
+              when /^info$/i  then Logger::INFO
+              when /^warn$/i  then Logger::WARN
+              when /^error$/i then Logger::ERROR
+              when /^fatal$/i then Logger::FATAL
+              else Logger::ERROR
+              end
             end
         end
-      end
 
-      l
-    end
-
-    def cast_for_env(v)
-      case v
-      when true  then 'true'
-      when false then 'false'
-      when nil   then 'nil'
-      else v.to_s
+        l
       end
-    end
 
+      def cast_for_env(val)
+        case val
+        when true  then "true"
+        when false then "false"
+        when nil   then "nil"
+        else val.to_s
+        end
+      end
   end
 end

data/lib/skylight/core/deprecation.rb

@@ -1,7 +1,7 @@
-require 'active_support/deprecation'
+require "active_support/deprecation"
 
 module Skylight::Core
-  SKYLIGHT_GEM_ROOT = File.expand_path("../../..", __FILE__) + "/"
+  SKYLIGHT_GEM_ROOT = File.expand_path("../..", __dir__) + "/"
 
   class Deprecation < ActiveSupport::Deprecation
     private
@@ -11,5 +11,5 @@ module Skylight::Core
       end
   end
 
-  DEPRECATOR = Deprecation.new('4.0', 'skylight-core')
+  DEPRECATOR = Deprecation.new("4.0", "skylight-core")
 end

data/lib/skylight/core/fanout.rb

@@ -14,7 +14,7 @@ module Skylight
       end
 
       def self.trace(*args)
-        registered.map{|r| r.trace(*args) }
+        registered.map { |r| r.trace(*args) }
       end
 
       def self.instrument(*args)
@@ -33,8 +33,8 @@ module Skylight
         end
       end
 
-      def self.done(spans, meta=nil)
-        spans.reverse.each do |(target, span)|
+      def self.done(spans, meta = nil)
+        spans.reverse_each do |(target, span)|
           target.done(span, meta)
         end
       end

data/lib/skylight/core/formatters/http.rb

@@ -2,7 +2,6 @@ module Skylight
   module Core
     module Formatters
       module HTTP
-
         # Build instrumentation options for HTTP queries
         #
         # @param [String] method HTTP method, e.g. get, post
@@ -12,7 +11,7 @@ module Skylight
         # @param [String] path Request path
         # @param [String] query Request query string
         # @return [Hash] a hash containing `:category`, `:title`, and `:annotations`
-        def self.build_opts(method, scheme, host, port, path, query)
+        def self.build_opts(method, _scheme, host, _port, _path, _query)
           { category: "api.http.#{method.downcase}",
             title:    "#{method.upcase} #{host}",
             meta:     { host: host } }

data/lib/skylight/core/gc.rb

@@ -1,9 +1,7 @@
-require 'thread'
-
 module Skylight::Core
   # @api private
   class GC
-    METHODS   = [ :enable, :total_time ]
+    METHODS   = %i[enable total_time].freeze
     TH_KEY    = :SK_GC_CURR_WINDOW
     MAX_COUNT = 1000
     MAX_TIME  = 30_000_000
@@ -36,9 +34,7 @@ module Skylight::Core
     end
 
     def track
-      unless @profiler
-        win = Window.new(nil)
-      else
+      if @profiler
         win = Window.new(self)
 
         @lock.synchronize do
@@ -46,17 +42,17 @@ module Skylight::Core
           @listeners << win
 
           # Cleanup any listeners that might have leaked
-          until @listeners[0].time < MAX_TIME
-            @listeners.shift
-          end
+          @listeners.shift until @listeners[0].time < MAX_TIME
 
           if @listeners.length > MAX_COUNT
             @listeners.shift
           end
         end
-      end
 
-      win
+        win
+      else
+        Window.new(nil)
+      end
     end
 
     def release(win)
@@ -73,40 +69,39 @@ module Skylight::Core
       nil
     end
 
-  private
+    private
 
-    def __update
-      time  = @profiler.total_time
-      diff  = time - @time
-      @time = time
+      def __update
+        time  = @profiler.total_time
+        diff  = time - @time
+        @time = time
 
-      if diff > 0
-        @listeners.each do |l|
-          l.add(diff)
+        if diff > 0
+          @listeners.each do |l|
+            l.add(diff)
+          end
         end
       end
-    end
 
-    class Window
-      attr_reader :time
+      class Window
+        attr_reader :time
 
-      def initialize(global)
-        @global = global
-        @time   = 0
-      end
+        def initialize(global)
+          @global = global
+          @time   = 0
+        end
 
-      def update
-        @global.update if @global
-      end
+        def update
+          @global.update if @global
+        end
 
-      def add(time)
-        @time += time
-      end
+        def add(time)
+          @time += time
+        end
 
-      def release
-        @global.release(self) if @global
+        def release
+          @global.release(self) if @global
+        end
       end
-    end
-
   end
 end

data/lib/skylight/core/instrumentable.rb

@@ -1,7 +1,6 @@
 module Skylight
   module Core
     module Instrumentable
-
       def self.included(base)
         base.extend(Util::Logging)
         base.extend(ClassMethods)
@@ -16,7 +15,6 @@ module Skylight
       end
 
       module ClassMethods
-
         def instrumenter_class
           Skylight::Core::Instrumenter
         end
@@ -38,7 +36,7 @@ module Skylight
         end
 
         # Start instrumenting
-        def start!(config=nil)
+        def start!(config = nil)
           return @instrumenter if @instrumenter
 
           const_get(:LOCK).synchronize do
@@ -50,11 +48,14 @@ module Skylight
             @instrumenter = instrumenter_class.new(config).start!
           end
         rescue => e
-          level, message = if e.is_a? ConfigError
-            [:warn, sprintf("Unable to start Instrumenter due to a configuration error: %s", e.message)]
-          else
-            [:error, sprintf("Unable to start Instrumenter; msg=%s; class=%s", e.message, e.class)]
-          end
+          level, message =
+            if e.is_a?(ConfigError)
+              [:warn, format("Unable to start Instrumenter due to a configuration error: %<message>s",
+                             message: e.message)]
+            else
+              [:error, format("Unable to start Instrumenter; msg=%<message>s; class=%<klass>s",
+                              message: e.message, klass: e.class)]
+            end
 
           if config && config.respond_to?("log_#{level}") && config.respond_to?(:log_trace)
             config.send("log_#{level}", message)
@@ -82,21 +83,23 @@ module Skylight
 
         # Check tracing
         def tracing?
-          t { "checking tracing?; thread=#{Thread.current.object_id}"}
+          t { "checking tracing?; thread=#{Thread.current.object_id}" }
           instrumenter && instrumenter.current_trace
         end
 
         # Start a trace
-        def trace(endpoint=nil, cat=nil, title=nil, meta=nil)
+        def trace(endpoint = nil, cat = nil, title = nil, meta = nil, segment: nil)
           unless instrumenter
             return yield if block_given?
             return
           end
 
+          cat ||= DEFAULT_CATEGORY
+
           if block_given?
-            instrumenter.trace(endpoint, cat || DEFAULT_CATEGORY, title, nil, meta) { yield }
+            instrumenter.trace(endpoint, cat, title, nil, meta, segment: segment) { |tr| yield tr }
           else
-            instrumenter.trace(endpoint, cat || DEFAULT_CATEGORY, title, nil, meta)
+            instrumenter.trace(endpoint, cat, title, nil, meta, segment: segment)
           end
         end
 
@@ -107,7 +110,7 @@ module Skylight
             return
           end
 
-          if Hash === opts
+          if opts.is_a?(Hash)
             category    = opts[:category] || DEFAULT_CATEGORY
             title       = opts[:title]
             desc        = opts[:description]
@@ -131,7 +134,7 @@ module Skylight
         end
 
         # End a span
-        def done(span, meta=nil)
+        def done(span, meta = nil)
           return unless instrumenter
           instrumenter.done(span, meta)
         end
@@ -155,9 +158,7 @@ module Skylight
           return unless instrumenter
           instrumenter.config
         end
-
       end
-
     end
   end
 end