skylight 4.3.2 → 5.1.1

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

@@ -16,14 +16,8 @@ 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/Gemfile.rails-5.2.x
+export BUNDLE_GEMFILE=$PWD/gemfiles/rails-5.2.x/Gemfile
 bundle install
-
-# Run the skylight-core test suite (takes a few seconds)
-pushd skylight-core
-bundle exec rspec
-popd
-
-# Run the main test suite (takes 5-10 minutes)
+# Run the test suite (takes 5-10 minutes)
 bundle exec rspec
 ```

data/LICENSE.md

@@ -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,4 +1,5 @@
 # Skylight Ruby Agent
+
 [![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)
 
@@ -9,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/ext/extconf.rb

@@ -27,12 +27,13 @@ end
 include Skylight::Util
 
 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
+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_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"]
@@ -41,7 +42,7 @@ SKYLIGHT_CHECKSUM = ENV["SKYLIGHT_CHECKSUM"]
 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
@@ -65,26 +66,26 @@ 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/ && !$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
+# 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(__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)
+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)
 
@@ -96,14 +97,10 @@ LOG.info "file exists; path=#{skylight_dlopen_h}" if File.exist?(skylight_dlopen
 
 # If libskylight is not present, fetch it
 if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(skylight_dlopen_h)
-  unless 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))
     fail "`#{libskylight_yml}` does not contain data"
@@ -132,26 +129,26 @@ if !File.exist?(libskylight) && !File.exist?(skylight_dlopen_c) && !File.exist?(
 
     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
+             "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
@@ -159,15 +156,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
@@ -181,9 +174,7 @@ end
 def find_file(file, root = nil)
   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
@@ -206,8 +197,8 @@ 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")
-  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:
@@ -217,9 +208,7 @@ 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
   if try_compile("__thread int foo;")

data/ext/libskylight.yml

@@ -1,7 +1,11 @@
-version: "4.1.0-46806f5"
+# commit b6bb0714913a5be54f4eac717d5096dc7ba5f3eb
+---
+version: "5.1.0-0d59831"
 checksums:
-  x86-linux:         "4054632757516aa44e812860601fcb7f21c8c5d412b2d585868b46c7a8e3cae6"
-  x86_64-linux:      "4675694fba4448ba14787551237bd4e388443895d5c9e5d8a71c550eccd203db"
-  x86_64-linux-musl: "7a81880830d0a409a6f0f39ff42f90a1422542b05384e2480ae05515f6b5f831"
-  x86_64-darwin:     "84eef6c330818c2bad1628ff189b9cb88275c9d72a28afac88a0d054d8002230"
-  x86_64-freebsd:    "a86a52203fab4f9a56ad91d5700e14823e6e997b4df1bcb3ae2d9e4296c50b1f"
+  x86-linux:          "e15fff9269f5451302aaee56b4d4631c86f979298bc22536f28f884c170c127f"
+  x86_64-linux:       "be95b9c91dffb0133b57183d160cad700213703a87f52488cf114a4fff92ff4d"
+  x86_64-linux-musl:  "945ebefa0384e23121bc1674f0eda0600aef204599e5819bdbecd6d62252b769"
+  x86_64-darwin:      "d98ee1d331394ac43bd37f2d3d5d591a41d912dfa2c3e5d0b21d97f7a5198cf1"
+  aarch64-linux:      "b6add5dda52a2cae4b5e3899a5e0c938049385443d82acbd1a8a2fb0d8502933"
+  aarch64-linux-musl: "667030ade09a69a664380262ec1e6ceeb77f49585201e670528f4cd52d3def86"
+  aarch64-darwin:     "d3225034d18d99e358ace24cf951468feaf3b83f0b33e32965bc2139e0300505"

data/ext/skylight_native.c

@@ -86,14 +86,6 @@ typedef void* (*blocking_fn_t)(void*);
 #define WITHOUT_GVL(fn, a) \
   rb_thread_call_without_gvl((blocking_fn_t)(fn), (a), 0, 0)
 
-// Ruby 1.9
-#elif defined(HAVE_RB_THREAD_BLOCKING_REGION)
-
-typedef VALUE (*blocking_fn_t)(void*);
-#define WITHOUT_GVL(fn, a) \
-  rb_thread_blocking_region((blocking_fn_t)(fn), (a), 0, 0)
-
-
 #endif
 
 
@@ -103,7 +95,6 @@ typedef VALUE (*blocking_fn_t)(void*);
 
 VALUE rb_mSkylight;
 VALUE rb_eNativeError;
-VALUE rb_mCore;
 VALUE rb_mUtil;
 VALUE rb_cClock;
 VALUE rb_cTrace;
@@ -140,7 +131,7 @@ load_libskylight(VALUE klass, VALUE path) {
 
 /*
  *
- * class Skylight::Core::Util::Clock
+ * class Skylight::Util::Clock
  *
  */
 
@@ -152,7 +143,7 @@ clock_high_res_time(VALUE self) {
 
 /*
  *
- * class Skylight::Core::Instrumenter
+ * class Skylight::Instrumenter
  *
  */
 
@@ -243,33 +234,9 @@ instrumenter_submit_trace(VALUE self, VALUE rb_trace) {
   return Qnil;
 }
 
-static VALUE
-instrumenter_track_desc(VALUE self, VALUE rb_endpoint, VALUE rb_desc) {
-  int tracked;
-  sky_instrumenter_t* instrumenter;
-
-  CHECK_TYPE(rb_endpoint, T_STRING);
-  CHECK_TYPE(rb_desc, T_STRING);
-
-  tracked = 0;
-
-  My_Struct(instrumenter, sky_instrumenter_t, no_instrumenter_msg);
-
-  CHECK_FFI(
-      sky_instrumenter_track_desc(instrumenter, STR2BUF(rb_endpoint), STR2BUF(rb_desc), &tracked),
-      "Instrumenter#native_track_desc");
-
-  if (tracked) {
-    return Qtrue;
-  }
-  else {
-    return Qfalse;
-  }
-}
-
 /*
  *
- * class Skylight::Core::Trace
+ * class Skylight::Trace
  *
  */
 
@@ -503,9 +470,24 @@ trace_span_set_description(VALUE self, VALUE span, VALUE desc) {
 
 static VALUE
 trace_span_set_meta(VALUE self, VALUE span, VALUE meta) {
-  UNUSED(self);
-  UNUSED(span);
-  UNUSED(meta);
+  sky_trace_t* trace;
+  VALUE rb_source_location;
+
+  My_Struct(trace, sky_trace_t, consumed_trace_msg);
+
+  CHECK_TYPE(span, T_FIXNUM);
+  CHECK_TYPE(meta, T_HASH);
+
+  rb_source_location = rb_hash_lookup(meta, ID2SYM(rb_intern("source_location")));
+  if (rb_source_location != Qnil) {
+    sky_buf_t source_location;
+
+    CHECK_TYPE(rb_source_location, T_STRING);
+    source_location = STR2BUF(rb_source_location);
+
+    sky_trace_span_add_string_annotation(trace, FIX2UINT(span), 3, source_location);
+  }
+
   return Qnil;
 }
 
@@ -525,71 +507,14 @@ trace_span_set_exception(VALUE self, VALUE span, VALUE exception, VALUE exceptio
   return Qnil;
 }
 
-static VALUE
-trace_span_get_correlation_header(VALUE self, VALUE span_id) {
-  UNUSED(self);
-  UNUSED(span_id);
-  return Qnil;
-}
-
-static VALUE
-lex_sql(VALUE klass, VALUE rb_sql) {
-  sky_buf_t sql;
-  sky_buf_t title;
-  sky_buf_t statement;
-  uint8_t title_store[128];
-  VALUE rb_statement;
-  VALUE ret;
-
-  UNUSED(klass);
-  CHECK_TYPE(rb_sql, T_STRING);
-
-  sql = STR2BUF(rb_sql);
-  title = (sky_buf_t) {
-    .data = title_store,
-    .len = sizeof(title_store),
-  };
-
-  // The statement cannot be longer than the original sql string
-  rb_statement = rb_str_buf_new(RSTRING_LEN(rb_sql));
-  statement = (sky_buf_t) {
-    .data = RSTRING_PTR(rb_statement),
-    .len = RSTRING_LEN(rb_sql),
-  };
-
-  CHECK_FFI(sky_lex_sql(sql, &title, &statement),
-    "Skylight#lex_sql");
-
-  // Set the statement return
-  rb_str_set_len(rb_statement, statement.len);
-  rb_enc_associate(rb_statement, rb_utf8_encoding());
-
-  ret = rb_ary_new2(2);
-
-  if (title.len > 0) {
-    rb_ary_store(ret, 0, BUF2STR(title));
-  }
-  else {
-    rb_ary_store(ret, 0, Qnil);
-  }
-
-  rb_ary_store(ret, 1, rb_statement);
-
-  return ret;
-}
-
 void Init_skylight_native() {
   rb_mSkylight = rb_define_module("Skylight");
 
   rb_eNativeError = rb_const_get(rb_mSkylight, rb_intern("NativeError"));
 
   rb_define_singleton_method(rb_mSkylight, "load_libskylight", load_libskylight, 1);
-  rb_define_singleton_method(rb_mSkylight, "lex_sql", lex_sql, 1);
-
-  rb_mCore = rb_define_module_under(rb_mSkylight, "Core");
 
-  // FIXME: Don't put these under Core
-  rb_mUtil  = rb_define_module_under(rb_mCore, "Util");
+  rb_mUtil  = rb_define_module_under(rb_mSkylight, "Util");
   rb_cClock = rb_define_class_under(rb_mUtil, "Clock", rb_cObject);
   rb_define_method(rb_cClock, "native_hrtime", clock_high_res_time, 0);
 
@@ -612,12 +537,10 @@ void Init_skylight_native() {
   rb_define_method(rb_cTrace, "native_span_set_meta", trace_span_set_meta, 2);
   rb_define_method(rb_cTrace, "native_span_started", trace_span_started, 1);
   rb_define_method(rb_cTrace, "native_span_set_exception", trace_span_set_exception, 3);
-  rb_define_method(rb_cTrace, "native_span_get_correlation_header", trace_span_get_correlation_header, 1);
 
   rb_cInstrumenter = rb_const_get(rb_mSkylight, rb_intern("Instrumenter"));
   rb_define_singleton_method(rb_cInstrumenter, "native_new", instrumenter_new, 2);
   rb_define_method(rb_cInstrumenter, "native_start", instrumenter_start, 0);
   rb_define_method(rb_cInstrumenter, "native_stop", instrumenter_stop, 0);
   rb_define_method(rb_cInstrumenter, "native_submit_trace", instrumenter_submit_trace, 1);
-  rb_define_method(rb_cInstrumenter, "native_track_desc", instrumenter_track_desc, 2);
 }