oboe 1.4.2.2 → 2.1.1

data/.gitignore

@@ -0,0 +1,4 @@
+oboe*.gem
+*~
+*.swp
+lib/so_variants

data/Gemfile

@@ -0,0 +1,30 @@
+source 'https://rubygems.org'
+
+# Import dependencies from oboe.gemspec
+gemspec :name => 'oboe'
+
+gem 'rake'
+
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+
+  gem 'rb-inotify', :require => false
+  gem 'rb-fsevent', :require => false
+  gem 'rb-fchange', :require => false
+end
+
+group :test do
+  gem 'rspec'
+
+  # Instrumented gems
+  gem 'dalli'
+  gem 'memcache-client'
+  gem 'memcached' if (RUBY_VERSION =~ /^1./) == 0
+  gem 'cassandra'
+  gem 'mongo'
+  gem 'bson_ext' # For Mongo, Yours Truly
+  gem 'moped'
+  gem 'resque'
+end
+

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    oboe (2.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    bson (1.8.2)
+    bson_ext (1.8.2)
+      bson (~> 1.8.2)
+    cassandra (0.17.0)
+      json
+      rake
+      simple_uuid (~> 0.2.0)
+      thrift_client (>= 0.7.0, < 0.9)
+    coderay (1.0.9)
+    dalli (2.6.2)
+    diff-lcs (1.1.3)
+    ffi (1.4.0)
+    guard (1.6.2)
+      listen (>= 0.6.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      terminal-table (>= 1.4.3)
+      thor (>= 0.14.6)
+    guard-rspec (2.4.1)
+      guard (>= 1.1)
+      rspec (~> 2.11)
+    json (1.7.7)
+    listen (0.7.3)
+    lumberjack (1.0.2)
+    memcache-client (1.8.5)
+    memcached (1.5.0)
+    method_source (0.8.1)
+    mongo (1.8.2)
+      bson (~> 1.8.2)
+    moped (1.4.2)
+    multi_json (1.6.1)
+    pry (0.9.12)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.4.5)
+    rack-protection (1.3.2)
+      rack
+    rake (10.0.3)
+    rb-fchange (0.0.6)
+      ffi
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    redis (3.0.2)
+    redis-namespace (1.2.1)
+      redis (~> 3.0.0)
+    resque (1.23.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    simple_uuid (0.2.0)
+    sinatra (1.3.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.3)
+      tilt (~> 1.3, >= 1.3.3)
+    slop (3.4.3)
+    terminal-table (1.4.5)
+    thor (0.17.0)
+    thrift (0.8.0)
+    thrift_client (0.8.3)
+      thrift (~> 0.8.0)
+    tilt (1.3.3)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext
+  cassandra
+  dalli
+  guard
+  guard-rspec
+  memcache-client
+  memcached
+  mongo
+  moped
+  oboe!
+  rake
+  rb-fchange
+  rb-fsevent
+  rb-inotify
+  resque
+  rspec

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -0,0 +1,36 @@
+# Tracelytics Ruby (and Ruby Frameworks) Instrumentation
+
+```oboe``` provides instrumentation for [Ruby](http://www.ruby-lang.org/en/) and the [Rails framework](http://rubyonrails.org/), as well as other
+common components used to build rails applications.
+
+## Installing
+
+See the [Ruby Knowedge Base article](http://support.tracelytics.com/kb/instrumenting-your-app/instrumenting-ruby-apps)
+for information on how to install. Release notes can be found [here](http://support.tracelytics.com/kb/instrumenting-your-app/ruby-instrumentation-release-notes)
+
+## Supported Technologies
+
+Check the [support matrix](https://github.com/tracelytics/oboe-ruby/wiki/Support-Matrix) for which versions of Ruby, Rails and technologies are supported.
+
+## Tips
+
+General tips using, installing and debugging the oboe gem can be found [here](https://github.com/tracelytics/oboe-ruby/wiki/Ruby-Oboe-Tips).
+
+## liboboe Linking Notes
+
+Build instructions
+
+  - Requires: liboboe development headers, available from the
+    liboboe-dev (Ubuntu) and liboboe-devel (Red Hat) packages.
+
+Build and install a gem the normal way:
+
+    gem build oboe.gemspec
+    gem install oboe-VERSION.gem
+
+Compile a binary gem from a regular gem, using gem-compile [1]:
+
+    sudo gem install gem-compile
+    gem compile oboe-VERSION.gem
+
+[1] https://github.com/frsyuki/gem-compile

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake/testtask'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+Rake::TestTask.new do |t|
+ t.libs << 'spec'
+end
+
+desc "Run tests"
+task :default => :spec
+task :test => :spec

data/ext/oboe_metal/extconf.rb

@@ -1,11 +1,8 @@
 # Copyright (c) 2012 by Tracelytics, Inc.
 # All rights reserved.
-
 require 'mkmf'
 require 'rbconfig'
 
-dir_config('oboe')
-
 # Check if we're running in JRuby
 if RbConfig::CONFIG.has_key?('arch')
   # nil meaning java string not found
@@ -14,7 +11,17 @@ else
   jruby = false
 end
 
-if not jruby and have_library('oboe')
+dir_config('oboe')
+
+if jruby or ENV.has_key?('TRACEVIEW_URL') 
+  # Build the noop extension under JRuby and Heroku.
+  # The oboe-heroku gem builds it's own c extension which links to
+  # libs specific to a Heroku dyno
+  # FIXME: For JRuby we need to remove the c extension entirely
+  create_makefile('oboe_noop', 'noop')
+
+elsif have_library('oboe') 
+
   $libs = append_library($libs, "oboe")
   $libs = append_library($libs, "stdc++")
 
@@ -24,6 +31,7 @@ if not jruby and have_library('oboe')
 
   cpp_command('g++') if RUBY_VERSION < '1.9'
   create_makefile('oboe_metal', 'src')
+
 else
   $stderr.puts "Error: Could not find the base liboboe libraries.  No tracing will occur."
   create_makefile('oboe_noop', 'noop')

data/ext/oboe_metal/tests/test.rb

@@ -0,0 +1,7 @@
+require 'oboe'
+
+r = Oboe::UdpReporter.new('127.0.0.1')
+Oboe::Context.init()
+e = Oboe::Context.createEvent()
+e.addInfo("TestKey", "TestValue")
+r.sendReport(e)

data/get_version.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.dirname(__FILE__) + '/lib/oboe/version.rb'
+
+puts Oboe::Version::STRING

data/lib/joboe_metal.rb

@@ -4,6 +4,8 @@
 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'
@@ -77,7 +79,50 @@ end
 module Oboe
   include Oboe_metal
   
+  def self.always?
+    Oboe::Config[:tracing_mode].to_s == "always"
+  end
+  
+  def self.continue?
+    Oboe::Context.isValid and not Oboe.never?
+  end
+  
   def self.log(layer, label, options = {})
     Context.log(layer, label, options = options)
   end
+  
+  def self.never?
+    Oboe::Config[:tracing_mode].to_s == "never"
+  end
+
+  def self.now?
+    Oboe::Context.isValid and not Oboe.never?
+  end
+  
+  def self.passthrough?
+    ["always", "through"].include?(Oboe::Config[:tracing_mode])
+  end
+    
+  def self.sample?
+    Java::ComTracelyticsJoboeSettingsReader.shouldTraceRequest('', '')
+  end
+
+  def self.start?
+    not Oboe::Context.isValid and Oboe.always?
+  end
+  
+  def self.through?
+    Oboe::Config[:tracing_mode] == "through"
+  end
+    
+  def self.tracing?
+    Oboe::Context.isValid and not Oboe.never?
+  end
+
+  def self.reporter
+    if !@reporter
+      @reporter = Oboe::UdpReporter.new(Oboe::Config[:reporter_host])
+    end
+    return @reporter
+  end
 end

data/lib/oboe.rb

@@ -3,13 +3,20 @@
 
 begin
   require 'rbconfig'
-  if RUBY_PLATFORM == 'java'
-    require '/usr/local/tracelytics/tracelyticsagent.jar'
-    require 'joboe_metal'
-  else
-    require 'oboe_metal.so'
-    require 'oboe_metal'
+  require 'logger'
+  
+  # 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)
+    if RUBY_PLATFORM == 'java'
+      require '/usr/local/tracelytics/tracelyticsagent.jar'
+      require 'joboe_metal'
+    else
+      require 'oboe_metal.so'
+      require 'oboe_metal'
+    end
   end
+  require 'oboe/logger'
   require 'oboe/config'
   require 'oboe/loading'
   require 'method_profiling'
@@ -20,5 +27,7 @@ begin
   require 'oboe/frameworks/rails' if defined?(::Rails)
 
 rescue LoadError
-  puts "Unsupported Tracelytics environment (no libs).  Going No-op."
+  $stderr.puts "Unsupported Tracelytics environment (no libs).  Going No-op."
+rescue Exception => e
+  $stderr.puts "[oboe/error] Problem loading: #{e.inspect}"
 end

data/lib/oboe/api/logging.rb

@@ -44,7 +44,7 @@ module Oboe
           log(layer, 'error', {
             :ErrorClass => exn.class.name,
             :Message => exn.message,
-            :ErrorBacktrace => exn.backtrace.join("\r\n")
+            :Backtrace => exn.backtrace.join("\r\n")
           })
           exn.instance_variable_set(:@oboe_logged, true)
         end

data/lib/oboe/api/tracing.rb

@@ -35,7 +35,7 @@ module Oboe
         begin 
           yield
         rescue Exception => e
-            log_exception(layer, e) 
+          log_exception(layer, e) 
           raise
         ensure
           log_exit(layer, {}, protect_op)

data/lib/oboe/api/util.rb

@@ -24,7 +24,7 @@ module Oboe
       #
       # Returns a string with each frame of the backtrace separated by '\r\n'.
       def backtrace(ignore=1)
-        trim_backtrace(Kernel.caller).join("\r\n");
+        trim_backtrace(Kernel.caller).join("\r\n")
       end
 
       def trim_backtrace(backtrace)

data/lib/oboe/config.rb

@@ -2,53 +2,6 @@
 # All rights reserved.
 
 module Oboe
-  
-  def self.always?
-    Oboe::Config[:tracing_mode].to_s == "always"
-  end
-  
-  def self.continue?
-    Oboe::Context.isValid and not Oboe.never?
-  end
-  
-  def self.log(layer, label, options = {})
-    Context.log(layer, label, options = options)
-  end
-
-  def self.never?
-    Oboe::Config[:tracing_mode].to_s == "never"
-  end
-
-  def self.now?
-    Oboe::Context.isValid and not Oboe.never?
-  end
-  
-  def self.passthrough?
-    ["always", "through"].include?(Oboe::Config[:tracing_mode])
-  end
-    
-  def self.sample?
-    # Note that this the only point in the code that currently does and
-    # should ever read the sample rate. When autopilot is released, modify
-    # the line below and that line only.
-    Oboe::Config[:sample_rate].to_i < rand(1e6)
-  end
-
-  def self.start?
-    not Oboe::Context.isValid and Oboe.always?
-  end
-  
-  def self.through?
-    Oboe::Config[:tracing_mode] == "through"
-  end
-    
-  def self.tracing?
-    Oboe::Context.isValid and not Oboe.never?
-  end
-
-  ############################
-  # Oboe Configuration Module
-  ############################
   module Config
     @@config = {}