traceview 3.0.2-java → 3.0.3-java

data/gemfiles/rails32.gemfile

@@ -0,0 +1,47 @@
+source "https://rubygems.org"
+
+if RUBY_VERSION < '1.9.3'
+  # i18n 0.7.0 dropped support for Ruby 1.9.2 and older.  ActiveSupport
+  # depends on i18n 0.7.0 since v 4.0.5.  For < 1.9.2 Ruby support, lock
+  # down to these versions to maintain functionality.
+  gem 'i18n', '< 0.7.0'
+  gem 'activesupport', '< 4.0'
+end
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'minitest-debugger', :require => false
+  gem 'rack-test'
+  gem 'puma'
+  if RUBY_VERSION < '1.9.3'
+    gem 'bson', '<= 1.12.3'
+  else
+    gem 'bson'
+  end
+end
+
+group :development do
+  gem 'ruby-debug',   :platforms => [ :mri_18, :jruby ]
+  gem 'debugger',     :platform  =>   :mri_19
+  gem 'byebug',       :platforms => [ :mri_20, :mri_21, :mri_22 ]
+#  gem 'perftools.rb', :platforms => [ :mri_20, :mri_21 ], :require => 'perftools'
+  if RUBY_VERSION > '1.8.7'
+    gem 'pry'
+    gem 'pry-byebug', :platforms => [ :mri_20, :mri_21, :mri_22 ]
+  else
+    gem 'pry', '0.9.12.4'
+  end
+end
+
+if defined?(JRUBY_VERSION)
+  gem 'sinatra', :require => false
+else
+  gem 'sinatra'
+end
+
+gem "rails", "~>3.2"
+
+gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')
+# vim:syntax=ruby

data/gemfiles/rails40.gemfile

@@ -0,0 +1,35 @@
+source "https://rubygems.org"
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'minitest-debugger', :require => false
+  gem 'rack-test'
+  gem 'puma'
+  gem 'bson'
+end
+
+group :development do
+  gem 'ruby-debug',   :platforms => [ :mri_18, :jruby ]
+  gem 'debugger',     :platform  =>   :mri_19
+  gem 'byebug',       :platforms => [ :mri_20, :mri_21, :mri_22 ]
+#  gem 'perftools.rb', :platforms => [ :mri_20, :mri_21 ], :require => 'perftools'
+  if RUBY_VERSION > '1.8.7'
+    gem 'pry'
+    gem 'pry-byebug', :platforms => [ :mri_20, :mri_21, :mri_22 ]
+  else
+    gem 'pry', '0.9.12.4'
+  end
+end
+
+if defined?(JRUBY_VERSION)
+  gem 'sinatra', :require => false
+else
+  gem 'sinatra'
+end
+
+gem "rails", "~>4.0"
+
+gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')
+# vim:syntax=ruby

data/gemfiles/rails41.gemfile

@@ -0,0 +1,35 @@
+source "https://rubygems.org"
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'minitest-debugger', :require => false
+  gem 'rack-test'
+  gem 'puma'
+  gem 'bson'
+end
+
+group :development do
+  gem 'ruby-debug',   :platforms => [ :mri_18, :jruby ]
+  gem 'debugger',     :platform  =>   :mri_19
+  gem 'byebug',       :platforms => [ :mri_20, :mri_21, :mri_22 ]
+#  gem 'perftools.rb', :platforms => [ :mri_20, :mri_21 ], :require => 'perftools'
+  if RUBY_VERSION > '1.8.7'
+    gem 'pry'
+    gem 'pry-byebug', :platforms => [ :mri_20, :mri_21, :mri_22 ]
+  else
+    gem 'pry', '0.9.12.4'
+  end
+end
+
+if defined?(JRUBY_VERSION)
+  gem 'sinatra', :require => false
+else
+  gem 'sinatra'
+end
+
+gem "rails", "~>4.1"
+
+gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')
+# vim:syntax=ruby

data/gemfiles/rails42.gemfile

@@ -0,0 +1,35 @@
+source "https://rubygems.org"
+
+group :development, :test do
+  gem 'rake'
+  gem 'minitest'
+  gem 'minitest-reporters'
+  gem 'minitest-debugger', :require => false
+  gem 'rack-test'
+  gem 'puma'
+  gem 'bson'
+end
+
+group :development do
+  gem 'ruby-debug',   :platforms => [ :mri_18, :jruby ]
+  gem 'debugger',     :platform  =>   :mri_19
+  gem 'byebug',       :platforms => [ :mri_20, :mri_21, :mri_22 ]
+#  gem 'perftools.rb', :platforms => [ :mri_20, :mri_21 ], :require => 'perftools'
+  if RUBY_VERSION > '1.8.7'
+    gem 'pry'
+    gem 'pry-byebug', :platforms => [ :mri_20, :mri_21, :mri_22 ]
+  else
+    gem 'pry', '0.9.12.4'
+  end
+end
+
+if defined?(JRUBY_VERSION)
+  gem 'sinatra', :require => false
+else
+  gem 'sinatra'
+end
+
+gem "rails", "~>4.2"
+
+gemspec :path => File.expand_path(File.dirname(__FILE__) + '/../')
+# vim:syntax=ruby

data/lib/traceview/api/logging.rb

@@ -5,20 +5,22 @@ module TraceView
   module API
     ##
     # This modules provides the X-Trace logging facilities.
+    #
     module Logging
+      ##
       # Public: Report an event in an active trace.
       #
-      # layer - The layer the reported event belongs to
-      # label - The label for the reported event. See API documentation for
-      #         reserved labels and usage.
-      # opts - A hash containing key/value pairs that will be reported along
-      #        with this event (optional).
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +label+ - The label for the reported event. See API documentation for reserved labels and usage.
+      # * +opts+ - A hash containing key/value pairs that will be reported along with this event (optional).
       #
-      # Example
+      # ==== Example
       #
-      #   log('logical_layer', 'entry')
-      #   log('logical_layer', 'info', { :list_length => 20 })
-      #   log('logical_layer', 'exit')
+      #   TraceView::API.log('logical_layer', 'entry')
+      #   TraceView::API.log('logical_layer', 'info', { :list_length => 20 })
+      #   TraceView::API.log('logical_layer', 'exit')
       #
       # Returns nothing.
       def log(layer, label, opts = {})
@@ -27,17 +29,20 @@ module TraceView
         end
       end
 
+      ##
       # Public: Report an exception.
       #
-      # layer - The layer the reported event belongs to
-      # exn - The exception to report
+      # ==== Arguments
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +exn+ - The exception to report
       #
-      # Example
+      # ==== Example
       #
       #   begin
-      #     function_without_traceview()
+      #     my_iffy_method
       #   rescue Exception => e
-      #     log_exception('rails', e)
+      #     TraceView::API.log_exception('rails', e)
       #     raise
       #   end
       #
@@ -53,15 +58,20 @@ module TraceView
         log(layer, 'error', kvs)
       end
 
+      ##
       # Public: Decide whether or not to start a trace, and report an event
       # appropriately.
       #
-      # layer - The layer the reported event belongs to
-      # xtrace - An xtrace metadata string, or nil.
-      # opts - A hash containing key/value pairs that will be reported along
-      #        with this event (optional).
+      # ==== Attributes
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +xtrace+ - An xtrace metadata string, or nil.  Used for cross-application tracing.
+      # * +opts+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
+      #
+      #   Oboe::API.log_start(:layer_name, nil, { :id => @user.id })
       #
-      # Returns nothing.
       def log_start(layer, xtrace = nil, opts = {})
         return if !TraceView.loaded || TraceView.never? ||
                   (opts.key?(:URL) && ::TraceView::Util.static_asset?(opts[:URL]))
@@ -100,9 +110,17 @@ module TraceView
         end
       end
 
-      # Public: Report an exit event.
+      ##
+      # Public: Report an exit event and potentially clear the tracing context.
+      #
+      # ==== Attributes
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +opts+ - A hash containing key/value pairs that will be reported along with this event (optional).
       #
-      # layer - The layer the reported event belongs to
+      # ==== Example
+      #
+      #   Oboe::API.log_end(:layer_name, { :id => @user.id })
       #
       # Returns an xtrace metadata string
       def log_end(layer, opts = {})
@@ -117,8 +135,17 @@ module TraceView
       ##
       # Public: Log an entry event
       #
-      # A helper method to create and log an
-      # entry event
+      # A helper method to create and log an entry event
+      #
+      # ==== Attributes
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      # * +op+ - To identify the current operation being traced.  Used to avoid double tracing recursive calls.
+      #
+      # ==== Example
+      #
+      #   Oboe::API.log_entry(:layer_name, { :id => @user.id })
       #
       # Returns an xtrace metadata string
       def log_entry(layer, kvs = {}, op = nil)
@@ -131,8 +158,16 @@ module TraceView
       ##
       # Public: Log an info event
       #
-      # A helper method to create and log an
-      # info event
+      # A helper method to create and log an info event
+      #
+      # ==== Attributes
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
+      #
+      #   Oboe::API.log_info(:layer_name, { :id => @user.id })
       #
       # Returns an xtrace metadata string
       def log_info(layer, kvs = {})
@@ -144,8 +179,17 @@ module TraceView
       ##
       # Public: Log an exit event
       #
-      # A helper method to create and log an
-      # exit event
+      # A helper method to create and log an exit event
+      #
+      # ==== Attributes
+      #
+      # * +layer+ - The layer the reported event belongs to
+      # * +kvs+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      # * +op+ - To identify the current operation being traced.  Used to avoid double tracing recursive calls.
+      #
+      # ==== Example
+      #
+      #   Oboe::API.log_exit(:layer_name, { :id => @user.id })
       #
       # Returns an xtrace metadata string
       def log_exit(layer, kvs = {}, op = nil)
@@ -155,23 +199,25 @@ module TraceView
         end
       end
 
+      ##
       # Internal: Report an event.
       #
-      # layer - The layer the reported event belongs to
-      # label - The label for the reported event. See API documentation for
-      #         reserved labels and usage.
-      # opts - A hash containing key/value pairs that will be reported along
-      #        with this event (optional).
+      # ==== Attributes
       #
-      # Examples
+      # * +layer+ - The layer the reported event belongs to
+      # * +label+ - The label for the reported event.  See API documentation for reserved labels and usage.
+      # * +event+ - The pre-existing TraceView context event.  See TraceView::Context.createEvent
+      # * +opts+ - A hash containing key/value pairs that will be reported along with this event (optional).
+      #
+      # ==== Example
       #
       #   entry = TraceView::Context.createEvent
-      #   log_event('rails', 'entry', exit, { :controller => 'user', :action => 'index' })
-      #   exit = TraceView::Context.createEvent
-      #   exit.addEdge(entry.getMetadata)
-      #   log_event('rails', 'exit', exit)
+      #   Oboe::API.log_event(:layer_name, 'entry',  entry_event, { :id => @user.id })
+      #
+      #   exit_event = TraceView::Context.createEvent
+      #   exit_event.addEdge(entry.getMetadata)
+      #   Oboe::API.log_event(:layer_name, 'exit',  exit_event, { :id => @user.id })
       #
-      # Returns nothing.
       def log_event(layer, label, event, opts = {})
         if TraceView.loaded
           event.addInfo('Layer', layer.to_s) if layer

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

@@ -138,7 +138,7 @@ module TraceView
           :Action       => self.action_name,
         }
 
-        TraceView::API.log_entry('rails')
+        TraceView::API.log_entry('rails', report_kvs)
         process_action_without_traceview(method_name, *args)
 
       rescue Exception => e

data/lib/traceview/inst/moped.rb

@@ -264,10 +264,10 @@ if defined?(::Moped) && TraceView::Config[:moped][:enabled]
             end
 
             TraceView::API.trace('mongo', report_kvs) do
-              update_without_traceview(change, flags = nil)
+              update_without_traceview(change, flags)
             end
           else
-            update_without_traceview(change, flags = nil)
+            update_without_traceview(change, flags)
           end
         end
 

data/lib/traceview/util.rb

@@ -142,18 +142,14 @@ module TraceView
       ##
       # to_query
       #
-      # Used under Ruby 1.8.7 to convert a hash into a URL
-      # query.  A backport of Hash#to_query.
+      # Used to convert a hash into a URL # query.
       #
       def to_query(h)
         return "" unless h.is_a?(Hash)
 
-        # If called from a newer Ruby, use the builtin.
-        return h.to_query if RUBY_VERSION >= '1.9.3'
-
         result = []
 
-        h.each { |k, v| result.push (k.to_s + '=' + v.to_s) }
+        h.each { |k, v| result.push(k.to_s + '=' + v.to_s) }
         return result.sort.join('&')
       end
 
@@ -167,38 +163,38 @@ module TraceView
         platform_info = { '__Init' => 1 }
 
         begin
-          platform_info['Force']                   = true
-          platform_info['Ruby.Platform.Version']   = RUBY_PLATFORM
-          platform_info['Ruby.Version']            = RUBY_VERSION
+          platform_info['Force']                        = true
+          platform_info['Ruby.Platform.Version']        = RUBY_PLATFORM
+          platform_info['Ruby.Version']                 = RUBY_VERSION
           platform_info['Ruby.TraceView.Version']       = ::TraceView::Version::STRING
           platform_info['RubyHeroku.TraceView.Version'] = ::TraceViewHeroku::Version::STRING if defined?(::TraceViewHeroku)
-          platform_info['Ruby.TraceMode.Version']  = ::TraceView::Config[:tracing_mode]
+          platform_info['Ruby.TraceMode.Version']       = ::TraceView::Config[:tracing_mode]
 
           # Report the framework in use
-          if defined?(::RailsLts)
-            platform_info['Ruby.RailsLts.Version'] = "RailsLts-#{::RailsLts::VERSION}"
-          elsif defined?(::Rails)
-            platform_info['Ruby.Rails.Version']    = "Rails-#{::Rails.version}"
+          if defined?(::RailsLts::VERSION)
+            platform_info['Ruby.RailsLts.Version']  = "RailsLts-#{::RailsLts::VERSION}"
+          elsif defined?(::Rails.version)
+            platform_info['Ruby.Rails.Version']     = "Rails-#{::Rails.version}"
           end
-          platform_info['Ruby.Grape.Version']    = "Grape-#{::Grape::VERSION}" if defined?(::Grape)
-          platform_info['Ruby.Cramp.Version']    = "Cramp-#{::Cramp::VERSION}" if defined?(::Cramp)
+          platform_info['Ruby.Grape.Version']       = "Grape-#{::Grape::VERSION}" if defined?(::Grape::VERSION)
+          platform_info['Ruby.Cramp.Version']       = "Cramp-#{::Cramp::VERSION}" if defined?(::Cramp::VERSION)
 
-          if defined?(::Padrino)
-            platform_info['Ruby.Padrino.Version'] = "Padrino-#{::Padrino::VERSION}"
-          elsif defined?(::Sinatra)
-            platform_info['Ruby.Sinatra.Version'] = "Sinatra-#{::Sinatra::VERSION}"
+          if defined?(::Padrino::VERSION)
+            platform_info['Ruby.Padrino.Version']   = "Padrino-#{::Padrino::VERSION}"
+          elsif defined?(::Sinatra::VERSION)
+            platform_info['Ruby.Sinatra.Version']   = "Sinatra-#{::Sinatra::VERSION}"
           end
 
           # Report the instrumented libraries
-          platform_info['Ruby.Cassandra.Version']  = "Cassandra-#{::Cassandra.VERSION}"    if defined?(::Cassandra)
-          platform_info['Ruby.Dalli.Version']      = "Dalli-#{::Dalli::VERSION}"           if defined?(::Dalli)
+          platform_info['Ruby.Cassandra.Version']  = "Cassandra-#{::Cassandra.VERSION}"    if defined?(::Cassandra.VERSION)
+          platform_info['Ruby.Dalli.Version']      = "Dalli-#{::Dalli::VERSION}"           if defined?(::Dalli::VERSION)
           platform_info['Ruby.Excon.Version']      = "Excon-#{::Excon::VERSION}"           if defined?(::Excon::VERSION)
-          platform_info['Ruby.Faraday.Version']    = "Faraday-#{::Faraday::VERSION}"       if defined?(::Faraday)
+          platform_info['Ruby.Faraday.Version']    = "Faraday-#{::Faraday::VERSION}"       if defined?(::Faraday::VERSION)
           platform_info['Ruby.HTTPClient.Version'] = "HTTPClient-#{::HTTPClient::VERSION}" if defined?(::HTTPClient::VERSION)
-          platform_info['Ruby.MemCache.Version']   = "MemCache-#{::MemCache::VERSION}"     if defined?(::MemCache)
-          platform_info['Ruby.Moped.Version']      = "Moped-#{::Moped::VERSION}"           if defined?(::Moped)
-          platform_info['Ruby.Redis.Version']      = "Redis-#{::Redis::VERSION}"           if defined?(::Redis)
-          platform_info['Ruby.Resque.Version']     = "Resque-#{::Resque::VERSION}"         if defined?(::Resque)
+          platform_info['Ruby.MemCache.Version']   = "MemCache-#{::MemCache::VERSION}"     if defined?(::MemCache::VERSION)
+          platform_info['Ruby.Moped.Version']      = "Moped-#{::Moped::VERSION}"           if defined?(::Moped::VERSION)
+          platform_info['Ruby.Redis.Version']      = "Redis-#{::Redis::VERSION}"           if defined?(::Redis::VERSION)
+          platform_info['Ruby.Resque.Version']     = "Resque-#{::Resque::VERSION}"         if defined?(::Resque::VERSION)
           platform_info['Ruby.RestClient.Version'] = "RestClient-#{::RestClient::VERSION}" if defined?(::RestClient::VERSION)
           platform_info['Ruby.Typhoeus.Version']   = "Typhoeus-#{::Typhoeus::VERSION}"     if defined?(::Typhoeus::VERSION)
 
@@ -214,19 +210,19 @@ module TraceView
           platform_info['Ruby.Sequel.Version']  = ::Sequel::VERSION            if defined?(::Sequel::VERSION)
 
           # Report the server in use (if possible)
-          if defined?(::Unicorn)
+          if defined?(::Unicorn::Const::UNICORN_VERSION)
             platform_info['Ruby.AppContainer.Version'] = "Unicorn-#{::Unicorn::Const::UNICORN_VERSION}"
-          elsif defined?(::Puma)
+          elsif defined?(::Puma::Const::PUMA_VERSION)
             platform_info['Ruby.AppContainer.Version'] = "Puma-#{::Puma::Const::PUMA_VERSION} (#{::Puma::Const::CODE_NAME})"
-          elsif defined?(::PhusionPassenger)
+          elsif defined?(::PhusionPassenger::PACKAGE_NAME)
             platform_info['Ruby.AppContainer.Version'] = "#{::PhusionPassenger::PACKAGE_NAME}-#{::PhusionPassenger::VERSION_STRING}"
-          elsif defined?(::Thin)
+          elsif defined?(::Thin::VERSION::STRING)
             platform_info['Ruby.AppContainer.Version'] = "Thin-#{::Thin::VERSION::STRING} (#{::Thin::VERSION::CODENAME})"
-          elsif defined?(::Mongrel)
+          elsif defined?(::Mongrel::Const::MONGREL_VERSION)
             platform_info['Ruby.AppContainer.Version'] = "Mongrel-#{::Mongrel::Const::MONGREL_VERSION}"
-          elsif defined?(::Mongrel2)
+          elsif defined?(::Mongrel2::VERSION)
             platform_info['Ruby.AppContainer.Version'] = "Mongrel2-#{::Mongrel2::VERSION}"
-          elsif defined?(::Trinidad)
+          elsif defined?(::Trinidad::VERSION)
             platform_info['Ruby.AppContainer.Version'] = "Trinidad-#{::Trinidad::VERSION}"
           elsif defined?(::WEBrick::VERSION)
             platform_info['Ruby.AppContainer.Version'] = "WEBrick-#{::WEBrick::VERSION}"