skylight 2.0.0.beta2 → 2.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db165039da03ba238e5a23b22d7194644f4f41652e85c881db67258998a953eb
-  data.tar.gz: 2552166e6e2982649d0ae01355cfd7648b7cecd4f905e33720adbac43b6cf70d
+  metadata.gz: 4b5dae77c81d35433c8d2da47b0a7a2b82f7730888802cf3ab892815ceba3f5a
+  data.tar.gz: f8c1649317979a382353b1410e1453e4af12fa025e2d03302860af1673990317
 SHA512:
-  metadata.gz: c433d4c32a30060baa0741220a6f49c0ebec54dfc42b9af3a9541d97b3178167caf68db4e27bd58882bc91826b817866e34c60b83a85f28db251139ab318cd3d
-  data.tar.gz: d6dc55b986b620bdca5b8a646f7f5e50c7e10f680931a08cd8eb87fb3c79291c41ece0aead98509c5c3203558271960ecc58fe69a19329640befc0ebd2450100
+  metadata.gz: 00f7d040355b847525a0c4d1ee6e47a5e64ab8040f9a7cb709fdbd482a912e6fef7d218a181bb9eb655fd3bdabd83a8af7d279527910c2ab783238b17780e519
+  data.tar.gz: dbe7b6e960a53d0be3f5ea0423b4bad1cb5dc90f0343c9ea7d73a897182537255f7a7d099e1e31d47e672abc24d29317bce511581c0d436f339091affbd8f74a

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 2.0.0-beta3 (March 22, 2017)
+
+* [BREAKING] `log_sql_parse_errors` config option is now on by default.
+* [IMPROVEMENT] Improved handling of errors generated in the Rust agent.
+* [IMPROVEMENT] Add a probe method to Instrumentable as a shortcut
+* [IMRPOVEMENT] Add logging to Instrumentable for easier access
+* [IMPROVEMENT] Improved logging during startup
+
 ## 2.0.0-beta2 (February 5, 2017)
 
 * [BUGFIX] Fix incorrect module path that caused installation issues
@@ -7,10 +15,23 @@
 * [FEATURE] New SQL lexer to support a wider variety of SQL queries.
 * [BREAKING] Drop support for a number of deprecated libraries, including Rails prior to 4.2, Ruby prior to 2.2, and Sinatra prior to 1.4.
 
+## 1.6.0 (March 21, 2018)
+
+* [FEATURE] Time spent the Rails router is now identified separately in the trace
+* [IMPROVEMENT] Switch logger to debug mode if tracing is enabled
+* [IMPROVEMENT] Improved logging for a number of error cases
+* [IMPROVEMENT] Middleware probe should now accept anything allowed by Rack::Lint
+* [IMPROVEMENT] We were using arity checks to determine Rails version but due to other libraries' monkey patches this could sometimes fail. We just check version numbers now.
+* [BUGFIX] Middleware probe no longer errors when Middleware returns a frozen array
+
+## 1.5.1 (February 7, 2018)
+
+* [BUGFIX] `skylight doctor` no longer erroneously reports inability to reach Skylight servers.
+
 ## 1.5.0 (December 6, 2017)
 
 * [FEATURE] [Coach](https://github.com/gocardless/coach) instrumentation. Enabled automatically via ActiveSupport::Notifications.
-* [FEATURE] Option to enable or disable agent by setting SKYLIGHT_ENABLE via ENV.
+* [FEATURE] Option to enable or disable agent by setting SKYLIGHT_ENABLED via ENV.
 * [IMPROVEMENT] Better logging for certain error cases.
 * [BUGFIX] Backport a SPEC compliance fix for older Rack::ETag to resolve case where the Middleware probe could cause empty traces.
 * [BUGFIX] Fix a case where using the non-block form of `Skylight.instrument` with `Skylight.done` could cause lost trace data.

data/ERRORS.md

@@ -0,0 +1,5 @@
+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
+E9999 - Unknown

data/ext/extconf.rb

@@ -246,7 +246,7 @@ $CFLAGS << " -std=c99 -Wall -fno-strict-aliasing"
 
 # Allow stricter checks to be turned on for development or debugging
 if SKYLIGHT_EXT_STRICT
-  $CFLAGS << " -pedantic"
+  $CFLAGS << " -Wextra"
 end
 
 # TODO: Compute the relative path to the location

data/ext/libskylight.yml

@@ -1,8 +1,8 @@
 ---
-version: "2.0.0-7fe2c49"
+version: "2.0.0-5ca78bf"
 checksums:
-  x86-linux:         "57e0b65fd5bd03be9ad406711279d6164982107a4af144a85d4a352f035244ff"
-  x86_64-linux:      "5a2648e000f7b184dfaadd01f37399e808c80826613279571b61e4d7b122118a"
-  x86_64-linux-musl: "39fc56d55782af71c8c37f93d1082e05c9a4c0decb68487ea6695d95971985f6"
-  x86_64-darwin:     "05a68826b7cef60c19d22302ec4f5eaa5134fd3be6d19513f6de76337fccb734"
-  x86_64-freebsd:    "97f4a65c0ba19cfa236fec73f2fdd74e0df9ae0e12ecec7709c996a3c4eb10f2"
+  x86-linux:         "b919d4bba6cd4998f63115a558229ac4f151b5a2df1acec767a6956650b5dc36"
+  x86_64-linux:      "862f509a9c4b53f4d18d1f41a1fbd6919ac822a7efa3c24a57acbfaf85a450ac"
+  x86_64-linux-musl: "b1bec2068b32465ae70291f5376f4384bcc09635be678974ee93a3f9a847bfe2"
+  x86_64-darwin:     "4cad72f0b4d7fda8e785b98e4d1523f05216e4b925ab79db02713f463c387011"
+  x86_64-freebsd:    "103bdfb9c47c90855b78f5e7bfa591e935ad6239533c6c3f07a1d82cf5a1528a"

data/ext/skylight_native.c

@@ -44,10 +44,11 @@ STR2BUF(VALUE str) {
   };
 }
 
-#define CHECK_FFI(success, message)               \
+#define CHECK_FFI(code, method_name)              \
   do {                                            \
-    if ((success) != 0 ) {                        \
-      rb_raise(rb_eRuntimeError, message);        \
+    if ((code) != 0 ) {                           \
+      VALUE error_class = rb_funcall(rb_eNativeError, rb_intern("for_code"), 1, INT2NUM(code)); \
+      rb_raise(error_class, method_name);         \
       return Qnil;                                \
     }                                             \
   } while(0)
@@ -99,9 +100,12 @@ typedef VALUE (*blocking_fn_t)(void*);
  */
 
 VALUE rb_mSkylight;
+VALUE rb_eNativeError;
 VALUE rb_mCore;
 VALUE rb_mUtil;
 VALUE rb_cClock;
+VALUE rb_cTrace;
+VALUE rb_cInstrumenter;
 
 static const char* no_instrumenter_msg =
   "Instrumenter not currently running";
@@ -109,6 +113,7 @@ static const char* no_instrumenter_msg =
 static const char* consumed_trace_msg =
   "Trace objects cannot be used once it has been submitted to the instrumenter";
 
+
 static VALUE
 load_libskylight(VALUE klass, VALUE path) {
   int res;
@@ -175,7 +180,7 @@ instrumenter_new(VALUE klass, VALUE rb_env) {
 
   CHECK_FFI(
       sky_instrumenter_new(env, envc, &instrumenter),
-      "failed to initialize instrumenter");
+      "Instrumenter#native_new");
 
   return Data_Wrap_Struct(klass, NULL, sky_instrumenter_free, instrumenter);
 }
@@ -213,7 +218,7 @@ instrumenter_stop(VALUE self) {
 
   CHECK_FFI(
       sky_instrumenter_stop(instrumenter),
-      "native Instrumenter#stop failed");
+      "Instrumenter#native_stop");
 
   sky_deactivate_memprof();
 
@@ -249,7 +254,7 @@ instrumenter_track_desc(VALUE self, VALUE rb_endpoint, VALUE rb_desc) {
 
   CHECK_FFI(
       sky_instrumenter_track_desc(instrumenter, STR2BUF(rb_endpoint), STR2BUF(rb_desc), &tracked),
-      "native Instrumenter#track_desc failed");
+      "Instrumenter#native_track_desc");
 
   if (tracked) {
     return Qtrue;
@@ -277,7 +282,7 @@ trace_new(VALUE klass, VALUE start, VALUE uuid, VALUE endpoint, VALUE meta) {
 
   CHECK_FFI(
       sky_trace_new(NUM2ULL(start), STR2BUF(uuid), STR2BUF(endpoint), &trace),
-      "native Trace#new failed");
+      "Trace#native_new");
 
   sky_clear_allocation_count();
 
@@ -293,7 +298,7 @@ trace_get_started_at(VALUE self) {
 
   CHECK_FFI(
       sky_trace_start(trace, &start),
-      "native Trace#started_at failed");
+      "Trace#native_get_started_at");
 
   return ULL2NUM(start);
 }
@@ -307,7 +312,7 @@ trace_get_endpoint(VALUE self) {
 
   CHECK_FFI(
       sky_trace_endpoint(trace, &endpoint),
-      "native Trace#endpoint failed");
+      "Trace#native_get_endpoint");
 
   return BUF2STR(endpoint);
 }
@@ -321,13 +326,15 @@ trace_set_endpoint(VALUE self, VALUE endpoint) {
 
   CHECK_FFI(
       sky_trace_set_endpoint(trace, STR2BUF(endpoint)),
-      "native Trace#set_endpoint failed");
+      "Trace#native_set_endpoint");
 
   return Qnil;
 }
 
 static VALUE
 trace_set_exception(VALUE self, VALUE exception) {
+  UNUSED(self);
+  UNUSED(exception);
   return Qnil;
 }
 
@@ -340,7 +347,7 @@ trace_get_uuid(VALUE self) {
 
   CHECK_FFI(
       sky_trace_uuid(trace, &uuid),
-      "native Trace#uuid failed");
+      "Trace#native_get_uuid");
 
   return BUF2STR(uuid);
 }
@@ -357,7 +364,7 @@ trace_start_span(VALUE self, VALUE time, VALUE category) {
 
   CHECK_FFI(
       sky_trace_instrument(trace, NUM2ULL(time), STR2BUF(category), &span),
-      "native Trace#start_span failed");
+      "Trace#native_start_span");
 
   if (sky_have_memprof()) {
     sky_trace_span_add_uint_annotation(trace, span, 2, sky_consume_allocations());
@@ -381,11 +388,27 @@ trace_stop_span(VALUE self, VALUE span, VALUE time) {
 
   CHECK_FFI(
       sky_trace_span_done(trace, FIX2UINT(span), NUM2ULL(time)),
-      "native Trace#stop_span failed");
+      "Trace#native_stop_span");
 
   return Qnil;
 }
 
+static VALUE
+trace_span_get_category(VALUE self, VALUE span) {
+  sky_trace_t* trace;
+  sky_buf_t category;
+
+  My_Struct(trace, sky_trace_t, consumed_trace_msg);
+
+  CHECK_TYPE(span, T_FIXNUM);
+
+  CHECK_FFI(
+      sky_trace_span_get_category(trace, FIX2UINT(span), &category),
+      "Trace#native_span_get_category");
+
+  return BUF2STR(category);
+}
+
 static VALUE
 trace_span_set_title(VALUE self, VALUE span, VALUE title) {
   sky_trace_t* trace;
@@ -402,6 +425,22 @@ trace_span_set_title(VALUE self, VALUE span, VALUE title) {
   return Qnil;
 }
 
+static VALUE
+trace_span_get_title(VALUE self, VALUE span) {
+  sky_trace_t* trace;
+  sky_buf_t title;
+
+  My_Struct(trace, sky_trace_t, consumed_trace_msg);
+
+  CHECK_TYPE(span, T_FIXNUM);
+
+  CHECK_FFI(
+      sky_trace_span_get_title(trace, FIX2UINT(span), &title),
+      "Trace#native_span_get_title");
+
+  return BUF2STR(title);
+}
+
 static VALUE
 trace_span_set_description(VALUE self, VALUE span, VALUE desc) {
   sky_trace_t* trace;
@@ -413,23 +452,38 @@ trace_span_set_description(VALUE self, VALUE span, VALUE desc) {
 
   CHECK_FFI(
       sky_trace_span_set_desc(trace, FIX2UINT(span), STR2BUF(desc)),
-      "native Trace#span_set_description failed");
+      "Trace#native_span_set_description");
 
   return Qnil;
 }
 
 static VALUE
 trace_span_set_meta(VALUE self, VALUE span, VALUE meta) {
+  UNUSED(self);
+  UNUSED(span);
+  UNUSED(meta);
+  return Qnil;
+}
+
+static VALUE
+trace_span_started(VALUE self) {
+  UNUSED(self);
   return Qnil;
 }
 
 static VALUE
 trace_span_set_exception(VALUE self, VALUE span, VALUE exception, VALUE exception_details) {
+  UNUSED(self);
+  UNUSED(span);
+  UNUSED(exception);
+  UNUSED(exception_details);
   return Qnil;
 }
 
 static VALUE
 trace_span_get_correlation_header(VALUE self, VALUE span_id) {
+  UNUSED(self);
+  UNUSED(span_id);
   return Qnil;
 }
 
@@ -460,10 +514,10 @@ lex_sql(VALUE klass, VALUE rb_sql, VALUE rb_use_old_lexer) {
 
   if (RTEST(rb_use_old_lexer)) {
     CHECK_FFI(sky_lex_sql_old(sql, &title, &statement),
-      "native lex_sql_old failed");
+      "Skylight#lex_sql (old)");
   } else {
     CHECK_FFI(sky_lex_sql(sql, &title, &statement),
-      "native lex_sql failed");
+      "Skylight#lex_sql");
   }
 
   // Set the statement return
@@ -486,6 +540,9 @@ lex_sql(VALUE klass, VALUE rb_sql, VALUE rb_use_old_lexer) {
 
 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, 2);
 
@@ -496,7 +553,7 @@ void Init_skylight_native() {
   rb_cClock = rb_define_class_under(rb_mUtil, "Clock", rb_cObject);
   rb_define_method(rb_cClock, "native_hrtime", clock_high_res_time, 0);
 
-  VALUE rb_cTrace = rb_const_get(rb_mSkylight, rb_intern("Trace"));
+  rb_cTrace = rb_const_get(rb_mSkylight, rb_intern("Trace"));
   rb_define_singleton_method(rb_cTrace, "native_new", trace_new, 4);
   rb_define_method(rb_cTrace, "native_get_started_at", trace_get_started_at, 0);
   rb_define_method(rb_cTrace, "native_get_endpoint", trace_get_endpoint, 0);
@@ -505,13 +562,16 @@ void Init_skylight_native() {
   rb_define_method(rb_cTrace, "native_get_uuid", trace_get_uuid, 0);
   rb_define_method(rb_cTrace, "native_start_span", trace_start_span, 2);
   rb_define_method(rb_cTrace, "native_stop_span", trace_stop_span, 2);
+  rb_define_method(rb_cTrace, "native_span_get_category", trace_span_get_category, 1);
   rb_define_method(rb_cTrace, "native_span_set_title", trace_span_set_title, 2);
+  rb_define_method(rb_cTrace, "native_span_get_title", trace_span_get_title, 1);
   rb_define_method(rb_cTrace, "native_span_set_description", trace_span_set_description, 2);
   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);
 
-  VALUE rb_cInstrumenter = rb_const_get(rb_mSkylight, rb_intern("Instrumenter"));
+  rb_cInstrumenter = rb_const_get(rb_mSkylight, rb_intern("Instrumenter"));
   rb_define_singleton_method(rb_cInstrumenter, "native_new", instrumenter_new, 1);
   rb_define_method(rb_cInstrumenter, "native_start", instrumenter_start, 0);
   rb_define_method(rb_cInstrumenter, "native_stop", instrumenter_stop, 0);

data/lib/skylight.rb

@@ -6,6 +6,7 @@ require 'skylight/middleware'
 require 'skylight/api'
 require 'skylight/helpers'
 require 'skylight/config'
+require 'skylight/errors'
 require 'skylight/native'
 
 module Skylight
@@ -28,9 +29,4 @@ module Skylight
     Config
   end
 
-  # Install probes
-  def self.probe(*probes)
-    Core::Probes.probe(*probes)
-  end
-
 end

data/lib/skylight/cli/doctor.rb

@@ -11,7 +11,7 @@ module Skylight
         say "Checking SSL"
         http = Util::HTTP.new(config)
         indent do
-          req = http.get("/", "Accept" => "text/html")
+          req = http.get("/status")
           if req.success?
             say "OK", :green
           else
@@ -113,7 +113,7 @@ module Skylight
           logger.level = Logger::DEBUG
           # Remove excess formatting
           logger.formatter = proc { |severity, datetime, progname, msg|
-            msg = msg.sub("[SKYLIGHT] [#{Skylight::Core::VERSION}] ", '')
+            msg = msg.sub("[SKYLIGHT] [#{Skylight::VERSION}] ", '')
             say "#{severity} - #{msg}" # Definitely non-standard
           }
           config.logger = logger

data/lib/skylight/errors.rb

@@ -0,0 +1,57 @@
+module Skylight
+  class NativeError < StandardError
+
+    @@classes = { }
+
+    def self.register(code, name, message)
+      if @@classes.has_key?(code)
+        raise "Duplicate error class code: #{code}; name=#{name}"
+      end
+
+      Skylight.module_eval <<-ruby
+        class #{name}Error < NativeError
+          def self.code; #{code}; end
+          def self.message; #{message.to_json}; end
+        end
+      ruby
+
+      klass = Skylight.const_get("#{name}Error")
+
+      @@classes[code] = klass
+    end
+
+    def self.for_code(code)
+      @@classes[code] || self
+    end
+
+    attr_reader :method_name
+
+    def self.code
+      9999
+    end
+
+    def self.message
+      "Encountered an unknown internal error"
+    end
+
+    def initialize(method_name)
+      @method_name = method_name
+      super(sprintf("[E%04d] %s [%s]", code, message, method_name))
+    end
+
+    def code
+      self.class.code
+    end
+
+    def formatted_code
+      "%04d" % code
+    end
+
+    # E0003
+    register(3, "MaximumTraceSpans", "Exceeded maximum number of spans in a trace.")
+
+    # E0004
+    register(4, "SqlLex", "Failed to lex SQL query.")
+  end
+
+end

data/lib/skylight/native.rb

@@ -56,7 +56,7 @@ module Skylight
 
     if File.exist?(install_log) && File.read(install_log) =~ /ERROR/
       config.alert_logger.error \
-          "[SKYLIGHT] [#{Skylight::Core::VERSION}] The Skylight native extension failed to install. " \
+          "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension failed to install. " \
           "Please check #{install_log} and notify support@skylight.io. " \
           "The missing extension will not affect the functioning of your application."
     end
@@ -65,7 +65,7 @@ module Skylight
   # @api private
   def self.warn_skylight_native_missing(config)
     config.alert_logger.error \
-      "[SKYLIGHT] [#{Skylight::Core::VERSION}] The Skylight native extension for " \
+      "[SKYLIGHT] [#{Skylight::VERSION}] The Skylight native extension for " \
       "your platform wasn't found. Supported operating systems are " \
       "Linux 2.6.18+ and Mac OS X 10.8+. The missing extension will not " \
       "affect the functioning of your application. If you are on a " \

data/lib/skylight/probes/sinatra_add_middleware.rb

@@ -3,12 +3,10 @@ module Skylight
     module Sinatra
       class Probe
         def install
-          puts "Installed"
           class << ::Sinatra::Base
             alias build_without_sk build
 
             def build(*args, &block)
-              puts "Using Middleware"
               self.use Skylight::Middleware
               build_without_sk(*args, &block)
             end

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '2.0.0-beta2'
+  VERSION = '2.0.0-beta3'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta2
+  version: 2.0.0.beta3
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-05 00:00:00.000000000 Z
+date: 2018-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: skylight-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: 2.0.0.beta3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: 2.0.0.beta3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
 description: 
 email:
 - engineering@tilde.io
@@ -148,6 +162,7 @@ files:
 - CHANGELOG.md
 - CLA.md
 - CONTRIBUTING.md
+- ERRORS.md
 - LICENSE.md
 - README.md
 - bin/skylight
@@ -163,6 +178,7 @@ files:
 - lib/skylight/cli/helpers.rb
 - lib/skylight/config.rb
 - lib/skylight/data/cacert.pem
+- lib/skylight/errors.rb
 - lib/skylight/helpers.rb
 - lib/skylight/instrumenter.rb
 - lib/skylight/middleware.rb