skylight 3.1.5 → 4.0.0.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdfb403ebb2a5b06699295afa21247e71b61e3bef1818b9ce4160df30e8c2c09
-  data.tar.gz: 95f4d5c385fef7794f03b67d78e7c3755b48726ce8c0a65987bc659358817791
+  metadata.gz: df25b1cb1ffff1e84bef0e911de92f5ed92ba455fe43b3319a332d3ca2670318
+  data.tar.gz: 758bab00fc5be7be085f507477a3ac4545d45205cc65a0863742d8698b7bc9a1
 SHA512:
-  metadata.gz: 82a3897ec11249746ef2864900ba66a83316749fd1f85ed3e5dd2fa6fd375b47fa89c8312cb297c1922e0b7a70fa3e6a83b4355462b3721c10a84703d24d01a0
-  data.tar.gz: f5eac98886f187f9f143474ddaace978125ff16d8e9d1561d489710f782d4f384e9ecf206b71c72db0e58bfd179ea41b4d44c0820f50cda6feeff62ee794a4b5
+  metadata.gz: f53ce448c301d94196132f0e392745aaff73bd7fa355cb7d5b469390c15f8694fd4c81639c0b5de5b9da4146134289b607d2ff7c830743456fbe7661edfd95aa
+  data.tar.gz: 1e6c1e179b7de9cb1752d690991c5216ac76e1aa4240f10c25de7475597375014a6bceabcef768576366baa8cb460298d1506da42e2dfed7843361e936e266f0

data/CHANGELOG.md

@@ -1,12 +1,9 @@
-## 3.1.5 (March 20, 2019)
-* [BUGFIX] Make Action View probe compatible with Rails 6 (backported from 4.0.0.beta2)
-
-## 3.1.4
-* [BUGFIX] ActiveJob#perform_now should not reassign the endpoint name
-
-## 3.1.3
-* [BUGFIX] skylightd should close cloned file descriptors on startup
-* [BUGFIX] Convert numeric git shas to strings
+## 4.0.0.alpha (December 3, 2018)
+* [FEATURE] Skylight for Background Jobs
+* [FEATURE] Probe for Delayed::Job (standalone)
+* [IMPROVEMENT] Handle 403 config validation response
+* [IMPROVEMENT] Config for `prune_large_traces` is now true by default
+* [BREAKING] New method for assigning 'segment' to a trace endpoint name
 
 ## 3.1.2 (November 29, 2018)
 * [BUGFIX] Fix derived endpoint names under Grape 1.2

data/bin/skylight

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 require "skylight/cli"
-Skylight::CLI::Base.start(ARGV)
+Skylight::CLI::Base.start(ARGV)

data/ext/extconf.rb

@@ -1,34 +1,33 @@
-require 'rbconfig'
-require 'mkmf'
-require 'yaml'
-require 'logger'
-require 'fileutils'
+require "rbconfig"
+require "mkmf"
+require "yaml"
+require "logger"
+require "fileutils"
 
-$:.unshift File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
 
-require 'skylight/version'
+require "skylight/version"
 
 # Don't use the gem for dev
-if File.exists?(File.expand_path("../../Gemfile", __FILE__))
+if File.exist?(File.expand_path("../Gemfile", __dir__))
   # This approach won't work in production since skylight-core isn't in the skylight gem
-  $:.unshift File.expand_path("../../skylight-core/lib", __FILE__)
+  $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('-', '.')
+  gem "skylight-core", Skylight::VERSION.tr("-", ".")
 end
 
-require 'skylight/native_ext_fetcher'
-require 'skylight/core/util/platform'
+require "skylight/native_ext_fetcher"
+require "skylight/core/util/platform"
 
 # Util allowing proxying writes to multiple location
 class MultiIO
-
   def initialize(*targets)
-      @targets = targets
+    @targets = targets
   end
 
   def write(*args)
-    @targets.each {|t| t.write(*args)}
+    @targets.each { |t| t.write(*args) }
   end
 
   def close
@@ -38,28 +37,28 @@ end
 
 include Skylight::Core::Util
 
-SKYLIGHT_INSTALL_LOG = File.expand_path("../install.log", __FILE__)
-SKYLIGHT_REQUIRED   = ENV.key?("SKYLIGHT_REQUIRED") && ENV['SKYLIGHT_REQUIRED'] !~ /^false$/i
-SKYLIGHT_FETCH_LIB  = !ENV.key?('SKYLIGHT_FETCH_LIB') || ENV['SKYLIGHT_FETCH_LIB'] !~ /^false$/i
+SKYLIGHT_INSTALL_LOG = File.expand_path("install.log", __dir__)
+SKYLIGHT_REQUIRED   = ENV.key?("SKYLIGHT_REQUIRED") && ENV["SKYLIGHT_REQUIRED"] !~ /^false$/i
+SKYLIGHT_FETCH_LIB  = !ENV.key?("SKYLIGHT_FETCH_LIB") || ENV["SKYLIGHT_FETCH_LIB"] !~ /^false$/i
 
 # Directory where skylight.h exists
-SKYLIGHT_HDR_PATH = ENV['SKYLIGHT_HDR_PATH'] || ENV['SKYLIGHT_LIB_PATH'] || '.'
-SKYLIGHT_LIB_PATH = ENV['SKYLIGHT_LIB_PATH'] || File.expand_path("../../lib/skylight/native/#{Platform.tuple}", __FILE__)
+SKYLIGHT_HDR_PATH = ENV["SKYLIGHT_HDR_PATH"] || ENV["SKYLIGHT_LIB_PATH"] || "."
+SKYLIGHT_LIB_PATH = ENV["SKYLIGHT_LIB_PATH"] || File.expand_path("../../lib/skylight/native/#{Platform.tuple}", __FILE__)
 
-SKYLIGHT_SOURCE_URL = ENV['SKYLIGHT_SOURCE_URL']
-SKYLIGHT_VERSION = ENV['SKYLIGHT_VERSION']
-SKYLIGHT_CHECKSUM = ENV['SKYLIGHT_CHECKSUM']
+SKYLIGHT_SOURCE_URL = ENV["SKYLIGHT_SOURCE_URL"]
+SKYLIGHT_VERSION = ENV["SKYLIGHT_VERSION"]
+SKYLIGHT_CHECKSUM = ENV["SKYLIGHT_CHECKSUM"]
 
-SKYLIGHT_EXT_STRICT = ENV.key?("SKYLIGHT_EXT_STRICT") && ENV['SKYLIGHT_EXT_STRICT'] =~ /^true$/i
+SKYLIGHT_EXT_STRICT = ENV.key?("SKYLIGHT_EXT_STRICT") && ENV["SKYLIGHT_EXT_STRICT"] =~ /^true$/i
 
 # Setup logger
-LOG = Logger.new(MultiIO.new(STDOUT, File.open(SKYLIGHT_INSTALL_LOG, 'a')))
+LOG = Logger.new(MultiIO.new(STDOUT, File.open(SKYLIGHT_INSTALL_LOG, "a")))
 
 # Handles terminating in the case of a failure. If we have a bug, we do not
 # want to break our customer's deploy, but extconf.rb requires a Makefile to be
 # present upon a successful exit. To satisfy this requirement, we create a
 # dummy Makefile.
-def fail(msg, type=:error)
+def fail(msg, type = :error)
   LOG.send type, msg
 
   if SKYLIGHT_REQUIRED
@@ -77,38 +76,38 @@ end
 # Check that Xcode license has been approved
 # Based on Homebrew's implementation
 # https://github.com/Homebrew/homebrew/blob/03708b016755847facc4f19a43ee9f7a44141ed7/Library/Homebrew/cmd/doctor.rb#L1183
-if Platform::OS == 'darwin'
+if Platform::OS == "darwin"
   # If the user installs Xcode-only, they have to approve the
   # license or no "xc*" tool will work.
-  if `/usr/bin/xcrun clang 2>&1` =~ /license/ && !$?.success?
-    fail <<-EOS
+  if `/usr/bin/xcrun clang 2>&1` =~ /license/ && !$CHILD_STATUS.success?
+    fail <<-MESSAGE
 You have not agreed to the Xcode license and so we are unable to build the native agent.
 To resolve this, you can agree to the license by opening Xcode.app or running:
     sudo xcodebuild -license
-EOS
+    MESSAGE
   end
 end
 
 #
 # === Setup paths
 #
-root              = File.expand_path('../', __FILE__)
+root              = File.expand_path(__dir__)
 hdrpath           = File.expand_path(SKYLIGHT_HDR_PATH)
 libpath           = File.expand_path(SKYLIGHT_LIB_PATH)
 libskylight       = File.expand_path("libskylight.#{Platform.libext}", libpath)
-libskylight_yml   = File.expand_path('libskylight.yml', root)
+libskylight_yml   = File.expand_path("libskylight.yml", root)
 skylight_dlopen_h = File.expand_path("skylight_dlopen.h", hdrpath)
 skylight_dlopen_c = File.expand_path("skylight_dlopen.c", hdrpath)
 
 LOG.info "SKYLIGHT_HDR_PATH=#{hdrpath}; SKYLIGHT_LIB_PATH=#{libpath}"
 
-LOG.info "file exists; path=#{libskylight}" if File.exists?(libskylight)
-LOG.info "file exists; path=#{skylight_dlopen_c}" if File.exists?(skylight_dlopen_c)
-LOG.info "file exists; path=#{skylight_dlopen_h}" if File.exists?(skylight_dlopen_h)
+LOG.info "file exists; path=#{libskylight}" if File.exist?(libskylight)
+LOG.info "file exists; path=#{skylight_dlopen_c}" if File.exist?(skylight_dlopen_c)
+LOG.info "file exists; path=#{skylight_dlopen_h}" if File.exist?(skylight_dlopen_h)
 
 # If libskylight is not present, fetch it
 if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(skylight_dlopen_h)
-  if !SKYLIGHT_FETCH_LIB
+  unless SKYLIGHT_FETCH_LIB
     fail "libskylight.#{LIBEXT} not found -- remote download disabled; aborting install"
   end
 
@@ -117,37 +116,35 @@ if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(
     fail "`#{libskylight_yml}` does not exist"
   end
 
-  unless libskylight_info = YAML.load_file(libskylight_yml)
+  unless (libskylight_info = YAML.load_file(libskylight_yml))
     fail "`#{libskylight_yml}` does not contain data"
   end
 
-  if version = SKYLIGHT_VERSION
-    unless checksum = SKYLIGHT_CHECKSUM
+  if (version = SKYLIGHT_VERSION)
+    unless (checksum = SKYLIGHT_CHECKSUM)
       fail "no checksum provided when using custom version"
     end
+  elsif (platform_info = libskylight_info[Platform.tuple])
+    unless (version = platform_info["version"])
+      fail "libskylight version missing from `#{libskylight_yml}`; platform=#{Platform.tuple}"
+    end
+
+    unless (checksum = platform_info["checksum"])
+      fail "checksum missing from `#{libskylight_yml}`; platform=#{Platform.tuple}"
+    end
   else
-    if platform_info = libskylight_info[Platform.tuple]
-      unless version = platform_info["version"]
-        fail "libskylight version missing from `#{libskylight_yml}`; platform=#{Platform.tuple}"
-      end
-
-      unless checksum = platform_info["checksum"]
-        fail "checksum missing from `#{libskylight_yml}`; platform=#{Platform.tuple}"
-      end
-    else
-      unless version = libskylight_info["version"]
-        fail "libskylight version missing from `#{libskylight_yml}`"
-      end
-
-      unless checksums = libskylight_info["checksums"]
-        fail "libskylight checksums missing from `#{libskylight_yml}`"
-      end
-
-      unless checksum = checksums[Platform.tuple]
-        fail "no checksum entry for requested architecture -- " \
-                "this probably means the requested architecture is not supported; " \
-                "platform=#{Platform.tuple}; available=#{checksums.keys}", :info
-      end
+    unless (version = libskylight_info["version"])
+      fail "libskylight version missing from `#{libskylight_yml}`"
+    end
+
+    unless (checksums = libskylight_info["checksums"])
+      fail "libskylight checksums missing from `#{libskylight_yml}`"
+    end
+
+    unless (checksum = checksums[Platform.tuple])
+      fail "no checksum entry for requested architecture -- " \
+              "this probably means the requested architecture is not supported; " \
+              "platform=#{Platform.tuple}; available=#{checksums.keys}", :info
     end
   end
 
@@ -160,7 +157,8 @@ if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(
       arch:     Platform.tuple,
       required: SKYLIGHT_REQUIRED,
       platform: Platform.tuple,
-      logger:   LOG)
+      logger:   LOG
+    )
 
     unless res
       fail "could not fetch archive -- aborting skylight native extension build"
@@ -174,11 +172,11 @@ if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(
       # Move
       FileUtils.mv "#{hdrpath}/libskylight.#{Platform.libext}",
                    "#{libpath}/libskylight.#{Platform.libext}",
-                   :force => true
+                   force: true
 
       FileUtils.mv "#{hdrpath}/skylightd",
                    "#{libpath}/skylightd",
-                   :force => true
+                   force: true
     end
   rescue => e
     fail "unable to fetch native extension; msg=#{e.message}\n#{e.backtrace.join("\n")}"
@@ -192,35 +190,35 @@ end
 #
 
 def find_file(file, root = nil)
-  path = File.expand_path(file, root || '.')
+  path = File.expand_path(file, root || ".")
 
   unless File.exist?(path)
     fail "#{file} missing; path=#{root}"
   end
 end
 
-$VPATH  << libpath
+$VPATH << libpath
 
 # Where the ruby binding src is
-SRC_PATH = File.expand_path('..', __FILE__)
+SRC_PATH = File.expand_path(__dir__)
 
 $srcs = Dir[File.expand_path("*.c", SRC_PATH)].map { |f| File.basename(f) }
 
 # If the native agent support files were downloaded to a different directory,
 # explicitly the file to the list of sources.
-unless $srcs.include?('skylight_dlopen.c')
+unless $srcs.include?("skylight_dlopen.c")
   $srcs << "skylight_dlopen.c" # From libskylight dist
 end
 
 # Make sure that the files are present
-find_file 'skylight_dlopen.h', hdrpath
-find_file 'skylight_dlopen.c', hdrpath
-find_header 'skylight_dlopen.h', hdrpath
-have_header 'dlfcn.h' or fail "could not create Makefile; dlfcn.h missing"
+find_file "skylight_dlopen.h", hdrpath
+find_file "skylight_dlopen.c", hdrpath
+find_header "skylight_dlopen.h", hdrpath
+fail "could not create Makefile; dlfcn.h missing" unless have_header "dlfcn.h"
 
 # For escaping the GVL
-unless have_func('rb_thread_call_without_gvl', 'ruby/thread.h')
-  have_func('rb_thread_blocking_region') or abort "Ruby is unexpectedly missing rb_thread_blocking_region. This should not happen."
+unless have_func("rb_thread_call_without_gvl", "ruby/thread.h") || have_func("rb_thread_blocking_region")
+  abort "Ruby is unexpectedly missing rb_thread_blocking_region. This should not happen."
 end
 
 # Previous comment stated:
@@ -234,7 +232,7 @@ if SKYLIGHT_EXT_STRICT
   $CFLAGS << " -Werror"
 end
 
-checking_for 'fast thread local storage' do
+checking_for "fast thread local storage" do
   if try_compile("__thread int foo;")
     $defs << "-DHAVE_FAST_TLS"
     true
@@ -250,4 +248,4 @@ if SKYLIGHT_EXT_STRICT
 end
 
 # TODO: Compute the relative path to the location
-create_makefile 'skylight_native', File.expand_path('..', __FILE__) # or fail "could not create makefile"
+create_makefile "skylight_native", File.expand_path(__dir__) # or fail "could not create makefile"

data/ext/libskylight.yml

@@ -1,7 +1,8 @@
-version: "3.1.0-c0a22d1"
+version: "3.1.0-ef54598"
 checksums:
-  x86-linux:         "1dc6a9ee453756c8b984c5733d2631ed27538f20cfde2f037ae31010edec6232"
-  x86_64-linux:      "b91dc91c2bc2954bf4587f3733a3c696a443bce13738a9073229ab4dfd09938e"
-  x86_64-linux-musl: "c7b00982688a344ee3808ea40452dd1f6c448e7f3aa0221b4c95fca2a51547b9"
-  x86_64-darwin:     "41cf89a75dc64cafb97303f31908b14a3ca2d15e5de935cbd57a611f396b5b90"
-  x86_64-freebsd:    "72ccb98f3f7604fddad116fe6ea4750643f9b088d4f25f3e21c4972680cc8f01"
+  x86-linux:         "b2e0df4a907c75a7296b147145dcb756ee9c0c506e9ff34ccf5dbfd33f762707"
+  x86_64-linux:      "ab6d9c22b4a9e1831370cd5a9dd100c70270aebe51be4ed99c2a636c972792fa"
+  x86_64-linux-musl: "0cc2e117097d0cbed11f6f8ce877d9bb48e9d7d8bb443eb19c00ccf1bc56c8c8"
+  x86_64-darwin:     "183cafb3df420db56b4062a654708f0981f3ef3c3ba47c8a07810c93a7d689d4"
+  x86_64-freebsd:    "bbdbd4c7faa4546278b557007f0131d554add50a4bc8aa2c24dd3d3288cf9337"
+

data/lib/skylight.rb

@@ -1,22 +1,25 @@
-require 'skylight/version'
-require 'skylight/core'
-require 'skylight/trace'
-require 'skylight/instrumenter'
-require 'skylight/middleware'
-require 'skylight/api'
-require 'skylight/helpers'
-require 'skylight/config'
-require 'skylight/errors'
-require 'skylight/native'
+require "skylight/version"
+require "skylight/core"
+require "skylight/trace"
+require "skylight/instrumenter"
+require "skylight/middleware"
+require "skylight/api"
+require "skylight/helpers"
+require "skylight/config"
+require "skylight/errors"
+require "skylight/native"
+
+# For prettier global names
+require "English"
 
 module Skylight
   # Used from the CLI
-  autoload :CLI, 'skylight/cli'
+  autoload :CLI, "skylight/cli"
 
   # 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)
-    require 'skylight/railtie'
+    require "skylight/railtie"
   end
 
   include Core::Instrumentable
@@ -30,5 +33,4 @@ module Skylight
   end
 
   Core::Probes.add_path(File.expand_path("skylight/probes", __dir__))
-
 end

data/lib/skylight/api.rb

@@ -1,5 +1,5 @@
-require 'uri'
-require 'skylight/util/http'
+require "uri"
+require "skylight/util/http"
 
 module Skylight
   # @api private
@@ -21,14 +21,14 @@ module Skylight
 
       def errors
         return unless res.respond_to?(:body) && res.body.is_a?(Hash)
-        res.body['errors']
+        res.body["errors"]
       end
 
       def to_s
         if errors
           errors.inspect
         elsif res
-          "#{res.class.to_s}: #{res.to_s}"
+          "#{res.class}: #{res}"
         else
           super
         end
@@ -36,7 +36,6 @@ module Skylight
     end
 
     class ConfigValidationResults
-
       include Core::Util::Logging
 
       attr_reader :raw_response
@@ -46,7 +45,7 @@ module Skylight
         @raw_response = raw_response
       end
 
-      def is_error_response?
+      def error_response?
         raw_response.is_a?(Util::HTTP::ErrorResponse) || status > 499
       end
 
@@ -55,7 +54,7 @@ module Skylight
       end
 
       def body
-        return nil if is_error_response?
+        return nil if error_response?
 
         unless raw_response.body.is_a?(Hash)
           warn("Unable to parse server response: status=%s, body=%s", raw_response.status, raw_response.body)
@@ -67,11 +66,14 @@ module Skylight
 
       def token_valid?
         # Don't prevent boot if it's an error response, so assume token is valid
-        return true if is_error_response?
+        return true if error_response?
         # A 2xx response means everything is good!
         return true if raw_response.success?
-        # A 422 means an invalid config, but the token must be valid if we got this far
-        return true if status === 422
+        return false if status == 401
+
+        # A 403/422 means an invalid config,
+        # but the token must be valid if we got this far
+        true
       end
 
       def config_valid?
@@ -79,23 +81,26 @@ module Skylight
         raw_response.success?
       end
 
+      def forbidden?
+        status == 403
+      end
+
       def validation_errors
-        return if config_valid?
-        body ? body['errors'] : nil
+        return {} if config_valid? || !body
+        body["errors"]
       end
 
       def corrected_config
-        return if config_valid?
-        body ? body['corrected'] : nil
+        return {} if config_valid? || !body
+        body["corrected"]
       end
-
     end
 
     def initialize(config)
       @config = config
     end
 
-    def create_app(name, token=nil)
+    def create_app(name, token = nil)
       params = { app: { name: name } }
       params[:token] = token if token
 
@@ -106,17 +111,17 @@ module Skylight
     end
 
     def fetch_mergeable_apps(token)
-      headers = { 'x-skylight-merge-token' => token }
+      headers = { "x-skylight-merge-token" => token }
       http_request(:merges, :get, headers).tap do |res|
-        raise error_for_status(res.status).new("HTTP #{res.status}: #{res.body}") unless res.success?
+        raise error_for_status(res.status), "HTTP #{res.status}: #{res.body}" unless res.success?
       end
     end
 
     def merge_apps!(token, app_guid:, component_guid:, environment:)
-      headers = { 'x-skylight-merge-token' => token }
+      headers = { "x-skylight-merge-token" => token }
       body = { environment: environment, app_guid: app_guid, component_guid: component_guid }
       http_request(:merges, :post, body, headers).tap do |res|
-        raise error_for_status(res.status).new("HTTP #{res.status}: #{res.body}") unless res.success?
+        raise error_for_status(res.status), "HTTP #{res.status}: #{res.body}" unless res.success?
       end
     end
 
@@ -127,24 +132,22 @@ module Skylight
 
     private
 
-    # TODO: Improve handling here: https://github.com/tildeio/direwolf-agent/issues/274
-    def http_request(service, method, *args)
-      http = Util::HTTP.new(config, service)
-      uri = URI.parse(config.get("#{service}_url"))
-      http.send(method, uri.path, *args)
-    end
-
-    def error_for_status(code)
-      case code
-      when 401
-        Unauthorized
-      when 409
-        Conflict
-      else
-        Error
+      # TODO: Improve handling here: https://github.com/tildeio/direwolf-agent/issues/274
+      def http_request(service, method, *args)
+        http = Util::HTTP.new(config, service)
+        uri = URI.parse(config.get("#{service}_url"))
+        http.send(method, uri.path, *args)
       end
-    end
 
+      def error_for_status(code)
+        case code
+        when 401
+          Unauthorized
+        when 409
+          Conflict
+        else
+          Error
+        end
+      end
   end
-
 end