oboe 2.6.8 → 2.7.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00e70b05a4e3e6fed6f8e9aaf40d1a716049b556
-  data.tar.gz: a24fdb8ad85e75927854011e25e64f4d5d09fc44
+  metadata.gz: 7835aa1d91871340702efcd183ca19671ed7657d
+  data.tar.gz: 9e798783e0b7a3b00b24a73e85e689161911cef7
 SHA512:
-  metadata.gz: ef5339b9b487819eeb6e45aba7527b127c985d2e707697ed44952a757461f0206ddd761e5bd4a8efb978acad95762412e42b0ee6cc03b5e42592f5596f575ca0
-  data.tar.gz: 723de2eb92aded756128afbc01516255148c2078588ecdcf3062939552d7e7731f1ee38291636b4695caebc42ec34ee283651cf73aa6edf452fbed7537b33114
+  metadata.gz: aa269012fc13f4b4c27e2daff5270802d9875d3f04827a461245982e55f26f5cb57c495f59c153add71ed4a13d63d447d67b0f0a43b7134efd88d61cac8bdd52
+  data.tar.gz: 406c373f4c9325c526448b59776b08edc05d4e334e50924d677a0b65a283ae114c4a71861215ebfbf08cdc92552a1d99381f4cd41f451e46ea84d347c8369570

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
+
+cache: 
+  bundler: true
+  directories:
+  - vendor/bundle
+
 rvm:
   - 2.1.1
   - 2.0.0
@@ -6,6 +12,7 @@ rvm:
   - 1.9.2
   - 1.8.7
   - ree
+  - jruby-19mode
 
 #gemfile:
 #  - gemfiles/mongo.gemfile
@@ -25,6 +32,7 @@ before_script: sleep 10
 install: 
   - wget https://www.tracelytics.com/install_tracelytics.sh
   - sudo sh ./install_tracelytics.sh f51e2a43-0ee5-4851-8a54-825773b3218e
+  - sudo apt-get install -y tracelytics-java-agent
 
 before_script:
   - bundle install --without development
@@ -38,3 +46,6 @@ services:
   - cassandra
   - redis
 
+matrix:
+  allow_failures:
+ 

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# oboe 2.7.0 (08/13/2014)
+
+This minor release includes:
+
+* [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
+
+# oboe 2.6.8 (07/31/2014)
+
+This patch release includes:
+
+* Fix [instrumentation load for Padrino in test environments](https://github.com/appneta/oboe-ruby/pull/65)
+* [Add delay](https://github.com/appneta/oboe-ruby/pull/66) in test suite to allow downloading of sample rate info
+
+Pushed to Rubygems: https://rubygems.org/gems/oboe/versions/2.6.8
+
 # oboe 2.6.7.1 (07/23/2014)
 
 This patch release includes better error handling, API clean-up and RUM template improvements.

data/Gemfile

@@ -8,8 +8,8 @@ group :development, :test do
 end
 
 group :development do
-  gem 'ruby-debug',   :platform  => :mri_18
-  gem 'debugger',     :platform  => :mri_19
+  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 'pry'
@@ -18,15 +18,24 @@ end
 # Instrumented gems
 gem 'dalli'
 gem 'memcache-client'
-gem 'memcached', '1.7.2' if RUBY_VERSION < '2.0.0'
 gem 'cassandra'
 gem 'mongo'
-gem 'moped', '~> 1.5' if RUBY_VERSION >= '1.9'
+gem 'moped' if RUBY_VERSION >= '1.9'
 gem 'resque'
 gem 'redis'
 
+unless defined?(JRUBY_VERSION)
+  gem 'memcached', '1.7.2' if RUBY_VERSION < '2.0.0'
+  gem 'bson_ext' # For Mongo, Yours Truly
+end
+
 # Instrumented Frameworks
-gem 'sinatra'
+
+if defined?(JRUBY_VERSION)
+  gem 'sinatra', :require => false
+else
+  gem 'sinatra'
+end
 
 if RUBY_VERSION >= '1.9.3'
   gem 'padrino', '0.12.0'
@@ -36,6 +45,5 @@ else
   gem 'bson', '1.10.2'
 end
 
-# Import dependencies from oboe.gemspec
-gemspec :name => 'oboe'
+gemspec
 

data/README.md

@@ -21,19 +21,21 @@ The oboe gem is [available on Rubygems](https://rubygems.org/gems/oboe) and can
 gem install oboe
 ```
 
-or added to your bundle Gemfile and running `bundle install`:
+or added to _the end_ of your bundle Gemfile and running `bundle install`:
 
 ```ruby
 gem 'oboe'
 ```
 
+On Heroku?  Use the `oboe-heroku` gem instead.  It wraps some additional functionality specialized for Heroku.
+
 # Running
 
 ## Rails
 
 No special steps are needed to instrument Ruby on Rails.  Once part of the bundle, the oboe gem will automatically detect Rails and instrument on stack initialization.
 
-*Note: You will still need to decide on your `tracing_mode` depending on whether you are running with an instrumented Apache or nginx in front of your Rails stack.  See below for more details.*
+*Note: Unless you are Heroku, you will still need to decide on your `tracing_mode` depending on whether you are running with an instrumented Apache or nginx in front of your Rails stack.  See below for more details.*
 
 ### The Install Generator
 
@@ -62,15 +64,11 @@ require 'oboe'
 # order to initiate tracing.
 Oboe::Config[:tracing_mode] = 'through'
 
-# You can remove the following line in production to allow for
-# auto sampling or managing the sample rate through the TraceView portal.
-# Oboe::Config[:sample_rate] = 1000000
-
 # You may want to replace the Oboe.logger with whichever logger you are using
 # Oboe.logger = Sinatra.logger
 ```
 
-Note: If you're on Heroku, you don't need to set `tracing_mode` or `sample_rate` - they will be automatically configured.
+Note: If you're on Heroku, you don't need to set `tracing_mode` - it will be automatically configured.
 
 Make sure that the oboe gem is loaded _after_ Sinatra either by listing `gem 'oboe'` after Sinatra in your Gemfile or calling the `require 'oboe'` directive after Sinatra is loaded.
 
@@ -90,14 +88,10 @@ Padrino.before_load do
   # from upstream) and "never". You must set this directive to "always" in
   # order to initiate tracing.
   Oboe::Config[:tracing_mode] = 'always'
-
-  # You can remove the following line in production to allow for
-  # auto sampling or managing the sample rate through the TraceView portal.
-  Oboe::Config[:sample_rate] = 1e6
 end
 ```
 
-Note: If you're on Heroku, you don't need to set `tracing_mode` or `sample_rate` - they will be automatically configured.
+Note: If you're on Heroku, you don't need to set `tracing_mode` - it will be automatically configured.
 
 ## Grape
 
@@ -114,10 +108,6 @@ You can instrument your Grape application by adding the following code to your `
     # order to initiate tracing.
     Oboe::Config[:tracing_mode] = 'through'
     
-    # You can remove the following line in production to allow for
-    # auto sampling or managing the sample rate through the TraceView portal.
-    # Oboe::Config[:sample_rate] = 1000000
-    
     ...
 
     class App < Grape::API
@@ -125,7 +115,7 @@ You can instrument your Grape application by adding the following code to your `
     end
 ```
 
-Note: If you're on Heroku, you don't need to set `tracing_mode` or `sample_rate` - they will be automatically configured.
+Note: If you're on Heroku, you don't need to set `tracing_mode` - it will be automatically configured.
 
 Make sure that the oboe gem is loaded _after_ Grape either by listing `gem 'oboe'` after Grape in your Gemfile or calling the `require 'oboe'` directive after Grape is loaded.
 
@@ -146,9 +136,6 @@ require 'oboe'
 # Tracing mode can be 'never', 'through' (to follow upstream) or 'always'
 Oboe::Config[:tracing_mode] = 'always'
 
-# Number of requests to trace out of each million
-Oboe::Config[:sample_rate] = 1000000
-
 Oboe::Ruby.initialize
 ```
 

data/Rakefile

@@ -9,6 +9,9 @@ Rake::TestTask.new do |t|
   t.libs << "test"
   t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
+  if defined?(JRUBY_VERSION)
+    t.ruby_opts = ["-J-javaagent:/usr/local/tracelytics/tracelyticsagent.jar"]
+  end
 end
 
 if !ENV["APPRAISAL_INITIALIZED"] && !ENV["TRAVIS"]
@@ -19,62 +22,74 @@ end
 
 desc "Build the gem's c extension"
 task :compile do
-  puts "== Building the c extension against Ruby #{RUBY_VERSION}"
-
-  pwd     = Dir.pwd
-  ext_dir = File.expand_path('ext/oboe_metal')
-  lib_dir = File.expand_path('lib')
-  symlink = File.expand_path('lib/oboe_metal.so')
-  so_file = File.expand_path('ext/oboe_metal/oboe_metal.so')
-
-  Dir.chdir ext_dir
-  cmd = [ Gem.ruby, 'extconf.rb']
-  sh cmd.join(' ')
-  sh '/usr/bin/env make'
-  File.delete symlink if File.exist? symlink
-
-  if File.exists? so_file
-    File.symlink so_file, symlink
-    Dir.chdir pwd
-    puts "== Extension built and symlink'd to #{symlink}"
+  unless defined?(JRUBY_VERSION)
+    puts "== Building the c extension against Ruby #{RUBY_VERSION}"
+
+    pwd     = Dir.pwd
+    ext_dir = File.expand_path('ext/oboe_metal')
+    lib_dir = File.expand_path('lib')
+    symlink = File.expand_path('lib/oboe_metal.so')
+    so_file = File.expand_path('ext/oboe_metal/oboe_metal.so')
+
+    Dir.chdir ext_dir
+    cmd = [ Gem.ruby, 'extconf.rb']
+    sh cmd.join(' ')
+    sh '/usr/bin/env make'
+    File.delete symlink if File.exist? symlink
+
+    if File.exists? so_file
+      File.symlink so_file, symlink
+      Dir.chdir pwd
+      puts "== Extension built and symlink'd to #{symlink}"
+    else
+      Dir.chdir pwd
+      puts "!! Extension failed to build (see above).  Are the base TraceView packages installed?"
+      puts "!! See https://support.appneta.com/cloud/installing-traceview"
+    end
   else
-    Dir.chdir pwd
-    puts "!! Extension failed to build (see above).  Are the base TraceView packages installed?"
-    puts "!! See https://support.appneta.com/cloud/installing-traceview"
+    puts "== Nothing to do under JRuby."
   end
 end
 
 desc "Clean up extension build files"
 task :clean do
-  pwd     = Dir.pwd
-  ext_dir = File.expand_path('ext/oboe_metal')
-  lib_dir = File.expand_path('lib')
-  symlink = File.expand_path('lib/oboe_metal.so')
-  so_file = File.expand_path('ext/oboe_metal/oboe_metal.so')
+  unless defined?(JRUBY_VERSION)
+    pwd     = Dir.pwd
+    ext_dir = File.expand_path('ext/oboe_metal')
+    lib_dir = File.expand_path('lib')
+    symlink = File.expand_path('lib/oboe_metal.so')
+    so_file = File.expand_path('ext/oboe_metal/oboe_metal.so')
 
-  Dir.chdir ext_dir
-  sh '/usr/bin/env make clean'
+    Dir.chdir ext_dir
+    sh '/usr/bin/env make clean'
 
-  Dir.chdir pwd
+    Dir.chdir pwd
+  else
+    puts "== Nothing to do under JRuby."
+  end
 end
 
 desc "Remove all built files and extensions"
 task :distclean do
-  pwd     = Dir.pwd
-  ext_dir = File.expand_path('ext/oboe_metal')
-  lib_dir = File.expand_path('lib')
-  symlink = File.expand_path('lib/oboe_metal.so')
-  so_file = File.expand_path('ext/oboe_metal/oboe_metal.so')
-  mkmf_log = File.expand_path('ext/oboe_metal/mkmf.log')
-
-  if File.exists? mkmf_log
-    Dir.chdir ext_dir
-    File.delete symlink if File.exist? symlink
-    sh '/usr/bin/env make distclean'
-
-    Dir.chdir pwd
+  unless defined?(JRUBY_VERSION)
+    pwd     = Dir.pwd
+    ext_dir = File.expand_path('ext/oboe_metal')
+    lib_dir = File.expand_path('lib')
+    symlink = File.expand_path('lib/oboe_metal.so')
+    so_file = File.expand_path('ext/oboe_metal/oboe_metal.so')
+    mkmf_log = File.expand_path('ext/oboe_metal/mkmf.log')
+
+    if File.exists? mkmf_log
+      Dir.chdir ext_dir
+      File.delete symlink if File.exist? symlink
+      sh '/usr/bin/env make distclean'
+
+      Dir.chdir pwd
+    else
+      puts "Nothing to distclean. (nothing built yet?)"
+    end
   else
-    puts "Nothing to distclean. (nothing built yet?)"
+    puts "== Nothing to do under JRuby."
   end
 end
 

data/ext/oboe_metal/extconf.rb

@@ -5,12 +5,7 @@ require 'mkmf'
 require 'rbconfig'
 
 # Check if we're running in JRuby
-if RbConfig::CONFIG.has_key?('arch')
-  # nil meaning java string not found
-  jruby = (RbConfig::CONFIG['arch'] =~ /java/i) != nil
-else
-  jruby = false
-end
+jruby = defined?(JRUBY_VERSION) ? true : false
 
 openshift = ENV.has_key?('OPENSHIFT_TRACEVIEW_DIR')
 

data/lib/base.rb

@@ -22,32 +22,25 @@ SAMPLE_SOURCE_MASK = 0b1111000000000000000000000000
 ZERO_SAMPLE_RATE_MASK   = 0b1111000000000000000000000000
 ZERO_SAMPLE_SOURCE_MASK = 0b0000111111111111111111111111
 
-module Oboe_metal
-  class Context
-    class << self
-      attr_accessor :layer_op
-
-      def tracing_layer_op?(operation)
-        if operation.is_a?(Array)
-          return operation.include?(@layer_op)
-        else
-          return @layer_op == operation
-        end
-      end
-    end
-  end
-end
-
 module OboeBase
   attr_accessor :reporter
   attr_accessor :loaded
   attr_accessor :sample_source
   attr_accessor :sample_rate
+  attr_accessor :layer_op
 
   def self.included(cls)
     self.loaded = true
   end
 
+  def tracing_layer_op?(operation)
+    if operation.is_a?(Array)
+      return operation.include?(@layer_op)
+    else
+      return @layer_op == operation
+    end
+  end
+
   def always?
     Oboe::Config[:tracing_mode].to_s == "always"
   end
@@ -102,6 +95,5 @@ module OboeBase
   def set_sample_rate(rate)
     raise "set_sample_rate should be implemented by metal layer."
   end
-
 end
 

data/lib/joboe_metal.rb

@@ -5,18 +5,20 @@ require 'base'
 
 module Oboe_metal
   include_package 'com.tracelytics.joboe'
-  import 'com.tracelytics.joboe'
-  include_package 'com.tracelytics.joboe.SettingsReader'
-  import 'com.tracelytics.joboe.SettingsReader'
-  include_package 'com.tracelytics.joboe.Context'
-  import 'com.tracelytics.joboe.Context'
-  include_package 'com.tracelytics.joboe.Event'
-  import 'com.tracelytics.joboe.Event'
+  java_import 'com.tracelytics.joboe.LayerUtil'
+  java_import 'com.tracelytics.joboe.SettingsReader'
+  java_import 'com.tracelytics.joboe.Context'
+  java_import 'com.tracelytics.joboe.Event'
+  java_import 'com.tracelytics.agent.Agent'
 
   class Context
     class << self
       def toString
-        md = getMetadata.toString
+        md = getMetadata.toHexString
+      end
+
+      def fromString(xtrace)
+        Context.setMetadata(xtrace)
       end
 
       def clear
@@ -51,14 +53,30 @@ module Oboe_metal
       begin
         return unless Oboe.loaded
 
-        Oboe_metal::Context.init()
-
         if ENV.has_key?("OBOE_GEM_TEST")
-          Oboe.reporter = Oboe::FileReporter.new("/tmp/trace_output.bson")
+          Oboe.reporter = Java::ComTracelyticsJoboe::TestReporter.new
+        else
+          Oboe.reporter = Java::ComTracelyticsJoboe::ReporterFactory.getInstance().buildUdpReporter()
+        end
+
+
+        # Import the tracing mode and sample rate settings
+        # from the Java agent (user configured in
+        # /usr/local/tracelytics/javaagent.json when under JRuby)
+        cfg = LayerUtil.getLocalSampleRate(nil, nil)
+
+        if cfg.hasSampleStartFlag
+          Oboe::Config.tracing_mode = 'always'
+        elsif cfg.hasSampleThroughFlag
+          Oboe::Config.tracing_mode = 'through'
         else
-          Oboe.reporter = Oboe::UdpReporter.new(Oboe::Config[:reporter_host])
+          Oboe::Config.tracing_mode = 'never'
         end
 
+        Oboe.sample_rate = cfg.sampleRate
+        Oboe::Config.sample_rate = cfg.sampleRate
+        Oboe::Config.sample_source = cfg.sampleRateSource.a
+
         # Only report __Init from here if we are not instrumenting a framework.
         # Otherwise, frameworks will handle reporting __Init after full initialization
         unless defined?(::Rails) or defined?(::Sinatra) or defined?(::Padrino) or defined?(::Grape)
@@ -71,8 +89,41 @@ module Oboe_metal
       end
     end
 
+    ##
+    # clear_all_traces
+    #
+    # Truncates the trace output file to zero
+    #
+    def self.clear_all_traces
+      Oboe.reporter.reset if Oboe.loaded
+    end
+
+    ##
+    # get_all_traces
+    #
+    # Retrieves all traces written to the trace file
+    #
+    def self.get_all_traces
+      return [] unless Oboe.loaded
+
+      # Joboe TestReporter returns a Java::ComTracelyticsExtEbson::DefaultDocument
+      # document for traces which doesn't correctly support things like has_key? which
+      # raises an unhandled exception on non-existent key (duh).  Here we convert
+      # the Java::ComTracelyticsExtEbson::DefaultDocument doc to a pure array of Ruby
+      # hashes
+      traces = []
+      Oboe.reporter.getSentEventsAsBsonDocument.to_a.each do |e|
+        t = {}
+        e.each_pair { |k,v|
+          t[k] = v
+        }
+        traces << t
+      end
+      traces
+    end
+
     def self.sendReport(evt)
-      evt.report
+      evt.report(Oboe.reporter)
     end
   end
 end
@@ -83,23 +134,52 @@ module Oboe
 
   class << self
     def sample?(opts = {})
-      return false unless Oboe.always?
+      begin
+        return false unless Oboe.always? and Oboe.loaded
+
+        return true if ENV['OBOE_GEM_TEST'] == "test"
+
+        # Validation to make Joboe happy.  Assure that we have the KVs and that they
+        # are not empty strings.
+        opts[:layer]  = nil      if opts[:layer].is_a?(String)      and opts[:layer].empty?
+        opts[:xtrace] = nil      if opts[:xtrace].is_a?(String)     and opts[:xtrace].empty?
+        opts['X-TV-Meta'] = nil  if opts['X-TV-Meta'].is_a?(String) and opts['X-TV-Meta'].empty?
 
-      # Assure defaults since SWIG enforces Strings
-      opts[:layer]      ||= ''
-      opts[:xtrace]     ||= ''
-      opts['X-TV-Meta']   ||= ''
-      Java::ComTracelyticsJoboeSettingsReader.shouldTraceRequest(opts[:layer], opts[:xtrace], opts['X-TV-Meta'])
+        opts[:layer]      ||= nil
+        opts[:xtrace]     ||= nil
+        opts['X-TV-Meta'] ||= nil
+
+        sr_cfg = Java::ComTracelyticsJoboe::LayerUtil.shouldTraceRequest( opts[:layer],
+                               { 'X-Trace' => opts[:xtrace], 'X-TV-Meta' => opts['X-TV-Meta'] } )
+
+        # Store the returned SampleRateConfig into Oboe::Config
+        if sr_cfg
+          Oboe.sample_rate = sr_cfg.sampleRate
+          Oboe.sample_source = sr_cfg.sampleRateSource.a
+        end
+
+        sr_cfg
+      rescue => e
+        Oboe.logger.debug "[oboe/debug] #{e.message}"
+        false
+      end
     end
 
     def set_tracing_mode(mode)
-      # FIXME: TBD
+      Oboe.logger.warn "When using JRuby set the tracing mode in /usr/local/tracelytics/javaagent.json instead"
     end
 
     def set_sample_rate(rate)
-      # FIXME: TBD
+      # N/A
     end
   end
 end
 
-Oboe.loaded = true
+# 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
+end
+