oboe 2.7.10.1 → 2.7.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8bb2b787b9dc0d9063cbf0fa36b421d845f2d0f
-  data.tar.gz: 3136a7df38094cead5f1c5cc9b78b90acfb6cd9f
+  metadata.gz: cf54d0acc797dc2e44f88be2e6b78343238a3002
+  data.tar.gz: 8ad6c21adbb5bbf4f2b841b17d68db0535b67f73
 SHA512:
-  metadata.gz: 38fa91f208a17c8edc5543b0c7c87f792e5ef1631ec76924ee83b897ad88b13a2c7b7a1a55ed3ed5e5c4a2d3044ad529d1870181aac42a4b404b94784f8d4e3e
-  data.tar.gz: 678572388e75bd7f83e0e68a7009f69cf9799054ef8c26e0d28c3a14e722874f3d51187829597a06b852ce32515d4c83d6582fe1ba6c4b1ed55a8e2a68b5d456
+  metadata.gz: 9c8280991451e38d92ebe98eeed3e70640a48041bf92102d28e0d14eaf4e7871c356f23150e4df197f09ff37b6e50b4621cc2ba48dd3995873d22172a8a85779
+  data.tar.gz: fc98cddfe8e2607804b3584c902d0feb45062546a53e57294c5fb613e4ac1b172fe52e1bb6ff6822efc631e1ada4a64486d78ce2a7d0a8670fec5563594c29e8

data/CHANGELOG.md

@@ -4,6 +4,41 @@ https://github.com/appneta/oboe-ruby/releases
 
 Dates in this file are in the format MM/DD/YYYY.
 
+# oboe 2.7.11.1
+
+This patch release includes:
+
+* Grape instrumentation fixes and improvements: #102
+* Report Sequel and Typhoeus versions in __Init: #101
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.11.1
+https://rubygems.org/gems/oboe/versions/2.7.11.1-java
+
+# oboe 2.7.10.1
+
+This patch release includes:
+
+* Add the ability to configure the do not trace list: #100
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.10.1
+https://rubygems.org/gems/oboe/versions/2.7.10.1-java
+
+# oboe 2.7.9.6
+
+This patch release includes:
+
+* Better, faster, stronger Rack instrumentation: #99
+* A Typhoeus instrumentation fix for cross-app tracing: #97
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.9.6
+https://rubygems.org/gems/oboe/versions/2.7.9.6-java
+
 # oboe 2.7.8.1
 
 This patch release includes:

data/lib/oboe/config.rb

@@ -12,8 +12,9 @@ module Oboe
     @@config = {}
 
     @@instrumentation = [:action_controller, :action_view, :active_record,
-                         :cassandra, :dalli, :em_http_request, :faraday, :nethttp, :memcached,
-                         :memcache, :mongo, :moped, :rack, :redis, :resque, :sequel, :typhoeus]
+                         :cassandra, :dalli, :em_http_request, :faraday, :grape, :nethttp,
+                         :memcached, :memcache, :mongo, :moped, :rack, :redis, :resque,
+                         :sequel, :typhoeus]
     ##
     # Return the raw nested hash.
     #
@@ -40,6 +41,7 @@ module Oboe
       Oboe::Config[:cassandra][:collect_backtraces] = true
       Oboe::Config[:dalli][:collect_backtraces] = false
       Oboe::Config[:faraday][:collect_backtraces] = false
+      Oboe::Config[:grape][:collect_backtraces] = true
       Oboe::Config[:em_http_request][:collect_backtraces] = false
       Oboe::Config[:memcache][:collect_backtraces] = false
       Oboe::Config[:memcached][:collect_backtraces] = false

data/lib/oboe/frameworks/grape.rb

@@ -47,12 +47,35 @@ module Oboe
     module Middleware
       module Error
         def self.included(klass)
-          ::Oboe::Util.method_alias(klass, :call, ::Grape::Middleware::Error)
+          ::Oboe::Util.method_alias(klass, :error_response, ::Grape::Middleware::Error)
         end
 
-        def call_with_oboe(boom)
-          Oboe::API.log_exception(nil, boom) if Oboe.tracing?
-          call_without_oboe(boom)
+        def error_response_with_oboe(error = {})
+          status, headers, body = error_response_without_oboe(error)
+
+          if Oboe.tracing?
+            # Since Grape uses throw/catch and not Exceptions, we manually log
+            # the error here.
+            kvs = {}
+            kvs[:ErrorClass] = 'GrapeError'
+            kvs[:ErrorMsg] = error[:message] ? error[:message] : "No message given."
+            kvs[:Backtrace] = ::Oboe::API.backtrace if Oboe::Config[:grape][:collect_backtraces]
+
+            ::Oboe::API.log(nil, 'error', kvs)
+
+            # Since calls to error() are handled similar to abort in Grape.  We
+            # manually log the rack exit here since the original code won't
+            # be returned to
+            xtrace = Oboe::API.log_end('rack', :Status => status)
+
+            if headers && Oboe::XTrace.valid?(xtrace)
+              unless defined?(JRUBY_VERSION) && Oboe.is_continued_trace?
+                headers['X-Trace'] = xtrace if headers.is_a?(Hash)
+              end
+            end
+          end
+
+          [status, headers, body]
         end
       end
     end

data/lib/oboe/util.rb

@@ -161,6 +161,7 @@ module Oboe
           platform_info['Ruby.Moped.Version']     = "Moped-#{::Moped::VERSION}"        if defined?(::Moped)
           platform_info['Ruby.Redis.Version']     = "Redis-#{::Redis::VERSION}"        if defined?(::Redis)
           platform_info['Ruby.Resque.Version']    = "Resque-#{::Resque::VERSION}"      if defined?(::Resque)
+          platform_info['Ruby.Typhoeus.Version']  = "Typhoeus-#{::Typhoeus::VERSION}"  if defined?(::Typhoeus::VERSION)
 
           # Special case since the Mongo 1.x driver doesn't embed the version number in the gem directly
           if ::Gem.loaded_specs.key?('mongo')
@@ -171,6 +172,7 @@ module Oboe
           platform_info['Ruby.Mysql.Version']   = Mysql::GemVersion::VERSION   if defined?(Mysql::GemVersion::VERSION)
           platform_info['Ruby.PG.Version']      = PG::VERSION                  if defined?(PG::VERSION)
           platform_info['Ruby.Mysql2.Version']  = Mysql2::VERSION              if defined?(Mysql2::VERSION)
+          platform_info['Ruby.Sequel.Version']  = ::Sequel::VERSION            if defined?(::Sequel::VERSION)
 
           # Report the server in use (if possible)
           if defined?(::Unicorn)

data/lib/oboe/version.rb

@@ -8,7 +8,7 @@ module Oboe
   module Version
     MAJOR = 2
     MINOR = 7
-    PATCH = 10
+    PATCH = 11
     BUILD = 1
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')

data/lib/rails/generators/oboe/templates/oboe_initializer.rb

@@ -40,6 +40,34 @@ if defined?(Oboe::Config)
   # avoid collecting and reporting query literals to TraceView.
   # Oboe::Config[:sanitize_sql] = false
 
+  # Do Not Trace
+  # These two values allow you to configure specific URL patterns to
+  # never be traced.  By default, this is set to common static file
+  # extensions but you may want to customize this list for your needs.
+  #
+  # dnt_regexp and dnt_opts is passed to Regexp.new to create
+  # a regular expression object.  That is then used to match against
+  # the incoming request path.
+  #
+  # The path string originates from the rack layer and is retrieved
+  # as follows:
+  #
+  #   req = ::Rack::Request.new(env)
+  #   path = URI.unescape(req.path)
+  #
+  # Usage:
+  #   Oboe::Config[:dnt_regexp] = "lobster$"
+  #   Oboe::Config[:dnt_opts]   = Regexp::IGNORECASE
+  #
+  # This will ignore all requests that end with the string lobster
+  # regardless of case
+  #
+  # Requests with positive matches (non nil) will not be traced.
+  # See lib/oboe/util.rb: Oboe::Util.static_asset?
+  #
+  # Oboe::Config[:dnt_regexp] = "\.(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$"
+  # Oboe::Config[:dnt_opts]   = Regexp::IGNORECASE
+
   #
   # Enabling/Disabling Instrumentation
   #

data/test/frameworks/apps/grape_simple.rb

@@ -13,6 +13,10 @@ class GrapeSimple < Grape::API
     raise Exception.new("This should have http status code 500!")
   end
 
+  get "/error" do
+    error!("This is a error with 'error'!")
+  end
+
   get "/breakstring" do
     raise "This should have http status code 500!"
   end

data/test/frameworks/grape_test.rb

@@ -12,6 +12,9 @@ if RUBY_VERSION >= '1.9.3'
 
       r = get "/json_endpoint"
 
+      r.status.must_equal 200
+      r.headers.key?('X-Trace').must_equal true
+
       traces = get_all_traces
       traces.count.must_equal 4
 
@@ -28,7 +31,7 @@ if RUBY_VERSION >= '1.9.3'
       r.headers['X-Trace'].must_equal traces[3]['X-Trace']
     end
 
-    it "should trace a request with an error" do
+    it "should trace a request with an exception" do
       @app = GrapeSimple
 
       begin
@@ -52,5 +55,31 @@ if RUBY_VERSION >= '1.9.3'
       traces[3]['ErrorMsg'].must_equal "This should have http status code 500!"
       traces[4]['Label'].must_equal "exit"
     end
+
+    it "should trace a request with an error" do
+      @app = GrapeSimple
+
+      r = get "/error"
+
+      traces = get_all_traces
+      traces.count.must_equal 5
+
+      r.status.must_equal 500
+      r.headers.key?('X-Trace').must_equal true
+
+      validate_outer_layers(traces, 'rack')
+
+      traces[0]['Layer'].must_equal "rack"
+      traces[1]['Layer'].must_equal "grape"
+      traces[2]['Layer'].must_equal "grape"
+      traces[2].has_key?('Controller').must_equal true
+      traces[2].has_key?('Action').must_equal true
+      traces[3]['Label'].must_equal "error"
+      traces[3]['ErrorClass'].must_equal "GrapeError"
+      traces[3]['ErrorMsg'].must_equal "This is a error with 'error'!"
+      traces[4]['Layer'].must_equal "rack"
+      traces[4]['Label'].must_equal "exit"
+      traces[4]['Status'].must_equal "500"
+    end
   end
 end

data/test/support/config_test.rb

@@ -23,7 +23,7 @@ describe Oboe::Config do
     instrumentation = Oboe::Config.instrumentation_list
 
     # Verify the number of individual instrumentations
-    instrumentation.count.must_equal 17
+    instrumentation.count.must_equal 18
 
     Oboe::Config[:action_controller][:enabled].must_equal true
     Oboe::Config[:action_view][:enabled].must_equal true
@@ -32,6 +32,7 @@ describe Oboe::Config do
     Oboe::Config[:dalli][:enabled].must_equal true
     Oboe::Config[:em_http_request][:enabled].must_equal false
     Oboe::Config[:faraday][:enabled].must_equal true
+    Oboe::Config[:grape][:enabled].must_equal true
     Oboe::Config[:nethttp][:enabled].must_equal true
     Oboe::Config[:memcached][:enabled].must_equal true
     Oboe::Config[:memcache][:enabled].must_equal true
@@ -48,6 +49,7 @@ describe Oboe::Config do
     Oboe::Config[:dalli][:log_args].must_equal true
     Oboe::Config[:em_http_request][:log_args].must_equal true
     Oboe::Config[:faraday][:log_args].must_equal true
+    Oboe::Config[:grape][:log_args].must_equal true
     Oboe::Config[:nethttp][:log_args].must_equal true
     Oboe::Config[:memcached][:log_args].must_equal true
     Oboe::Config[:memcache][:log_args].must_equal true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oboe
 version: !ruby/object:Gem::Version
-  version: 2.7.10.1
+  version: 2.7.11.1
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-02 00:00:00.000000000 Z
+date: 2015-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -183,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: AppNeta TraceView performance instrumentation gem for Ruby