oboe 2.3.2 → 2.3.3.7

data/test/minitest_helper.rb

@@ -2,7 +2,10 @@ require "minitest/autorun"
 require "minitest/reporters"
 
 ENV["RACK_ENV"] = "test"
-MiniTest::Reporters.use!
+
+unless RUBY_VERSION =~ /^1.8/
+  MiniTest::Reporters.use! MiniTest::Reporters::SpecReporter.new
+end
 
 require 'rubygems'
 require 'bundler'
@@ -12,12 +15,9 @@ Bundler.require(:default, :test)
 # Preload memcache-client
 require 'memcache'
 
-@trace_dir = File.dirname(__FILE__) + "/../tmp/"
+@trace_dir = "/tmp/"
 $trace_file = @trace_dir + "trace_output.bson"
 
-# Create a oboe-ruby/tmp dir to store trace output
-Dir.mkdir @trace_dir unless File.exists?(@trace_dir) and File.directory?(@trace_dir)
-
 # Configure Oboe
 Oboe::Config[:tracing_mode] = "always"
 Oboe::Config[:sample_rate] = 1000000

data/test/profiling/method_test.rb

@@ -0,0 +1,198 @@
+require 'minitest_helper'
+
+describe OboeMethodProfiling do
+  before do
+    clear_all_traces 
+    # Conditionally Undefine TestWorker
+    # http://stackoverflow.com/questions/11503558/how-to-undefine-class-in-ruby
+    Object.send(:remove_const, :TestWorker) if defined?(TestWorker)
+  end
+  
+  it 'should be loaded, defined and ready' do
+    defined?(::OboeMethodProfiling).wont_match nil 
+  end
+
+  it 'should trace Class methods' do
+    class TestWorker 
+      def self.do_work
+        sleep 1
+      end
+
+      class << self
+        include OboeMethodProfiling
+        profile_method :do_work, 'do_work'
+      end
+    end
+
+    ::Oboe::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      TestWorker.do_work
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    
+    validate_outer_layers(traces, 'method_profiling')
+
+    kvs = {}
+    kvs["Layer"] = ""
+    kvs["Label"] = 'profile_entry'
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+    kvs["FunctionName"] = "do_work"
+    kvs["Class"] = "TestWorker"
+
+    validate_event_keys(traces[1], kvs)
+
+    traces[1].has_key?("File").must_equal true
+    traces[1].has_key?("LineNumber").must_equal true
+
+    kvs.clear
+    kvs["Layer"] = ""
+    kvs["Label"] = "profile_exit"
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+    
+    validate_event_keys(traces[2], kvs)
+  end
+  
+  it 'should trace Instance methods' do
+    class TestWorker 
+      def do_work
+        sleep 1
+      end
+
+      include OboeMethodProfiling
+      profile_method :do_work, 'do_work'
+    end
+
+    ::Oboe::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      tw = TestWorker.new
+      tw.do_work
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    
+    validate_outer_layers(traces, 'method_profiling')
+
+    kvs = {}
+    kvs["Layer"] = ""
+    kvs["Label"] = 'profile_entry'
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+    kvs["FunctionName"] = "do_work"
+    kvs["Class"] = "TestWorker"
+
+    validate_event_keys(traces[1], kvs)
+
+    traces[1].has_key?("File").must_equal true
+    traces[1].has_key?("LineNumber").must_equal true
+
+    kvs.clear
+    kvs["Layer"] = ""
+    kvs["Label"] = "profile_exit"
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+    
+    validate_event_keys(traces[2], kvs)
+  end
+  
+  it 'should trace Module class methods' do
+    module TestWorker 
+      def self.do_work
+        sleep 1
+      end
+
+      class << self
+        include OboeMethodProfiling
+        profile_method :do_work, 'do_work'
+      end
+    end
+
+    ::Oboe::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      TestWorker.do_work
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+    validate_outer_layers(traces, 'method_profiling')
+
+    kvs = {}
+    kvs["Layer"] = ""
+    kvs["Label"] = 'profile_entry'
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+    kvs["FunctionName"] = "do_work"
+    kvs["Module"] = "TestWorker"
+
+    validate_event_keys(traces[1], kvs)
+
+    traces[1].has_key?("File").must_equal true
+    traces[1].has_key?("LineNumber").must_equal true
+
+    kvs.clear
+    kvs["Layer"] = ""
+    kvs["Label"] = "profile_exit"
+    kvs["Language"] = "ruby"
+    kvs["ProfileName"] = "do_work"
+    
+    validate_event_keys(traces[2], kvs)
+  end
+  
+  it 'should not store arguments and return value by default' do
+    class TestWorker 
+      def self.do_work(s, i, a, h)
+        sleep 1
+        return "the zebra is loose"
+      end
+
+      class << self
+        include OboeMethodProfiling
+        # Default call method
+        profile_method :do_work, 'do_work'
+      end
+    end
+
+    ::Oboe::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      TestWorker.do_work('String Argument', 203984, ["1", "2", 3], { :color => :black })
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    traces[1].has_key?("Args").must_equal false
+    traces[2].has_key?("ReturnValue").must_equal false
+  end
+  
+  it 'should store arguments and return value when asked' do
+    class TestWorker 
+      def self.do_work(s, i, a, h)
+        sleep 1
+        return "the zebra is loose"
+      end
+
+      class << self
+        include OboeMethodProfiling
+        profile_method :do_work, 'do_work', true, true
+      end
+    end
+
+    ::Oboe::API.start_trace('method_profiling', '', {}) do
+      # Call the profiled class method
+      TestWorker.do_work('String Argument', 203984, ["1", "2", 3], { :color => :black })
+    end
+
+    traces = get_all_traces
+    traces.count.must_equal 4
+
+    traces[1].has_key?("Args").must_equal true
+    traces[1]["Args"].must_equal "\"String Argument\"\n203984\n[\"1\", \"2\", 3]\n{:color=>:black}\n"
+    
+    traces[2].has_key?("ReturnValue").must_equal true
+    traces[2]["ReturnValue"].must_equal "\"the zebra is loose\"\n"
+  end
+end

metadata

@@ -1,75 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: oboe
-version: !ruby/object:Gem::Version 
-  hash: 7
-  prerelease: 
-  segments: 
-  - 2
-  - 3
-  - 2
-  version: 2.3.2
+version: !ruby/object:Gem::Version
+  version: 2.3.3.7
 platform: ruby
-authors: 
+authors:
 - Peter Giacomo Lombardo
 - Spiros Eliopoulos
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-10-22 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: minitest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bson
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bson
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: The oboe gem provides TraceView instrumentation for Ruby and Ruby frameworks.
 email: traceviewsupport@appneta.com
 executables: []
-
-extensions: 
+extensions:
 - ext/oboe_metal/extconf.rb
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
-files: 
+files:
 - .gitignore
+- .travis.yml
 - Appraisals
 - CHANGELOG
 - Gemfile
@@ -94,6 +87,7 @@ files:
 - gemfiles/rails3.2.gemfile.lock
 - get_version.rb
 - init.rb
+- lib/base.rb
 - lib/joboe_metal.rb
 - lib/method_profiling.rb
 - lib/oboe.rb
@@ -151,49 +145,41 @@ files:
 - test/instrumentation/rack_test.rb
 - test/instrumentation/resque_test.rb
 - test/minitest_helper.rb
+- test/profiling/method_test.rb
 - test/support/config_test.rb
 homepage: http://www.appneta.com/application-performance-management
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: AppNeta TraceView performance instrumentation gem for Ruby
-test_files: 
+test_files:
 - test/minitest_helper.rb
-- test/support/config_test.rb
-- test/instrumentation/memcached_test.rb
-- test/instrumentation/memcache_test.rb
+- test/instrumentation/mongo_test.rb
 - test/instrumentation/dalli_test.rb
 - test/instrumentation/http_test.rb
-- test/instrumentation/cassandra_test.rb
 - test/instrumentation/resque_test.rb
-- test/instrumentation/rack_test.rb
 - test/instrumentation/moped_test.rb
-- test/instrumentation/mongo_test.rb
+- test/instrumentation/rack_test.rb
+- test/instrumentation/memcache_test.rb
+- test/instrumentation/cassandra_test.rb
+- test/instrumentation/memcached_test.rb
+- test/profiling/method_test.rb
+- test/support/config_test.rb