oboe 2.7.4.1 → 2.7.5.wolf1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 252963036ab61953b873cbd86fc07eaeb42b1b07
-  data.tar.gz: 2385bcb4b3d56f42cb7f0a255e339c9a9f998f59
+  metadata.gz: 3beaf0fdfd2e981df546c71cd4a327a5448c730d
+  data.tar.gz: 35885d335b9a1b25183f44489247759dad1be927
 SHA512:
-  metadata.gz: 4692130035aace8a2bcbd42a8c865abe1ed9636fba5db142bef0cf395b066ad7b86a645335d21c63a5fae9c37d6604aebf46cb711dd65001942a18474dff7d9c
-  data.tar.gz: 5fa46e4de898c01918014c81ea0550647f7a0b12a18272894ede7c1feb07ae0f148dede11f36f5c2273d62d5ef8bc2d6ed7af36e0090d9c4e3405f0345621929
+  metadata.gz: 3a6c75e8f5b6cba14d28f1ad18766cf4fc0a061fddd8d3ff586d8d84f2893beca177830c567c3a3921dcaf96c90971095fade5bee82a84f77b5050411e7691fd
+  data.tar.gz: f27d9e690055fac51907fce0331af8ee8faabcd3fe80f37b2473f6da285f5f81f366050d5da44da34ec4e6d3a51a1ca681972caa8ae7fdcdff683a1e114564a3

data/CHANGELOG.md

@@ -1,3 +1,60 @@
+
+For the latest release info, see here:
+https://github.com/appneta/oboe-ruby/releases
+
+Dates in this file are in the format MM/DD/YYYY.
+
+# oboe 2.7.4.1 (10/26/2014)
+
+This patch release includes:
+
+* Make Oboe::API available even when liboboe.so is not #81 (thanks Cannon!)
+* Add OS and Oboe::Config info to support_report #80 
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.4.1
+https://rubygems.org/gems/oboe/versions/2.7.4.1-java
+
+# oboe 2.7.3.1 (10/15/2014)
+
+This patch release includes:
+
+* Fix require statements under certain variations of REE-1.8.7: #78 (thanks @madrobby)
+* Faraday instrumentation fails to capture and pass params update block: #79
+* Add method to log environment details for support investigations (`Oboe.support_report`): #77
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.3.1
+https://rubygems.org/gems/oboe/versions/2.7.3.1-java
+
+# oboe 2.7.2.2 (09/26/2014)
+
+This patch release includes:
+
+* New [Faraday](https://github.com/lostisland/faraday) instrumentation: https://github.com/appneta/oboe-ruby/pull/68
+* Auto-initialize instrumentation when no framework detected: https://github.com/appneta/oboe-ruby/pull/76
+* Willingly ignore traceview missing libraries warning: https://github.com/appneta/oboe-ruby/pull/75 (thanks @theist!)
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.2.2
+https://rubygems.org/gems/oboe/versions/2.7.2.2-java
+
+# oboe 2.7.1.7 (09/08/2014)
+
+This patch release includes:
+
+* Fixed load stack trace when missing TraceView base libraries: [#72](https://github.com/appneta/oboe-ruby/pull/72) - thanks @theist!
+* Beta `em-http-request` instrumentation: [#60](https://github.com/appneta/oboe-ruby/pull/60)/[#73](https://github.com/appneta/oboe-ruby/pull/73) - Thanks @diogobenica!
+* Improved loading when on Heroku with oboe-heroku gem
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.1.7
+https://rubygems.org/gems/oboe/versions/2.7.1.7-java
+
 # oboe 2.7.0.3 (08/19/2014)
 
 This minor release includes:

data/CONFIG.md

@@ -0,0 +1,16 @@
+# Oboe Gem Configuration
+
+## Environment Variables
+
+The following environment variables are detected by the oboe gem:
+
+* `IGNORE_TRACEVIEW_WARNING` - tells the oboe gem to __not__ output the _missing TraceView libraries_ message on stack initialization
+
+* `OBOE_GEM_VERBOSE` - sets the verbose flag (`Oboe::Config[:verbose]`) early in the gem loading process which may output valuable information
+
+## Oboe::Config
+
+`Oboe::Config` is a nested hash used by the oboe gem to store preferences and switches.
+
+See [this Rails generator template file](https://github.com/appneta/oboe-ruby/blob/master/lib/rails/generators/oboe/templates/oboe_initializer.rb) for documentation on all of the supported values.
+

data/Gemfile

@@ -28,6 +28,7 @@ gem 'resque'
 gem 'redis'
 gem 'faraday'
 gem 'excon'
+gem 'typhoeus'
 
 if RUBY_VERSION >= '1.9'
   gem 'moped'

data/README.md

@@ -29,6 +29,12 @@ gem 'oboe'
 
 On Heroku?  Use the `oboe-heroku` gem instead.  It wraps some additional functionality specialized for Heroku.
 
+## Oboe?
+
+What the heck is an [oboe](https://en.wikipedia.org/wiki/Oboe)?  
+
+_AKA Performance Instrumentation_
+
 # Running
 
 ## Rails

data/lib/joboe_metal.rb

@@ -169,9 +169,26 @@ module Oboe
 end
 
 # Assure that the Joboe Java Agent was loaded via premain
-status = Java::ComTracelyticsAgent::Agent.getStatus
-if status == Java::ComTracelyticsAgent::Agent::AgentStatus::UNINITIALIZED
-  Oboe.loaded = false
-else
-  Oboe.loaded = true
+case Java::ComTracelyticsAgent::Agent.getStatus
+  when Java::ComTracelyticsAgent::Agent::AgentStatus::INITIALIZED_SUCCESSFUL
+    Oboe.loaded = true
+
+  when Java::ComTracelyticsAgent::Agent::AgentStatus::INITIALIZED_FAILED
+    Oboe.loaded = false
+    $stderr.puts '=============================================================='
+    $stderr.puts 'TraceView Java Agent not initialized properly.'
+    $stderr.puts 'Possibly misconfigured?  Going into no-op mode.'
+    $stderr.puts 'See: http://bit.ly/1zwS5xj'
+    $stderr.puts '=============================================================='
+
+  when Java::ComTracelyticsAgent::Agent::AgentStatus::UNINITIALIZED
+    Oboe.loaded = false
+    $stderr.puts '=============================================================='
+    $stderr.puts 'TraceView Java Agent not loaded. Going into no-op mode.'
+    $stderr.puts 'To preload the TraceView java agent see:'
+    $stderr.puts 'https://support.appneta.com/cloud/installing-jruby-instrumentation'
+    $stderr.puts '=============================================================='
+
+  else
+    Oboe.loaded = false
 end

data/lib/oboe/config.rb

@@ -13,7 +13,7 @@ module Oboe
 
     @@instrumentation = [:action_controller, :action_view, :active_record,
                          :cassandra, :dalli, :em_http_request, :faraday, :nethttp, :memcached,
-                         :memcache, :mongo, :moped, :rack, :redis, :resque]
+                         :memcache, :mongo, :moped, :rack, :redis, :resque, :typhoeus]
     ##
     # Return the raw nested hash.
     #
@@ -48,6 +48,7 @@ module Oboe
       Oboe::Config[:nethttp][:collect_backtraces] = true
       Oboe::Config[:redis][:collect_backtraces] = false
       Oboe::Config[:resque][:collect_backtraces] = true
+      Oboe::Config[:typhoeus][:collect_backtraces] = false
 
       # Special instrument specific flags
       #
@@ -81,7 +82,7 @@ module Oboe
         @@config[:reporter_port] = '7831'
       end
 
-      @@config[:verbose] = false
+      @@config[:verbose] = ENV.key?('OBOE_GEM_VERBOSE') ? true : false
     end
 
     def self.update!(data)

data/lib/oboe/inst/faraday.rb

@@ -66,7 +66,7 @@ end
 
 if Oboe::Config[:faraday][:enabled]
   if defined?(::Faraday)
-    Oboe.logger.info '[oboe/loading] Instrumenting faraday'
+    Oboe.logger.info '[oboe/loading] Instrumenting faraday' if Oboe::Config[:verbose]
     ::Oboe::Util.send_include(::Faraday::Connection, ::Oboe::Inst::FaradayConnection)
   end
 end

data/lib/oboe/inst/typhoeus.rb

@@ -0,0 +1,99 @@
+module Oboe
+  module Inst
+    module TyphoeusRequestOps
+
+      def self.included(klass)
+        ::Oboe::Util.method_alias(klass, :run, ::Typhoeus::Request::Operations)
+      end
+
+      def run_with_oboe
+        return run_without_oboe unless Oboe.tracing?
+
+        Oboe::API.log_entry('typhoeus')
+
+        # Prepare X-Trace header handling
+        blacklisted = Oboe::API.blacklisted?(url)
+        context = Oboe::Context.toString
+        task_id = Oboe::XTrace.task_id(context)
+        options[:headers]['X-Trace'] = context unless blacklisted
+
+        response = run_without_oboe
+
+        if response.code == 0
+          Oboe::API.log('typhoeus', 'error', { :ErrorClass => response.return_code,
+                                               :ErrorMsg => response.return_message })
+        end
+
+        kvs = {}
+        kvs[:HTTPStatus] = response.code
+        kvs['Backtrace'] = Oboe::API.backtrace if Oboe::Config[:typhoeus][:collect_backtraces]
+
+        # Avoid cross host tracing for blacklisted domains
+        # Conditionally add the X-Trace header to the outgoing request
+        response.headers['X-Trace'] = context unless blacklisted
+
+        uri = URI(response.effective_url)
+        kvs['IsService'] = 1
+        kvs['RemoteProtocol'] = uri.scheme
+        kvs['RemoteHost'] = uri.host
+        kvs['RemotePort'] = uri.port ? uri.port : 80
+        kvs['ServiceArg'] = uri.path
+        kvs['HTTPMethod'] = options[:method]
+        kvs['Blacklisted'] = true if blacklisted
+
+        # Re-attach net::http edge unless it's blacklisted or if we don't have a
+        # valid X-Trace header
+        unless blacklisted
+          xtrace = response.headers['X-Trace']
+
+          if xtrace && Oboe::XTrace.valid?(xtrace) && Oboe.tracing?
+
+            # Assure that we received back a valid X-Trace with the same task_id
+            if task_id == Oboe::XTrace.task_id(xtrace)
+              Oboe::Context.fromString(xtrace)
+            else
+              Oboe.logger.debug "Mismatched returned X-Trace ID: #{xtrace}"
+            end
+          end
+        end
+
+        Oboe::API.log('typhoeus', 'info', kvs)
+        response
+      rescue => e
+        Oboe::API.log_exception('typhoeus', e)
+        raise e
+      ensure
+        Oboe::API.log_exit('typhoeus')
+      end
+    end
+
+    module TyphoeusHydraRunnable
+      def self.included(klass)
+        ::Oboe::Util.method_alias(klass, :run, ::Typhoeus::Hydra)
+      end
+
+      def run_with_oboe
+        kvs = {}
+
+        kvs[:queued_requests] = queued_requests.count
+        kvs[:max_concurrency] = max_concurrency
+
+        # FIXME: Until we figure out a strategy to deal with libcurl internal
+        # threading and Ethon's use of easy handles, here we just do a simple
+        # trace of the hydra run.
+        Oboe::API.trace("typhoeus_hydra", kvs) do
+          run_without_oboe
+        end
+      end
+    end
+
+  end
+end
+
+if Oboe::Config[:typhoeus][:enabled]
+  if defined?(::Typhoeus)
+    Oboe.logger.info '[oboe/loading] Instrumenting typhoeus' if Oboe::Config[:verbose]
+    ::Oboe::Util.send_include(::Typhoeus::Request::Operations, ::Oboe::Inst::TyphoeusRequestOps)
+    ::Oboe::Util.send_include(::Typhoeus::Hydra, ::Oboe::Inst::TyphoeusHydraRunnable)
+  end
+end

data/lib/oboe/util.rb

@@ -166,6 +166,11 @@ module Oboe
             platform_info['Ruby.Mongo.Version']     = "Mongo-#{::Gem.loaded_specs['mongo'].version}"
           end
 
+          # Report the DB adapter in use
+          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)
+
           # Report the server in use (if possible)
           if defined?(::Unicorn)
             platform_info['Ruby.AppContainer.Version'] = "Unicorn-#{::Unicorn::Const::UNICORN_VERSION}"

data/lib/oboe/version.rb

@@ -8,8 +8,8 @@ module Oboe
   module Version
     MAJOR = 2
     MINOR = 7
-    PATCH = 4
-    BUILD = 1
+    PATCH = 5
+    BUILD = "wolf1"
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
   end

data/test/instrumentation/typhoeus_test.rb

@@ -0,0 +1,154 @@
+require 'minitest_helper'
+
+describe Oboe::Inst::TyphoeusRequestOps do
+  before do
+    clear_all_traces
+    @collect_backtraces = Oboe::Config[:typhoeus][:collect_backtraces]
+  end
+
+  after do
+    Oboe::Config[:typhoeus][:collect_backtraces] = @collect_backtraces
+  end
+
+  it 'Typhoeus should be defined and ready' do
+    defined?(::Typhoeus::Request::Operations).wont_match nil
+  end
+
+  it 'Typhoeus should have oboe methods defined' do
+    [ :run_with_oboe ].each do |m|
+      ::Typhoeus::Request::Operations.method_defined?(m).must_equal true
+    end
+  end
+
+  it 'should trace a typhoeus request' do
+    Oboe::API.start_trace('typhoeus_test') do
+      Typhoeus.get("www.appneta.com/products/traceview/")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 5
+
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal Oboe::Config[:typhoeus][:collect_backtraces]
+
+    traces[2]['Layer'].must_equal 'typhoeus'
+    traces[2]['Label'].must_equal 'info'
+    traces[2]['IsService'].must_equal '1'
+    traces[2]['RemoteProtocol'].downcase.must_equal 'http'
+    traces[2]['RemoteHost'].must_equal 'www.appneta.com'
+    traces[2]['ServiceArg'].must_equal '/products/traceview/'
+    traces[2]['HTTPMethod'].must_equal 'get'
+    traces[2]['HTTPStatus'].must_equal '200'
+
+    traces[3]['Layer'].must_equal 'typhoeus'
+    traces[3]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace a typhoeus request to an instr\'d app' do
+    Oboe::API.start_trace('typhoeus_test') do
+      Typhoeus.get("www.gameface.in/gamers")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 5
+
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal Oboe::Config[:typhoeus][:collect_backtraces]
+
+    traces[2]['Layer'].must_equal 'typhoeus'
+    traces[2]['Label'].must_equal 'info'
+    traces[2]['IsService'].must_equal '1'
+    traces[2]['RemoteProtocol'].downcase.must_equal 'http'
+    traces[2]['RemoteHost'].must_equal 'www.gameface.in'
+    traces[2]['ServiceArg'].must_equal '/gamers'
+    traces[2]['HTTPMethod'].must_equal 'get'
+    traces[2]['HTTPStatus'].must_equal '200'
+
+    traces[3]['Layer'].must_equal 'typhoeus'
+    traces[3]['Label'].must_equal 'exit'
+  end
+  it 'should trace a typhoeus request with error' do
+    Oboe::API.start_trace('typhoeus_test') do
+      Typhoeus.get("thisdomaindoesntexisthopefully.asdf/products/traceview/")
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 6
+
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus'
+    traces[1].key?('Backtrace').must_equal Oboe::Config[:typhoeus][:collect_backtraces]
+
+    traces[2]['Layer'].must_equal 'typhoeus'
+    traces[2]['Label'].must_equal 'error'
+
+    traces[3]['Layer'].must_equal 'typhoeus'
+    traces[3]['Label'].must_equal 'info'
+    traces[3]['IsService'].must_equal '1'
+    traces[3]['RemoteProtocol'].downcase.must_equal 'http'
+    traces[3]['RemoteHost'].must_equal 'thisdomaindoesntexisthopefully.asdf'
+    traces[3]['ServiceArg'].must_equal '/products/traceview/'
+    traces[3]['HTTPMethod'].must_equal 'get'
+    traces[3]['HTTPStatus'].must_equal '0'
+
+    traces[3]['Layer'].must_equal 'typhoeus'
+    traces[3]['Label'].must_equal 'info'
+
+    traces[4]['Layer'].must_equal 'typhoeus'
+    traces[4]['Label'].must_equal 'exit'
+  end
+
+  it 'should trace parallel typhoeus requests' do
+    Oboe::API.start_trace('typhoeus_test') do
+      hydra = Typhoeus::Hydra.hydra
+
+      first_request  = Typhoeus::Request.new("www.appneta.com/products/traceview/")
+      second_request = Typhoeus::Request.new("www.appneta.com/products/")
+      third_request  = Typhoeus::Request.new("www.curlmyip.com")
+
+      hydra.queue first_request
+      hydra.queue second_request
+      hydra.queue third_request
+
+      hydra.run
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    validate_outer_layers(traces, 'typhoeus_test')
+
+    traces[1]['Layer'].must_equal 'typhoeus_hydra'
+    traces[1]['Label'].must_equal 'entry'
+
+    traces[2]['Layer'].must_equal 'typhoeus_hydra'
+    traces[2]['Label'].must_equal 'exit'
+  end
+
+  it 'should obey :collect_backtraces setting when true' do
+    Oboe::Config[:typhoeus][:collect_backtraces] = true
+
+    Oboe::API.start_trace('typhoeus_test') do
+      Typhoeus.get("www.appneta.com/products/traceview/")
+    end
+
+    traces = get_all_traces
+    layer_has_key(traces, 'typhoeus', 'Backtrace')
+  end
+
+  it 'should obey :collect_backtraces setting when false' do
+    Oboe::Config[:typhoeus][:collect_backtraces] = false
+
+    Oboe::API.start_trace('typhoeus_test') do
+      Typhoeus.get("www.appneta.com/products/traceview/")
+    end
+
+    traces = get_all_traces
+    layer_doesnt_have_key(traces, 'typhoeus', 'Backtrace')
+  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 15
+    instrumentation.count.must_equal 16
 
     Oboe::Config[:action_controller][:enabled].must_equal true
     Oboe::Config[:action_view][:enabled].must_equal true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oboe
 version: !ruby/object:Gem::Version
-  version: 2.7.4.1
+  version: 2.7.5.wolf1
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-26 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -53,6 +53,7 @@ files:
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
+- CONFIG.md
 - Gemfile
 - LICENSE
 - README.md
@@ -111,6 +112,7 @@ files:
 - lib/oboe/inst/rack.rb
 - lib/oboe/inst/redis.rb
 - lib/oboe/inst/resque.rb
+- lib/oboe/inst/typhoeus.rb
 - lib/oboe/instrumentation.rb
 - lib/oboe/loading.rb
 - lib/oboe/logger.rb
@@ -150,6 +152,7 @@ files:
 - test/instrumentation/redis_sortedsets_test.rb
 - test/instrumentation/redis_strings_test.rb
 - test/instrumentation/resque_test.rb
+- test/instrumentation/typhoeus_test.rb
 - test/minitest_helper.rb
 - test/profiling/method_test.rb
 - test/support/config_test.rb
@@ -170,9 +173,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.8.6
 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
@@ -196,6 +199,7 @@ test_files:
 - test/instrumentation/redis_strings_test.rb
 - test/instrumentation/redis_sets_test.rb
 - test/instrumentation/http_test.rb
+- test/instrumentation/typhoeus_test.rb
 - test/instrumentation/resque_test.rb
 - test/instrumentation/em_http_request_test.rb
 - test/instrumentation/moped_test.rb