oboe 2.7.0.3-java → 2.7.1.7-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f0a040f9289a43385bb49458b187fbecbfd5ffb
-  data.tar.gz: 614168d4ec921cf592a3c705cc8cedccaad842b4
+  metadata.gz: 2f61d146e29c52fd9cfd7df4b64e37907660c646
+  data.tar.gz: 6e0643dfdd8202eab11ddf38f0f5ddc36b67d563
 SHA512:
-  metadata.gz: 142a42184a68638aaeb72b9db3ee4e23f8424dc7c884f115109fa05cfe40878a53fcee5cf9b2789806dea560f2fd0dc35662413ee2b054eb292dfbad040648cc
-  data.tar.gz: ecf5a96ff5be01a9b7185e346e2f8cdba3b56a6facd0d8aa22ccdd1d890b6f901db524870d7c4c30af26b3977a093af42508f0713c6c02ec34aa0c8f2ab777d7
+  metadata.gz: f1ee3d5063bae9674ac2083a12a08459aa5103f209d7d7548df53ad5e7edc721b45182fa96483d3ab3e196a6ebb9cd53355d2150b1800fc1194e453a24a61e23
+  data.tar.gz: ff2ec048ad2c95013644396bf71a3fb3626b737b51c9be8796d5de835e3c07eee6660d0fa8dd1ed9608ae9bc35df10308b62c8faf8e213a1123026a2ffcca6b7

data/CHANGELOG.md

@@ -1,12 +1,19 @@
-# oboe 2.7.0 (08/13/2014)
+# oboe 2.7.0.3 (08/19/2014)
 
 This minor release includes:
 
-* [JRuby instrumentation](https://github.com/appneta/oboe-ruby/pull/51) is back and better than ever
+* [JRuby instrumentation](https://github.com/appneta/oboe-ruby/pull/51) is back and better than ever.
 * [Updated moped instrumentation](https://github.com/appneta/oboe-ruby/pull/63) to support moped v2 changes
 * Simplify start_trace by setting a default param: [#67](https://github.com/appneta/oboe-ruby/pull/67)
 
-Pushed to Rubygems: https://rubygems.org/gems/oboe/versions/2.7.0
+This release also includes [our first pure java platform Ruby gem](https://rubygems.org/gems/oboe/versions/2.7.0.3-java) (no c-extension for JRuby yay!).
+
+Pushed to Rubygems:
+
+https://rubygems.org/gems/oboe/versions/2.7.0.3
+https://rubygems.org/gems/oboe/versions/2.7.0.3-java
+
+Related: http://www.appneta.com/blog/jruby-whole-java-world/
 
 # oboe 2.6.8 (07/31/2014)
 

data/Gemfile

@@ -12,7 +12,11 @@ group :development do
   gem 'debugger',     :platform  =>   :mri_19
   gem 'byebug',       :platforms => [ :mri_20, :mri_21 ]
   gem 'perftools.rb', :platforms => [ :mri_20, :mri_21 ], :require => 'perftools'
-  gem 'pry'
+  if RUBY_VERSION > '1.8.7'
+    gem 'pry'
+  else
+    gem 'pry', '0.9.12.4'
+  end
 end
 
 # Instrumented gems
@@ -20,10 +24,16 @@ gem 'dalli'
 gem 'memcache-client'
 gem 'cassandra'
 gem 'mongo'
-gem 'moped' if RUBY_VERSION >= '1.9'
 gem 'resque'
 gem 'redis'
 
+if RUBY_VERSION >= '1.9'
+  gem 'moped'
+  gem 'eventmachine'
+  gem 'em-synchrony'
+  gem 'em-http-request'
+end
+
 unless defined?(JRUBY_VERSION)
   gem 'memcached', '1.7.2' if RUBY_VERSION < '2.0.0'
   gem 'bson_ext' # For Mongo, Yours Truly

data/lib/joboe_metal.rb

@@ -1,8 +1,6 @@
 # Copyright (c) 2013 AppNeta, Inc.
 # All rights reserved.
 
-require 'base'
-
 module Oboe_metal
   include_package 'com.tracelytics.joboe'
   java_import 'com.tracelytics.joboe.LayerUtil'

data/lib/oboe.rb

@@ -2,21 +2,24 @@
 # All rights reserved.
 
 begin
-  require 'oboe/version'
-  require 'oboe/logger'
-  require 'oboe/util'
-  require 'oboe/xtrace'
-
-  # If Oboe_metal is already defined then we are in a PaaS environment
-  # with an alternate metal (such as Heroku: see the oboe-heroku gem)
-  unless defined?(Oboe_metal)
+  require "oboe/version"
+  require "oboe/thread_local"
+  require "oboe/logger"
+  require "oboe/util"
+  require "oboe/xtrace"
+
+  # If OboeHeroku is already defined then we are in a PaaS environment
+  # with an alternate metal (see the oboe-heroku gem)
+  unless defined?(OboeHeroku)
+    require "oboe/base"
+
     begin
       if RUBY_PLATFORM == 'java'
-        require '/usr/local/tracelytics/tracelyticsagent.jar'
-        require 'joboe_metal'
+        require "/usr/local/tracelytics/tracelyticsagent.jar"
+        require "joboe_metal"
       else
-        require 'oboe_metal.so'
-        require 'oboe_metal'
+        require "oboe_metal.so"
+        require "oboe_metal"
       end
     rescue LoadError
       Oboe.loaded = false
@@ -30,18 +33,19 @@ begin
     end
   end
 
-  require 'oboe/config'
-  require 'oboe/loading'
-  require 'method_profiling'
-  require 'oboe/instrumentation'
-  require 'oboe/ruby'
+  require "oboe/config"
 
-  # Frameworks
   if Oboe.loaded
-    require 'oboe/frameworks/rails'   if defined?(::Rails)
-    require 'oboe/frameworks/sinatra' if defined?(::Sinatra)
-    require 'oboe/frameworks/padrino' if defined?(::Padrino)
-    require 'oboe/frameworks/grape'   if defined?(::Grape)
+    require "oboe/loading"
+    require "method_profiling"
+    require "oboe/instrumentation"
+    require "oboe/ruby"
+
+    # Frameworks
+    require "oboe/frameworks/rails"   if defined?(::Rails)
+    require "oboe/frameworks/sinatra" if defined?(::Sinatra)
+    require "oboe/frameworks/padrino" if defined?(::Padrino)
+    require "oboe/frameworks/grape"   if defined?(::Grape)
   end
 rescue Exception => e
   $stderr.puts "[oboe/error] Problem loading: #{e.inspect}"

data/lib/{base.rb → oboe/base.rb}

@@ -23,11 +23,13 @@ ZERO_SAMPLE_RATE_MASK   = 0b1111000000000000000000000000
 ZERO_SAMPLE_SOURCE_MASK = 0b0000111111111111111111111111
 
 module OboeBase
+  extend ::Oboe::ThreadLocal
+
   attr_accessor :reporter
   attr_accessor :loaded
   attr_accessor :sample_source
   attr_accessor :sample_rate
-  attr_accessor :layer_op
+  thread_local :layer_op
 
   def self.included(cls)
     self.loaded = true
@@ -35,9 +37,9 @@ module OboeBase
 
   def tracing_layer_op?(operation)
     if operation.is_a?(Array)
-      return operation.include?(@layer_op)
+      return operation.include?(Oboe.layer_op)
     else
-      return @layer_op == operation
+      return Oboe.layer_op == operation
     end
   end
 
@@ -97,3 +99,6 @@ module OboeBase
   end
 end
 
+module Oboe
+  extend OboeBase
+end

data/lib/oboe/config.rb

@@ -11,10 +11,9 @@ module Oboe
   module Config
     @@config = {}
 
-    @@instrumentation = [ :cassandra, :dalli, :nethttp, :memcached, :memcache, :mongo,
-                          :moped, :rack, :redis, :resque, :action_controller, :action_view,
-                          :active_record ]
-
+    @@instrumentation = [ :action_controller, :action_view, :active_record,
+                          :cassandra, :dalli, :em_http_request, :nethttp, :memcached,
+                          :memcache, :mongo, :moped, :rack, :redis, :resque]
     ##
     # Return the raw nested hash.
     #
@@ -31,12 +30,16 @@ module Oboe
         @@config[k][:log_args] = true
       end
 
+      # Beta instrumentation disabled by default
+      Oboe::Config[:em_http_request][:enabled] = false
+
       # Set collect_backtraces defaults
       Oboe::Config[:action_controller][:collect_backtraces] = true
       Oboe::Config[:active_record][:collect_backtraces] = true
       Oboe::Config[:action_view][:collect_backtraces] = true
       Oboe::Config[:cassandra][:collect_backtraces] = true
       Oboe::Config[:dalli][:collect_backtraces] = false
+      Oboe::Config[:em_http_request][:collect_backtraces] = false
       Oboe::Config[:memcache][:collect_backtraces] = false
       Oboe::Config[:memcached][:collect_backtraces] = false
       Oboe::Config[:mongo][:collect_backtraces] = true
@@ -114,15 +117,19 @@ module Oboe
         # Assure value is an integer
         @@config[key.to_sym] = value.to_i
 
-        Oboe.set_sample_rate(value)
+        Oboe.set_sample_rate(value) if Oboe.loaded
       end
 
       # Update liboboe if updating :tracing_mode
       if key == :tracing_mode
-        Oboe.set_tracing_mode(value)
+        Oboe.set_tracing_mode(value) if Oboe.loaded
       end
     end
 
+    def self.instrumentation_list
+      @@instrumentation
+    end
+
     def self.method_missing(sym, *args)
       if sym.to_s =~ /(.+)=$/
         self[$1] = args.first
@@ -137,4 +144,3 @@ module Oboe
 end
 
 Oboe::Config.initialize
-

data/lib/oboe/inst/em-http-request.rb

@@ -0,0 +1,99 @@
+module Oboe
+  module Inst
+    module EventMachine
+      module HttpConnection
+        def setup_request_with_oboe(*args, &block)
+          report_kvs = {}
+          context = Oboe::Context.toString
+          blacklisted = Oboe::API.blacklisted?(@uri)
+
+          begin
+            report_kvs["IsService"] = 1
+            report_kvs["RemoteURL"] = @uri
+            report_kvs["HTTPMethod"] = args[0]
+            report_kvs["Blacklisted"] = true if blacklisted
+
+            if Oboe::Config[:em_http_request][:collect_backtraces]
+              report_kvs[:Backtrace] = Oboe::API.backtrace
+            end
+          rescue => e
+            Oboe.logger.debug "[oboe/debug] em-http-request KV error: #{e.inspect}"
+          end
+
+          ::Oboe::API.log_entry("em-http-request", report_kvs)
+          client = setup_request_without_oboe(*args, &block)
+          client.req.headers["X-Trace"] = context unless blacklisted
+          client
+        end
+      end
+
+      module HttpClient
+        def parse_response_header_with_oboe(*args, &block)
+          report_kvs = {}
+          xtrace = nil
+          blacklisted = Oboe::API.blacklisted?(@uri)
+
+          begin
+            report_kvs[:HTTPStatus] = args[2]
+            report_kvs[:Async] = 1
+          rescue => e
+            Oboe.logger.debug "[oboe/debug] em-http-request KV error: #{e.inspect}"
+          end
+
+          parse_response_header_without_oboe(*args, &block)
+
+          unless blacklisted
+            headers = args[0]
+            context = Oboe::Context.toString
+            task_id = Oboe::XTrace.task_id(context)
+
+            if headers.is_a?(Hash) && headers.has_key?("X-Trace")
+              xtrace = headers["X-Trace"]
+            end
+
+            if 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_exit("em-http-request", report_kvs)
+        end
+      end
+    end
+  end
+end
+
+if RUBY_VERSION >= "1.9"
+  if defined?(::EventMachine::HttpConnection) && defined?(::EventMachine::HttpClient) && Oboe::Config[:em_http_request][:enabled]
+    Oboe.logger.info "[oboe/loading] Instrumenting em-http-request" if Oboe::Config[:verbose]
+
+    class ::EventMachine::HttpConnection
+      include Oboe::Inst::EventMachine::HttpConnection
+
+      if method_defined?(:setup_request)
+        class_eval 'alias :setup_request_without_oboe :setup_request'
+        class_eval 'alias :setup_request :setup_request_with_oboe'
+      else
+        Oboe.logger.warn "[oboe/loading] Couldn't properly instrument em-http-request (:setup_request).  Partial traces may occur."
+      end
+    end
+
+    class ::EventMachine::HttpClient
+      include Oboe::Inst::EventMachine::HttpClient
+
+      if method_defined?(:parse_response_header)
+        class_eval 'alias :parse_response_header_without_oboe :parse_response_header'
+        class_eval 'alias :parse_response_header :parse_response_header_with_oboe'
+      else
+        Oboe.logger.warn "[oboe/loading] Couldn't properly instrument em-http-request (:parse_response_header).  Partial traces may occur."
+      end
+    end
+  end
+end

data/lib/oboe/thread_local.rb

@@ -0,0 +1,18 @@
+# Copyright (c) 2014 AppNeta, Inc.
+# All rights reserved.
+
+module Oboe
+  module ThreadLocal
+    def thread_local(name)
+      key = "__#{self}_#{name}__".intern
+
+      define_method(name) do
+        Thread.current[key]
+      end
+
+      define_method(name.to_s + "=") do |value|
+        Thread.current[key] = value
+      end
+    end
+  end
+end

data/lib/oboe/version.rb

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

data/lib/oboe_metal.rb

@@ -1,8 +1,6 @@
 # Copyright (c) 2013 AppNeta, Inc.
 # All rights reserved.
 
-require 'base'
-
 module Oboe
   extend OboeBase
   include Oboe_metal

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

@@ -59,6 +59,7 @@ if defined?(Oboe::Config)
   # Oboe::Config[:nethttp][:enabled] = true
   # Oboe::Config[:redis][:enabled] = true
   # Oboe::Config[:resque][:enabled] = true
+  # Oboe::Config[:em_http_request][:enabled] = true
 
   #
   # Enabling/Disabling Backtrace Collection
@@ -80,6 +81,7 @@ if defined?(Oboe::Config)
   # Oboe::Config[:nethttp][:collect_backtraces] = true
   # Oboe::Config[:redis][:collect_backtraces] = false
   # Oboe::Config[:resque][:collect_backtraces] = true
+  # Oboe::Config[:em_http_request][:collect_backtraces] = true
   #
 
   #

data/test/instrumentation/em_http_request_test.rb

@@ -0,0 +1,86 @@
+require 'minitest_helper'
+
+# Disable this test on JRuby until we can investigate
+# "SOCKET: SET COMM INACTIVITY UNIMPLEMENTED 10"
+# https://travis-ci.org/appneta/oboe-ruby/jobs/33745752
+if RUBY_VERSION >= '1.9' and Oboe::Config[:em_http_request][:enabled] and not defined?(JRUBY_VERSION)
+
+  describe Oboe::Inst::EventMachine::HttpConnection do
+    before do
+      clear_all_traces
+      @collect_backtraces = Oboe::Config[:em_http_request][:collect_backtraces]
+    end
+
+    after do
+      Oboe::Config[:em_http_request][:collect_backtraces] = @collect_backtraces
+    end
+
+    it 'EventMachine::HttpConnection should be loaded, defined and ready' do
+      defined?(::EventMachine::HttpConnection).wont_match nil
+    end
+
+    it 'should have oboe methods defined' do
+      ::EventMachine::HttpConnection.method_defined?("setup_request_with_oboe").must_equal true
+    end
+
+    it 'should trace request' do
+      Oboe::API.start_trace('em-http-request_test', '', {}) do
+        EventMachine.run do
+          http = EventMachine::HttpRequest.new('http://appneta.com/').get
+          http.callback do
+            EventMachine.stop
+          end
+        end
+      end
+
+      traces = get_all_traces
+
+      traces.count.must_equal 4
+      validate_outer_layers(traces, 'em-http-request_test')
+
+      traces[1]["Layer"].must_equal "em-http-request"
+      traces[1]["Label"].must_equal "entry"
+      traces[1]["IsService"].must_equal "1"
+      traces[1]["RemoteURL"].must_equal "http://appneta.com/"
+      traces[1].has_key?('Backtrace').must_equal Oboe::Config[:em_http_request][:collect_backtraces]
+
+      traces[2]["Layer"].must_equal "em-http-request"
+      traces[2]["Label"].must_equal "exit"
+      traces[2]["Async"].must_equal "1"
+      traces[2].has_key?('Backtrace').must_equal Oboe::Config[:em_http_request][:collect_backtraces]
+    end
+
+    it "should obey :collect_backtraces setting when true" do
+      Oboe::Config[:em_http_request][:collect_backtraces] = true
+
+      Oboe::API.start_trace('em-http-request_test', '', {}) do
+        EventMachine.run do
+          http = EventMachine::HttpRequest.new('http://appneta.com/').get
+          http.callback do
+            EventMachine.stop
+          end
+        end
+      end
+
+      traces = get_all_traces
+      layer_has_key(traces, 'em-http-request', 'Backtrace')
+    end
+
+    it "should obey :collect_backtraces setting when false" do
+      Oboe::Config[:em_http_request][:collect_backtraces] = false
+
+      Oboe::API.start_trace('em-http-request_test', '', {}) do
+        EventMachine.run do
+          http = EventMachine::HttpRequest.new('http://appneta.com/').get
+          http.callback do
+            EventMachine.stop
+          end
+        end
+      end
+
+      traces = get_all_traces
+      layer_doesnt_have_key(traces, 'em-http-request', 'Backtrace')
+    end
+  end
+
+end # unless defined?(JRUBY_VERSION)

data/test/support/config_test.rb

@@ -20,17 +20,40 @@ describe Oboe::Config do
     # Reset Oboe::Config to defaults
     Oboe::Config.initialize
 
-    instrumentation = [ :cassandra, :dalli, :nethttp, :memcached, :memcache, :mongo,
-                        :moped, :rack, :resque, :action_controller, :action_view,
-                        :active_record ]
+    instrumentation = Oboe::Config.instrumentation_list
 
     # Verify the number of individual instrumentations
-    instrumentation.count.must_equal 12
-
-    instrumentation.each do |k|
-      Oboe::Config[k][:enabled].must_equal true
-      Oboe::Config[k][:log_args].must_equal true
-    end
+    instrumentation.count.must_equal 14
+
+    Oboe::Config[:action_controller][:enabled].must_equal true
+    Oboe::Config[:action_view][:enabled].must_equal true
+    Oboe::Config[:active_record][:enabled].must_equal true
+    Oboe::Config[:cassandra][:enabled].must_equal true
+    Oboe::Config[:dalli][:enabled].must_equal true
+    Oboe::Config[:em_http_request][:enabled].must_equal false
+    Oboe::Config[:nethttp][:enabled].must_equal true
+    Oboe::Config[:memcached][:enabled].must_equal true
+    Oboe::Config[:memcache][:enabled].must_equal true
+    Oboe::Config[:mongo][:enabled].must_equal true
+    Oboe::Config[:moped][:enabled].must_equal true
+    Oboe::Config[:rack][:enabled].must_equal true
+    Oboe::Config[:redis][:enabled].must_equal true
+    Oboe::Config[:resque][:enabled].must_equal true
+
+    Oboe::Config[:action_controller][:log_args].must_equal true
+    Oboe::Config[:action_view][:log_args].must_equal true
+    Oboe::Config[:active_record][:log_args].must_equal true
+    Oboe::Config[:cassandra][:log_args].must_equal true
+    Oboe::Config[:dalli][:log_args].must_equal true
+    Oboe::Config[:em_http_request][: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
+    Oboe::Config[:mongo][:log_args].must_equal true
+    Oboe::Config[:moped][:log_args].must_equal true
+    Oboe::Config[:rack][:log_args].must_equal true
+    Oboe::Config[:redis][:log_args].must_equal true
+    Oboe::Config[:resque][:log_args].must_equal true
 
     Oboe::Config[:resque][:link_workers].must_equal false
     Oboe::Config[:blacklist].is_a?(Array).must_equal true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oboe
 version: !ruby/object:Gem::Version
-  version: 2.7.0.3
+  version: 2.7.1.7
 platform: java
 authors:
 - Peter Giacomo Lombardo
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -66,7 +66,6 @@ files:
 - gemfiles/moped.gemfile
 - get_version.rb
 - init.rb
-- lib/base.rb
 - lib/joboe_metal.rb
 - lib/method_profiling.rb
 - lib/oboe.rb
@@ -77,6 +76,7 @@ files:
 - lib/oboe/api/profiling.rb
 - lib/oboe/api/tracing.rb
 - lib/oboe/api/util.rb
+- lib/oboe/base.rb
 - lib/oboe/config.rb
 - lib/oboe/frameworks/grape.rb
 - lib/oboe/frameworks/padrino.rb
@@ -99,6 +99,7 @@ files:
 - lib/oboe/frameworks/sinatra/templates.rb
 - lib/oboe/inst/cassandra.rb
 - lib/oboe/inst/dalli.rb
+- lib/oboe/inst/em-http-request.rb
 - lib/oboe/inst/http.rb
 - lib/oboe/inst/memcache.rb
 - lib/oboe/inst/memcached.rb
@@ -111,6 +112,7 @@ files:
 - lib/oboe/loading.rb
 - lib/oboe/logger.rb
 - lib/oboe/ruby.rb
+- lib/oboe/thread_local.rb
 - lib/oboe/util.rb
 - lib/oboe/version.rb
 - lib/oboe/xtrace.rb
@@ -127,6 +129,7 @@ files:
 - test/frameworks/sinatra_test.rb
 - test/instrumentation/cassandra_test.rb
 - test/instrumentation/dalli_test.rb
+- test/instrumentation/em_http_request_test.rb
 - test/instrumentation/http_test.rb
 - test/instrumentation/memcache_test.rb
 - test/instrumentation/memcached_test.rb
@@ -188,6 +191,7 @@ test_files:
 - test/instrumentation/redis_sets_test.rb
 - test/instrumentation/http_test.rb
 - test/instrumentation/resque_test.rb
+- test/instrumentation/em_http_request_test.rb
 - test/instrumentation/moped_test.rb
 - test/instrumentation/rack_test.rb
 - test/instrumentation/memcache_test.rb