skylight 2.0.0.beta3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b5dae77c81d35433c8d2da47b0a7a2b82f7730888802cf3ab892815ceba3f5a
-  data.tar.gz: f8c1649317979a382353b1410e1453e4af12fa025e2d03302860af1673990317
+  metadata.gz: 17059168e3e446548088b9b7c407c1bbccb75c23761bcb86cda22a25bf33f1b2
+  data.tar.gz: 8e7c71985c76b22fdf0b02055a2ef383941590cb6f1780386611c6a7a83f3b37
 SHA512:
-  metadata.gz: 00f7d040355b847525a0c4d1ee6e47a5e64ab8040f9a7cb709fdbd482a912e6fef7d218a181bb9eb655fd3bdabd83a8af7d279527910c2ab783238b17780e519
-  data.tar.gz: dbe7b6e960a53d0be3f5ea0423b4bad1cb5dc90f0343c9ea7d73a897182537255f7a7d099e1e31d47e672abc24d29317bce511581c0d436f339091affbd8f74a
+  metadata.gz: 90d537527078acf4b625b8316fb172f30a5ba262674ccd235e3e1171beda689bbd0dedb6366ec843716c3ff51aa3993e79b03e9127e78a353d6f4cdb64a415ad
+  data.tar.gz: fbe5fd2153f0a85c3ae15f25d3aa364400e095743f810a86813e21dc08a510007e6719ef5de43e90a83ea175d3f6e2487c39960f69af5c8c1ef7f80fb67c0247

data/CHANGELOG.md

@@ -1,19 +1,35 @@
-## 2.0.0-beta3 (March 22, 2017)
+## 2.0.0 (April 25, 2018)
 
+* [FEATURE] New SQL lexer to support a wider variety of SQL queries.
+* [BREAKING] Drop support for Ruby versions prior to 2.2
+* [BREAKING] Drop support for Rails versions prior to 4.2
+* [BREAKING] Drop support for Tilt versions prior to 1.4.1
+* [BREAKING] Drop support for Sinatra versions prior to 1.4
+* [BREAKING] Drop support for Grape versions prior to 0.13.0
+* [BREAKING] Drop support for Linux with glibc versions prior to 2.15
+* [BREAKING] Remove couch_potato normalizer as it doesn't appear to have ever worked
 * [BREAKING] `log_sql_parse_errors` config option is now on by default.
+* [IMPROVEMENT] Auto-disable Middleware probe if it appears to be causing issues
+* [IMPROVEMENT] More detailed logging and improved error handling
+* [IMPROVEMENT] Fix Ruby Warnings (Thanks @amatsuda!)
 * [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)
+## 1.7.0 (April 24, 2018)
 
-* [BUGFIX] Fix incorrect module path that caused installation issues
+* [FEATURE] New API for loading Probes. Example: `Skylight.probe(:excon')`
+* [FEATURE] New API for enabling non-default Normalizers. Example: `Skylight.enable_normalizer('active_job')`
+* [DEPRECATION] Support for Rails versions prior to 4.2
+* [DEPRECATION] Support for Tilt versions prior to 1.4.1
+* [DEPRECATION] Support for Sinatra versions prior to 1.4
+* [DEPRECATION] Support for Grape versions prior to 0.13.0
 
-## 2.0.0-beta1 (February 5, 2017)
+## 1.6.1 (April 12, 2018)
 
-* [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.
+* [IMPROVEMENT] Include endpoint name in error logging
+* [BUGFIX] Make sure to correctly release broken traces
+* [BUGFIX] Keep the `require` method private when overwriting
 
 ## 1.6.0 (March 21, 2018)
 

data/ext/libskylight.yml

@@ -1,8 +1,8 @@
 ---
-version: "2.0.0-5ca78bf"
+version: "2.0.0-b7a5dfb"
 checksums:
-  x86-linux:         "b919d4bba6cd4998f63115a558229ac4f151b5a2df1acec767a6956650b5dc36"
-  x86_64-linux:      "862f509a9c4b53f4d18d1f41a1fbd6919ac822a7efa3c24a57acbfaf85a450ac"
-  x86_64-linux-musl: "b1bec2068b32465ae70291f5376f4384bcc09635be678974ee93a3f9a847bfe2"
-  x86_64-darwin:     "4cad72f0b4d7fda8e785b98e4d1523f05216e4b925ab79db02713f463c387011"
-  x86_64-freebsd:    "103bdfb9c47c90855b78f5e7bfa591e935ad6239533c6c3f07a1d82cf5a1528a"
+  x86-linux:         "9d0f7236869d27c4f3614fa3428271c1d5a1d5cb0a7ac42d6242610b0baa3295"
+  x86_64-linux:      "12a0ec3c8e74a23e38d4ccaf670a5d167e2d977075b89caf5f3e9b2274b83d4d"
+  x86_64-linux-musl: "23c0858b0a8e5aad5fb34f7417f677dadc37c66a874e9a43ffae32f6ed174ce6"
+  x86_64-darwin:     "0a62e2cca7b13b1663663a84071b1be428556c69f2eee74a2e698c8ada8b4381"
+  x86_64-freebsd:    "a3f10212dce2dbc4f169dbb1ec18c58ede4bbf324aa0bdbd9ff79fecc37b7423"

data/ext/skylight_native.c

@@ -46,8 +46,10 @@ STR2BUF(VALUE str) {
 
 #define CHECK_FFI(code, method_name)              \
   do {                                            \
-    if ((code) != 0 ) {                           \
-      VALUE error_class = rb_funcall(rb_eNativeError, rb_intern("for_code"), 1, INT2NUM(code)); \
+    /* Ensure single execution if code is function call */ \
+    int c = (code);                               \
+    if (c != 0 ) {                                \
+      VALUE error_class = rb_funcall(rb_eNativeError, rb_intern("for_code"), 1, INT2NUM(c)); \
       rb_raise(error_class, method_name);         \
       return Qnil;                                \
     }                                             \
@@ -155,11 +157,12 @@ clock_high_res_time(VALUE self) {
  */
 
 static VALUE
-instrumenter_new(VALUE klass, VALUE rb_env) {
+instrumenter_new(VALUE klass, VALUE rb_uuid, VALUE rb_env) {
   sky_instrumenter_t* instrumenter;
   sky_buf_t env[256];
   int i, envc;
 
+  CHECK_TYPE(rb_uuid, T_STRING);
   CHECK_TYPE(rb_env, T_ARRAY);
 
   if (RARRAY_LEN(rb_env) >= 256) {
@@ -179,7 +182,7 @@ instrumenter_new(VALUE klass, VALUE rb_env) {
   }
 
   CHECK_FFI(
-      sky_instrumenter_new(env, envc, &instrumenter),
+      sky_instrumenter_new(STR2BUF(rb_uuid), env, envc, &instrumenter),
       "Instrumenter#native_new");
 
   return Data_Wrap_Struct(klass, NULL, sky_instrumenter_free, instrumenter);
@@ -572,7 +575,7 @@ void Init_skylight_native() {
   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, 1);
+  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);

data/lib/skylight.rb

@@ -29,4 +29,6 @@ module Skylight
     Config
   end
 
+  Core::Probes.add_path(File.expand_path("skylight/probes", __dir__))
+
 end

data/lib/skylight/config.rb

@@ -1,5 +1,5 @@
 require 'openssl'
-require 'skylight/core/util/deploy'
+require 'skylight/util/deploy'
 require 'skylight/core/util/platform'
 require 'skylight/util/hostname'
 require 'skylight/util/ssl'
@@ -25,6 +25,9 @@ module Skylight
         # == Sql Lexer ==
         'USE_OLD_SQL_LEXER' => :use_old_sql_lexer,
 
+        # == Max Span Handling ==
+        'REPORT_MAX_SPANS_EXCEEDED' => :report_max_spans_exceeded,
+
         # == Instrumenter ==
         "IGNORED_ENDPOINT" => :ignored_endpoint,
         "IGNORED_ENDPOINTS" => :ignored_endpoints,
@@ -80,7 +83,8 @@ module Skylight
           :validation_url       => 'https://auth.skylight.io/agent/config',
           :'daemon.lazy_start'  => true,
           :hostname             => Util::Hostname.default_hostname,
-          :use_old_sql_lexer    => false
+          :use_old_sql_lexer    => false,
+          :report_max_spans_exceeded => false
         )
 
         if Core::Util::Platform::OS != 'darwin'
@@ -113,7 +117,6 @@ module Skylight
         :version,
         :root,
         :hostname,
-        :deploy_id,
         :session_token,
         :auth_url,
         :auth_http_deflate,
@@ -278,7 +281,7 @@ authentication: #{self[:authentication]}
     end
 
     def deploy
-      @deploy ||= Core::Util::Deploy.build(self)
+      @deploy ||= Util::Deploy.build(self)
     end
 
   private

data/lib/skylight/probes/sinatra_add_middleware.rb

@@ -15,6 +15,6 @@ module Skylight
       end
     end
 
-    Skylight::Core::Probes.register("Sinatra::Base", "sinatra/base", Sinatra::Probe.new)
+    Skylight::Core::Probes.register(:sinatra_add_middleware, "Sinatra::Base", "sinatra/base", Sinatra::Probe.new)
   end
 end

data/lib/skylight/railtie.rb

@@ -16,10 +16,10 @@ module Skylight
     config.skylight.config_path = "config/skylight.yml"
 
     # The probes to load
-    #   net_http, action_controller, action_view, middleware, and grape are on by default
+    #   net_http, action_controller, action_dispatch, action_view, and middleware 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']
+    config.skylight.probes = ['net_http', 'action_controller', 'action_dispatch', 'action_view', 'middleware']
 
     # The position in the middleware stack to place Skylight
     # Default is first, but can be `{ after: Middleware::Name }` or `{ before: Middleware::Name }`

data/lib/skylight/sinatra.rb

@@ -1,3 +1,2 @@
 require 'skylight'
-require 'skylight/probes/sinatra_add_middleware'
-Skylight.probe(:sinatra, :tilt, :sequel)
+Skylight.probe(:sinatra_add_middleware, :sinatra, :tilt, :sequel)

data/lib/skylight/trace.rb

@@ -1,4 +1,52 @@
 module Skylight
   class Trace < Core::Trace
+
+    def initialize(*)
+      super
+      @too_many_spans = false
+    end
+
+    def uuid
+      native_get_uuid
+    end
+
+    def uuid=(value)
+      # We can't change the UUID so just check to make sure we weren't trying to change
+      raise "unable to change uuid" unless value == uuid
+    end
+
+    def too_many_spans!
+      @too_many_spans = true
+    end
+
+    def too_many_spans?
+      !!@too_many_spans
+    end
+
+    def maybe_broken(e)
+      if e.is_a?(Skylight::MaximumTraceSpansError) && config.get(:report_max_spans_exceeded)
+        too_many_spans!
+      else
+        super
+      end
+    end
+
+    def traced
+      if too_many_spans?
+          error("[E%04d] The request exceeded the maximum number of spans allowed. It will still " \
+                  "be tracked but with reduced information. endpoint=%s", Skylight::MaximumTraceSpansError.code, endpoint)
+      end
+
+      super
+    end
+
+    private
+
+      def track_gc(*)
+        # This attempts to log another span which will fail if we have too many
+        return if too_many_spans?
+        super
+      end
+
   end
 end

data/lib/skylight/util/deploy.rb

@@ -0,0 +1,134 @@
+require 'json'
+require 'uri'
+require 'skylight/core/util/logging'
+
+module Skylight
+  module Util
+
+    module Deploy
+
+      def self.build(config)
+        DEPLOY_TYPES.each do |type|
+          deploy = type.new(config)
+          return deploy if deploy.id
+        end
+        nil
+      end
+
+      class EmptyDeploy
+
+        attr_reader :config
+        attr_reader :timestamp
+
+        def initialize(config)
+          @config = config
+          @timestamp = Time.now.to_i
+        end
+
+        def id
+          git_sha
+        end
+
+        def git_sha
+          nil
+        end
+
+        def description
+          nil
+        end
+
+        def to_query_string
+          hash = {
+            timestamp:   timestamp,
+            deploy_id:   id.to_s[0..100] # Keep this sane
+          }
+          hash[:git_sha] = git_sha[0..40] if git_sha # A valid SHA will never exceed 40
+          hash[:description] = description[0..255] if description # Avoid massive descriptions
+          URI.encode_www_form(hash)
+        end
+
+      end
+
+      class DefaultDeploy < EmptyDeploy
+        include Core::Util::Logging
+
+        def initialize(*)
+          super
+          if description && !id
+            warn "The configured deploy will be ignored as an id or git_sha must be provided."
+          end
+        end
+
+        def id
+          config.get(:'deploy.id') || git_sha
+        end
+
+        def git_sha
+          config.get(:'deploy.git_sha')
+        end
+
+        def description
+          config.get(:'deploy.description')
+        end
+
+      end
+
+      class HerokuDeploy < EmptyDeploy
+
+        def initialize(*)
+          super
+          @info = get_info
+        end
+
+        def id
+          @info ? @info['id'] : nil
+        end
+
+        def git_sha
+          @info ? @info['commit'] : nil
+        end
+
+        def description
+          @info ? @info['description'] : nil
+        end
+
+        private
+
+          def get_info
+            info_path = config[:'heroku.dyno_info_path']
+
+            if File.exist?(info_path)
+              if info = JSON.parse(File.read(info_path))
+                info['release']
+              end
+            end
+          end
+
+      end
+
+      class GitDeploy < EmptyDeploy
+
+        attr_reader :git_sha, :description
+
+        def initialize(*)
+          super
+          @git_sha, @description = get_info
+        end
+
+        private
+
+          def get_info
+            Dir.chdir(config.root) do
+              info = `git log -1 --pretty="%H %s" 2>&1`
+              info.split(" ", 2).map(&:strip) if $?.success?
+            end
+          end
+
+      end
+
+      DEPLOY_TYPES = [DefaultDeploy, HerokuDeploy, GitDeploy]
+
+    end
+
+  end
+end

data/lib/skylight/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta3
+  version: 2.0.0
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-04-25 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.beta3
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta3
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -184,11 +184,11 @@ files:
 - lib/skylight/middleware.rb
 - lib/skylight/native.rb
 - lib/skylight/native_ext_fetcher.rb
-- lib/skylight/normalizers/active_job/enqueue_at.rb
 - lib/skylight/probes/sinatra_add_middleware.rb
 - lib/skylight/railtie.rb
 - lib/skylight/sinatra.rb
 - lib/skylight/trace.rb
+- lib/skylight/util/deploy.rb
 - lib/skylight/util/hostname.rb
 - lib/skylight/util/http.rb
 - lib/skylight/util/ssl.rb
@@ -247,12 +247,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.2.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Skylight is a smart profiler for Rails, Sinatra, and other Ruby apps.

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

@@ -1,3 +0,0 @@
-warn "[DEPRECATED] [SKYLIGHT] [#{Skylight::VERSION}] Require 'skylight/core/normalizers/active_job/enqueue_at' instead of 'skylight/normalizers/active_job/enqueue_at'."
-
-require 'skylight/core/normalizers/active_job/enqueue_at'