oboe 2.3.2 → 2.3.3.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45fc7604fa67548997b691856dbd87e2e769a1a6
+  data.tar.gz: 4c1b623a594db6e3894482f018af8c68dea5562c
+SHA512:
+  metadata.gz: ce0e2ad674ade428b114ab3f3431d57cd573bb59110e49ebde9ccf55804076632190b904174ef3a511cf260e8f651765aa0591544073df5fba7164de311b3334
+  data.tar.gz: 89e7abdfa4c4d0a0adae647b5ac231043e9620097cd97c158bdea3071f02759c95a970554b5b35c5b9eaedaa568596deda634c17231f7844291aa0826cb8a6ef

data/.travis.yml

@@ -0,0 +1,26 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree
+
+# Attempt Travis/Cassandra fix re: https://github.com/travis-ci/travis-ci/issues/1484
+before_install:
+  - echo "127.0.0.1 " `hostname` | sudo tee /etc/hosts
+  - sudo service cassandra start
+
+install: 
+  - wget https://www.tracelytics.com/install_tracelytics.sh
+  - sudo sh ./install_tracelytics.sh f51e2a43-0ee5-4851-8a54-825773b3218e
+
+before_script:
+  - bundle install
+  - bundle exec rake compile
+
+services: 
+  - mongodb
+  - memcached
+#  - cassandra
+

data/CHANGELOG

@@ -1,5 +1,31 @@
-
-# oboe 2.2.0
+# oboe 2.3.3 (11/06/13)
+
+* Rename the _Init layer to "rack"
+* Decode URLS when reporting them
+* Resque layer naming split into 1) client queuing of a job: 'resque-client', 2) Resque worker running a job: 'resque-worker'
+* Fix for an extension load error and some refactoring of functionality into a base module (OboeBase)
+* Improved and more resilient method profiling
+* Further refactoring for Ruby 2.0 support
+* Track the version of the instrumentation installed
+
+# oboe 2.3.2 (10/22/13)
+
+* Backtrace collection can now be configured to skip certain components if a lighter-weight trace is desired
+* On MRI Ruby the hostname of the Tracelyzer is now configurable via Oboe::Config[:reporter_host] (default is localhost)
+* Fix to MongoDb query identification
+* Event building in the Rack layer optimized
+* Renamed "sampling_rate" to be "sample_rate" for consistency
+* More tests added and documentation in anticipation of our Ruby open-source initiative
+
+# oboe 2.2.6 (09/27/13)
+
+* Query Privacy now fully supported; can configure the app to not send SQL parameters if needed
+* Configuring the local sample rate now supports 1e6 notation
+* Improved log messaging if a gem dependency is missing
+* Now reporting HTTPStatus on http client calls
+* Heroku - the start time when a request hits the load balancer now captured
+
+# oboe 2.2.0 (09/12/13)
 
 * Initial support for Rails 4
 * Various internal reporting fixes and improvements

data/Gemfile

@@ -9,7 +9,7 @@ gem 'appraisal'
 group :development, :test do
   gem 'minitest'
   gem 'minitest-reporters'
-  gem 'debugger'
+  gem 'debugger' unless (RUBY_VERSION =~ /^1.8/) == 0
   gem 'rack-test'
 end
 
@@ -20,7 +20,7 @@ gem 'memcached' if (RUBY_VERSION =~ /^1./) == 0
 gem 'cassandra'
 gem 'mongo'
 gem 'bson_ext' # For Mongo, Yours Truly
-gem 'moped'
+gem 'moped' unless (RUBY_VERSION =~ /^1.8/) == 0
 gem 'resque'
 gem 'rack-test'
 

data/README.md

@@ -45,8 +45,8 @@ You can instrument your Sinatra or Padrino application by adding the following c
     require 'oboe/inst/rack'
     
     # When traces should be initiated for incoming requests. Valid options are
-    # “always,” “through” (when the request is initiated with a tracing header 
-    # from upstream) and “never”. You must set this directive to “always” in 
+    # "always", "through" (when the request is initiated with a tracing header 
+    # from upstream) and "never". You must set this directive to "always" in 
     # order to initiate tracing.
     Oboe::Config[:tracing_mode] = 'through'
     
@@ -125,7 +125,7 @@ This example demonstrates method profiling of instance methods.  Class methods a
 
 # Support
 
-If you find a bug or would like to request an enhancement, feel free to file an issue.  For all other support requests, see our [support portal](https://support.tv.appneta.com/) or on IRC @ #appneta on Freenode.
+If you find a bug or would like to request an enhancement, feel free to file an issue.  For all other support requests, see our [support portal](https://support.tv.appneta.com/) or on IRC @ #appneta on [Freenode](http://freenode.net/).
 
 # Contributing
 
@@ -257,7 +257,7 @@ Note: Make sure you have the development package `liboboe0-dev` installed before
     ii  liboboe-dev    1.1.1-precise1    Tracelytics common library -- development files
     ii  liboboe0       1.1.1-precise1    Tracelytics common library
 
-See [Installing Base Packages on Debian and Ubuntu](https://support.tv.appneta.com/support/solutions/articles/86359-installing-base-packages-on-debian-and-ubuntu) in the Knowledge Base for details.  Our hacker extraodinaire [Rob Salmond](https://github.com/rsalmond) from the support team have even gotten these packages to [run on Gentoo](http://www.appneta.com/blog/unsupported-doesnt-work/)!
+See [Installing Base Packages on Debian and Ubuntu](https://support.tv.appneta.com/support/solutions/articles/86359-installing-base-packages-on-debian-and-ubuntu) in the Knowledge Base for details.  Our hacker extraodinaire [Rob Salmond](https://github.com/rsalmond) from the support team has even gotten these packages to [run on Gentoo](http://www.appneta.com/blog/unsupported-doesnt-work/)!
 
 To see the code related to the C extension, take a look at `ext/oboe_metal/extconf.rb` for details.
 

data/Rakefile

@@ -28,10 +28,16 @@ task :compile do
   sh cmd.join(' ')
   sh '/usr/bin/env make'
   File.delete symlink if File.exist? symlink
-  File.symlink so_file, symlink
 
-  Dir.chdir pwd
-  puts "== Extension built and symlink'd to #{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.tv.appneta.com/support/solutions/articles/86359"
+  end
 end
 
 desc "Clean up extension build files"
@@ -55,12 +61,17 @@ task :distclean do
   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')
   
-  Dir.chdir ext_dir
-  File.delete symlink if File.exist? symlink
-  sh '/usr/bin/env make distclean'
+  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
+    Dir.chdir pwd
+  else
+    puts "Nothing to distclean. (nothing built yet?)"
+  end
 end
 
 desc "Rebuild the gem's c extension"

data/lib/base.rb

@@ -0,0 +1,58 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module OboeBase
+  attr_accessor :reporter
+  attr_accessor :loaded
+
+  def self.included(cls)
+    self.loaded = true
+  end
+  
+  def always?
+    Oboe::Config[:tracing_mode].to_s == "always"
+  end
+  
+  def never?
+    Oboe::Config[:tracing_mode].to_s == "never"
+  end
+
+  def passthrough?
+    ["always", "through"].include?(Oboe::Config[:tracing_mode])
+  end
+  
+  def through?
+    Oboe::Config[:tracing_mode] == "through"
+  end
+  
+  def tracing?
+    return false unless Oboe.loaded
+
+    Oboe::Context.isValid and not Oboe.never?
+  end
+  
+  def log(layer, label, options = {})
+    Context.log(layer, label, options = options)
+  end
+
+  ##
+  # These methods should be implemented by the descendants
+  # (Oboe_metal, Oboe_metal (JRuby), Heroku_metal)
+  #
+  def sample?(opts = {})
+    raise "sample? should be implemented by metal layer."
+  end
+  
+  def log(layer, label, options = {})
+    raise "log should be implemented by metal layer."
+  end
+    
+  def set_tracing_mode(mode)
+    raise "set_tracing_mode should be implemented by metal layer."
+  end
+  
+  def set_sample_rate(rate)
+    raise "set_sample_rate should be implemented by metal layer."
+  end
+end
+

data/lib/joboe_metal.rb

@@ -1,7 +1,7 @@
 # Copyright (c) 2013 AppNeta, Inc.
 # All rights reserved.
 
-module Oboe_metal
+module Oboe_metal < MetalBase
   include_package 'com.tracelytics.joboe'
   import 'com.tracelytics.joboe'
   include_package 'com.tracelytics.joboe.SettingsReader'
@@ -12,46 +12,42 @@ module Oboe_metal
   import 'com.tracelytics.joboe.Event'
 
   class Context
-    def self.log(layer, label, options = {}, with_backtrace = false)
-      evt = Oboe::Context.createEvent()
-      evt.addInfo("Layer", layer.to_s)
-      evt.addInfo("Label", label.to_s)
-
-      options.each_pair do |k, v|
-        evt.addInfo(k.to_s, v.to_s)
-      end
-
-      evt.addInfo("Backtrace", Oboe::API.backtrace) if with_backtrace
-
-      Oboe::Reporter.sendReport(evt)
-    end
+    class << self
+      attr_accessor :layer_op
+      
+      def log(layer, label, options = {}, with_backtrace = false)
+        evt = Oboe::Context.createEvent()
+        evt.addInfo("Layer", layer.to_s)
+        evt.addInfo("Label", label.to_s)
 
-    def self.layer_op=(op)
-      @layer_op = op
-    end
+        options.each_pair do |k, v|
+          evt.addInfo(k.to_s, v.to_s)
+        end
 
-    def self.layer_op
-      @layer_op
-    end
+        evt.addInfo("Backtrace", Oboe::API.backtrace) if with_backtrace
 
-    def self.tracing_layer_op?(operation)
-      if operation.is_a?(Array)
-        return operation.include?(@layer_op)
-      else
-        return @layer_op == operation
+        Oboe.reporter.sendReport(evt)
+      end
+       
+      def tracing_layer_op?(operation)
+        if operation.is_a?(Array)
+          return operation.include?(@layer_op)
+        else
+          return @layer_op == operation
+        end
+      end
+      
+      def toString
+        md = getMetadata.toString
       end
-    end
-
-    def self.toString
-      md = getMetadata.toString
-    end
 
-    def self.clear
-      clearMetadata
-    end
+      def clear
+        clearMetadata
+      end
 
-    def self.get
-      getMetadata
+      def get
+        getMetadata
+      end
     end
   end
   
@@ -75,15 +71,17 @@ module Oboe_metal
     #
     def self.start
       begin
+        return unless Oboe.loaded
+
         Oboe_metal::Context.init() 
 
         if ENV['RACK_ENV'] == "test"
-          Oboe.reporter = Oboe::FileReporter.new("./tmp/trace_output.bson")
+          Oboe.reporter = Oboe::FileReporter.new("/tmp/trace_output.bson")
         else
           Oboe.reporter = Oboe::UdpReporter.new(Oboe::Config[:reporter_host])
         end
 
-        Oboe::API.report_init('ruby') unless ["development", "test"].include? ENV['RACK_ENV']
+        Oboe::API.report_init('rack') unless ["development", "test"].include? ENV['RACK_ENV']
       
       rescue Exception => e
         $stderr.puts e.message
@@ -97,28 +95,11 @@ module Oboe_metal
   end
 end
 
-module Oboe
+module Oboe 
+  extend OboeBase
   include Oboe_metal
   
   class << self
-    attr_accessor :reporter
-  
-    def always?
-      Oboe::Config[:tracing_mode].to_s == "always"
-    end
-    
-    def log(layer, label, options = {})
-      Context.log(layer, label, options = options)
-    end
-    
-    def never?
-      Oboe::Config[:tracing_mode].to_s == "never"
-    end
-
-    def passthrough?
-      ["always", "through"].include?(Oboe::Config[:tracing_mode])
-    end
-      
     def sample?(opts = {})
       # Assure defaults since SWIG enforces Strings
       opts[:layer]      ||= ''
@@ -126,13 +107,15 @@ module Oboe
       opts['X-TV-Meta']   ||= ''
       Java::ComTracelyticsJoboeSettingsReader.shouldTraceRequest(opts[:layer], opts[:xtrace], opts['X-TV-Meta'])
     end
-
-    def through?
-      Oboe::Config[:tracing_mode] == "through"
+    
+    def set_tracing_mode(mode)
+      # FIXME: TBD
     end
-      
-    def tracing?
-      Oboe::Context.isValid and not Oboe.never?
+    
+    def set_sample_rate(rate)
+      # FIXME: TBD
     end
   end
 end
+
+Oboe.loaded = true

data/lib/method_profiling.rb

@@ -8,70 +8,63 @@ module OboeMethodProfiling
 
   module ClassMethods
     def profile_method(method_name, profile_name, store_args=false, store_return=false, profile=false)
-      #this only gets file and line where profiling is turned on, presumably
-      #right after the function definition. ruby 1.9 has nice introspection (Method.source_location)
-      #but its appears no such luck for ruby 1.8
-      version = RbConfig::CONFIG['ruby_version']
-      file = nil
-      line = nil
-      if version and version.match(/^1.9/)
-        info = self.instance_method(method_name).source_location
-        if !info.nil?
-          file = info[0]
-          line = info[1] 
+      begin
+        # this only gets file and line where profiling is turned on, presumably
+        # right after the function definition. ruby 1.9 and 2.0 has nice introspection (Method.source_location)
+        # but its appears no such luck for ruby 1.8
+        version = RbConfig::CONFIG['ruby_version']
+        file = ''
+        line = ''
+        if version and (version.match(/^1.9/) or version.match(/^2.0/))
+          info = self.instance_method(method_name).source_location
+          if !info.nil?
+            file = info[0].to_s
+            line = info[1].to_s
+          end
+        else
+          info = Kernel.caller[0].split(':')
+          file = info.first.to_s
+          line = info.last.to_s
         end
-      else
-        info = Kernel.caller[0].split(':')
-        file = info.first
-        line = info.last
-      end
-
-      #profiling via ruby-prof, is it possible to get return value of profiled code?
-      code = "def _oboe_profiled_#{method_name}(*args, &block)
-                def pps(*args)
-                  old_out = $stdout
-                  begin
-                    s = StringIO.new
-                    $stdout = s
-                    pp(*args)
-                  ensure
-                    $stdout = old_out
-                  end
-                  s.string
-                end
-
-                entry_kvs = {'Language'     => 'ruby',
-                             'ProfileName'  => '#{profile_name}',
-                             'FunctionName' => '#{method_name}',
-                             'Class'        => self.class.to_s.rpartition('::').last,
-                             'Module'       => self.class.to_s.rpartition('::').first,
-                             'File'         => '#{file}',
-                             'LineNumber'    => '#{line}' 
-                            }
 
-                if #{store_args}
-                  entry_kvs['Args'] = pps *args
-                end
+        # Safety:  Make sure there are no quotes or double quotes to break the class_eval
+        file = file.gsub /[\'\"]/, ''
+        line = line.gsub /[\'\"]/, ''
+      
+        # profiling via ruby-prof, is it possible to get return value of profiled code?
+        code = "def _oboe_profiled_#{method_name}(*args, &block)
+                  entry_kvs                  = {}
+                  entry_kvs['Language']      = 'ruby'
+                  entry_kvs['ProfileName']   = '#{profile_name}'
+                  entry_kvs['FunctionName']  = '#{method_name}'
+                  entry_kvs['File']          = '#{file}'
+                  entry_kvs['LineNumber']    = '#{line}'
+                  entry_kvs['Args']          = Oboe::API.pps(*args) if #{store_args}
+                  entry_kvs.merge!(::Oboe::API.get_class_name(self))
 
-                Oboe::Context.log(nil, 'profile_entry', entry_kvs)
+                  Oboe::Context.log(nil, 'profile_entry', entry_kvs)
 
-                ret = _oboe_orig_#{method_name}(*args, &block)
+                  ret = _oboe_orig_#{method_name}(*args, &block)
 
-                exit_kvs =  {'Language'     => 'ruby',
-                             'ProfileName'  => '#{profile_name}'
-                            }
-                
-                if #{store_return}
-                  exit_kvs['ReturnValue'] = pps ret
-                end
+                  exit_kvs =  {}
+                  exit_kvs['Language'] = 'ruby'
+                  exit_kvs['ProfileName'] = '#{profile_name}'
+                  exit_kvs['ReturnValue'] = Oboe::API.pps(ret) if #{store_return}
 
-                Oboe::Context.log(nil, 'profile_exit', exit_kvs)
+                  Oboe::Context.log(nil, 'profile_exit', exit_kvs)
+                  ret
+                end"
+      rescue Exception => e
+        Oboe.logger.warn "[oboe/warn] profile_method: #{e.inspect}"
+      end
 
-                ret
-              end"
-      class_eval code, __FILE__, __LINE__
-      alias_method "_oboe_orig_#{method_name}", method_name
-      alias_method method_name, "_oboe_profiled_#{method_name}"
+      begin
+        class_eval code, __FILE__, __LINE__
+        alias_method "_oboe_orig_#{method_name}", method_name
+        alias_method method_name, "_oboe_profiled_#{method_name}"
+      rescue Exception => e
+        Oboe.logger.warn "[oboe/warn] Fatal error profiling method (#{method_name}): #{e.inspect}" if Oboe::Config[:verbose]
+      end
     end
   end
 end