skylight 0.7.1 → 0.8.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da9baa6ea5e74582e4f12f1f609dad96b41060fb
-  data.tar.gz: 71d118970abb5b4be8f11e013c5aeaede224a593
+  metadata.gz: b0e3fa37632ad3220389279e789146f96720de4d
+  data.tar.gz: 6a338bac5dfcaaafa26e1737da491f6281bc5470
 SHA512:
-  metadata.gz: 54363976405c9c7fef83293dc3dabb0d83b5e289991074b32be420fce72561fc5e0071869eaf9b3bd7795c42498e45963aaf55cb2dc530cfc11a5f243b11da84
-  data.tar.gz: 729f3144b5fdc1b263132abc4899a8cf8f75878a68b098f548b171b2abed79a29ba38f567ae726f194faa4f2055d8c20077a4401daaeb05ea0e38034d3479ca7
+  metadata.gz: 5b15f061ab93da78cbe138458d81b93c2019473c46040740c06bdd079179c781b2267f2261d16ef3325bc9c91fff2c459c1a78c731e782ff2bd95f9d4baa2c90
+  data.tar.gz: 70bb2e9ea8f4effb5d3878a0e6159366ebbdf836f7111f65f004ac9244933420edf1121a9533989c2abb8891261e12a12cc70495c59898c2dcd60a708364fe62

data/CHANGELOG.md

@@ -1,30 +1,17 @@
+## 0.8.0-beta.1 (August 4, 2015)
+
+* [FEATURE] Add Grape instumentation
+
 ## 0.7.1 (August 4, 2015)
 
 * [BUGFIX] Fix bug in FFI error handling
 
 ## 0.7.0 (August 3, 2015)
 
-* No changes
-
-## 0.7.0-beta.3 (July 30, 2015)
-
 * [BUFIX] Condvar bug in Rust. Updated to latest nightly.
-
-## 0.7.0-beta.2 (July 23, 2015)
-
-* [IMPROVEMENT] Silence a noisy log message
-
-## 0.7.0-beta.1 (July 15, 2015)
-
 * [BUGFIX] Don't crash on ruby stack overflow
+* [IMPROVEMENT] Silence a noisy log message
 * [IMPROVEMENT] Update to latest openssl & curl
-
-## 0.6.2-beta.2 (July 1, 2015)
-
-* No changes. Replaces bad 0.6.2-beta.1 build.
-
-## 0.6.2-beta.1 (June 30, 2015) [YANKED]
-
 * [FEATURE] Add probe on ActionView for layout renders
 
 ## 0.6.1 (June 30, 2015)

data/lib/skylight/grape.rb

@@ -0,0 +1,2 @@
+require 'skylight'
+require 'skylight/probes/grape'

data/lib/skylight/probes/grape.rb

@@ -0,0 +1,118 @@
+module Skylight
+  module Probes
+    module Grape
+      class Probe
+        def install
+          version = ::Grape::VERSION.split('.')
+          if version[0] == '0' && version[1].to_i < 10
+            # Using $stderr here isn't great, but we don't have a logger accessible
+            $stderr.puts "[SKYLIGHT] [#{Skylight::VERSION}] The Grape probe only works with version 0.10.0+ " \
+                          "and will be disabled."
+
+            return
+          end
+
+          # Grape relies on this but does doesn't correctly require it.
+          # However, when using ActiveSupport 4 it is implicitly loaded,
+          #   in AS 3, it will fail.
+          # https://github.com/ruby-grape/grape/issues/1087
+          require 'active_support/core_ext/hash/except'
+
+          ::Grape::Endpoint.class_eval do
+            alias initialize_without_sk initialize
+            def initialize(*args, &block)
+              initialize_without_sk(*args, &block)
+
+              # This solution of wrapping the block is effective, but potentially fragile.
+              # A cleaner solution would be to call the original initialize with the already
+              # modified block. However, Grape does some odd stuff with the block binding
+              # that makes this difficult to reason about.
+              if original_block = @block
+                opts = {
+                  category: "app.grape.endpoint",
+                  title: method_name.gsub(/\s+/, ' ')
+                }
+
+                @block = lambda do |endpoint_instance|
+                  Skylight.instrument(opts) do
+                    original_block.call(endpoint_instance)
+                  end
+                end
+              end
+            end
+
+            alias run_without_sk run
+            def run(*args)
+              # We run the original method first since it gives us access to more information
+              # about the current state, including populating `route`.
+              run_without_sk(*args)
+            ensure
+              if instrumenter = Skylight::Instrumenter.instance
+                if trace = instrumenter.current_trace
+                  # FIXME: How do we handle endpoints with multiple methods?
+                  #   Currently we'll see things like "PUT POST DELETE PATCH HEAD"
+
+                  # OPTION A: GET /prefix/name [v1]
+                  # # FIXME: Ideally we wouldn't have to do this, but I don't know
+                  # #   of a better way
+                  # info = route.instance_variable_get :@options
+
+                  # # FIXME: Consider whether we should include the module name
+                  # name = "#{info[:method]} #{info[:path]}"
+                  # name << " [#{info[:version]}]" if info[:version]
+
+
+                  # OPTION B: Module::Class GET /name
+                  http_method = options[:method].first
+                  http_method << "..." if options[:method].length > 1
+
+                  path = options[:path].join("/")
+                  namespace = ::Grape::Namespace.joined_space(namespace_stackable(:namespace))
+
+                  if namespace && !namespace.empty?
+                    path = "/#{path}" if path[0] != '/'
+                    path = "#{namespace}#{path}"
+                  end
+
+                  name = "#{options[:for]} [#{http_method}] #{path}"
+
+                  trace.endpoint = name
+                end
+              end
+            end
+
+            alias run_filters_without_sk run_filters
+            def run_filters(filters)
+              if !filters || filters.empty?
+                # If there's no filters nothing should happen, but let Grape decide
+                return run_filters_without_sk(filters)
+              end
+
+              # Unfortunately, this method only gets passed an array of filters.
+              # This means we have to compare to known lists to attempt to detect
+              # the type.
+              type = case filters
+                when befores            then "Before"
+                when before_validations then "Before Validation"
+                when after_validations  then "After Validation"
+                when afters             then "After"
+                else                         "Other"
+                end
+
+              opts = {
+                category: "app.grape.filters",
+                title: "#{type} Filters"
+              }
+
+              Skylight.instrument(opts) do
+                run_filters_without_sk(filters)
+              end
+            end
+          end
+        end
+      end
+    end
+
+    register("Grape", "grape", Grape::Probe.new)
+  end
+end

data/lib/skylight/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skylight
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0.beta.1
 platform: ruby
 authors:
 - Tilde, Inc.
@@ -14,14 +14,14 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
 description: 
@@ -53,6 +53,7 @@ files:
 - lib/skylight/data/cacert.pem
 - lib/skylight/formatters/http.rb
 - lib/skylight/gc.rb
+- lib/skylight/grape.rb
 - lib/skylight/helpers.rb
 - lib/skylight/instrumenter.rb
 - lib/skylight/middleware.rb
@@ -81,6 +82,7 @@ files:
 - lib/skylight/probes/action_view.rb
 - lib/skylight/probes/excon.rb
 - lib/skylight/probes/excon/middleware.rb
+- lib/skylight/probes/grape.rb
 - lib/skylight/probes/net_http.rb
 - lib/skylight/probes/redis.rb
 - lib/skylight/probes/sequel.rb
@@ -163,17 +165,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       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
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Skylight is a smart profiler for Rails apps