traceview 3.8.0 → 3.8.1

data/lib/traceview/inst/sidekiq-client.rb

@@ -29,7 +29,7 @@ module TraceView
       # args: 0: worker_class, 1: msg, 2: queue, 3: redis_pool
       report_kvs = collect_kvs(args)
 
-      TraceView::API.log_entry('sidekiq-client', report_kvs)
+      TraceView::API.log_entry(:'sidekiq-client', report_kvs)
       args[1]['SourceTrace'] = TraceView::Context.toString if TraceView.tracing?
 
       result = yield
@@ -37,10 +37,10 @@ module TraceView
       report_kvs = { :JobID => result['jid'] }
       result
     rescue => e
-      TraceView::API.log_exception('sidekiq-client', e, report_kvs)
+      TraceView::API.log_exception(:'sidekiq-client', e, report_kvs)
       raise
     ensure
-      TraceView::API.log_exit('sidekiq-client', report_kvs)
+      TraceView::API.log_exit(:'sidekiq-client', report_kvs)
     end
   end
 end

data/lib/traceview/inst/sidekiq-worker.rb

@@ -18,10 +18,10 @@ module TraceView
         report_kvs[:JobName]    = worker.class.to_s
         report_kvs[:MsgID]      = msg['jid']
         report_kvs[:Args]       = msg['args'].to_s[0..1024] if TV::Config[:sidekiqworker][:log_args]
-        report_kvs['Backtrace'] = TV::API.backtrace         if TV::Config[:sidekiqworker][:collect_backtraces]
+        report_kvs[:Backtrace]  = TV::API.backtrace         if TV::Config[:sidekiqworker][:collect_backtraces]
 
         # Webserver Spec KVs
-        report_kvs['HTTP-Host'] = Socket.gethostname
+        report_kvs[:'HTTP-Host'] = Socket.gethostname
         report_kvs[:Controller] = "Sidekiq_#{queue}"
         report_kvs[:Action] = msg['class']
         report_kvs[:URL] = "/sidekiq/#{queue}/#{msg['class']}"
@@ -49,7 +49,7 @@ module TraceView
         report_kvs['X-TV-Meta'] = args[1]['SourceTrace']
       end
 
-      result = TraceView::API.start_trace('sidekiq-worker', nil, report_kvs) do
+      result = TraceView::API.start_trace(:'sidekiq-worker', nil, report_kvs) do
         yield
       end
 

data/lib/traceview/inst/twitter-cassandra.rb

@@ -48,7 +48,7 @@ module TraceView
 
         report_kvs = extract_trace_details(:insert, column_family, key, hash, options)
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           insert_without_traceview(column_family, key, hash, options = {})
         end
       end
@@ -59,7 +59,7 @@ module TraceView
         args = [column_family, key] + columns_and_options
         report_kvs = extract_trace_details(:remove, column_family, key, columns_and_options)
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           send :remove_without_traceview, *args
         end
       end
@@ -70,7 +70,7 @@ module TraceView
         args = [column_family, key] + columns_and_options
         report_kvs = extract_trace_details(:count_columns, column_family, key, columns_and_options)
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           send :count_columns_without_traceview, *args
         end
       end
@@ -81,7 +81,7 @@ module TraceView
         if TraceView.tracing? && !TraceView.tracing_layer_op?(:multi_get_columns)
           report_kvs = extract_trace_details(:get_columns, column_family, key, columns_and_options)
 
-          TraceView::API.trace('cassandra', report_kvs) do
+          TraceView::API.trace(:cassandra, report_kvs) do
             send :get_columns_without_traceview, *args
           end
         else
@@ -95,7 +95,7 @@ module TraceView
         args = [column_family, key] + columns_and_options
         report_kvs = extract_trace_details(:multi_get_columns, column_family, key, columns_and_options)
 
-        TraceView::API.trace('cassandra', report_kvs, :multi_get_columns) do
+        TraceView::API.trace(:cassandra, report_kvs, :multi_get_columns) do
           send :multi_get_columns_without_traceview, *args
         end
       end
@@ -106,7 +106,7 @@ module TraceView
         args = [column_family, key] + columns_and_options
         report_kvs = extract_trace_details(:get, column_family, key, columns_and_options)
 
-        TraceView::API.trace('cassandra', report_kvs, :get) do
+        TraceView::API.trace(:cassandra, report_kvs, :get) do
           send :get_without_traceview, *args
         end
       end
@@ -117,7 +117,7 @@ module TraceView
         if TraceView.tracing? && !TraceView.tracing_layer_op?(:get)
           report_kvs = extract_trace_details(:multi_get, column_family, key, columns_and_options)
 
-          TraceView::API.trace('cassandra', report_kvs) do
+          TraceView::API.trace(:cassandra, report_kvs) do
             send :multi_get_without_traceview, *args
           end
         else
@@ -131,7 +131,7 @@ module TraceView
         args = [column_family, key] + columns_and_options
         report_kvs = extract_trace_details(:exists?, column_family, key, columns_and_options)
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           send :exists_without_traceview?, *args
         end
       end
@@ -140,7 +140,7 @@ module TraceView
         if TraceView.tracing? && !TraceView.tracing_layer_op?(:get_range_batch)
           report_kvs = extract_trace_details(:get_range_single, column_family, nil, nil)
 
-          TraceView::API.trace('cassandra', report_kvs) do
+          TraceView::API.trace(:cassandra, report_kvs) do
             get_range_single_without_traceview(column_family, options)
           end
         else
@@ -153,7 +153,7 @@ module TraceView
 
         report_kvs = extract_trace_details(:get_range_batch, column_family, nil, nil)
 
-        TraceView::API.trace('cassandra', report_kvs, :get_range_batch) do
+        TraceView::API.trace(:cassandra, report_kvs, :get_range_batch) do
           get_range_batch_without_traceview(column_family, options)
         end
       end
@@ -164,7 +164,7 @@ module TraceView
         args = [column_family, index_clause] + columns_and_options
         report_kvs = extract_trace_details(:get_indexed_slices, column_family, nil, columns_and_options)
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           send :get_indexed_slices_without_traceview, *args
         end
       end
@@ -183,7 +183,7 @@ module TraceView
           TraceView.logger.debug "[traceview/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if TraceView::Config[:verbose]
         end
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           create_index_without_traceview(keyspace, column_family, column_name, validation_class)
         end
       end
@@ -199,7 +199,7 @@ module TraceView
           TraceView.logger.debug "[traceview/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if TraceView::Config[:verbose]
         end
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           drop_index_without_traceview(keyspace, column_family, column_name)
         end
       end
@@ -214,7 +214,7 @@ module TraceView
           TraceView.logger.debug "[traceview/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if TraceView::Config[:verbose]
         end
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           add_column_family_without_traceview(cf_def)
         end
       end
@@ -224,7 +224,7 @@ module TraceView
 
         report_kvs = extract_trace_details(:drop_column_family, column_family, nil, nil)
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           drop_column_family_without_traceview(column_family)
         end
       end
@@ -235,7 +235,7 @@ module TraceView
         report_kvs = extract_trace_details(:add_keyspace, nil, nil, nil)
         report_kvs[:Name] = ks_def.name rescue ''
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           add_keyspace_without_traceview(ks_def)
         end
       end
@@ -246,7 +246,7 @@ module TraceView
         report_kvs = extract_trace_details(:drop_keyspace, nil, nil, nil)
         report_kvs[:Name] = keyspace.to_s rescue ''
 
-        TraceView::API.trace('cassandra', report_kvs) do
+        TraceView::API.trace(:cassandra, report_kvs) do
           drop_keyspace_without_traceview(keyspace)
         end
       end

data/lib/traceview/inst/typhoeus.rb

@@ -12,7 +12,7 @@ module TraceView
       def run_with_traceview
         return run_without_traceview unless TraceView.tracing?
 
-        TraceView::API.log_entry('typhoeus')
+        TraceView::API.log_entry(:typhoeus)
 
         # Prepare X-Trace header handling
         blacklisted = TraceView::API.blacklisted?(url)
@@ -23,26 +23,26 @@ module TraceView
         response = run_without_traceview
 
         if response.code == 0
-          TraceView::API.log('typhoeus', 'error', { :ErrorClass => response.return_code,
-                                               :ErrorMsg => response.return_message })
+          TraceView::API.log(:typhoeus, :error, { :ErrorClass => response.return_code,
+                                                  :ErrorMsg => response.return_message })
         end
 
         kvs = {}
-        kvs['IsService'] = 1
+        kvs[:IsService] = 1
         kvs[:HTTPStatus] = response.code
-        kvs['Backtrace'] = TraceView::API.backtrace if TraceView::Config[:typhoeus][:collect_backtraces]
+        kvs[:Backtrace] = TraceView::API.backtrace if TraceView::Config[:typhoeus][:collect_backtraces]
 
         uri = URI(response.effective_url)
 
         # Conditionally log query params
         if TraceView::Config[:typhoeus][:log_args]
-          kvs['RemoteURL'] = uri.to_s
+          kvs[:RemoteURL] = uri.to_s
         else
-          kvs['RemoteURL'] = uri.to_s.split('?').first
+          kvs[:RemoteURL] = uri.to_s.split('?').first
         end
 
-        kvs['HTTPMethod'] = ::TraceView::Util.upcase(options[:method])
-        kvs['Blacklisted'] = true if blacklisted
+        kvs[:HTTPMethod] = ::TraceView::Util.upcase(options[:method])
+        kvs[:Blacklisted] = true if blacklisted
 
         # Re-attach net::http edge unless it's blacklisted or if we don't have a
         # valid X-Trace header
@@ -60,13 +60,13 @@ module TraceView
           end
         end
 
-        TraceView::API.log('typhoeus', 'info', kvs)
+        TraceView::API.log(:typhoeus, :info, kvs)
         response
       rescue => e
-        TraceView::API.log_exception('typhoeus', e)
+        TraceView::API.log_exception(:typhoeus, e)
         raise e
       ensure
-        TraceView::API.log_exit('typhoeus')
+        TraceView::API.log_exit(:typhoeus)
       end
     end
 
@@ -84,7 +84,7 @@ module TraceView
         # FIXME: Until we figure out a strategy to deal with libcurl internal
         # threading and Ethon's use of easy handles, here we just do a simple
         # trace of the hydra run.
-        TraceView::API.trace("typhoeus_hydra", kvs) do
+        TraceView::API.trace(:typhoeus_hydra, kvs) do
           run_without_traceview
         end
       end

data/lib/traceview/method_profiling.rb

@@ -5,7 +5,7 @@ module TraceView
       report_kvs[:Backtrace] = TraceView::API.backtrace(2) if opts[:backtrace]
       report_kvs[:Arguments] = args if opts[:arguments]
 
-      TraceView::API.log(nil, 'profile_entry', report_kvs)
+      TraceView::API.log(nil, :profile_entry, report_kvs)
 
       begin
         rv = self.send(method, *args, &block)
@@ -18,7 +18,7 @@ module TraceView
         report_kvs.delete(:Backtrace)
         report_kvs.delete(:Controller)
         report_kvs.delete(:Action)
-        TraceView::API.log(nil, 'profile_exit', report_kvs)
+        TraceView::API.log(nil, :profile_exit, report_kvs)
       end
     end
   end

data/lib/traceview/ruby.rb

@@ -31,6 +31,6 @@ module TraceView
   end
 end
 
-if TraceView.loaded and !TraceView.framework?
+if TraceView.loaded && !TraceView.framework?
   ::TraceView::Ruby.load
 end

data/lib/traceview/util.rb

@@ -42,8 +42,8 @@ module TraceView
             cls.private_method_defined?(without_traceview.to_sym)
 
             cls.class_eval do
-              alias_method without_traceview, "#{method}"
-              alias_method "#{method}", with_traceview
+              alias_method without_traceview, method.to_s
+              alias_method method.to_s, with_traceview
             end
           end
         else
@@ -71,8 +71,8 @@ module TraceView
 
           # Only alias if we haven't done so already
           unless cls.singleton_methods.include? without_traceview.to_sym
-            cls.singleton_class.send(:alias_method, without_traceview, "#{method}")
-            cls.singleton_class.send(:alias_method, "#{method}", with_traceview)
+            cls.singleton_class.send(:alias_method, without_traceview, method.to_s)
+            cls.singleton_class.send(:alias_method, method.to_s, with_traceview)
           end
         else TraceView.logger.warn "[traceview/loading] Couldn't properly instrument #{name}.  Partial traces may occur."
         end

data/lib/traceview/version.rb

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

data/test/frameworks/rails3x_test.rb

@@ -8,9 +8,14 @@ if defined?(::Rails)
   describe "Rails3x" do
     before do
       clear_all_traces
+      @collect_backtraces = TraceView::Config[:action_controller][:collect_backtraces]
       ENV['DBTYPE'] = "postgresql" unless ENV['DBTYPE']
     end
 
+    after do
+      TraceView::Config[:action_controller][:collect_backtraces] = @collect_backtraces
+    end
+
     it "should trace a request to a rails stack" do
 
       uri = URI.parse('http://127.0.0.1:8140/hello/world')
@@ -294,5 +299,105 @@ if defined?(::Rails)
       r.header.key?('X-Trace').must_equal true
       r.header['X-Trace'].must_equal traces[13]['X-Trace']
     end
+
+    it "should collect backtraces when true" do
+
+      TraceView::Config[:action_controller][:collect_backtraces] = true
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/world')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 8
+      unless defined?(JRUBY_VERSION)
+        # We don't test this under JRuby because the Java instrumentation
+        # for the DB drivers doesn't use our test reporter hence we won't
+        # see all trace events. :-(  To be improved.
+        valid_edges?(traces).must_equal true
+      end
+      validate_outer_layers(traces, 'rack')
+
+      traces[0]['Layer'].must_equal "rack"
+      traces[0]['Label'].must_equal "entry"
+      traces[0]['URL'].must_equal "/hello/world"
+
+      traces[1]['Layer'].must_equal "rack"
+      traces[1]['Label'].must_equal "info"
+
+      traces[2]['Layer'].must_equal "rails"
+      traces[2]['Label'].must_equal "entry"
+
+      traces[3]['Label'].must_equal "info"
+      traces[3]['Controller'].must_equal "HelloController"
+      traces[3]['Action'].must_equal "world"
+      traces[3].key?('Backtrace').must_equal true
+
+      traces[4]['Layer'].must_equal "actionview"
+      traces[4]['Label'].must_equal "entry"
+
+      traces[5]['Layer'].must_equal "actionview"
+      traces[5]['Label'].must_equal "exit"
+
+      traces[6]['Layer'].must_equal "rails"
+      traces[6]['Label'].must_equal "exit"
+
+      traces[7]['Layer'].must_equal "rack"
+      traces[7]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r.header.key?('X-Trace').must_equal true
+      r.header['X-Trace'].must_equal traces[7]['X-Trace']
+    end
+
+    it "should NOT collect backtraces when false" do
+
+      TraceView::Config[:action_controller][:collect_backtraces] = false
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/world')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 8
+      unless defined?(JRUBY_VERSION)
+        # We don't test this under JRuby because the Java instrumentation
+        # for the DB drivers doesn't use our test reporter hence we won't
+        # see all trace events. :-(  To be improved.
+        valid_edges?(traces).must_equal true
+      end
+      validate_outer_layers(traces, 'rack')
+
+      traces[0]['Layer'].must_equal "rack"
+      traces[0]['Label'].must_equal "entry"
+      traces[0]['URL'].must_equal "/hello/world"
+
+      traces[1]['Layer'].must_equal "rack"
+      traces[1]['Label'].must_equal "info"
+
+      traces[2]['Layer'].must_equal "rails"
+      traces[2]['Label'].must_equal "entry"
+
+      traces[3]['Label'].must_equal "info"
+      traces[3]['Controller'].must_equal "HelloController"
+      traces[3]['Action'].must_equal "world"
+      traces[3].key?('Backtrace').must_equal false
+
+      traces[4]['Layer'].must_equal "actionview"
+      traces[4]['Label'].must_equal "entry"
+
+      traces[5]['Layer'].must_equal "actionview"
+      traces[5]['Label'].must_equal "exit"
+
+      traces[6]['Layer'].must_equal "rails"
+      traces[6]['Label'].must_equal "exit"
+
+      traces[7]['Layer'].must_equal "rack"
+      traces[7]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r.header.key?('X-Trace').must_equal true
+      r.header['X-Trace'].must_equal traces[7]['X-Trace']
+    end
   end
 end

data/test/frameworks/rails4x_test.rb

@@ -8,9 +8,14 @@ if defined?(::Rails)
   describe "Rails4x" do
     before do
       clear_all_traces
+      @collect_backtraces = TraceView::Config[:action_controller][:collect_backtraces]
       ENV['DBTYPE'] = "postgresql" unless ENV['DBTYPE']
     end
 
+    after do
+      TraceView::Config[:action_controller][:collect_backtraces] = @collect_backtraces
+    end
+
     it "should trace a request to a rails stack" do
 
       uri = URI.parse('http://127.0.0.1:8140/hello/world')
@@ -286,5 +291,97 @@ if defined?(::Rails)
       # Validate the existence of the response header
       r['X-Trace'].must_equal traces[4]['X-Trace']
     end
+
+    it "should collect backtraces when true" do
+      TraceView::Config[:action_controller][:collect_backtraces] = true
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/world')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 7
+      unless defined?(JRUBY_VERSION)
+        # We don't test this under JRuby because the Java instrumentation
+        # for the DB drivers doesn't use our test reporter hence we won't
+        # see all trace events. :-(  To be improved.
+        valid_edges?(traces).must_equal true
+      end
+      validate_outer_layers(traces, 'rack')
+
+      traces[0]['Layer'].must_equal "rack"
+      traces[0]['Label'].must_equal "entry"
+      traces[0]['URL'].must_equal "/hello/world"
+
+      traces[1]['Layer'].must_equal "rack"
+      traces[1]['Label'].must_equal "info"
+
+      traces[2]['Layer'].must_equal "rails"
+      traces[2]['Label'].must_equal "entry"
+      traces[2]['Controller'].must_equal "HelloController"
+      traces[2]['Action'].must_equal "world"
+      traces[2].key?('Backtrace').must_equal true
+
+      traces[3]['Layer'].must_equal "actionview"
+      traces[3]['Label'].must_equal "entry"
+
+      traces[4]['Layer'].must_equal "actionview"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "rails"
+      traces[5]['Label'].must_equal "exit"
+
+      traces[6]['Layer'].must_equal "rack"
+      traces[6]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[6]['X-Trace']
+    end
+
+    it "should NOT collect backtraces when false" do
+      TraceView::Config[:action_controller][:collect_backtraces] = false
+
+      uri = URI.parse('http://127.0.0.1:8140/hello/world')
+      r = Net::HTTP.get_response(uri)
+
+      traces = get_all_traces
+
+      traces.count.must_equal 7
+      unless defined?(JRUBY_VERSION)
+        # We don't test this under JRuby because the Java instrumentation
+        # for the DB drivers doesn't use our test reporter hence we won't
+        # see all trace events. :-(  To be improved.
+        valid_edges?(traces).must_equal true
+      end
+      validate_outer_layers(traces, 'rack')
+
+      traces[0]['Layer'].must_equal "rack"
+      traces[0]['Label'].must_equal "entry"
+      traces[0]['URL'].must_equal "/hello/world"
+
+      traces[1]['Layer'].must_equal "rack"
+      traces[1]['Label'].must_equal "info"
+
+      traces[2]['Layer'].must_equal "rails"
+      traces[2]['Label'].must_equal "entry"
+      traces[2]['Controller'].must_equal "HelloController"
+      traces[2]['Action'].must_equal "world"
+      traces[2].key?('Backtrace').must_equal false
+
+      traces[3]['Layer'].must_equal "actionview"
+      traces[3]['Label'].must_equal "entry"
+
+      traces[4]['Layer'].must_equal "actionview"
+      traces[4]['Label'].must_equal "exit"
+
+      traces[5]['Layer'].must_equal "rails"
+      traces[5]['Label'].must_equal "exit"
+
+      traces[6]['Layer'].must_equal "rack"
+      traces[6]['Label'].must_equal "exit"
+
+      # Validate the existence of the response header
+      r['X-Trace'].must_equal traces[6]['X-Trace']
+    end
   end
 end