skylight 1.4.0.beta → 1.4.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a44af3f665e6d0fd8a25dc3d867ea86dae43620
-  data.tar.gz: edac70c82631fb57e9990aeeedbb55a62e4111d5
+  metadata.gz: 26a5c49afa9a810288570e751ee26df5982b98e9
+  data.tar.gz: 606b839a3ad60282a40fa50567c2703a3f6fff4f
 SHA512:
-  metadata.gz: da6cec1e164c3c49cce1239c88efb74f7dca60e0b699aadf051cf97fb2def14a813e0a99badac04c50c2750ab2bd0f420d69fb88fb2421ce92ef4d9a42dc1bb6
-  data.tar.gz: 12bc7d82549fc243fd7446892d2387ce635a941d5ae23600713e9b2432d68dbb2b7793e8bcaa369227127b1027d964d1125492f273e89f5e5220813fcf027bed
+  metadata.gz: 9791c329fa6bd1088fb2841110d891e47c5eb363af5bea00eca268bc59f9105e0168cf80acc82cb4627529e316be509116c825cc11ef537e1066edb7fc66723d
+  data.tar.gz: a81389b6de9384fc7e2ac59bb4cb0a77ed8ff1cc2db9e215469787c4010531d99f63b1b748694a94ee2bacf6384c460c074e0c88116dbbfd2feb29d6db35a494

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.4.0-beta.2 (September 28, 2017)
+
+* [FEATURE] Faraday instrumentation
+* [FEATURE] Rack Middleware probe enabled by default
+* [FEATURE] ActiveRecord Instantiation instrumentation
+* [IMPROVEMENT] Improved handling of the user-level configuration options
+* [EXPERIMENTAL] ActionJob Enqueue instrumentation. (Only tracks the enqueuing of new jobs. Does not instrument jobs themselves. Off by default since it's not clear how useful it is. To enable: `require 'skylight/normalizers/active_job/enqueue_at`.)
+* [EXPERIMENTAL] FreeBSD support. (This should work automatically on FreeBSD systems, but real-world testing has been minimal.)
+
 ## 1.4.0-beta (July 13, 2017)
 
 * [FEATURE] Add probe for Rack Middlewares. To enable, add 'middleware' to `config.skylight.probes` list.

data/CONTRIBUTING.md

@@ -6,4 +6,10 @@ If you've got a bug report or have a feature you'd like to request, please conta
 
 Before contributing, please [sign the CLA](https://docs.google.com/spreadsheet/viewform?usp=drive_web&formkey=dHJVY1M5bzNzY0pwN2dRZjMxV0dXSkE6MA#gid=0).
 
-In general, we recommend that you speak with us about any new features you'd like to add so we can make sure we're on the same page.
+In general, we recommend that you speak with us about any new features you'd like to add so we can make sure we're on the same page.
+
+## Emulating Travis Builds
+
+We have many Travis build configurations that must pass in order to merge a pull request. You can emulate these configurations locally by running `rake run_travis_builds`. The only prerequisites are that you have both [VirtualBox](https://www.virtualbox.org/wiki/VirtualBox) and [Vagrant](https://www.vagrantup.com/) installed (most recent versions are best).
+
+After that rake task completes, be sure to run `rake clean build`. This will delete the local native extension that was built when you ran `rake run_travis_builds` and rebuilds it.

data/README.md

@@ -3,11 +3,11 @@
 Instrument your ruby application and send the data to the Skylight
 servers.
 
-Sign up at https://skylight.io.
+Sign up at https://www.skylight.io.
 
-For more documentation see https://docs.skylight.io/.
+For more documentation see https://www.skylight.io/support.
 
 
 ## Bug Reports and Feature Requests
 
-If you've got a bug report or have a feature you'd like to request, please contact us at support@skylight.io or use the "?" button in the Skylight web interface. We'll be much quicker to respond that way :)
+If you've got a bug report or have a feature you'd like to request, please contact us at support@skylight.io or use the built-in messenger in the Skylight web interface. We'll be much quicker to respond that way :)

data/ext/libskylight.yml

@@ -5,3 +5,4 @@ checksums:
   x86_64-linux:      "117ac0ff29240a518717fcf52f7cd3eeec69a135c481693b8eb259bb4c2b528c"
   x86_64-linux-musl: "bab4030060eb4b83d0543839e0f51b09545d7d5b20c3f7dd35ae6f81f3189499"
   x86_64-darwin:     "1c0fdb68c0dde34a1b0842403db2ea2ca6a0de2fb7d729e869f395f6d10383b5"
+  x86_64-freebsd:    "1b81c47c154c7dcb40787f159e663bc3c97c204c5baedf2d741e5f561fa41ecd"

data/lib/skylight/cli.rb

@@ -56,7 +56,7 @@ you should set the `SKYLIGHT_AUTHENTICATION` variable to:
 
         OUT
       rescue Api::CreateFailed => e
-        say "Could not create the application. Please run `skylight doctor` for diagnostics.", :red
+        say "Could not create the application. Please run `bundle exec skylight doctor` for diagnostics.", :red
         say e.to_s, :yellow
       rescue Interrupt
       end
@@ -132,7 +132,7 @@ you should set the `SKYLIGHT_AUTHENTICATION` variable to:
       end
 
       def user_config
-        UserConfig.instance
+        config.user_config
       end
 
     end

data/lib/skylight/config.rb

@@ -59,6 +59,9 @@ module Skylight
       "REPORT_HTTP_CONNECT_TIMEOUT"  => :report_http_connect_timeout,
       "REPORT_HTTP_READ_TIMEOUT"     => :report_http_read_timeout,
 
+      # == User config settings ==
+      "USER_CONFIG_PATH"             => :'user_config_path',
+
       # == Native agent settings ==
       #
       "LAZY_START"                   => :'daemon.lazy_start',
@@ -600,6 +603,10 @@ authentication: #{self[:authentication]}
       !!get(:enable_segments)
     end
 
+    def user_config
+      @user_config ||= UserConfig.new(self)
+    end
+
   private
 
     def check_nfs(path)

data/lib/skylight/core.rb

@@ -1,5 +1,6 @@
 require 'skylight/version'
 
+# Root Skylight namespace
 module Skylight
   # @api private
   TRACE_ENV_KEY = 'SKYLIGHT_ENABLE_TRACE_LOGS'.freeze

data/lib/skylight/formatters/http.rb

@@ -1,6 +1,16 @@
 module Skylight
   module Formatters
     module HTTP
+
+      # Build instrumentation options for HTTP queries
+      #
+      # @param [String] method HTTP method, e.g. get, post
+      # @param [String] scheme HTTP scheme, e.g. http, https
+      # @param [String] host Request host, e.g. example.com
+      # @param [String, Integer] port Request port
+      # @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)
         { category: "api.http.#{method.downcase}",
           title:    "#{method.upcase} #{host}" }

data/lib/skylight/normalizers.rb

@@ -47,6 +47,7 @@ module Skylight
       end
     end
 
+    # Base Normalizer for Rails rendering
     class RenderNormalizer < Normalizer
       include Util::AllocationFree
 
@@ -54,6 +55,11 @@ module Skylight
         @paths = config['normalizers.render.view_paths'] || []
       end
 
+      # Generic normalizer for renders
+      # @param category [String]
+      # @param payload [Hash]
+      # @option payload [String] :identifier
+      # @return [Array]
       def normalize_render(category, payload)
         if path = payload[:identifier]
           title = relative_path(path)
@@ -143,13 +149,18 @@ module Skylight
         action_view/render_partial
         action_view/render_template
         active_model_serializers/render
+        active_record/instantiation
         active_record/sql
         active_support/cache
         elasticsearch/request
         grape/endpoint
         moped/query
+        faraday/request
         couch_potato/query).each do |file|
       require "skylight/normalizers/#{file}"
     end
+
+    # The following are not required by default as they are of dubious usefulness:
+    # - active_job/enqueue_at
   end
 end

data/lib/skylight/normalizers/action_controller/process_action.rb

@@ -1,6 +1,7 @@
 module Skylight
   module Normalizers
     module ActionController
+      # Normalizer for processing a Rails controller action
       class ProcessAction < Normalizer
         register "process_action.action_controller"
 
@@ -10,6 +11,12 @@ module Skylight
         #   Additional keys available in `normalize_after`: status, view_runtime
         #     Along with ones added by probe: variant
 
+        # @param trace [Skylight::Messages::Trace::Builder]
+        # @param name [String] ignored, only present to match API
+        # @param payload [Hash]
+        # @option payload [String] :controller Controller name
+        # @option payload [String] :action Action name
+        # @return [Array]
         def normalize(trace, name, payload)
           trace.endpoint = controller_action(payload)
           [ CAT, trace.endpoint, nil ]

data/lib/skylight/normalizers/action_view/render_collection.rb

@@ -1,11 +1,18 @@
 module Skylight
   module Normalizers
     module ActionView
+      # Normalizer for Rails collection rendering
       class RenderCollection < RenderNormalizer
         register "render_collection.action_view"
 
         CAT = "view.render.collection".freeze
 
+        # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+        # @param name [String] ignored, only present to match API
+        # @param payload (see RenderNormalizer#normalize_render)
+        # @option payload (see RenderNormalizer#normalize_render)
+        # @option payload [Integer] :count
+        # @return (see RenderNormalizer#normalize_render)
         def normalize(trace, name, payload)
           normalize_render(CAT, payload)
         end

data/lib/skylight/normalizers/action_view/render_partial.rb

@@ -1,11 +1,17 @@
 module Skylight
   module Normalizers
     module ActionView
+      # Normalizer for Rails partial rendering
       class RenderPartial < RenderNormalizer
         register "render_partial.action_view"
 
         CAT = "view.render.template".freeze
 
+        # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+        # @param name [String] ignored, only present to match API
+        # @param payload (see RenderNormalizer#normalize_render)
+        # @option payload (see RenderNormalizer#normalize_render)
+        # @return (see RenderNormalizer#normalize_render)
         def normalize(trace, name, payload)
           normalize_render(CAT, payload)
         end

data/lib/skylight/normalizers/action_view/render_template.rb

@@ -1,11 +1,17 @@
 module Skylight
   module Normalizers
     module ActionView
+      # Normalizer for Rails template rendering
       class RenderTemplate < RenderNormalizer
         register "render_template.action_view"
 
         CAT = "view.render.template".freeze
 
+        # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+        # @param name [String] ignored, only present to match API
+        # @param payload (see RenderNormalizer#normalize_render)
+        # @option payload (see RenderNormalizer#normalize_render)
+        # @return (see RenderNormalizer#normalize_render)
         def normalize(trace, name, payload)
           normalize_render(CAT, payload)
         end

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

@@ -0,0 +1,21 @@
+module Skylight
+  module Normalizers
+    module ActiveJob
+      class EnqueueAt < Normalizer
+        register "enqueue_at.active_job"
+
+        CAT = "other.job.enqueue_at".freeze
+
+        def normalize(_trace, _name, payload)
+					title = "Enqueue #{payload[:job].class}"
+
+					adapter_class_name = payload[:adapter].class.name
+					adapter_name = adapter_class_name.match(/^ActiveJob::QueueAdapters::(\w+)Adapter$/)[1].underscore
+					desc = "{ adapter: '#{adapter_name}', queue: '#{payload[:job].queue_name}' }"
+
+					[ CAT, title, desc ]
+        end
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/active_record/instantiation.rb

@@ -0,0 +1,17 @@
+module Skylight
+  module Normalizers
+    module ActiveRecord
+      class Instantiation < Normalizer
+        register "instantiation.active_record"
+
+        CAT = "db.active_record.instantiation".freeze
+
+        def normalize(trace, name, payload)
+          # Payload also includes `:record_count` but this will be variable
+          [ CAT, "#{payload[:class_name]} Instantiation", nil]
+        end
+
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/active_record/sql.rb

@@ -3,6 +3,7 @@ require "json"
 module Skylight
   module Normalizers
     module ActiveRecord
+      # Normalizer for SQL requests
       class SQL < Normalizer
         register "sql.active_record"
         register "sql.sequel"
@@ -10,6 +11,12 @@ module Skylight
 
         CAT = "db.sql.query".freeze
 
+        # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+        # @param name [String] ignored, only present to match API
+        # @param payload [Hash]
+        # @option payload [String] [:name] The SQL operation
+        # @option payload [Hash] [:binds] The bound parameters
+        # @return [Array]
         def normalize(trace, name, payload)
           case payload[:name]
           when "SCHEMA".freeze, "CACHE".freeze

data/lib/skylight/normalizers/active_support/cache.rb

@@ -33,6 +33,7 @@ if defined?(ActiveSupport::Cache::Store.instrument)
   end
 
   unless deprecated
+    # @api private
     class ActiveSupport::Cache::Store
       def self.instrument
         true

data/lib/skylight/normalizers/default.rb

@@ -1,7 +1,15 @@
 module Skylight
   module Normalizers
+
+    # The default normalizer, used if no other is found.
     class Default
 
+      # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+      # @param name [String]
+      # @param payload [Hash]
+      # @option payload [String] :title
+      # @option payload [String] :description
+      # @return [Array, :skip] the normalized array or `:skip` if `name` is not part of a known {Skylight::TIERS tier}
       def normalize(trace, name, payload)
         if name =~ TIER_REGEX
           [

data/lib/skylight/normalizers/faraday/request.rb

@@ -0,0 +1,36 @@
+module Skylight
+  module Normalizers
+    module Faraday
+      class Request < Normalizer
+        register "request.faraday"
+
+        DISABLED_KEY = :__skylight_faraday_disabled
+
+        def self.disable
+          Thread.current[DISABLED_KEY] = true
+          yield
+        ensure
+          Thread.current[DISABLED_KEY] = false
+        end
+
+        def disabled?
+          !!Thread.current[DISABLED_KEY]
+        end
+
+        def normalize(_trace, _name, payload)
+          uri = payload[:url]
+
+          if disabled?
+            return :skip
+          end
+
+          opts = Formatters::HTTP.build_opts(payload[:method], uri.scheme,
+          uri.host, uri.port, uri.path, uri.query)
+          description = opts[:title]
+
+          [opts[:category], "Faraday", description]
+        end
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/moped/query.rb

@@ -6,6 +6,15 @@ module Skylight
 
         CAT = "db.mongo.query".freeze
 
+        # Normalizes a Moped operation
+        #
+        # @param trace [Skylight::Messages::Trace::Builder] ignored, only present to match API
+        # @param name [String] ignored, only present to match API
+        # @param payload [Hash]
+        # @option payload [Array<Moped::Protocol::*>] :ops array of performed operations. Supported operations are
+        #   `Query`, `GetMore`, `Insert`, `Update`, and `Delete`.
+        # @option payload [String] :prefix ignored, provided by Moped
+        # @return [Array, :skip] the normalized array or `:skip` if not a known operation type
         def normalize(trace, name, payload)
           # payload: { prefix: "  MOPED: #{address.resolved}", ops: operations }
 

data/lib/skylight/probes/elasticsearch.rb

@@ -11,10 +11,13 @@ module Skylight
                                                       method: method,
                                                       path:   path do
 
+
                 # Prevent HTTP-related probes from firing
-                disable_skylight_probe(:NetHTTP) do
-                  disable_skylight_probe(:HTTPClient) do
-                    perform_request_without_sk(method, path, *args, &block)
+                Skylight::Normalizers::Faraday::Request.disable do
+                  disable_skylight_probe(:NetHTTP) do
+                    disable_skylight_probe(:HTTPClient) do
+                      perform_request_without_sk(method, path, *args, &block)
+                    end
                   end
                 end
               end

data/lib/skylight/probes/excon.rb

@@ -1,6 +1,7 @@
 module Skylight
   module Probes
     module Excon
+      # Probe for instrumenting Excon requests. Installs {Excon::Middleware} to achieve this.
       class Probe
         def install
           if defined?(::Excon::Middleware)

data/lib/skylight/probes/excon/middleware.rb

@@ -3,6 +3,8 @@ require 'skylight/formatters/http'
 module Skylight
   module Probes
     module Excon
+
+      # Middleware for Excon that instruments requests
       class Middleware < ::Excon::Middleware::Base
 
         # This probably won't work since config isn't defined

data/lib/skylight/probes/faraday.rb

@@ -0,0 +1,22 @@
+module Skylight
+  module Probes
+    module Faraday
+      class Probe
+        def install
+          ::Faraday::Connection.class_eval do
+            alias initialize_without_sk initialize
+
+            def initialize(*args, &block)
+              initialize_without_sk(*args, &block)
+
+              @builder.insert 0, ::Faraday::Request::Instrumentation
+            end
+          end
+        end
+
+      end
+    end
+
+    register("Faraday", "faraday", Faraday::Probe.new)
+  end
+end

data/lib/skylight/probes/net_http.rb

@@ -3,6 +3,7 @@ require 'skylight/formatters/http'
 module Skylight
   module Probes
     module NetHTTP
+      # Probe for instrumenting Net::HTTP requests. Works by monkeypatching the default Net::HTTP#request method.
       class Probe
         DISABLED_KEY = :__skylight_net_http_disabled
 

data/lib/skylight/railtie.rb

@@ -13,9 +13,10 @@ module Skylight
     config.skylight.config_path = "config/skylight.yml"
 
     # The probes to load
-    #   net_http, action_controller, action_view, and grape are on by default
-    #   Also available: excon, redis, sinatra, tilt, sequel
-    config.skylight.probes = ['net_http', 'action_controller', 'action_view', 'grape']
+    #   net_http, action_controller, action_view, middleware, and grape are on by default
+    #   See https://www.skylight.io/support/getting-more-from-skylight#available-instrumentation-options
+    #   for a full list.
+    config.skylight.probes = ['net_http', 'action_controller', 'action_view', 'middleware', 'grape']
 
     # The position in the middleware stack to place Skylight
     # Default is first, but can be `{ after: Middleware::Name }` or `{ before: Middleware::Name }`
@@ -41,12 +42,12 @@ module Skylight
           end
         end
       elsif Rails.env.development?
-        unless UserConfig.instance.disable_dev_warning?
+        unless config.user_config.disable_dev_warning?
           log_warning config, "[SKYLIGHT] [#{Skylight::VERSION}] Running Skylight in development mode. No data will be reported until you deploy your app.\n" \
                                 "(To disable this message for all local apps, run `skylight disable_dev_warning`.)"
         end
       elsif !Rails.env.test?
-        unless UserConfig.instance.disable_env_warning?
+        unless config.user_config.disable_env_warning?
           log_warning config, "[SKYLIGHT] [#{Skylight::VERSION}] You are running in the #{Rails.env} environment but haven't added it to config.skylight.environments, so no data will be sent to skylight.io."
         end
       end

data/lib/skylight/user_config.rb

@@ -5,24 +5,21 @@ module Skylight
 
     attr_accessor :disable_dev_warning, :disable_env_warning
 
-    def self.instance
-      @instance ||= new
-    end
-
-    def initialize
+    def initialize(config)
+      @config = config
       reload
     end
 
     def file_path
       return @file_path if @file_path
 
-      config_path = ENV.fetch("SKYLIGHT_USER_CONFIG_PATH") do
+      config_path = @config[:user_config_path] || begin
         require "etc"
         home_dir = ENV['HOME'] || Etc.getpwuid.dir || (ENV["USER"] && File.expand_path("~#{ENV['USER']}"))
         if home_dir
           File.join(home_dir, ".skylight")
         else
-          raise KeyError, "SKYLIGHT_USER_CONFIG_PATH must be defined since the home directory cannot be inferred"
+          raise ConfigError, "The Skylight `user_config_path` must be defined since the home directory cannot be inferred"
         end
       end
 

data/lib/skylight/util/allocation_free.rb

@@ -1,6 +1,15 @@
 module Skylight
   module Util
+    # Helpers to reduce memory allocation
     module AllocationFree
+
+      # Find an item in an array without allocation.
+      #
+      # @param array [Array] the array to search
+      # @yield a block called against each item until a match is found
+      # @yieldparam item an item from the array
+      # @yieldreturn [Boolean] whether `item` matches the criteria
+      # return the found item or nil, if nothing found
       def array_find(array)
         i = 0
 

data/lib/skylight/util/clock.rb

@@ -1,5 +1,6 @@
 module Skylight
   module Util
+    # A more precise clock
     class Clock
 
       if Skylight.native?

data/lib/skylight/util/gzip.rb

@@ -2,7 +2,13 @@ require 'zlib'
 
 module Skylight
   module Util
+    # Provides Gzip compressing support
     module Gzip
+
+      # Compress a string with Gzip
+      #
+      # @param str [String] uncompressed string
+      # @return [String] compressed string
       def self.compress(str)
         output = StringIO.new
         gz = Zlib::GzipWriter.new(output)

data/lib/skylight/util/inflector.rb

@@ -1,10 +1,12 @@
 module Skylight
   module Util
+
+    # String Inflector methods
+    #
+    # From https://github.com/rails/rails/blob/f8e5022c73679f41db9bb6743179bab4571fb28e/activesupport/lib/active_support/inflector/methods.rb
     module Inflector
       extend self
 
-      # From https://github.com/rails/rails/blob/f8e5022c73679f41db9bb6743179bab4571fb28e/activesupport/lib/active_support/inflector/methods.rb
-
       # Tries to find a constant with the name specified in the argument string.
       #
       #   'Module'.constantize     # => Module

data/lib/skylight/util/logging.rb

@@ -24,11 +24,13 @@ module Skylight
     end
 
     module Logging
+
       def self.trace?
         ENV[TRACE_ENV_KEY]
       end
 
       if trace?
+        # The second set is picked up by YARD
         def trace(msg, *args)
           log :debug, msg, *args
         end
@@ -37,25 +39,44 @@ module Skylight
           log :debug, yield
         end
       else
-        def trace(*)
+        # Logs if `ENV[TRACE_ENV_KEY]` is set.
+        #
+        # @param (see #debug)
+        #
+        # See {TRACE_ENV_KEY}.
+        def trace(msg, *args)
         end
 
+        # Evaluates and logs the result of the block if `ENV[TRACE_ENV_KEY]` is set
+        #
+        # @yield block to be evaluted
+        # @yieldreturn arguments for {#debug}
+        #
+        # See {TRACE_ENV_KEY}.
         def t
         end
       end
 
+      # @param msg (see #log)
+      # @param args (see #log)
       def debug(msg, *args)
         log :debug, msg, *args
       end
 
+      # @param msg (see #log)
+      # @param args (see #log)
       def info(msg, *args)
         log :info, msg, *args
       end
 
+      # @param msg (see #log)
+      # @param args (see #log)
       def warn(msg, *args)
         log :warn, msg, *args
       end
 
+      # @param msg (see #log)
+      # @param args (see #log)
       def error(msg, *args)
         raise sprintf(msg, *args) if ENV['SKYLIGHT_RAISE_ON_ERROR']
         log :error, msg, *args
@@ -67,8 +88,15 @@ module Skylight
       alias log_warn  warn
       alias log_error error
 
-      alias fmt       sprintf
+      # Alias for `Kernel#sprintf`
+      # @return [String]
+      def fmt(*args)
+        sprintf(*args)
+      end
 
+      # @param level [String,Symbol] the method on `logger` to use for logging
+      # @param msg [String] the message to log
+      # @param args [Array] values for `Kernel#sprintf` on `msg`
       def log(level, msg, *args)
         c = if respond_to?(:config)
           config

data/lib/skylight/util/native_ext_fetcher.rb

@@ -9,6 +9,7 @@ require 'skylight/util/proxy'
 # Used from extconf.rb
 module Skylight
   module Util
+    # Utility class for fetching the native extension from a URL
     class NativeExtFetcher
       BASE_URL = "https://s3.amazonaws.com/skylight-agent-packages/skylight-native"
       MAX_REDIRECTS = 5
@@ -18,6 +19,8 @@ module Skylight
 
       class FetchError < StandardError; end
 
+      # Creates a new fetcher and fetches
+      # @param opts [Hash]
       def self.fetch(opts = {})
         fetcher = new(
           opts[:source] || BASE_URL,
@@ -32,6 +35,14 @@ module Skylight
         fetcher.fetch
       end
 
+      # @param source [String] the base url to download from
+      # @param target [String] file to download as
+      # @param version [String] version to download
+      # @param checksum [String] checksum of the archive
+      # @param arch [String] platform architecture, e.g. `linux-x86_64`
+      # @param required [Boolean] whether the download is required to be successful
+      # @param platform
+      # @param log [Logger]
       def initialize(source, target, version, checksum, arch, required, platform, log)
         raise "source required" unless source
         raise "target required" unless target
@@ -48,6 +59,9 @@ module Skylight
         @log = log
       end
 
+      # Fetch the native extension, verify, inflate, and save (if applicable)
+      #
+      # @return [String] the inflated archive
       def fetch
         log "fetching native ext; curr-platform=#{@platform}; " \
           "requested-arch=#{@arch}; version=#{@version}"
@@ -118,6 +132,15 @@ module Skylight
         return
       end
 
+      # Get with `Net::HTTP`
+      #
+      # @param host [String] host for `Net::HTTP` request
+      # @param port [String,Integer] port for `Net::HTTP` request
+      # @param use_ssl [Boolean] whether SSL should be used for this request
+      # @param path [String] the path to request
+      # @param out [IO]
+      #
+      # 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 = Proxy.detect_url(ENV)
           log "connecting with proxy: #{http_proxy}"
@@ -158,6 +181,10 @@ module Skylight
         end
       end
 
+      # Verify the checksum of the archive
+      #
+      # @param actual [String]
+      # @return [Boolean] whether the checksum matches
       def verify_checksum(actual)
         unless @checksum == actual
           log "checksum mismatch; expected=#{@checksum}; actual=#{actual}"
@@ -174,15 +201,26 @@ module Skylight
         "skylight_#{@arch}.tar.gz"
       end
 
+      # The url that will be fetched
+      #
+      # @return String
       def source_uri
         "#{@source}/#{@version}/#{basename}"
       end
 
+      # Split the uri string into its component parts
+      #
+      # @param uri [String] the uri
+      # @return [Array<String>] the host, port, scheme, and request_uri
       def deconstruct_uri(uri)
         uri = URI(uri)
         [ uri.host, uri.port, uri.scheme == 'https', uri.request_uri ]
       end
 
+      # Log an error and raise if `required` is `true`
+      #
+      # @param err [String]
+      # @return [void]
       def maybe_raise(err)
         error err
 
@@ -191,11 +229,20 @@ module Skylight
         end
       end
 
+      # Log an `info` to the `logger`
+      #
+      # @param msg [String]
+      # @return [void]
       def log(msg)
         msg = "[SKYLIGHT] #{msg}"
         @log.info msg
       end
 
+      # Log an `error` to the `logger`
+      #
+      # @param msg [String]
+      # @param e [Exception] the exception associated with the error
+      # @return [void]
       def error(msg, e=nil)
         msg = "[SKYLIGHT] #{msg}"
         msg << "\n#{e.backtrace.join("\n")}" if e

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '1.4.0-beta'
+  VERSION = '1.4.0-beta.2'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 1.4.0.beta
+  version: 1.4.0.beta.2
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-13 00:00:00.000000000 Z
+date: 2017-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -65,7 +65,9 @@ files:
 - lib/skylight/normalizers/action_view/render_collection.rb
 - lib/skylight/normalizers/action_view/render_partial.rb
 - lib/skylight/normalizers/action_view/render_template.rb
+- lib/skylight/normalizers/active_job/enqueue_at.rb
 - lib/skylight/normalizers/active_model_serializers/render.rb
+- lib/skylight/normalizers/active_record/instantiation.rb
 - lib/skylight/normalizers/active_record/sql.rb
 - lib/skylight/normalizers/active_support/cache.rb
 - lib/skylight/normalizers/active_support/cache_clear.rb
@@ -81,6 +83,7 @@ files:
 - lib/skylight/normalizers/couch_potato/query.rb
 - lib/skylight/normalizers/default.rb
 - lib/skylight/normalizers/elasticsearch/request.rb
+- lib/skylight/normalizers/faraday/request.rb
 - lib/skylight/normalizers/grape/endpoint.rb
 - lib/skylight/normalizers/grape/endpoint_render.rb
 - lib/skylight/normalizers/grape/endpoint_run.rb
@@ -93,6 +96,7 @@ files:
 - lib/skylight/probes/elasticsearch.rb
 - lib/skylight/probes/excon.rb
 - lib/skylight/probes/excon/middleware.rb
+- lib/skylight/probes/faraday.rb
 - lib/skylight/probes/grape.rb
 - lib/skylight/probes/httpclient.rb
 - lib/skylight/probes/middleware.rb
@@ -172,7 +176,8 @@ files:
 - lib/skylight/version.rb
 - lib/skylight/vm/gc.rb
 homepage: http://www.skylight.io
-licenses: []
+licenses:
+- Nonstandard
 metadata: {}
 post_install_message: 
 rdoc_options: []