oboe 2.1.3 → 2.1.4

data/lib/joboe_metal.rb

@@ -83,10 +83,6 @@ module Oboe
     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
@@ -95,22 +91,18 @@ module Oboe
     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('', '')
+  def self.sample?(opts = {})
+    # 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'])
   end
 
-  def self.start?
-    not Oboe::Context.isValid and Oboe.always?
-  end
-  
   def self.through?
     Oboe::Config[:tracing_mode] == "through"
   end

data/lib/oboe/api/layerinit.rb

@@ -6,18 +6,27 @@ module Oboe
       # layer.
       #
       def report_init(layer)
-        platform_info                         = { '__Init' => 1 }
-        platform_info['RubyPlatformVersion']  = RUBY_PLATFORM
-        platform_info['RubyVersion']          = RUBY_VERSION
-        platform_info['RailsVersion']         = ::Rails.version if defined?(Rails)
-        platform_info['OboeRubyVersion']      = Gem.loaded_specs['oboe'].version if Gem.loaded_specs['oboe']
-
-        force_trace do
-          start_trace(layer, nil, platform_info) { }
+        platform_info = { '__Init' => 1 }
+        
+        begin
+          platform_info['Force']                 = true
+          platform_info['RubyPlatformVersion']   = RUBY_PLATFORM
+          platform_info['RubyVersion']           = RUBY_VERSION
+          platform_info['RailsVersion']          = ::Rails.version if defined?(Rails)
+          platform_info['OboeRubyVersion']       = Oboe::Version::STRING
+          platform_info['OboeHerokuRubyVersion'] = OboeHeroku::Version::STRING if defined?(OboeHeroku)
+        rescue
         end
+
+        start_trace(layer, nil, platform_info) { }
       end
 
+      ##
+      # force_trace has been deprecated and will be removed in a subsequent version.
+      #
       def force_trace
+        Oboe.logger.warn "Oboe::API::LayerInit.force_trace has been deprecated and will be removed in a subsequent version."
+
         saved_mode = Oboe::Config[:tracing_mode]
         Oboe::Config[:tracing_mode] = 'always'
         yield

data/lib/oboe/api/logging.rb

@@ -68,7 +68,7 @@ module Oboe
   
         if Oboe.tracing?
           log_entry(layer, opts)
-        elsif Oboe.always? or Oboe.sample?
+        elsif Oboe.sample?(opts.merge(:layer => layer, :xtrace => xtrace)) or opts.has_key?('Force')
           log_event(layer, 'entry', Oboe::Context.startTrace, opts)
         end
       end

data/lib/oboe/config.rb

@@ -2,6 +2,12 @@
 # All rights reserved.
 
 module Oboe
+  ##
+  # This module exposes a nested configuration hash that can be used to
+  # configure and/or modify the functionality of the oboe gem.
+  #
+  # Use Oboe::Config.show to view the entire nested hash.
+  #
   module Config
     @@config = {}
 
@@ -9,6 +15,9 @@ module Oboe
                           :moped, :rack, :resque, :action_controller, :action_view, 
                           :active_record ]
 
+    ##
+    # Return the raw nested hash.
+    #
     def self.show
       @@config
     end

data/lib/oboe/frameworks/rails.rb

@@ -108,6 +108,7 @@ if defined?(::Rails)
 
         config.after_initialize do
           Oboe::Loading.setup_logger
+          Oboe::Loading.set_tracing_mode
           Oboe::Loading.load_access_key
           Oboe::Inst.load_instrumentation
           Oboe::Rails.load_instrumentation
@@ -117,6 +118,7 @@ if defined?(::Rails)
   else
     Oboe::Loading.setup_logger
     Oboe::Rails.load_initializer
+    Oboe::Loading.set_tracing_mode
     Oboe::Loading.load_access_key
     
     Rails.configuration.after_initialize do

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

@@ -43,13 +43,11 @@ end
 
 if defined?(ActionController::Base) and Oboe::Config[:action_controller][:enabled]
   if ::Rails::VERSION::MAJOR == 3
-    Oboe::API.report_init('rails')
 
     class ActionController::Base
       include Oboe::Inst::Rails3ActionController
     end
   elsif ::Rails::VERSION::MAJOR == 2
-    Oboe::API.report_init('rails')
 
     ActionController::Base.class_eval do
       alias :perform_action_without_oboe :perform_action

data/lib/oboe/inst/rack.rb

@@ -24,6 +24,7 @@ module Oboe
         report_kvs[:URL]             = req.path
         report_kvs[:Method]          = req.request_method
         report_kvs['AJAX']           = true if req.xhr?
+        report_kvs['X-TV-Meta']      = req.headers['X-TV-Meta'] if req.headers.has_key?('X-TV-Meta')
       rescue
         # Discard any potential exceptions. Report whatever we can.
       end

data/lib/oboe/inst/resque.rb

@@ -121,10 +121,10 @@ module Oboe
           rescue
           end
 
-          Oboe::API.force_trace do
-            Oboe::API.start_trace('resque', nil, report_kvs) do
-              perform_without_oboe(job)
-            end
+          # Force this trace regardless of sampling rate so that child trace can be
+          # link to parent trace.
+          Oboe::API.start_trace('resque', nil, report_kvs.merge('Force' => true)) do
+            perform_without_oboe(job)
           end
 
         else

data/lib/oboe/loading.rb

@@ -5,6 +5,9 @@ require 'digest/sha1'
 
 module Oboe
   module Util
+    ##
+    # This module is used solely for RUM ID calculation
+    #
     module Base64URL
       module_function
 
@@ -23,6 +26,16 @@ module Oboe
     end
   end
 
+  ##
+  # This module houses all of the loading functionality for the oboe gem.  
+  #
+  # Note that this does not necessarily _have_ to include initialization routines 
+  # (although it can).
+  #
+  # Actual initialization is often separated out as it can be dependent on on the state
+  # of the stack boot process.  e.g. code requiring that initializers, frameworks or 
+  # instrumented libraries are already loaded...
+  #
   module Loading
     def self.setup_logger
       if defined?(::Rails) and ::Rails.logger
@@ -30,6 +43,10 @@ module Oboe
       end
     end
 
+    ##
+    # Load the TraceView access key (either from system configuration file
+    # or environment variable) and calculate internal RUM ID
+    #
     def self.load_access_key
       begin
         if ENV.has_key?('TRACEVIEW_CUUID')
@@ -57,6 +74,9 @@ module Oboe
       end
     end
 
+    ##
+    # Load the oboe tracing API
+    # 
     def self.require_api
       require 'oboe/version'
 
@@ -75,6 +95,10 @@ module Oboe
       require 'oboe/config'
     end
 
+    ## 
+    # Load instrumentation for the various frameworks located in
+    # lib/oboe/frameworks/*/*.rb
+    # 
     def self.load_framework_instrumentation
       pattern = File.join(File.dirname(__FILE__), 'frameworks/*/', '*.rb')
       Dir.glob(pattern) do |f|
@@ -85,9 +109,46 @@ module Oboe
         end
       end
     end
+
+    ##
+    # Update liboboe with the configured tracing mode
+    #
+    def self.set_tracing_mode
+      # If we are in Heroku, let the oboe-heroku gem configure tracing mode 
+      # itself as the requirements are slightly different.
+      return if defined?(OboeHeroku)
+      
+      # OBOE_TRACE_NEVER   0
+      # OBOE_TRACE_ALWAYS  1
+      # OBOE_TRACE_THROUGH 2
+      
+      if defined?(Oboe::Config)
+        
+        case Oboe::Config[:tracing_mode].to_s.downcase.to_sym
+        when :never
+          # OBOE_TRACE_NEVER
+          Oboe.logger.debug "Setting liboboe TracingMode to OBOE_TRACE_NEVER"
+          Oboe::Context.setTracingMode(0)
+        when :always
+          # OBOE_TRACE_ALWAYS
+          Oboe.logger.debug "Setting liboboe TracingMode to OBOE_TRACE_ALWAYS"
+          Oboe::Context.setTracingMode(1)
+        else
+          # OBOE_TRACE_THROUGH
+          Oboe.logger.debug "Setting liboboe TracingMode to OBOE_TRACE_THROUGH"
+          Oboe::Context.setTracingMode(2)
+        end
+      else
+        # OBOE_TRACE_THROUGH
+        Oboe.logger.debug "Setting liboboe TracingMode to OBOE_TRACE_THROUGH (no Oboe::Config?)"
+        Oboe::Context.setTracingMode(2)
+      end
+    end
+
   end
 end
 
 Oboe::Loading.require_api
 Oboe::Loading.load_framework_instrumentation
+Oboe::API.report_init('ruby')
 

data/lib/oboe/ruby.rb

@@ -1,8 +1,8 @@
 module Oboe
   module Ruby
     def self.initialize
-      Oboe::API.report_init('ruby')
       Oboe::Loading.load_access_key
+      Oboe::Loading.set_tracing_mode
       Oboe::Inst.load_instrumentation
     end
   end

data/lib/oboe/version.rb

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

data/lib/oboe_metal.rb

@@ -53,10 +53,6 @@ module Oboe
       Oboe::Config[:tracing_mode].to_s == "always"
     end
     
-    def continue?
-      Oboe::Context.isValid and not Oboe.never?
-    end
-    
     def log(layer, label, options = {})
       Context.log(layer, label, options = options)
     end
@@ -65,22 +61,18 @@ module Oboe
       Oboe::Config[:tracing_mode].to_s == "never"
     end
 
-    def now?
-      Oboe::Context.isValid and not Oboe.never?
-    end
-    
     def passthrough?
       ["always", "through"].include?(Oboe::Config[:tracing_mode])
     end
       
-    def sample?
-      Oboe::Config[:sample_rate].to_i < rand(1e6)
+    def sample?(opts = {})
+      # Assure defaults since SWIG enforces Strings
+      opts[:layer]      ||= ''
+      opts[:xtrace]     ||= ''
+      opts['X-TV-Meta'] ||= ''
+      Oboe::Context.sampleRequest(opts[:layer], opts[:xtrace], opts['X-TV-Meta'])
     end
 
-    def start?
-      not Oboe::Context.isValid and Oboe.always?
-    end
-    
     def through?
       Oboe::Config[:tracing_mode] == "through"
     end

data/oboe.gemspec

@@ -16,4 +16,14 @@ Gem::Specification.new do |s|
     s.test_files  = Dir.glob("{spec}/**/*.rb")
     s.add_development_dependency 'rake'
     s.add_development_dependency 'rspec'
+
+    s.post_install_message = "
+
+This oboe gem requires updated AppNeta liboboe (>= 1.1.1) and 
+tracelytics-java-agent packages (if using JRuby).  Make sure to update all 
+of your hosts or this gem will just sit in the corner and weep quietly.
+
+- Your Friendly AppNeta TraceView Team
+
+"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: oboe
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 3
   prerelease: 
   segments: 
   - 2
   - 1
-  - 3
-  version: 2.1.3
+  - 4
+  version: 2.1.4
 platform: ruby
 authors: 
 - Tracelytics, Inc.
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-07-11 00:00:00 Z
+date: 2013-08-01 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -55,6 +55,7 @@ extra_rdoc_files:
 - LICENSE
 files: 
 - .gitignore
+- CHANGELOG
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -63,6 +64,9 @@ files:
 - Rakefile
 - ext/oboe_metal/extconf.rb
 - ext/oboe_metal/noop/noop.c
+- ext/oboe_metal/src/bson/bson.h
+- ext/oboe_metal/src/bson/platform_hacks.h
+- ext/oboe_metal/src/oboe.h
 - ext/oboe_metal/src/oboe.hpp
 - ext/oboe_metal/src/oboe_wrap.cxx
 - ext/oboe_metal/tests/test.rb
@@ -121,7 +125,15 @@ files:
 homepage: http://tracelytics.com
 licenses: []
 
-post_install_message: 
+post_install_message: |+
+  
+  
+  This oboe gem requires updated AppNeta liboboe (>= 1.1.1) and 
+  tracelytics-java-agent packages (if using JRuby).  Make sure to update all 
+  of your hosts or this gem will just sit in the corner and weep quietly.
+  
+  - Your Friendly AppNeta TraceView Team
+  
 rdoc_options: []
 
 require_paths: