skylight 3.1.4 → 5.3.4

data/CLA.md

@@ -6,4 +6,4 @@ right (whether now known or hereinafter invented), title, and interest,
 throughout the world, including any copyrights and renewals or extensions
 thereto, in the contributions to Skylight made by Assignor.
 
-IN WITNESS THEREOF, Assignor has duly executed this Agreement.
+IN WITNESS THEREOF, Assignor has duly executed this Agreement.

data/CONTRIBUTING.md

@@ -8,8 +8,16 @@ Before contributing, please [sign the CLA](https://docs.google.com/spreadsheet/v
 
 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
+## Emulating Gitlab CI 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).
+We have many CI build configurations that must pass in order to merge a pull request. You can run these individual configurations locally by running e.g., `gitlab-runner exec docker ruby23-rails42`. The only prerequisites are that you have both [Gitlab Runner](https://docs.gitlab.com/runner/) and [Docker](https://www.docker.com/) installed (most recent versions are best). Configuration names may be found in the `.gitlab.yml` file.
 
-After that rake task completes, be sure to run `rake clobber compile`. This will delete the local native extension that was built when you ran `rake run_travis_builds` and rebuilds it.
+If you prefer to run tests in your own environment, you may do so as follows:
+
+```shell
+# Select a gemfile and bundle install
+export BUNDLE_GEMFILE=$PWD/gemfiles/rails-5.2.x/Gemfile
+bundle install
+# Run the test suite (takes 5-10 minutes)
+bundle exec rspec
+```

data/ERRORS.md

@@ -2,4 +2,7 @@ E0001 - Spans were closed out of order
 E0002 - Exceeded the number of unique span descriptions
 E0003 - Exceeded maximum number of spans
 E0004 - Failed to lex SQL query
+E0005 - Instrumenter is not running
+E0006 - Invalid UTF-8
+E0007 - Failed to connect to gRPC server
 E9999 - Unknown

data/LICENSE.md

@@ -1,5 +1,5 @@
 All other components of this product, except where otherwise noted, are
-Copyright (c) 2013-2016 Tilde, Inc.
+Copyright (c) 2013-2019 Tilde, Inc.
 All rights reserved.
 
 Certain inventions disclosed in this file may be claimed within patents
@@ -28,19 +28,15 @@ brand (if any) provided by Tilde.
 Unless otherwise expressly agreed by Tilde in a separate written
 license agreement, these files are provided AS IS, WITHOUT WARRANTY OF
 ANY KIND, including without any implied warranties of MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT.  As a
+FITNESS FOR A PARTICULAR PURPOSE, TITLE, or NON-INFRINGEMENT. As a
 condition to your use of these files, you are solely responsible for
 such use. Tilde will have no liability to you for direct,
 indirect, consequential, incidental, special, or punitive damages or
 for lost profits or data.
 
+# Other Licenses
 
-
-Other Licenses
-==============
-
-Ruby on Rails
--------------
+## Ruby on Rails
 
 Copyright (c) 2005-2016 David Heinemeier Hansson
 
@@ -48,9 +44,7 @@ Released under the MIT License.
 
 Original source at https://github.com/rails/rails.
 
-
-HighLine
---------
+## HighLine
 
 Copyright (c) 2014 James Edward Gray II, Gregory Brown, et al.
 
@@ -58,9 +52,7 @@ Distributed under the user's choice of the GPL Version 2 or the Ruby software li
 
 Original source at https://github.com/JEG2/highline.
 
-
-Thor
-----
+## Thor
 
 Copyright (c) 2008 Yehuda Katz, Eric Hodel, et al.
 
@@ -68,12 +60,10 @@ Released under the MIT License.
 
 Original source at https://github.com/erikhuda/thor.
 
-
-ThreadSafe
-----------
+## ThreadSafe
 
 Copyright (c) 2014 Charles Oliver Nutter, thedarkone, et al.
 
 Distributed under Apache License, Version 2.0, January 2004
 
-Original source at https://github.com/ruby-concurrency/thread_safe.
+Original source at https://github.com/ruby-concurrency/thread_safe.

data/README.md

@@ -1,6 +1,6 @@
 # Skylight Ruby Agent
 
-![Rubygems Version](https://img.shields.io/gem/v/skylight.svg)
+[![Gem Version](https://badge.fury.io/rb/skylight.svg)](https://badge.fury.io/rb/skylight)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=skylight&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=skylight&package-manager=bundler&version-scheme=semver)
 
 Instrument your ruby application and send the data to the Skylight
@@ -10,7 +10,6 @@ Sign up at https://www.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 built-in messenger in the Skylight web interface. We'll be much quicker to respond that way :)

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,38 @@
-require 'rbconfig'
-require 'mkmf'
-require 'yaml'
-require 'logger'
-require 'fileutils'
-
-$:.unshift File.expand_path("../../lib", __FILE__)
-
-require 'skylight/version'
-
-# Don't use the gem for dev
-if File.exists?(File.expand_path("../../Gemfile", __FILE__))
-  # This approach won't work in production since skylight-core isn't in the skylight gem
-  $:.unshift File.expand_path("../../skylight-core/lib", __FILE__)
-else
-  # Is there a better way to get this into lib?
-  gem 'skylight-core', Skylight::VERSION.tr('-', '.')
-end
+require "rbconfig"
+require "mkmf"
+require "yaml"
+require "logger"
+require "fileutils"
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+
+require "skylight/native_ext_fetcher"
+require "skylight/util/platform"
+
+GLIBC_MIN = 2.23
+GLIBC_V4_MIN = 2.15
+
+ldd_output =
+  begin
+    `ldd --version`
+  rescue Errno::ENOENT
+    nil
+  end
 
-require 'skylight/native_ext_fetcher'
-require 'skylight/core/util/platform'
+if ldd_output =~ /GLIBC (\d+(\.\d+)+)/ && ($1.to_f < GLIBC_MIN)
+  message = "glibc #{GLIBC_MIN}+ is required but you have #{$1} installed."
+  message << "\nYou may be able to use Skylight v4 instead." if $1.to_f >= GLIBC_V4_MIN
+  fail message
+end
 
 # 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
@@ -36,30 +40,31 @@ class MultiIO
   end
 end
 
-include Skylight::Core::Util
+include Skylight::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.fetch("SKYLIGHT_REQUIRED", nil) !~ /^false$/i
+SKYLIGHT_FETCH_LIB = !ENV.key?("SKYLIGHT_FETCH_LIB") || ENV.fetch("SKYLIGHT_FETCH_LIB", nil) !~ /^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.fetch("SKYLIGHT_HDR_PATH") { ENV.fetch("SKYLIGHT_LIB_PATH", ".") }
+SKYLIGHT_LIB_PATH =
+  ENV.fetch("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.fetch("SKYLIGHT_SOURCE_URL", nil)
+SKYLIGHT_VERSION = ENV.fetch("SKYLIGHT_VERSION", nil)
+SKYLIGHT_CHECKSUM = ENV.fetch("SKYLIGHT_CHECKSUM", nil)
 
-SKYLIGHT_EXT_STRICT = ENV.key?("SKYLIGHT_EXT_STRICT") && ENV['SKYLIGHT_EXT_STRICT'] =~ /^true$/i
+SKYLIGHT_EXT_STRICT = ENV.key?("SKYLIGHT_EXT_STRICT") && ENV.fetch("SKYLIGHT_EXT_STRICT", nil) =~ /^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,94 +82,89 @@ 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 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
-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
-  end
+# If the user installs Xcode-only, they have to approve the
+# license or no "xc*" tool will work.
+
+# prettier-ignore
+if Platform::OS == "darwin" && (`/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
+  MESSAGE
 end
 
 #
 # === Setup paths
 #
-root              = File.expand_path('../', __FILE__)
-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)
+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)
 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
-    fail "libskylight.#{LIBEXT} not found -- remote download disabled; aborting install"
-  end
+  fail "libskylight.#{LIBEXT} not found -- remote download disabled; aborting install" unless SKYLIGHT_FETCH_LIB
 
   # Ensure that libskylight.yml is present and load it
-  unless File.exist?(libskylight_yml)
-    fail "`#{libskylight_yml}` does not exist"
-  end
+  fail "`#{libskylight_yml}` does not exist" unless File.exist?(libskylight_yml)
 
-  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
 
   begin
-    res = Skylight::NativeExtFetcher.fetch(
-      source:   SKYLIGHT_SOURCE_URL,
-      version:  version,
-      target:   hdrpath,
-      checksum: checksum,
-      arch:     Platform.tuple,
-      required: SKYLIGHT_REQUIRED,
-      platform: Platform.tuple,
-      logger:   LOG)
-
-    unless res
-      fail "could not fetch archive -- aborting skylight native extension build"
-    end
+    res =
+      Skylight::NativeExtFetcher.fetch(
+        source: SKYLIGHT_SOURCE_URL,
+        version: version,
+        target: hdrpath,
+        checksum: checksum,
+        arch: Platform.tuple,
+        required: SKYLIGHT_REQUIRED,
+        platform: Platform.tuple,
+        logger: LOG
+      )
+
+    fail "could not fetch archive -- aborting skylight native extension build" unless res
 
     # Move skylightd & libskylight to appropriate directory
     if hdrpath != libpath
@@ -172,15 +172,11 @@ if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(
       FileUtils.mkdir_p libpath
 
       # Move
-      FileUtils.mv "#{hdrpath}/libskylight.#{Platform.libext}",
-                   "#{libpath}/libskylight.#{Platform.libext}",
-                   :force => true
+      FileUtils.mv "#{hdrpath}/libskylight.#{Platform.libext}", "#{libpath}/libskylight.#{Platform.libext}", force: true
 
-      FileUtils.mv "#{hdrpath}/skylightd",
-                   "#{libpath}/skylightd",
-                   :force => true
+      FileUtils.mv "#{hdrpath}/skylightd", "#{libpath}/skylightd", force: true
     end
-  rescue => e
+  rescue StandardError => e
     fail "unable to fetch native extension; msg=#{e.message}\n#{e.backtrace.join("\n")}"
   end
 end
@@ -192,35 +188,33 @@ 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
+  fail "#{file} missing; path=#{root}" unless File.exist?(path)
 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")
+  abort "Ruby is unexpectedly missing rb_thread_call_without_gvl. This should not happen."
 end
 
 # Previous comment stated:
@@ -230,11 +224,9 @@ end
 #   flag can cause issues for some customers we're turning it off by default. However,
 #   in development and CI, we still have the option of turning it back on to help catch
 #   potential issues.
-if SKYLIGHT_EXT_STRICT
-  $CFLAGS << " -Werror"
-end
+$CFLAGS << " -Werror" if SKYLIGHT_EXT_STRICT
 
-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
@@ -247,7 +239,11 @@ $CFLAGS << " -std=c99 -Wall -fno-strict-aliasing"
 # Allow stricter checks to be turned on for development or debugging
 if SKYLIGHT_EXT_STRICT
   $CFLAGS << " -Wextra"
+
+  # Enabling unused-parameter causes failures in Ruby 2.6+
+  #   ruby/ruby.h:2186:35: error: unused parameter 'allow_transient'
+  $CFLAGS << " -Wno-error=unused-parameter"
 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,9 @@
-version: "3.1.0-c0a22d1"
+version: "5.1.0-cd7d6af"
 checksums:
-  x86-linux:         "1dc6a9ee453756c8b984c5733d2631ed27538f20cfde2f037ae31010edec6232"
-  x86_64-linux:      "b91dc91c2bc2954bf4587f3733a3c696a443bce13738a9073229ab4dfd09938e"
-  x86_64-linux-musl: "c7b00982688a344ee3808ea40452dd1f6c448e7f3aa0221b4c95fca2a51547b9"
-  x86_64-darwin:     "41cf89a75dc64cafb97303f31908b14a3ca2d15e5de935cbd57a611f396b5b90"
-  x86_64-freebsd:    "72ccb98f3f7604fddad116fe6ea4750643f9b088d4f25f3e21c4972680cc8f01"
+  x86-linux:          "921381c014b87e67fa2049e9891377f737b5abb10963228ddcd65caede7b58d2"
+  x86_64-linux:       "e89f0ec3f39ecca060b757fcd1b9d8f38e5846f65579785454bb69a968e8528f"
+  x86_64-linux-musl:  "78239bc7581c124c2a00cfbc42ec6cf73e7ed280ed1a27d85bb915531a683f1a"
+  x86_64-darwin:      "faa7363ada4bf476511f6700856fd91b9d61fed055297417ce41d83aa11fe07c"
+  aarch64-linux:      "e172515a6f7923552e842d21319b3630bdc6e264b6a434b43d2db682dcde18cc"
+  aarch64-linux-musl: "1665adf149bd2c12e409f387de5d796ef9e55d4cfd9a886f69c42cab59a51926"
+  aarch64-darwin:     "027bec103668e89f318b55ddc2a48ca5c84c7a6dcd1dd273cc9b7b46d918ef12"