oboe 2.2.6 → 2.3.2

data/test/instrumentation/rack_test.rb

@@ -0,0 +1,55 @@
+require 'minitest_helper'
+require 'rack/test'
+require 'rack/lobster'
+require 'oboe/inst/rack'
+
+Oboe::Config[:tracing_mode] = 'always'
+Oboe::Config[:sample_rate] = 1e6
+    
+class RackTestApp < MiniTest::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    @app = Rack::Builder.new {
+      use Rack::CommonLogger
+      use Rack::ShowExceptions
+      use Oboe::Rack
+      map "/lobster" do
+        use Rack::Lint
+        run Rack::Lobster.new
+      end
+    }
+  end
+
+  def test_get_the_lobster
+    clear_all_traces 
+
+    get "/lobster"
+
+    traces = get_all_traces
+    traces.count.must_equal 3
+
+    validate_outer_layers(traces, 'rack')
+
+    kvs = {} 
+    kvs["Label"] = "entry"
+    validate_event_keys(traces[0], kvs)
+
+    kvs.clear
+    kvs["Label"] = "info"
+    kvs["Status"] = "200"
+    kvs["SampleRate"] = "1000000"
+    kvs["SampleSource"] = "1"
+    kvs["HTTP-Host"] = "example.org"
+    kvs["Port"] = "80"
+    kvs["Proto"] = "http"
+    kvs["URL"] = "/lobster"
+    kvs["Method"] = "GET"
+    kvs["ClientIP"] = "127.0.0.1"
+    validate_event_keys(traces[1], kvs)
+
+    assert last_response.ok?
+    assert last_response['X-Trace']
+  end
+end
+

data/test/instrumentation/resque_test.rb

@@ -0,0 +1,62 @@
+require 'minitest_helper'
+
+describe Oboe::Inst::Resque do
+  before do
+    clear_all_traces 
+
+    # These are standard entry/exit KVs that are passed up with all moped operations
+    @entry_kvs = {
+      'Layer' => 'resque',
+      'Label' => 'entry' }
+
+    @exit_kvs = { 'Layer' => 'resque', 'Label' => 'exit' }
+  end
+
+  it 'Stock Resque should be loaded, defined and ready' do
+    defined?(::Resque).wont_match nil 
+    defined?(::Resque::Worker).wont_match nil
+    defined?(::Resque::Job).wont_match nil
+  end
+
+  it 'Resque should have oboe methods defined' do
+    [ :enqueue, :enqueue_to, :dequeue ].each do |m|
+      ::Resque.method_defined?("#{m}_with_oboe").must_equal true
+    end
+
+    ::Resque::Worker.method_defined?("perform_with_oboe").must_equal true
+    ::Resque::Job.method_defined?("fail_with_oboe").must_equal true
+  end
+
+  it "should trace enqueue" do
+    skip
+    Oboe::API.start_trace('resque-client_test', '', {}) do
+      Resque.enqueue(OboeResqueJob, { :generate => :activerecord, :delay => rand(5..30).to_f })
+      Resque.enqueue(OboeResqueJobThatFails)
+      Resque.dequeue(OboeResqueJob, { :generate => :moped })
+    end
+    
+    traces = get_all_traces
+    
+    traces.count.must_equal 4
+    validate_outer_layers(traces, 'resque-client_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    validate_event_keys(traces[2], @exit_kvs)
+  end
+  
+  it "should trace dequeue" do
+    skip
+    Oboe::API.start_trace('resque-client_test', '', {}) do
+      Resque.dequeue(OboeResqueJob, { :generate => :moped })
+    end
+    
+    traces = get_all_traces
+    
+    traces.count.must_equal 4
+    validate_outer_layers(traces, 'resque-client_test')
+
+    validate_event_keys(traces[1], @entry_kvs)
+    validate_event_keys(traces[2], @exit_kvs)
+  end
+end
+

data/test/minitest_helper.rb

@@ -0,0 +1,113 @@
+require "minitest/autorun"
+require "minitest/reporters"
+
+ENV["RACK_ENV"] = "test"
+MiniTest::Reporters.use!
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default, :test)
+
+# Preload memcache-client
+require 'memcache'
+
+@trace_dir = File.dirname(__FILE__) + "/../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
+Oboe::Ruby.initialize
+Oboe.logger.level = Logger::DEBUG
+
+Oboe.logger.debug "[oboe/test] Debug log output test."
+
+##
+# clear_all_traces
+#
+# Truncates the trace output file to zero
+#
+def clear_all_traces
+  File.truncate($trace_file, 0)
+end
+
+##
+# get_all_traces
+#
+# Retrieves all traces written to the trace file
+#
+def get_all_traces
+  traces = []
+  f = File.open($trace_file)
+  until f.eof?
+    traces << BSON.read_bson_document(f)
+  end
+  traces
+end
+
+##
+# validate_outer_layers
+#
+# Validates that the KVs in kvs are present
+# in event
+#
+def validate_outer_layers(traces, layer)
+  traces.first['Layer'].must_equal layer
+  traces.first['Label'].must_equal 'entry'
+  traces.last['Layer'].must_equal layer
+  traces.last['Label'].must_equal 'exit'
+end
+
+##
+# validate_event_keys
+#
+# Validates that the KVs in kvs are present
+# in event
+#
+def validate_event_keys(event, kvs)
+  kvs.each do |k, v|
+    event.has_key?(k).must_equal true
+    event[k].must_equal v
+  end
+end
+
+##
+# layer_has_key
+#
+# Checks an array of trace events if a specific layer (regardless of event type)
+# has he specified key
+#
+def layer_has_key(traces, layer, key)
+  has_key = false
+
+  traces.each do |t|
+    if t["Layer"] == layer and t.has_key?(key)
+      has_key = true
+
+      (t["Backtrace"].length > 0).must_equal true
+    end
+  end
+
+  has_key.must_equal true
+end
+
+##
+# layer_doesnt_have_key
+#
+# Checks an array of trace events to assure that a specific layer 
+# (regardless of event type) doesn't have the specified key
+#
+def layer_doesnt_have_key(traces, layer, key)
+  has_key = false
+
+  traces.each do |t|
+    has_key = true if t["Layer"] == layer and t.has_key?(key)
+  end
+
+  has_key.must_equal false
+end
+

data/test/support/config_test.rb

@@ -0,0 +1,41 @@
+require 'minitest_helper'
+
+describe Oboe::Config do
+  after do
+    # Set back to always trace mode
+    Oboe::Config[:tracing_mode] = "always"
+    Oboe::Config[:sample_rate] = 1000000
+  end
+
+  it 'should have the correct default values' do
+    # Reset Oboe::Config to defaults
+    Oboe::Config.initialize
+
+    Oboe::Config[:verbose].must_equal false
+    Oboe::Config[:sample_source].must_equal 2
+    Oboe::Config[:sample_rate].must_equal 300000
+    Oboe::Config[:tracing_mode].must_equal "through"
+    Oboe::Config[:reporter_host].must_equal "127.0.0.1"
+  end
+
+  it 'should have the correct instrumentation defaults' do
+    # Reset Oboe::Config to defaults
+    Oboe::Config.initialize
+
+    instrumentation = [ :cassandra, :dalli, :nethttp, :memcached, :memcache, :mongo,
+                        :moped, :rack, :resque, :action_controller, :action_view,
+                        :active_record ]
+
+    # Verify the number of individual instrumentations
+    instrumentation.count.must_equal 12
+
+    instrumentation.each do |k|
+      Oboe::Config[k][:enabled].must_equal true
+      Oboe::Config[k][:log_args].must_equal true
+    end
+
+    Oboe::Config[:resque][:link_workers].must_equal false
+    Oboe::Config[:blacklist].is_a?(Array).must_equal true
+  end
+
+end

metadata

@@ -1,21 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: oboe
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: 
   segments: 
   - 2
+  - 3
   - 2
-  - 6
-  version: 2.2.6
+  version: 2.3.2
 platform: ruby
 authors: 
-- Tracelytics, Inc.
+- Peter Giacomo Lombardo
+- Spiros Eliopoulos
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2013-09-27 00:00:00 Z
+date: 2013-10-22 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
@@ -32,7 +33,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: minitest
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -45,8 +46,22 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
-description: The oboe gem provides AppNeta instrumentation for Ruby and Ruby frameworks.
-email: contact@tracelytics.com
+- !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"
+  type: :development
+  version_requirements: *id003
+description: The oboe gem provides TraceView instrumentation for Ruby and Ruby frameworks.
+email: traceviewsupport@appneta.com
 executables: []
 
 extensions: 
@@ -55,10 +70,9 @@ extra_rdoc_files:
 - LICENSE
 files: 
 - .gitignore
+- Appraisals
 - CHANGELOG
 - Gemfile
-- Gemfile.lock
-- Guardfile
 - LICENSE
 - README.md
 - Rakefile
@@ -70,9 +84,16 @@ files:
 - ext/oboe_metal/src/oboe.hpp
 - ext/oboe_metal/src/oboe_wrap.cxx
 - ext/oboe_metal/tests/test.rb
+- gemfiles/rails2.3.gemfile
+- gemfiles/rails2.3.gemfile.lock
+- gemfiles/rails3.0.gemfile
+- gemfiles/rails3.0.gemfile.lock
+- gemfiles/rails3.1.gemfile
+- gemfiles/rails3.1.gemfile.lock
+- gemfiles/rails3.2.gemfile
+- gemfiles/rails3.2.gemfile.lock
 - get_version.rb
 - init.rb
-- install.rb
 - lib/joboe_metal.rb
 - lib/method_profiling.rb
 - lib/oboe.rb
@@ -120,18 +141,18 @@ files:
 - oboe.gemspec
 - oboe_fu.gemspec
 - release.sh
-- spec/instrumentation/cassandra_spec.rb
-- spec/instrumentation/dalli_spec.rb
-- spec/instrumentation/http_spec.rb
-- spec/instrumentation/memcache_spec.rb
-- spec/instrumentation/memcached_spec.rb
-- spec/instrumentation/mongo_spec.rb
-- spec/instrumentation/moped_spec.rb
-- spec/instrumentation/resque_spec.rb
-- spec/spec_helper.rb
-- spec/support/config_spec.rb
-- spec/support/oboe_spec.rb
-homepage: http://tracelytics.com
+- test/instrumentation/cassandra_test.rb
+- test/instrumentation/dalli_test.rb
+- test/instrumentation/http_test.rb
+- test/instrumentation/memcache_test.rb
+- test/instrumentation/memcached_test.rb
+- test/instrumentation/mongo_test.rb
+- test/instrumentation/moped_test.rb
+- test/instrumentation/rack_test.rb
+- test/instrumentation/resque_test.rb
+- test/minitest_helper.rb
+- test/support/config_test.rb
+homepage: http://www.appneta.com/application-performance-management
 licenses: []
 
 post_install_message: 
@@ -163,16 +184,16 @@ rubyforge_project:
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Tracelytics instrumentation gem
+summary: AppNeta TraceView performance instrumentation gem for Ruby
 test_files: 
-- spec/support/oboe_spec.rb
-- spec/support/config_spec.rb
-- spec/instrumentation/mongo_spec.rb
-- spec/instrumentation/moped_spec.rb
-- spec/instrumentation/cassandra_spec.rb
-- spec/instrumentation/http_spec.rb
-- spec/instrumentation/resque_spec.rb
-- spec/instrumentation/dalli_spec.rb
-- spec/instrumentation/memcache_spec.rb
-- spec/instrumentation/memcached_spec.rb
-- spec/spec_helper.rb
+- test/minitest_helper.rb
+- test/support/config_test.rb
+- test/instrumentation/memcached_test.rb
+- test/instrumentation/memcache_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

data/Gemfile.lock

@@ -1,103 +0,0 @@
-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