oboe 2.7.5.1 → 2.7.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1059bbe25a316d6aff4e47bfc54425319d927b83
-  data.tar.gz: 6c69d5e5e31a09e538eecc54b60f233fc059cd69
+  metadata.gz: 3bbafabb39decad386dc3d7f69fe5bf05c37f871
+  data.tar.gz: cdc1a52a1853ed4a41e0293deb13393659b667c0
 SHA512:
-  metadata.gz: 55bdc56bf7ffd69bde324e1ec9a83f2be500336fb5b08ec25c3bd70df2282787ab78c7962312613203cf3f5a7281894df78b3796a73a175eeed9c5dff635e5f5
-  data.tar.gz: da3a740d93c420c2f7644105bb6a5bb569c8b2a9ae1205c956f0662d47f64b5c9a5cf486bc8d7a4cae0e845c927e0f24f20c5a9b5badd090f1cf073ef06b9ab9
+  metadata.gz: 6a67d61562e9906c6cdd62fba61e35a5461525a422fcc18cdc52b84fffed0537b4f6477310e961a2e42775ec603db1e6ff24f4c42429ed30518e7fbb3ed5d5d5
+  data.tar.gz: 2109d23dffb9c361964fdcecf459a2ca0e4d07991d6c217c91c693480c7f9715d980986f2416472d440181a78458611c087e6f70ab1519a8d2282d906e5e288d

data/Gemfile

@@ -11,7 +11,7 @@ group :development do
   gem 'ruby-debug',   :platforms => [ :mri_18, :jruby ]
   gem 'debugger',     :platform  =>   :mri_19
   gem 'byebug',       :platforms => [ :mri_20, :mri_21 ]
-  gem 'perftools.rb', :platforms => [ :mri_20, :mri_21 ], :require => 'perftools'
+#  gem 'perftools.rb', :platforms => [ :mri_20, :mri_21 ], :require => 'perftools'
   if RUBY_VERSION > '1.8.7'
     gem 'pry'
     gem 'pry-byebug', :platforms => [ :mri_20, :mri_21 ]
@@ -32,7 +32,7 @@ gem 'excon'
 gem 'typhoeus'
 
 if RUBY_VERSION >= '1.9'
-  gem 'moped'
+  gem 'moped', '1.3.2'
   gem 'eventmachine'
   gem 'em-synchrony'
   gem 'em-http-request'

data/lib/joboe_metal.rb

@@ -12,7 +12,7 @@ module Oboe_metal
   class Context
     class << self
       def toString
-        md = getMetadata.toHexString
+        getMetadata.toHexString
       end
 
       def fromString(xtrace)
@@ -71,9 +71,9 @@ module Oboe_metal
           Oboe::Config.tracing_mode = 'never'
         end
 
-        Oboe.sample_rate = cfg.sampleRate
+        Oboe.sample_rate = cfg.getSampleRate
         Oboe::Config.sample_rate = cfg.sampleRate
-        Oboe::Config.sample_source = cfg.sampleRateSource.a
+        Oboe::Config.sample_source = cfg.sampleRateSourceValue
       rescue => e
         Oboe.logger.debug "[oboe/debug] Couldn't retrieve/acces joboe sampleRateCfg"
         Oboe.logger.debug "[oboe/debug] #{e.message}"

data/lib/oboe/api/layerinit.rb

@@ -18,7 +18,19 @@ module Oboe
         return unless Oboe.loaded
 
         platform_info = Oboe::Util.build_init_report
+
+        # If already tracing, save and clear the context.  Restore it after
+        # the __Init is sent
+        context = nil
+
+        if Oboe.tracing?
+          context = Oboe::Context.toString
+          Oboe::Context.clear
+        end
+
         start_trace(layer, nil, platform_info.merge('Force' => true)) {}
+
+        Oboe::Context.fromString(context) if context
       end
 
       ##

data/lib/oboe/api/logging.rb

@@ -63,12 +63,13 @@ module Oboe
       #
       # Returns nothing.
       def log_start(layer, xtrace, opts = {})
-        return if !Oboe.loaded || Oboe.never? || 
+        return if !Oboe.loaded || Oboe.never? ||
                   (opts.key?(:URL) && ::Oboe::Util.static_asset?(opts[:URL]))
 
-        Oboe::Context.fromString(xtrace) if xtrace && !xtrace.to_s.empty?
+        Oboe::Context.fromString(xtrace) if Oboe.pickup_context?(xtrace)
 
         if Oboe.tracing?
+          Oboe.is_continued_trace = true
           log_entry(layer, opts)
         elsif opts.key?('Force') || Oboe.sample?(opts.merge(:layer => layer, :xtrace => xtrace))
           log_event(layer, 'entry', Oboe::Context.startTrace, opts)
@@ -84,7 +85,7 @@ module Oboe
         if Oboe.loaded
           log_event(layer, 'exit', Oboe::Context.createEvent, opts)
           xtrace = Oboe::Context.toString
-          Oboe::Context.clear
+          Oboe::Context.clear unless Oboe.has_incoming_context?
           xtrace
         end
       end

data/lib/oboe/base.rb

@@ -35,14 +35,79 @@ module OboeBase
   attr_accessor :sample_rate
   thread_local :layer_op
 
-  def self.included(cls)
-    cls.loaded = true
-  end
+  # The following accessors indicate the incoming tracing state received
+  # by the rack layer.  These are primarily used to identify state
+  # between the Ruby and JOboe instrumentation under JRuby.
+  #
+  # This is because that even though there may be an incoming
+  # X-Trace request header, tracing may have already been started
+  # by Joboe.  Such a scenario occurs when the application is being
+  # hosted by a Java container (such as Tomcat or Glassfish) and
+  # JOboe has already initiated tracing.  In this case, we shouldn't
+  # pickup the X-Trace context in the X-Trace header and we shouldn't
+  # set the outgoing response X-Trace header or clear context.
+  # Yeah I know.  Yuck.
+
+  # Occurs only on Jruby.  Indicates that Joboe (the java instrumentation)
+  # has already started tracing before it hit the JRuby instrumentation.
+  thread_local :has_incoming_context
+
+  # Indicates the existence of a valid X-Trace request header
+  thread_local :has_xtrace_header
+
+  # This indicates that this trace was continued from
+  # an incoming X-Trace request header or in the case
+  # of JRuby, a trace already started by JOboe.
+  thread_local :is_continued_trace
 
+  ##
+  # extended
+  #
+  # Invoked when this module is extended.
+  # e.g. extend OboeBase
+  #
   def self.extended(cls)
     cls.loaded = true
+
+    # This gives us pretty accessors with questions marks at the end
+    # e.g. is_continued_trace --> is_continued_trace?
+    Oboe.methods.select{ |m| m =~ /^is_|^has_/ }.each do |c|
+      unless c =~ /\?$|=$/
+        # Oboe.logger.debug "aliasing #{c}? to #{c}"
+        alias_method "#{c}?", c
+      end
+    end
+  end
+
+  ##
+  # pickup_context
+  #
+  # Determines whether we should pickup context
+  # from an incoming X-Trace request header.  The answer
+  # is generally yes but there are cases in JRuby under
+  # Tomcat (or Glassfish etc.) where tracing may have
+  # been already started by the Java instrumentation (Joboe)
+  # in which case we don't want to do this.
+  #
+  def pickup_context?(xtrace)
+    return false unless Oboe::XTrace.valid?(xtrace)
+
+    if defined?(JRUBY_VERSION) && Oboe.tracing?
+      return false
+    else
+      return true
+    end
   end
 
+  ##
+  # tracing_layer_op?
+  #
+  # Queries the thread local variable about the current
+  # operation being traced.  This is used in cases of recursive
+  # operation tracing or one instrumented operation calling another.
+  #
+  # In such cases, we only want to trace the outermost operation.
+  #
   def tracing_layer_op?(operation)
     if operation.is_a?(Array)
       return operation.include?(Oboe.layer_op)

data/lib/oboe/frameworks/rails/inst/active_record.rb

@@ -7,7 +7,7 @@ require 'oboe/frameworks/rails/inst/connection_adapters/mysql2'
 require 'oboe/frameworks/rails/inst/connection_adapters/postgresql'
 require 'oboe/frameworks/rails/inst/connection_adapters/oracle'
 
-if Oboe::Config[:active_record][:enabled]
+if Oboe::Config[:active_record][:enabled] && !defined?(JRUBY_VERSION)
   begin
     adapter = ActiveRecord::Base.connection.adapter_name.downcase
 

data/lib/oboe/inst/http.rb

@@ -11,6 +11,9 @@ if Oboe::Config[:nethttp][:enabled]
         return request_without_oboe(*args, &block)
       end
 
+      # If we're not tracing, just do a fast return
+      return request_without_oboe(*args, &block) unless Oboe.tracing?
+
       # Avoid cross host tracing for blacklisted domains
       blacklisted = Oboe::API.blacklisted?(addr_port)
 

data/lib/oboe/inst/moped.rb

@@ -450,10 +450,11 @@ if defined?(::Moped) && Oboe::Config[:moped][:enabled]
           end
         end
 
-        def aggregate_with_oboe(pipeline)
+        def aggregate_with_oboe(*pipeline)
           return aggregate_without_oboe(pipeline) unless Oboe.tracing?
 
           report_kvs = extract_trace_details(:aggregate)
+          report_kvs[:Query] = pipeline
 
           Oboe::API.trace('mongo', report_kvs) do
             aggregate_without_oboe(pipeline)

data/lib/oboe/inst/rack.rb

@@ -52,14 +52,24 @@ module Oboe
 
       if Oboe.always?
         # Only report these KVs under tracing_mode 'always' (never for 'through')
+        # These KVs need to be in the entry event for server side.
         report_kvs[:SampleRate]        = Oboe.sample_rate
         report_kvs[:SampleSource]      = Oboe.sample_source
       end
 
+      # Under JRuby, JOboe may have already started a trace.  Make note of this
+      # if so and don't clear context on log_end (see oboe/api/logging.rb)
+      Oboe.has_incoming_context = Oboe.tracing?
+
+      # Check for and validate X-Trace request header to pick up tracing context
       xtrace = env.is_a?(Hash) ? env['HTTP_X_TRACE'] : nil
+      xtrace_header = xtrace if xtrace && Oboe::XTrace.valid?(xtrace)
+      Oboe.has_xtrace_header = xtrace_header
 
-      result, xtrace = Oboe::API.start_trace('rack', xtrace, report_kvs) do
+      Oboe.is_continued_trace = Oboe.has_incoming_context or Oboe.has_xtrace_header
 
+      # The actual block of work to instrument
+      result, xtrace = Oboe::API.start_trace('rack', xtrace_header, report_kvs) do
         status, headers, response = @app.call(env)
 
         if Oboe.tracing?
@@ -73,8 +83,13 @@ module Oboe
       xtrace = e.instance_variable_get(:@xtrace)
       raise
     ensure
-      result[1]['X-Trace'] = xtrace if result && Oboe::XTrace.valid?(xtrace)
+      if result && Oboe::XTrace.valid?(xtrace)
+        unless defined?(JRUBY_VERSION) && Oboe.is_continued_trace?
+          result[1]['X-Trace'] = xtrace
+        end
+      end
       return result
     end
   end
 end
+

data/lib/oboe/version.rb

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

data/test/instrumentation/faraday_test.rb

@@ -22,10 +22,11 @@ describe Oboe::Inst::FaradayConnection do
 
   it "should trace a Faraday request to an instr'd app" do
     Oboe::API.start_trace('faraday_test') do
-      conn = Faraday.new(:url => 'http://www.appneta.com') do |faraday|
+      conn = Faraday.new(:url => 'http://www.gameface.in') do |faraday|
         faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
       end
-      response = conn.get '/?q=ruby_test_suite'
+      response = conn.get '/games?q=1'
+      response.headers["x-trace"].wont_match nil
     end
 
     traces = get_all_traces
@@ -39,8 +40,8 @@ describe Oboe::Inst::FaradayConnection do
     traces[3]['Layer'].must_equal 'net-http'
     traces[3]['IsService'].must_equal '1'
     traces[3]['RemoteProtocol'].must_equal 'HTTP'
-    traces[3]['RemoteHost'].must_equal 'www.appneta.com'
-    traces[3]['ServiceArg'].must_equal '/?q=ruby_test_suite'
+    traces[3]['RemoteHost'].must_equal 'www.gameface.in'
+    traces[3]['ServiceArg'].must_equal '/games?q=1'
     traces[3]['HTTPMethod'].must_equal 'GET'
     traces[3]['HTTPStatus'].must_equal '200'
 
@@ -118,10 +119,10 @@ describe Oboe::Inst::FaradayConnection do
 
   it 'should trace a Faraday with an alternate adapter' do
     Oboe::API.start_trace('faraday_test') do
-      conn = Faraday.new(:url => 'http://www.google.com') do |faraday|
+      conn = Faraday.new(:url => 'http://www.curlmyip.com') do |faraday|
         faraday.adapter :excon
       end
-      response = conn.get '/?q=ruby_test_suite'
+      response = conn.get '/?q=1'
     end
 
     traces = get_all_traces
@@ -134,8 +135,8 @@ describe Oboe::Inst::FaradayConnection do
 
     traces[2]['IsService'].must_equal '1'
     traces[2]['RemoteProtocol'].must_equal 'HTTP'
-    traces[2]['RemoteHost'].must_equal 'www.google.com'
-    traces[2]['ServiceArg'].must_equal '/?q=ruby_test_suite'
+    traces[2]['RemoteHost'].must_equal 'www.curlmyip.com'
+    traces[2]['ServiceArg'].must_equal '/?q=1'
     traces[2]['HTTPMethod'].downcase.must_equal 'get'
 
     traces[2]['Layer'].must_equal 'faraday'

data/test/instrumentation/http_test.rb

@@ -23,10 +23,12 @@ describe Oboe::Inst do
 
   it "should trace a Net::HTTP request to an instr'd app" do
     Oboe::API.start_trace('net-http_test', '', {}) do
-      uri = URI('http://www.appneta.com')
+      uri = URI('http://www.gameface.in/games?q=1')
       http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = false
-      http.get('/?q=ruby_test_suite').read_body
+      request = Net::HTTP::Get.new(uri.request_uri)
+      response = http.request(request)
+      # The HTTP response should have an X-Trace header inside of it
+      response["x-trace"].wont_match nil
     end
 
     traces = get_all_traces
@@ -37,8 +39,8 @@ describe Oboe::Inst do
     traces[1]['Layer'].must_equal 'net-http'
     traces[2]['IsService'].must_equal "1"
     traces[2]['RemoteProtocol'].must_equal "HTTP"
-    traces[2]['RemoteHost'].must_equal "www.appneta.com"
-    traces[2]['ServiceArg'].must_equal "/?q=ruby_test_suite"
+    traces[2]['RemoteHost'].must_equal "www.gameface.in"
+    traces[2]['ServiceArg'].must_equal "/games?q=1"
     traces[2]['HTTPMethod'].must_equal "GET"
     traces[2]['HTTPStatus'].must_equal "200"
     traces[2].has_key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]
@@ -46,10 +48,9 @@ describe Oboe::Inst do
 
   it "should trace a Net::HTTP request" do
     Oboe::API.start_trace('net-http_test', '', {}) do
-      uri = URI('https://www.google.com')
+      uri = URI('http://www.curlmyip.com')
       http = Net::HTTP.new(uri.host, uri.port)
-      http.use_ssl = true
-      http.get('/?q=ruby_test_suite').read_body
+      http.get('/?q=1').read_body
     end
 
     traces = get_all_traces
@@ -59,9 +60,9 @@ describe Oboe::Inst do
 
     traces[1]['Layer'].must_equal 'net-http'
     traces[2]['IsService'].must_equal "1"
-    traces[2]['RemoteProtocol'].must_equal "HTTPS"
-    traces[2]['RemoteHost'].must_equal "www.google.com"
-    traces[2]['ServiceArg'].must_equal "/?q=ruby_test_suite"
+    traces[2]['RemoteProtocol'].must_equal "HTTP"
+    traces[2]['RemoteHost'].must_equal "www.curlmyip.com"
+    traces[2]['ServiceArg'].must_equal "/?q=1"
     traces[2]['HTTPMethod'].must_equal "GET"
     traces[2]['HTTPStatus'].must_equal "200"
     traces[2].has_key?('Backtrace').must_equal Oboe::Config[:nethttp][:collect_backtraces]

data/test/instrumentation/memcache_test.rb

@@ -4,7 +4,7 @@ require 'memcache'
 describe Oboe::API::Memcache do
   before do
     clear_all_traces
-    @mc = ::MemCache.new('localhost')
+    @mc = ::MemCache.new('127.0.0.1')
 
     # These are standard entry/exit KVs that are passed up with all mongo operations
     @entry_kvs = {
@@ -77,7 +77,7 @@ describe Oboe::API::Memcache do
 
     validate_event_keys(traces[2], @info_kvs)
     traces[2]['KVKey'].must_equal "msg"
-    traces[2]['RemoteHost'].must_equal "localhost"
+    traces[2]['RemoteHost'].must_equal "127.0.0.1"
     traces[2].has_key?('Backtrace').must_equal Oboe::Config[:memcache][:collect_backtraces]
 
     traces[3].has_key?('KVHit').must_equal true

data/test/instrumentation/memcached_test.rb

@@ -7,7 +7,7 @@ if RUBY_VERSION < '2.0' and not defined?(JRUBY_VERSION)
 
     before do
       clear_all_traces
-      @mc = ::Memcached::Rails.new(:servers => ['localhost'])
+      @mc = ::Memcached::Rails.new(:servers => ['127.0.0.1'])
 
       # These are standard entry/exit KVs that are passed up with all mongo operations
       @entry_kvs = {

data/test/instrumentation/moped_test.rb

@@ -449,6 +449,27 @@ if RUBY_VERSION >= '1.9.3'
       validate_event_keys(traces[4], @exit_kvs)
     end
 
+    it 'should trace aggregate' do
+      Oboe::API.start_trace('moped_test', '', {}) do
+        @users.aggregate(
+          {'$match' => {:name => "Mary"}},
+          {'$group' => {"_id" => "$name"}}
+        )
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'moped_test')
+
+      validate_event_keys(traces[1], @entry_kvs)
+      traces[1]['QueryOp'].must_equal "aggregate"
+      traces[1]['Query'].must_equal "[{\"$match\"=>{:name=>\"Mary\"}}, {\"$group\"=>{\"_id\"=>\"$name\"}}]"
+      traces[1]['Collection'].must_equal "users"
+      traces[1].has_key?('Backtrace').must_equal Oboe::Config[:moped][:collect_backtraces]
+      validate_event_keys(traces[2], @exit_kvs)
+    end
+
     it "should obey :collect_backtraces setting when true" do
       Oboe::Config[:moped][:collect_backtraces] = true
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oboe
 version: !ruby/object:Gem::Version
-  version: 2.7.5.1
+  version: 2.7.6.2
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-20 00:00:00.000000000 Z
+date: 2014-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -213,4 +213,3 @@ test_files:
 - test/support/liboboe_settings_test.rb
 - test/support/config_test.rb
 - test/support/xtrace_test.rb
-has_rdoc: