skylight 0.2.0.beta.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c34ce7c2bd1892ae5f05d4e9cc0ee5054cbb9f1
-  data.tar.gz: ce556c192f1f5b1d72be7680d358d8373a80cfe7
+  metadata.gz: 01c568e8a8c6485f4257cc1cbd29c7649fa11397
+  data.tar.gz: 15a33396cd41de105c07c3879c65fbe7a0c30ea3
 SHA512:
-  metadata.gz: a9b4be609c1d76a2075cbb9ad116d724fc35be01dfe133e00978c3b09a8e32765a78d2db0ccb2f3c43a60182891a57e42ee8bcecd53ec8d50750a6fc2f38f138
-  data.tar.gz: 082e9dd9bfc81ea18b53b830c52bf26796b90943c6af65b78723b21a8d1207478f87ac835a8386c4f0741a4fb97d9d89200ed2746b8fdadb8d9945b869c1a975
+  metadata.gz: 0dda0d97a94a3e6366110f8a88fa50c16abede270e0f1eae2908f80aeef5b4c279c948e53cc5e52c89f815d906aed9c05c55abe22bdd6ebb6a00a15b2cd8acd6
+  data.tar.gz: e9563e4dda34af825883d28260d098176bc30bb7217fdf6f2a845472a6c1a9a7d2bdf26ba92988b6e46eac568cbcedc2094977add1e2f5e1845db4cc8475eedb

data/CHANGELOG.md

@@ -1,4 +1,13 @@
-## unreleased ##
+## 0.2.0 (December 3, 2013)
+
+* Added Probes, initially Net::HTTP and Excon
+* Wide-ranging memory cleanup
+* Better resiliance to binary and encoding errors
+* Add support for disabling
+* De-dupe rendering instrumentation better
+* Fix send_file event to not spew a gazillion nodes
+* Rails 3.0 compatibility
+* Detailed SQL annotations
 
 ## 0.1.8 (July 19, 2013)
 

data/lib/skylight.rb

@@ -35,12 +35,17 @@ module Skylight
     autoload :Clock,         'skylight/util/clock'
     autoload :Gzip,          'skylight/util/gzip'
     autoload :HTTP,          'skylight/util/http'
+    autoload :Inflector,     'skylight/util/inflector'
     autoload :Logging,       'skylight/util/logging'
     autoload :Queue,         'skylight/util/queue'
     autoload :Task,          'skylight/util/task'
     autoload :UniformSample, 'skylight/util/uniform_sample'
   end
 
+  module Formatters
+    autoload :HTTP, 'skylight/formatters/http'
+  end
+
   # ==== Vendor ====
   autoload :Beefcake, 'skylight/vendor/beefcake'
 
@@ -127,4 +132,6 @@ module Skylight
   if defined?(Rails)
     require 'skylight/railtie'
   end
+
+  require 'skylight/probes'
 end

data/lib/skylight/config.rb

@@ -255,6 +255,10 @@ authentication: #{self[:authentication]}
       @gc ||= GC.new(self, get('gc.profiler', VM::GC.new))
     end
 
+    def constant_flush?
+      get('test.constant_flush')
+    end
+
     def root
       self[:root] || Dir.pwd
     end

data/lib/skylight/formatters/http.rb

@@ -0,0 +1,32 @@
+module Skylight
+  module Formatters
+    module HTTP
+
+      def self.build_opts(method, scheme, host, port, path, query)
+        category    = "api.http.#{method.downcase}"
+        title       = "#{method.upcase} #{host || path}"
+        description = "#{method.upcase} #{build_url(scheme, host, port, path, query)}"
+
+        { category: category, title: title, description: description }
+      end
+
+      def self.build_url(scheme, host, port, path, query)
+        url = ''
+        if scheme
+          url << "#{scheme}://"
+        end
+        if host
+          url << host
+        end
+        if port
+          url << ":#{port}"
+        end
+        url << path
+        if query
+          url << "?#{query}"
+        end
+        url
+      end
+    end
+  end
+end

data/lib/skylight/normalizers.rb

@@ -78,7 +78,8 @@ module Skylight
 
       SEPARATOR_BYTE = File::SEPARATOR.ord
 
-      if File::NULL == "NUL"
+      if File.const_defined?(:NULL) ? File::NULL == "NUL" : RbConfig::CONFIG['host_os'] =~ /mingw|mswin32/
+        # This is a DOSish environment
         ALT_SEPARATOR_BYTE = File::ALT_SEPARATOR && File::ALT_SEPARATOR.ord
         COLON_BYTE = ":".ord
         def absolute_path?(path)

data/lib/skylight/probes.rb

@@ -0,0 +1,90 @@
+# skylight/probes.rb
+
+module Skylight
+  module Probes
+
+    class ProbeRegistration
+      attr_reader :klass_name, :require_paths, :probe
+
+      def initialize(klass_name, require_paths, probe)
+        @klass_name = klass_name
+        @require_paths = Array(require_paths)
+        @probe = probe
+      end
+
+      def install
+        probe.install
+      end
+    end
+
+    def self.require_hooks
+      @require_hooks ||= {}
+    end
+
+    def self.installed
+      @installed ||= {}
+    end
+
+    def self.is_available?(klass_name)
+      !!Skylight::Util::Inflector.safe_constantize(klass_name)
+    end
+
+    def self.register(*args)
+      registration = ProbeRegistration.new(*args)
+
+      if is_available?(registration.klass_name)
+        installed[registration.klass_name] = registration
+        registration.install
+      else
+        register_require_hook(registration)
+      end
+    end
+
+    def self.require_hook(require_path)
+      registration = lookup_by_require_path(require_path)
+      return unless registration
+
+      # Double check constant is available
+      if is_available?(registration.klass_name)
+        installed[registration.klass_name] = registration
+        registration.install
+
+        # Don't need this to be called again
+        unregister_require_hook(registration)
+      end
+    end
+
+    def self.register_require_hook(registration)
+      registration.require_paths.each do |p|
+        require_hooks[p] = registration
+      end
+    end
+
+    def self.unregister_require_hook(registration)
+      registration.require_paths.each do |p|
+        require_hooks.delete(p)
+      end
+    end
+
+    def self.lookup_by_require_path(require_path)
+      require_hooks[require_path]
+    end
+  end
+end
+
+# Allow hooking require
+module ::Kernel
+  alias require_without_sk require
+
+  def require(name)
+    ret = require_without_sk(name)
+
+    begin
+      Skylight::Probes.require_hook(name)
+    rescue Exception
+      # FIXME: Log these errors
+    end
+
+    ret
+  end
+end

data/lib/skylight/probes/excon.rb

@@ -0,0 +1,19 @@
+module Skylight
+  module Probes
+    module Excon
+      class Probe
+        def install
+          # Don't require until installation since it depends on Excon being loaded
+          require 'skylight/probes/excon/middleware'
+
+          idx = ::Excon.defaults[:middlewares].index(::Excon::Middleware::Instrumentor)
+
+          # TODO: Handle possibility of idx being nil
+          ::Excon.defaults[:middlewares].insert(idx, Skylight::Probes::Excon::Middleware)
+        end
+      end
+    end
+
+    register("Excon", "excon", Excon::Probe.new)
+  end
+end

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

@@ -0,0 +1,62 @@
+module Skylight
+  module Probes
+    module Excon
+      class Middleware < ::Excon::Middleware::Base
+
+        include Util::Logging
+
+        def initialize(*)
+          @requests = {}
+          super
+        end
+
+        # TODO:
+        # - Consider whether a LIFO queue would be sufficient
+        # - Check that errors can't be called without a request
+
+        def request_call(datum)
+          begin_instrumentation(datum)
+          super
+        end
+
+        def response_call(datum)
+          super
+        ensure
+          end_instrumentation(datum)
+        end
+
+        def error_call(datum)
+          super
+        ensure
+          end_instrumentation(datum)
+        end
+
+        private
+
+          def begin_instrumentation(datum)
+            method = datum[:method].to_s
+            scheme = datum[:scheme]
+            host   = datum[:host]
+            # TODO: Maybe don't show other default ports like 443
+            port   = datum[:port] != 80 ? datum[:port] : nil
+            path   = datum[:path]
+            query  = datum[:query]
+
+            opts = Formatters::HTTP.build_opts(method, scheme, host, port, path, query)
+
+            @requests[datum.object_id] = Skylight.instrument(opts)
+          rescue Exception => e
+            error "failed to begin instrumentation for Excon; msg=%s", e.message
+          end
+
+          def end_instrumentation(datum)
+            @requests[datum.object_id].done
+            @requests.delete(datum)
+          rescue Exception => e
+            error "failed to end instrumentation for Excon; msg=%s", e.message
+          end
+
+      end
+    end
+  end
+end

data/lib/skylight/probes/net_http.rb

@@ -0,0 +1,42 @@
+module Skylight
+  module Probes
+    module NetHTTP
+      class Probe
+        def install
+          Net::HTTP.class_eval do
+            alias request_without_sk request
+
+            def request(req, body = nil, &block)
+              unless started?
+                return request_without_sk(req, body, &block)
+              end
+
+              method = req.method
+
+              # req['host'] also includes special handling for default ports
+              host, port = req['host'] ? req['host'].split(':') : nil
+
+              # If we're connected with a persistent socket
+              host ||= self.address
+              port ||= self.port
+
+              path   = req.path
+              scheme = use_ssl? ? "https" : "http"
+
+              # Contained in the path
+              query  = nil
+
+              opts = Formatters::HTTP.build_opts(method, scheme, host, port, path, query)
+
+              Skylight.instrument(opts) do
+                request_without_sk(req, body, &block)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    register("Net::HTTP", "net/http", NetHTTP::Probe.new)
+  end
+end

data/lib/skylight/railtie.rb

@@ -11,8 +11,13 @@ module Skylight
     # The path to the configuration file
     config.skylight.config_path = "config/skylight.yml"
 
+    # The probes to load
+    config.skylight.probes = []
+
     initializer 'skylight.configure' do |app|
       if activate?
+        load_probes
+
         if config = load_skylight_config(app)
           Instrumenter.start!(config)
           app.middleware.insert 0, Middleware
@@ -85,5 +90,12 @@ module Skylight
     def activate?
       environments.include?(Rails.env.to_s)
     end
+
+    def load_probes
+      probes = config.skylight.probes || []
+      probes.each do |p|
+        require 'skylight/probes/#{p}'
+      end
+    end
   end
 end

data/lib/skylight/util/inflector.rb

@@ -0,0 +1,107 @@
+module Skylight
+  module Util
+    module Inflector
+      extend self
+
+      # From https://github.com/rails/rails/blob/f8e5022c73679f41db9bb6743179bab4571fb28e/activesupport/lib/active_support/inflector/methods.rb
+
+      # Tries to find a constant with the name specified in the argument string.
+      #
+      #   'Module'.constantize     # => Module
+      #   'Test::Unit'.constantize # => Test::Unit
+      #
+      # The name is assumed to be the one of a top-level constant, no matter
+      # whether it starts with "::" or not. No lexical context is taken into
+      # account:
+      #
+      #   C = 'outside'
+      #   module M
+      #     C = 'inside'
+      #     C               # => 'inside'
+      #     'C'.constantize # => 'outside', same as ::C
+      #   end
+      #
+      # NameError is raised when the name is not in CamelCase or the constant is
+      # unknown.
+      def constantize(camel_cased_word)
+        names = camel_cased_word.split('::')
+
+        # Trigger a builtin NameError exception including the ill-formed constant in the message.
+        Object.const_get(camel_cased_word) if names.empty?
+
+        # Remove the first blank element in case of '::ClassName' notation.
+        names.shift if names.size > 1 && names.first.empty?
+
+        names.inject(Object) do |constant, name|
+          if constant == Object
+            constant.const_get(name)
+          else
+            candidate = constant.const_get(name)
+            next candidate if constant.const_defined?(name, false)
+            next candidate unless Object.const_defined?(name)
+
+            # Go down the ancestors to check it it's owned
+            # directly before we reach Object or the end of ancestors.
+            constant = constant.ancestors.inject do |const, ancestor|
+              break const    if ancestor == Object
+              break ancestor if ancestor.const_defined?(name, false)
+              const
+            end
+
+            # owner is in Object, so raise
+            constant.const_get(name, false)
+          end
+        end
+      end
+
+      # Tries to find a constant with the name specified in the argument string.
+      #
+      #   'Module'.safe_constantize     # => Module
+      #   'Test::Unit'.safe_constantize # => Test::Unit
+      #
+      # The name is assumed to be the one of a top-level constant, no matter
+      # whether it starts with "::" or not. No lexical context is taken into
+      # account:
+      #
+      #   C = 'outside'
+      #   module M
+      #     C = 'inside'
+      #     C                    # => 'inside'
+      #     'C'.safe_constantize # => 'outside', same as ::C
+      #   end
+      #
+      # +nil+ is returned when the name is not in CamelCase or the constant (or
+      # part of it) is unknown.
+      #
+      #   'blargle'.safe_constantize  # => nil
+      #   'UnknownModule'.safe_constantize  # => nil
+      #   'UnknownModule::Foo::Bar'.safe_constantize  # => nil
+      def safe_constantize(camel_cased_word)
+        constantize(camel_cased_word)
+      rescue NameError => e
+        raise unless e.message =~ /(uninitialized constant|wrong constant name) #{const_regexp(camel_cased_word)}$/ ||
+          e.name.to_s == camel_cased_word.to_s
+      rescue ArgumentError => e
+        raise unless e.message =~ /not missing constant #{const_regexp(camel_cased_word)}\!$/
+      end
+
+      private
+
+      # Mount a regular expression that will match part by part of the constant.
+      #
+      #   const_regexp("Foo::Bar::Baz") # => /Foo(::Bar(::Baz)?)?/
+      #   const_regexp("::")            # => /::/
+      def const_regexp(camel_cased_word) #:nodoc:
+        parts = camel_cased_word.split("::")
+
+        return Regexp.escape(camel_cased_word) if parts.empty?
+
+        last  = parts.pop
+
+        parts.reverse.inject(last) do |acc, part|
+          part.empty? ? acc : "#{part}(::#{acc})?"
+        end
+      end
+    end
+  end
+end

data/lib/skylight/version.rb

@@ -1,4 +1,4 @@
 module Skylight
-  VERSION = '0.2.0.beta.4'
+  VERSION = '0.2.0'
 end
 

data/lib/skylight/worker/collector.rb

@@ -173,6 +173,7 @@ module Skylight
         end
 
         def should_flush?(now)
+          return true if @config.constant_flush?
           now >= @flush_at
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 0.2.0.beta.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,7 +24,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-description: Currently in pre-alpha.
+description: 
 email:
 - engineering@tilde.io
 executables:
@@ -38,6 +38,7 @@ files:
 - lib/skylight/compat.rb
 - lib/skylight/config.rb
 - lib/skylight/data/cacert.pem
+- lib/skylight/formatters/http.rb
 - lib/skylight/gc.rb
 - lib/skylight/helpers.rb
 - lib/skylight/instrumenter.rb
@@ -60,12 +61,17 @@ files:
 - lib/skylight/normalizers/render_template.rb
 - lib/skylight/normalizers/send_file.rb
 - lib/skylight/normalizers/sql.rb
+- lib/skylight/probes.rb
+- lib/skylight/probes/excon.rb
+- lib/skylight/probes/excon/middleware.rb
+- lib/skylight/probes/net_http.rb
 - lib/skylight/railtie.rb
 - lib/skylight/subscriber.rb
 - lib/skylight/util/allocation_free.rb
 - lib/skylight/util/clock.rb
 - lib/skylight/util/gzip.rb
 - lib/skylight/util/http.rb
+- lib/skylight/util/inflector.rb
 - lib/skylight/util/logging.rb
 - lib/skylight/util/queue.rb
 - lib/skylight/util/task.rb
@@ -149,13 +155,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.9
+rubygems_version: 2.1.0
 signing_key: 
 specification_version: 4
-summary: Skylight is a ruby application monitoring tool.
+summary: Skylight is a ruby application monitoring tool. Currently in closed beta.
 test_files: []