skylight 0.5.2 → 0.6.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 298cf9d0f31b9d3dcb480039c94900a954263549
-  data.tar.gz: 776b66cdce89e49c98bc12662a40865af657af2d
+  metadata.gz: a5fe0175d64d6a4fa8ee48ee5fb11f7c12229419
+  data.tar.gz: 57bc045e5555aae042471c7920854ac1c022fcfa
 SHA512:
-  metadata.gz: 45a4f7c2396dc01028e6df143ba618ff327191ae99cbf00dedfbf2e4fee8436c545b84a18e7cbfe47709dec4c7ac49180627abd22eb92c60c7762c1d1da44c3b
-  data.tar.gz: fb9506358d97811463238d7363e730636657f96989f6c04c3ab3c0d8f43a9ab656df3c14f711db106361b8456111c4ee77c6ce0b3111dad04bb272712ca6134a
+  metadata.gz: a1f45b52db2a62340ab610b4fa5658032105212950cf8bf8a40fad751930b7b4d63690b799b5fd88af959674017ce08e9fe03b017007e76c187ee6393edaa49e
+  data.tar.gz: 172582d67e1c2ad1420f02a63b32874feee80eb19cacfd7565509de8aa5df9437daa7543096cac8b0ffcad846660e2573d025958850aaebf5007bea7c47bb54e

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## 0.6.0 - Beta 1 (January 5, 2014)
+
+* [IMPROVEMENT] Eliminates runtime dependency on the Rails
+  constant across the entire codebase
+* [FEATURE] Support for Sinatra applications. During the
+  beta period, this requires an opt-in via
+  `require "skylight/sinatra". See http://docs.skylight.io/sinatra/
+* [FEATURE] Support for the Sequel ORM (off by default for Rails apps
+  during the beta)
+* [FEATURE] Support for Tilt templates (off by default for Rails apps
+  during the beta)
+
 ## 0.5.2 (December 15, 2014)
 
 * [IMPROVEMENT] Support ignoring multiple heartbeat endpoints

data/lib/skylight.rb

@@ -1,124 +1,2 @@
-require 'skylight/version'
-
-module Skylight
-  # @api private
-  TRACE_ENV_KEY = 'SKYLIGHT_ENABLE_TRACE_LOGS'.freeze
-
-  # Load the native agent
-  require 'skylight/native'
-
-  if defined?(Rails)
-    require 'skylight/railtie'
-  end
-
-  require 'active_support/notifications'
-  require 'skylight/compat' # Require after AS::N
-
-  # Require VM specific things
-  require 'skylight/config'
-  require 'skylight/gc'
-  require 'skylight/helpers'
-  require 'skylight/instrumenter'
-  require 'skylight/middleware'
-  require 'skylight/trace'
-  require 'skylight/vm/gc'
-  require 'skylight/util'
-
-  # Used from the CLI
-  autoload :Api,          'skylight/api'
-  autoload :CLI,          'skylight/cli'
-  autoload :Normalizers,  'skylight/normalizers'
-  autoload :Subscriber,   'skylight/subscriber'
-
-  # @api private
-  class ConfigError < RuntimeError; end
-
-  # @api private
-  TIERS = %w(
-    api
-    app
-    view
-    db
-    noise
-    other)
-
-  # @api private
-  TIER_REGEX = /^(?:#{TIERS.join('|')})(?:\.|$)/u
-
-  # @api private
-  CATEGORY_REGEX = /^[a-z0-9_-]+(?:\.[a-z0-9_-]+)*$/iu
-
-  # @api private
-  DEFAULT_CATEGORY = "app.block".freeze
-
-  # @api private
-  DEFAULT_OPTIONS = { category: DEFAULT_CATEGORY }
-
-  # Start instrumenting
-  def self.start!(*args)
-    Instrumenter.start!(*args)
-  end
-
-  # Stop instrumenting
-  def self.stop!(*args)
-    Instrumenter.stop!(*args)
-  end
-
-  # Start a trace
-  def self.trace(endpoint=nil, cat=nil, title=nil)
-    unless inst = Instrumenter.instance
-      return yield if block_given?
-      return
-    end
-
-    if block_given?
-      inst.trace(endpoint, cat || DEFAULT_CATEGORY, title) { yield }
-    else
-      inst.trace(endpoint, cat || DEFAULT_CATEGORY, title)
-    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)
-    unless inst = Instrumenter.instance
-      return yield if block_given?
-      return
-    end
-
-    if Hash === opts
-      category    = opts[:category] || DEFAULT_CATEGORY
-      title       = opts[:title]
-      desc        = opts[:description]
-      annotations = opts[:annotations]
-    else
-      category    = DEFAULT_CATEGORY
-      title       = opts.to_s
-      desc        = nil
-      annotations = nil
-    end
-
-    if block_given?
-      inst.instrument(category, title, desc, annotations) { yield }
-    else
-      inst.instrument(category, title, desc, annotations)
-    end
-  end
-
-  # Temporarily disable
-  def self.disable
-    unless inst = Instrumenter.instance
-      return yield if block_given?
-      return
-    end
-
-    inst.disable { yield }
-  end
-
-  require 'skylight/probes'
-end
+require 'skylight/core'
+require 'skylight/probes'

data/lib/skylight/cli.rb

@@ -41,6 +41,11 @@ repository and deploy from there. You can learn more about the process at:
 
   http://docs.skylight.io/getting-started/#deploy
 
+If you want to specify the authentication token as an environment variable,
+you should set the `SKYLIGHT_AUTHENTICATION` variable to:
+
+  #{config[:authentication]}
+
       OUT
     rescue Api::CreateFailed => e
       say "Could not create the application", :red

data/lib/skylight/config.rb

@@ -387,9 +387,6 @@ module Skylight
       File.open(path, 'w') do |f|
         f.puts <<-YAML
 ---
-# The Skylight ID for the application.
-application: #{self[:application]}
-
 # The authentication token for the application.
 authentication: #{self[:authentication]}
         YAML

data/lib/skylight/core.rb

@@ -0,0 +1,122 @@
+require 'skylight/version'
+
+module Skylight
+  # @api private
+  TRACE_ENV_KEY = 'SKYLIGHT_ENABLE_TRACE_LOGS'.freeze
+
+  # Load the native agent
+  require 'skylight/native'
+
+  if defined?(Rails)
+    require 'skylight/railtie'
+  end
+
+  require 'active_support/notifications'
+  require 'skylight/compat' # Require after AS::N
+
+  # Require VM specific things
+  require 'skylight/config'
+  require 'skylight/gc'
+  require 'skylight/helpers'
+  require 'skylight/instrumenter'
+  require 'skylight/middleware'
+  require 'skylight/trace'
+  require 'skylight/vm/gc'
+  require 'skylight/util'
+
+  # Used from the CLI
+  autoload :Api,          'skylight/api'
+  autoload :CLI,          'skylight/cli'
+  autoload :Normalizers,  'skylight/normalizers'
+  autoload :Subscriber,   'skylight/subscriber'
+
+  # @api private
+  class ConfigError < RuntimeError; end
+
+  # @api private
+  TIERS = %w(
+    api
+    app
+    view
+    db
+    noise
+    other)
+
+  # @api private
+  TIER_REGEX = /^(?:#{TIERS.join('|')})(?:\.|$)/u
+
+  # @api private
+  CATEGORY_REGEX = /^[a-z0-9_-]+(?:\.[a-z0-9_-]+)*$/iu
+
+  # @api private
+  DEFAULT_CATEGORY = "app.block".freeze
+
+  # @api private
+  DEFAULT_OPTIONS = { category: DEFAULT_CATEGORY }
+
+  # Start instrumenting
+  def self.start!(*args)
+    Instrumenter.start!(*args)
+  end
+
+  # Stop instrumenting
+  def self.stop!(*args)
+    Instrumenter.stop!(*args)
+  end
+
+  # Start a trace
+  def self.trace(endpoint=nil, cat=nil, title=nil)
+    unless inst = Instrumenter.instance
+      return yield if block_given?
+      return
+    end
+
+    if block_given?
+      inst.trace(endpoint, cat || DEFAULT_CATEGORY, title) { yield }
+    else
+      inst.trace(endpoint, cat || DEFAULT_CATEGORY, title)
+    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)
+    unless inst = Instrumenter.instance
+      return yield if block_given?
+      return
+    end
+
+    if Hash === opts
+      category    = opts[:category] || DEFAULT_CATEGORY
+      title       = opts[:title]
+      desc        = opts[:description]
+      annotations = opts[:annotations]
+    else
+      category    = DEFAULT_CATEGORY
+      title       = opts.to_s
+      desc        = nil
+      annotations = nil
+    end
+
+    if block_given?
+      inst.instrument(category, title, desc, annotations) { yield }
+    else
+      inst.instrument(category, title, desc, annotations)
+    end
+  end
+
+  # Temporarily disable
+  def self.disable
+    unless inst = Instrumenter.instance
+      return yield if block_given?
+      return
+    end
+
+    inst.disable { yield }
+  end
+end

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

@@ -6,6 +6,8 @@ module Skylight
     module ActiveRecord
       class SQL < Normalizer
         register "sql.active_record"
+        register "sql.sequel"
+        register "sql.data_mapper"
 
         CAT = "db.sql.query".freeze
 
@@ -24,7 +26,7 @@ module Skylight
             binds = binds.map { |col, val| val.inspect }
           end
 
-          extracted_title, sql, binds, error = extract_binds(payload, binds)
+          extracted_title, sql, binds, _ = extract_binds(payload, binds)
           title = extracted_title if extracted_title
 
           if sql

data/lib/skylight/probes/sequel.rb

@@ -0,0 +1,29 @@
+module Skylight
+  module Probes
+    module Sequel
+      class Probe
+        def install
+          require 'sequel/database/logging'
+          ::Sequel::Database.class_eval do
+            alias log_yield_without_sk log_yield
+
+            def log_yield(sql, args=nil, &block)
+              log_yield_without_sk(sql, *args) do
+                ::ActiveSupport::Notifications.instrument(
+                  "sql.sequel",
+                  sql: sql,
+                  name: "SQL",
+                  binds: args
+                ) do
+                  block.call
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+
+    register("Sequel", "sequel", Sequel::Probe.new)
+  end
+end

data/lib/skylight/probes/sinatra.rb

@@ -0,0 +1,74 @@
+module Skylight
+  module Probes
+    module Sinatra
+      class Probe
+        def install
+          class << ::Sinatra::Base
+            alias build_without_sk build
+            alias compile_without_sk! compile!
+
+            def compile!(verb, path, *args, &block)
+              compile_without_sk!(verb, path, *args, &block).tap do |_, _, _, wrapper|
+                # Deal with the situation where the path is a regex, and the default behavior
+                # of Ruby stringification produces an unreadable mess
+                if path.is_a?(Regexp)
+                  human_readable = "<sk-regex>%r{#{path.source}}</sk-regex>"
+                  wrapper.instance_variable_set(:@route_name, "#{verb} #{human_readable}")
+                else
+                  wrapper.instance_variable_set(:@route_name, "#{verb} #{path}")
+                end
+
+                # Newer versions of Sinatra populate env['sinatra.route']. Polyfill older
+                # versions in a targeted but hackish way.
+                if ::Sinatra::VERSION < '1.4.0'
+                  def wrapper.[](app, args)
+                    app.env['sinatra.route'] = @route_name
+                    super
+                  end
+                end
+              end
+            end
+
+            def build(*args, &block)
+              self.use Skylight::Middleware
+              build_without_sk(*args, &block)
+            end
+          end
+
+          ::Sinatra::Base.class_eval do
+            alias dispatch_without_sk! dispatch!
+            alias compile_template_without_sk compile_template
+
+            def dispatch!(*args, &block)
+              dispatch_without_sk!(*args, &block).tap do
+                instrumenter = Skylight::Instrumenter.instance
+                next unless instrumenter
+                trace = instrumenter.current_trace
+                next unless trace
+
+                # Set the endpoint name to the route name
+                route = env['sinatra.route']
+                trace.endpoint = route if route
+              end
+            end
+
+            def compile_template(engine, data, options, *args, &block)
+              # Pass along a useful "virtual path" to Tilt. The Tilt probe will handle
+              # instrumenting correctly.
+              case data
+              when Symbol
+                options[:sky_virtual_path] = data.to_s
+              else
+                options[:sky_virtual_path] = "Inline template (#{engine})"
+              end
+
+              compile_template_without_sk(engine, data, options, *args, &block)
+            end
+          end
+        end
+      end
+    end
+
+    register("Sinatra::Base", "sinatra/base", Sinatra::Probe.new)
+  end
+end

data/lib/skylight/probes/tilt.rb

@@ -0,0 +1,26 @@
+module Skylight
+  module Probes
+    module Tilt
+      class Probe
+        def install
+          ::Tilt::Template.class_eval do
+            alias render_without_sk render
+
+            def render(*args, &block)
+              opts = {
+                category: "view.render.template",
+                title: options[:sky_virtual_path] || "Unknown template name"
+              }
+
+              Skylight.instrument(opts) do
+                render_without_sk(*args, &block)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    register("Tilt::Template", "tilt/template", Tilt::Probe.new)
+  end
+end

data/lib/skylight/sinatra.rb

@@ -0,0 +1,4 @@
+require 'skylight'
+require 'skylight/probes/sinatra'
+require 'skylight/probes/tilt'
+require 'skylight/probes/sequel'

data/lib/skylight/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0.beta.1
 platform: ruby
 authors:
 - Tilde, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2015-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -49,6 +49,7 @@ files:
 - lib/skylight/cli.rb
 - lib/skylight/compat.rb
 - lib/skylight/config.rb
+- lib/skylight/core.rb
 - lib/skylight/data/cacert.pem
 - lib/skylight/formatters/http.rb
 - lib/skylight/gc.rb
@@ -81,7 +82,11 @@ files:
 - lib/skylight/probes/excon/middleware.rb
 - lib/skylight/probes/net_http.rb
 - lib/skylight/probes/redis.rb
+- lib/skylight/probes/sequel.rb
+- lib/skylight/probes/sinatra.rb
+- lib/skylight/probes/tilt.rb
 - lib/skylight/railtie.rb
+- lib/skylight/sinatra.rb
 - lib/skylight/subscriber.rb
 - lib/skylight/trace.rb
 - lib/skylight/util.rb
@@ -162,9 +167,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2
@@ -172,4 +177,3 @@ signing_key:
 specification_version: 4
 summary: Skylight is a smart profiler for Rails apps
 test_files: []
-has_rdoc: