skylight 0.9.3 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1564afa767483c0b2e5ce584e197f5ea3f72933a
-  data.tar.gz: f20f7f995bfff398ee791d73066cd0495a8bef7d
+  metadata.gz: 3a889a7a09786acddcdf866faaf84ed4862909f4
+  data.tar.gz: 5e2f48fcfcea4166894f19422b435eb82d809856
 SHA512:
-  metadata.gz: 61bb59ac6c2c256370adcc09962b3555c1b68bdedf6590926283f4398900a3a83c852b7686f693d4068666b11f6145fa70b0e3c8e82e66436c5fdf490a2dc728
-  data.tar.gz: e1dc0699037df80f0127058b15263cf718f7e1e9fe441a00296e0edd5200d1f938afb9c1e2a823c3fad5fc2a97aed9c4e15ce3566d853db85ad7488851824680
+  metadata.gz: 59381efc987947df3b1a8bff022beb0a61288c02b41124b861ea3923db126a4b38fb74100ad67b8efac86b694843fa7c70545bef02be511c9b1892d265a998fa
+  data.tar.gz: 7c433c0b9b74b350955aa27641b3ae1ac6d1a2ddd8d018f71f94302078d04e1a000c697b8f339663d8af12d2417df4b973c5f786386cb14a426865eaa9b9ea95

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.9.4 (November 23, 2015)
+
+* [FEATURE] Added instrumentation for official Mongo Ruby Driver (utilized by Mongoid 5+). Add 'mongo' to probes list to enable. 
+* [BUGFIX] SQL lexer now handles indentifiers beginning with underscores.
+* [BUGFIX] Excon instrumentation now works correctly.
+* [BUGFIX] Graceful handling of native agent failures on old OS X versions.
+* [IMPROVEMENT] Freeze some more strings for (likely very minor) performance improvements.
+* [IMPROVEMENT] Better error messages when sockdir is an NFS mount.
+* [IMPROVEMENT] On OS X, ensure that Xcode license has been approved before trying to build native agent.
+
 ## 0.9.3 (November 17, 2015)
 
 * [BUGFIX] Update SQL lexer to handle more common queries

data/ext/extconf.rb

@@ -46,6 +46,21 @@ def fail(msg, type=:error)
   end
 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
+end
+
 #
 # === Setup paths
 #

data/ext/libskylight.yml

@@ -1,6 +1,6 @@
 ---
-version: "0.7.0-629fc27"
+version: "0.7.0-ffe066b"
 checksums:
-  x86-linux:     "cd601750d0250d9e2cfed96fa9d4ac642a1b22053cf5ee5a7523da2f583fdf2d"
-  x86_64-linux:  "eef6301799be9e1e6e70f71c59ac1449f52f65cf1dfe5c996762a42f31e08d5f"
-  x86_64-darwin: "62b19c0f34e983d8d752b1b9514d427cc019cfdf2f3f6b2f1424cf06710330d8"
+  x86-linux:     "311cf34d25383d1a0c7f4611919ac78e49cbd2e227532ea9aa2b308212e9fca9"
+  x86_64-linux:  "9d4969487f16e0f1d2ed6410dc4ea408e28ec4ea157c1a56c93b0bf596600461"
+  x86_64-darwin: "4e40e9a08efa8953ed1afca07c684385fa374833a057136057bf36ef41cce55e"

data/lib/skylight/config.rb

@@ -39,6 +39,7 @@ module Skylight
 
       # == Instrumenter ==
       "IGNORED_ENDPOINT" => :'ignored_endpoint',
+      "IGNORED_ENDPOINTS" => :'ignored_endpoints',
       "SQL_MODE" => :'sql_mode',
 
       # == Skylight Remote ==
@@ -268,6 +269,8 @@ module Skylight
         end
       end
 
+      # FIXME: Why not set the sockdir_path and pidfile_path explicitly?
+      # That way we don't have to keep this in sync with the Rust repo.
       sockdir_path = self[:'daemon.sockdir_path'] || File.expand_path('.')
       pidfile_path = self[:'daemon.pidfile_path'] || File.expand_path('skylight.pid', sockdir_path)
 
@@ -283,11 +286,11 @@ module Skylight
       FileUtils.mkdir_p sockdir_path
 
       if File.exist?(pidfile)
-        if !FileTest.writable?(pidfile)
+        unless FileTest.writable?(pidfile)
           raise ConfigError, "File `#{pidfile}` not writable. Please set daemon.pidfile_path or daemon.sockdir_path in your config to a writable path"
         end
       else
-        if !FileTest.writable?(pidfile_root)
+        unless FileTest.writable?(pidfile_root)
           raise ConfigError, "Directory `#{pidfile_root}` not writable. Please set daemon.pidfile_path or daemon.sockdir_path in your config to a writable path"
         end
       end
@@ -295,6 +298,10 @@ module Skylight
       unless FileTest.writable?(sockdir_path)
         raise ConfigError, "Directory `#{sockdir_path}` not writable. Please set daemon.sockdir_path in your config to a writable path"
       end
+
+      if check_nfs(pidfile)
+        raise ConfigError, "Directory `#{sockdir_path}` is an NFS mount and will not allow sockets. Please set daemon.sockdir_path in your config to a non-NFS path."
+      end
     end
 
     def key?(key)
@@ -420,8 +427,16 @@ authentication: #{self[:authentication]}
     def ignored_endpoints
       @ignored_endpoints ||=
         begin
+          ignored_endpoints = get(:'ignored_endpoints')
+
+          # If, for some odd reason you have a comma in your endpoint name, use the
+          # YML config instead.
+          if ignored_endpoints.is_a?(String)
+            ignored_endpoints = ignored_endpoints.split(/\s*,\s*/)
+          end
+
           val = Array(get(:'ignored_endpoint'))
-          val.concat(Array(get(:'ignored_endpoints')))
+          val.concat(Array(ignored_endpoints))
           val
         end
     end
@@ -470,6 +485,11 @@ authentication: #{self[:authentication]}
 
   private
 
+    def check_nfs(path)
+      # Should work on most *nix, though not on OS X
+      `stat -f -L -c %T #{path} 2>&1`.strip == 'nfs'
+    end
+
     def load_logger
       unless l = @logger
         out = get(:'log_file')

data/lib/skylight/core.rb

@@ -86,7 +86,7 @@ module Skylight
   end
 
   # Instrument
-  def self.instrument(opts = DEFAULT_OPTIONS)
+  def self.instrument(opts = DEFAULT_OPTIONS, &block)
     unless inst = Instrumenter.instance
       return yield if block_given?
       return
@@ -105,11 +105,7 @@ module Skylight
       desc        = nil
     end
 
-    if block_given?
-      inst.instrument(category, title, desc) { yield }
-    else
-      inst.instrument(category, title, desc)
-    end
+    inst.instrument(category, title, desc, &block)
   end
 
   # Temporarily disable

data/lib/skylight/native.rb

@@ -32,6 +32,9 @@ module Skylight
         raise LoadError, "Cannot find native extensions in #{libskylight_path}"
       end
     end
+  rescue RuntimeError => e
+    # Old versions of OS X can have dlerrors, just treat it like a missing native
+    raise if skylight_required || e.message !~ /dlerror/
   rescue LoadError => e
     raise if skylight_required
   end

data/lib/skylight/normalizers/active_record/sql.rb

@@ -13,11 +13,11 @@ module Skylight
 
         def normalize(trace, name, payload)
           case payload[:name]
-          when "SCHEMA", "CACHE"
+          when "SCHEMA".freeze, "CACHE".freeze
             return :skip
           else
             name  = CAT
-            title = payload[:name] || "SQL"
+            title = payload[:name] || "SQL".freeze
           end
 
           binds = payload[:binds]
@@ -41,9 +41,9 @@ module Skylight
 
         def extract_binds(payload, precalculated)
           case config[:sql_mode]
-          when 'rust'
+          when 'rust'.freeze
             extract_rust(payload)
-          when 'ruby'
+          when 'ruby'.freeze
             extract_ruby(payload, precalculated)
           else
             raise "Unrecognized sql_mode: #{config.sql_mode}"

data/lib/skylight/normalizers/moped/query.rb

@@ -15,11 +15,11 @@ module Skylight
           type = operation && operation.class.to_s =~ /^Moped::Protocol::(.+)$/ ? $1 : nil
 
           case type
-          when "Query"       then normalize_query(operation)
-          when "GetMore"     then normalize_get_more(operation)
-          when "Insert"      then normalize_insert(operation)
-          when "Update"      then normalize_update(operation)
-          when "Delete"      then normalize_delete(operation)
+          when "Query".freeze   then normalize_query(operation)
+          when "GetMore".freeze then normalize_get_more(operation)
+          when "Insert".freeze  then normalize_insert(operation)
+          when "Update".freeze  then normalize_update(operation)
+          when "Delete".freeze  then normalize_delete(operation)
           else :skip
           end
         end
@@ -27,7 +27,7 @@ module Skylight
       private
 
         def normalize_query(operation)
-          title = normalize_title("QUERY", operation)
+          title = normalize_title("QUERY".freeze, operation)
 
           hash = extract_binds(operation.selector)
           description = hash.to_json
@@ -36,19 +36,19 @@ module Skylight
         end
 
         def normalize_get_more(operation)
-          title = normalize_title("GET_MORE", operation)
+          title = normalize_title("GET_MORE".freeze, operation)
 
           [CAT, title, nil]
         end
 
         def normalize_insert(operation)
-          title = normalize_title("INSERT", operation)
+          title = normalize_title("INSERT".freeze, operation)
 
           [CAT, title, nil]
         end
 
         def normalize_update(operation)
-          title = normalize_title("UPDATE", operation)
+          title = normalize_title("UPDATE".freeze, operation)
 
           selector_hash = extract_binds(operation.selector)
           update_hash = extract_binds(operation.update)
@@ -59,7 +59,7 @@ module Skylight
         end
 
         def normalize_delete(operation)
-          title = normalize_title("DELETE", operation)
+          title = normalize_title("DELETE".freeze, operation)
 
           hash = extract_binds(operation.selector)
           description = hash.to_json
@@ -78,17 +78,13 @@ module Skylight
             if v.is_a?(Hash)
               ret[k] = extract_binds(v)
             else
-              ret[k] = '?'
+              ret[k] = '?'.freeze
             end
           end
 
           ret
         end
 
-        def stringify(value)
-          value.is_a?(Regexp) ? value.inspect : value.to_s
-        end
-
       end
     end
   end

data/lib/skylight/probes/excon/middleware.rb

@@ -53,8 +53,9 @@ module Skylight
           end
 
           def end_instrumentation(datum)
-            @requests[datum.object_id].done
-            @requests.delete(datum)
+            if request = @requests.delete(datum.object_id)
+              Skylight.done(request)
+            end
           rescue Exception => e
             error "failed to end instrumentation for Excon; msg=%s", e.message
           end

data/lib/skylight/probes/mongo.rb

@@ -0,0 +1,159 @@
+module Skylight
+  module Probes
+    module Mongo
+      class Probe
+        def install
+          ::Mongo::Monitoring::Global.subscribe(::Mongo::Monitoring::COMMAND, Subscriber.new)
+        end
+      end
+
+      class Subscriber
+        include Skylight::Util::Logging
+
+        COMMANDS = [:insert, :find, :count, :distinct, :update, :findandmodify, :delete].freeze
+
+        COMMAND_NAMES = {
+          findandmodify: 'findAndModify'.freeze
+        }.freeze
+
+        def initialize
+          @events = {}
+        end
+
+        def started(event)
+          begin_instrumentation(event)
+        end
+
+        def succeeded(event)
+          end_instrumentation(event)
+        end
+
+        def failed(event)
+          end_instrumentation(event)
+        end
+
+        # For logging
+        def config
+          instrumenter = Skylight::Instrumenter.instance
+          instrumenter ? instrumenter.config : nil
+        end
+
+        private
+
+          def begin_instrumentation(event)
+            return unless COMMANDS.include?(event.command_name.to_sym)
+
+            command_name = COMMAND_NAMES[event.command_name] || event.command_name
+
+            title = "#{event.database_name}.#{command_name}"
+
+            command = event.command
+
+            # Not sure if this will always exist
+            # Delete so the description will be less redundant
+            if target = command[event.command_name]
+              title << " #{target}"
+            end
+
+            payload = {}
+
+            # Ruby Hashes are ordered based on insertion so do the most important ones first
+
+            add_value('key'.freeze, command, payload)
+            add_bound('query'.freeze, command, payload)
+            add_bound('filter'.freeze, command, payload)
+            add_value('sort'.freeze, command, payload)
+
+            if event.command_name == :findandmodify
+              add_bound('update'.freeze, command, payload)
+            end
+
+            add_value('remove'.freeze, command, payload)
+            add_value('new'.freeze, command, payload)
+
+            if updates = command['updates'.freeze]
+              # AFAICT the gem generally just sends one item in the updates array
+              update = updates[0]
+              update_payload = {}
+              add_bound('q'.freeze, update, update_payload)
+              add_bound('u'.freeze, update, update_payload)
+              add_value('multi'.freeze, update, update_payload)
+              add_value('upsert'.freeze, update, update_payload)
+
+              payload['updates'.freeze] = [update_payload]
+
+              if updates.length > 1
+                payload['updates'.freeze] << '...'
+              end
+            end
+
+            if deletes = command['deletes'.freeze]
+              # AFAICT the gem generally just sends one item in the updates array
+              delete = deletes[0]
+              delete_payload = {}
+              add_bound('q'.freeze, delete, delete_payload)
+              add_value('limit'.freeze, delete, delete_payload)
+
+              payload['deletes'.freeze] = [delete_payload]
+
+              if deletes.length > 1
+                payload['deletes'.freeze] << '...'
+              end
+            end
+
+
+            # We're ignoring documents from insert because they could have completely inconsistent
+            # format which would make it hard to merge.
+
+            opts = {
+              category:    "db.mongo.command".freeze,
+              title:       title,
+              description: payload.empty? ? nil : payload.to_json
+            }
+
+            @events[event.operation_id] = Skylight.instrument(opts)
+          rescue Exception => e
+            error "failed to begin instrumentation for Mongo; msg=%s", e.message
+          end
+
+          def end_instrumentation(event)
+            if original_event = @events.delete(event.operation_id)
+              Skylight.done(original_event)
+            end
+          rescue Exception => e
+            error "failed to end instrumentation for Mongo; msg=%s", e.message
+          end
+
+          def add_value(key, command, payload)
+            if command.has_key?(key)
+              value = command[key]
+              payload[key] = value
+            end
+          end
+
+          def add_bound(key, command, payload)
+            if value = command[key]
+              payload[key] = extract_binds(value)
+            end
+          end
+
+          def extract_binds(hash)
+            ret = {}
+
+            hash.each do |k,v|
+              if v.is_a?(Hash)
+                ret[k] = extract_binds(v)
+              else
+                ret[k] = '?'.freeze
+              end
+            end
+
+            ret
+          end
+
+      end
+    end
+
+    register("Mongo", "mongo", Mongo::Probe.new)
+  end
+end

data/lib/skylight/probes/mongoid.rb

@@ -0,0 +1,21 @@
+module Skylight
+  module Probes
+    module Mongoid
+      class Probe
+
+        def install
+          require 'mongoid/version'
+          version = Gem::Version.new(::Mongoid::VERSION)
+
+          if version < Gem::Version.new("5.0")
+            require 'skylight/probes/moped'
+          else
+            require 'skylight/probes/mongo'
+          end
+        end
+      end
+    end
+
+    register("Mongoid", "mongoid", Mongoid::Probe.new)
+  end
+end

data/lib/skylight/probes/moped.rb

@@ -0,0 +1,31 @@
+module Skylight
+  module Probes
+    module Moped
+      class Probe
+
+        def install
+          ::Moped::Instrumentable.module_eval do
+            alias instrument_without_sk instrument
+
+            def instrument(*args, &block)
+              # Mongoid sets the instrumenter to AS::N
+              if instrumenter == ActiveSupport::Notifications
+                asn_block = block
+              else
+                # If the instrumenter hasn't been changed to AS::N use both
+                asn_block = Proc.new do
+                  ActiveSupport::Notifications.instrument(*args, &block)
+                end
+              end
+
+              instrument_without_sk(*args, &asn_block)
+            end
+          end
+        end
+
+      end
+    end
+
+    register("Moped", "moped", Moped::Probe.new)
+  end
+end

data/lib/skylight/railtie.rb

@@ -66,12 +66,12 @@ module Skylight
       end
 
       config = Config.load(file: path, environment: Rails.env.to_s)
-      config['root'] = Rails.root
+      config[:root] = Rails.root
 
       configure_logging(config, app)
 
-      config['daemon.sockdir_path'] ||= tmp
-      config['normalizers.render.view_paths'] = existent_paths(app.config.paths["app/views"]) + [Rails.root.to_s]
+      config[:'daemon.sockdir_path'] ||= tmp
+      config[:'normalizers.render.view_paths'] = existent_paths(app.config.paths["app/views"]) + [Rails.root.to_s]
       config.validate!
       config
 

data/lib/skylight/trace.rb

@@ -30,9 +30,7 @@ module Skylight
       @notifications = []
 
       # create the root node
-      @root = native_start_span(native_get_started_at, cat)
-      native_span_set_title(@root, title) if title
-      native_span_set_description(@root, desc) if desc
+      @root = start(native_get_started_at, cat, title, desc, normalize: false)
 
       @gc = config.gc.track unless ENV.key?("SKYLIGHT_DISABLE_GC_TRACKING")
     end
@@ -140,15 +138,18 @@ module Skylight
 
   private
 
-    def start(time, cat, title, desc)
-      sp = native_start_span(self.class.normalize_time(time), cat.to_s)
+    def start(time, cat, title, desc, opts={})
+      time = self.class.normalize_time(time) unless opts[:normalize] == false
+
+      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
       sp
     end
 
     def stop(span, time)
-      native_stop_span(span, self.class.normalize_time(time))
+      time = self.class.normalize_time(time)
+      native_stop_span(span, time)
       nil
     end
 

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '0.9.3'
+  VERSION = '0.9.4'
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.9.4
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -86,6 +86,9 @@ files:
 - lib/skylight/probes/excon.rb
 - lib/skylight/probes/excon/middleware.rb
 - lib/skylight/probes/grape.rb
+- lib/skylight/probes/mongo.rb
+- lib/skylight/probes/mongoid.rb
+- lib/skylight/probes/moped.rb
 - lib/skylight/probes/net_http.rb
 - lib/skylight/probes/redis.rb
 - lib/skylight/probes/sequel.rb