skylight 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14beed2152c9792a9f554eb74f63d5172eb92a11
-  data.tar.gz: '02378ab496fdf3483f3bef6fc37ec864a7deb0bc'
+  metadata.gz: 1a675aa7e9f2f19c9cc336569def0ffcf820876b
+  data.tar.gz: 6f9c5b843ef8ffc5a31fa936692468afde1a22c5
 SHA512:
-  metadata.gz: 4ea715250be7e1f2c7d7f8a3e6772b3b6ea57f56d305cfb3a1989e2e912f6d560b86fc74d756cea5f4ef72660796427ef55805176183507147680546a256cc4c
-  data.tar.gz: 80dc5105a4e76dcc9ac625a37260adbbcb2b565ac198fb32d47cf3b7d318a36ef129a41565d0e0ccae8a1c911d550718c056b542a11547b60aea7102577f40ba
+  metadata.gz: 31694926e3ab83229d89d13d5ef7605011c7590def3eb31b0f1be0a1830069a95b3bc3e58371b537287c14fa95840426cf6b2624f2082e0ca07dc6d2a00de257
+  data.tar.gz: db16281e6cf0ef307e5bf500bcbe58bf0f5e66bf7ebac3d743a81fc6239f291d1740793673e2426a9fe100b2e3aaff3d24c6c4dbaf9d9bfebd1bc80a7f39f748

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 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.
+* [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.
+
 ## 1.4.4 (November 7, 2017)
 
 * [BUGFIX] The minimum glibc requirement was errorneously bumped to 2.15. We have returned it to 2.5.

data/lib/skylight/compat.rb

@@ -45,3 +45,32 @@ if defined?(ActiveSupport::Notifications::Fanout::Subscribers::Evented)
     end
   end
 end
+
+require 'rack'
+require 'rack/etag'
+if Rack.release.to_f < 1.6
+  # Backport `close` compliance:
+  #   https://github.com/rack/rack/commit/4d9e1b228dacbcf1552c68e2ab2f21274fdcecb4
+  Rack::ETag.class_eval do
+    def call(env)
+      status, headers, body = @app.call(env)
+
+      if etag_status?(status) && etag_body?(body) && !skip_caching?(headers)
+        original_body = body
+        digest, body = digest_body(body)
+        original_body.close if original_body.respond_to?(:close)
+        headers['ETag'] = %("#{digest}") if digest
+      end
+
+      unless headers['Cache-Control']
+        if digest
+          headers['Cache-Control'] = @cache_control if @cache_control
+        else
+          headers['Cache-Control'] = @no_cache_control if @no_cache_control
+        end
+      end
+
+      [status, headers, body]
+    end
+  end
+end

data/lib/skylight/core.rb

@@ -89,12 +89,6 @@ module Skylight
     end
   end
 
-  # End a trace
-  def self.done(span)
-    return unless inst = Instrumenter.instance
-    inst.done(span)
-  end
-
   # Instrument
   def self.instrument(opts = DEFAULT_OPTIONS, &block)
     unless inst = Instrumenter.instance
@@ -118,6 +112,12 @@ module Skylight
     inst.instrument(category, title, desc, &block)
   end
 
+  # End a span
+  def self.done(span)
+    return unless inst = Instrumenter.instance
+    inst.done(span)
+  end
+
   # Temporarily disable
   def self.disable
     unless inst = Instrumenter.instance

data/lib/skylight/middleware.rb

@@ -26,7 +26,8 @@ module Skylight
         @closed
       end
 
-      # N.B. This method is a special case to address the bug described by #434.
+      # N.B. This method is a special case to address the bug described by
+      # https://github.com/rack/rack/issues/434.
       # We are applying this special case for #each only. Future bugs of this
       # class will be handled by requesting users to patch their ruby
       # implementation, to save adding too many methods in this class.
@@ -86,9 +87,6 @@ module Skylight
           t { "middleware exception: #{trace}"}
           trace.submit if trace
           raise
-        ensure
-          t { "middleware release: #{trace}"}
-          trace.release if trace
         end
       end
     end

data/lib/skylight/normalizers.rb

@@ -160,6 +160,13 @@ module Skylight
       require "skylight/normalizers/#{file}"
     end
 
+    # Coach instrumentation is only available in Ruby 2+
+    if RUBY_VERSION.split.first.to_i > 1
+      %w(coach/handler_finish coach/middleware_finish).each do |file|
+        require "skylight/normalizers/#{file}"
+      end
+    end
+
     # The following are not required by default as they are of dubious usefulness:
     # - active_job/enqueue_at
   end

data/lib/skylight/normalizers/coach/handler_finish.rb

@@ -0,0 +1,36 @@
+module Skylight
+  module Normalizers
+    module Coach
+      class HandlerFinish < Normalizer
+        register "coach.handler.finish"
+
+        CAT = "app.coach.handler".freeze
+
+        # See information on the events Coach emits here:
+        # https://github.com/gocardless/coach#instrumentation
+
+        # Run when the handler first starts, we need to set the trace endpoint to be the
+        # handler name.
+        #
+        # We can expect the payload to have the :middleware key.
+        def normalize(trace, name, payload)
+          trace.endpoint = payload[:middleware]
+          [ CAT, payload[:middleware], nil ]
+        end
+
+        def normalize_after(trace, span, name, payload)
+          return unless config.enable_segments?
+
+          segments = []
+
+          response_status = payload.fetch(:response, {}).fetch(:status, '').to_s
+          segments << "error" if response_status.start_with?('4', '5')
+
+          if segments.any?
+            trace.endpoint += "<sk-segment>#{segments.join("+")}</sk-segment>"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/coach/middleware_finish.rb

@@ -0,0 +1,23 @@
+module Skylight
+  module Normalizers
+    module Coach
+      class MiddlewareFinish < Normalizer
+        register "coach.middleware.finish"
+
+        CAT = "app.coach.middleware".freeze
+
+        # See information on the events Coach emits here:
+        # https://github.com/gocardless/coach#instrumentation
+
+        # Called whenever a new middleware is executed. We can expect this to happen
+        # within a Coach::Handler.
+        #
+        # We can expect the payload to have the :middleware key.
+        def normalize(trace, name, payload)
+          trace.endpoint = payload[:middleware]
+          [ CAT, payload[:middleware], nil ]
+        end
+      end
+    end
+  end
+end

data/lib/skylight/normalizers/faraday/request.rb

@@ -28,6 +28,8 @@ module Skylight
           uri.host, uri.port, uri.path, uri.query)
           description = opts[:title]
 
+          # We use "Faraday" as the title to differentiate it in the UI in 
+          # case it's wrapping or is wrapped by another HTTP backend
           [opts[:category], "Faraday", description]
         end
       end

data/lib/skylight/railtie.rb

@@ -117,7 +117,11 @@ module Skylight
     end
 
     def activate?
-      environments.include?(Rails.env.to_s)
+      if ENV.key?("SKYLIGHT_ENABLED")
+        ENV["SKYLIGHT_ENABLED"] !~ /^false$/i
+      else
+        environments.include?(Rails.env.to_s)
+      end
     end
 
     def load_probes

data/lib/skylight/trace.rb

@@ -29,6 +29,8 @@ module Skylight
 
       @notifications = []
 
+      @spans = []
+
       # create the root node
       @root = start(native_get_started_at, cat, title, desc, normalize: false)
 
@@ -132,7 +134,7 @@ module Skylight
 
       @instrumenter.process(self)
     rescue Exception => e
-      error e
+      error e.message
       t { e.backtrace.join("\n") }
     end
 
@@ -144,10 +146,22 @@ module Skylight
       sp = native_start_span(time, cat.to_s)
       native_span_set_title(sp, title.to_s) if title
       native_span_set_description(sp, desc.to_s) if desc
+
+      @spans << sp
+      t { "started span: #{sp} - #{cat}, #{title}" }
+
       sp
     end
 
     def stop(span, time)
+      t { "stopping span: #{span}" }
+
+      expected = @spans.pop
+      unless span == expected
+        error "invalid span nesting"
+        t { "expected=#{expected}, actual=#{span}" }
+      end
+
       time = self.class.normalize_time(time)
       native_stop_span(span, time)
       nil

data/lib/skylight/util/logging.rb

@@ -78,8 +78,8 @@ module Skylight
       # @param msg (see #log)
       # @param args (see #log)
       def error(msg, *args)
-        raise sprintf(msg, *args) if ENV['SKYLIGHT_RAISE_ON_ERROR']
         log :error, msg, *args
+        raise sprintf(msg, *args) if ENV['SKYLIGHT_RAISE_ON_ERROR']
       end
 
       alias log_trace trace

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '1.4.4'
+  VERSION = '1.5.0'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,8 @@ files:
 - lib/skylight/normalizers/active_support/cache_read.rb
 - lib/skylight/normalizers/active_support/cache_read_multi.rb
 - lib/skylight/normalizers/active_support/cache_write.rb
+- lib/skylight/normalizers/coach/handler_finish.rb
+- lib/skylight/normalizers/coach/middleware_finish.rb
 - lib/skylight/normalizers/couch_potato/query.rb
 - lib/skylight/normalizers/default.rb
 - lib/skylight/normalizers/elasticsearch/request.rb