traceview 3.8.1 → 3.8.2

data/Gemfile

@@ -15,13 +15,13 @@ group :development, :test do
 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'
+  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 ]
+    gem 'pry-byebug', :platforms => [:mri_20, :mri_21, :mri_22]
   else
     gem 'pry', '0.9.12.4'
   end
@@ -34,4 +34,3 @@ else
 end
 
 gemspec
-

data/README.md

@@ -8,9 +8,9 @@ It has the ability to report performance metrics on an array of libraries, datab
 
 It requires a [TraceView](http://www.appneta.com/products/traceview/) account to view metrics.  Get yours, [it's free](http://www.appneta.com/products/traceview-free-account/).
 
-[![Gem Version](https://badge.fury.io/rb/traceview.png)](http://badge.fury.io/rb/traceview)
+[![Gem Version](https://badge.fury.io/rb/traceview.png)](https://badge.fury.io/rb/traceview)
 [![Build Status](https://travis-ci.org/appneta/ruby-traceview.png?branch=master)](https://travis-ci.org/appneta/ruby-traceview)
-[![Code Climate](https://codeclimate.com/github/appneta/oboe-ruby.png)](https://codeclimate.com/github/appneta/oboe-ruby)
+[![Code Climate](https://codeclimate.com/github/appneta/ruby-traceview.png)](https://codeclimate.com/github/appneta/ruby-traceview)
 
 _Note: The repository name has been changed to ruby-traceview.  Please update your github remotes with `git remote set-url origin git@github.com:appneta/ruby-traceview.git`._
 
@@ -301,7 +301,7 @@ That is a very quick example of a simple instrumentation implementation.  If you
 
 Some other tips and guidelines:
 
-* You can point your Gemfile directly at your cloned traceview gem source by using `gem 'traceview', :path => '/path/to/oboe-ruby'`
+* You can point your Gemfile directly at your cloned traceview gem source by using `gem 'traceview', :path => '/path/to/ruby-traceview'`
 
 * If instrumenting a library, database or service, place your new instrumentation file into the `lib/traceview/inst/` directory.  From there, the traceview gem will detect it and automatically load the instrumentation file.
 

data/Rakefile

@@ -9,7 +9,7 @@ Rake::TestTask.new do |t|
   t.verbose = false
   t.warning = false
   t.ruby_opts = []
-  t.libs << "test"
+  t.libs << 'test'
 
   # Since we support so many libraries and frameworks, tests
   # runs are segmented into gemfiles that have different
@@ -45,13 +45,13 @@ Rake::TestTask.new do |t|
   end
 
   if defined?(JRUBY_VERSION)
-    t.ruby_opts << ["-J-javaagent:/usr/local/tracelytics/tracelyticsagent.jar"]
+    t.ruby_opts << ['-J-javaagent:/usr/local/tracelytics/tracelyticsagent.jar']
   end
 end
 
 desc "Build the gem's c extension"
 task :compile do
-  unless defined?(JRUBY_VERSION)
+  if !defined?(JRUBY_VERSION)
     puts "== Building the c extension against Ruby #{RUBY_VERSION}"
 
     pwd     = Dir.pwd
@@ -66,64 +66,61 @@ task :compile do
     sh '/usr/bin/env make'
     File.delete symlink if File.exist? symlink
 
-    if File.exists? so_file
+    if File.exist? so_file
       File.symlink so_file, symlink
       Dir.chdir pwd
       puts "== Extension built and symlink'd to #{symlink}"
     else
       Dir.chdir pwd
-      puts "!! Extension failed to build (see above).  Are the base TraceView packages installed?"
-      puts "!! See https://support.appneta.com/cloud/installing-traceview"
+      puts '!! Extension failed to build (see above).  Are the base TraceView packages installed?'
+      puts '!! See https://docs.appneta.com/install-instrumentation'
     end
   else
-    puts "== Nothing to do under JRuby."
+    puts '== Nothing to do under JRuby.'
   end
 end
 
-desc "Clean up extension build files"
+desc 'Clean up extension build files'
 task :clean do
-  unless defined?(JRUBY_VERSION)
+  if !defined?(JRUBY_VERSION)
     pwd     = Dir.pwd
     ext_dir = File.expand_path('ext/oboe_metal')
-    lib_dir = File.expand_path('lib')
     symlink = File.expand_path('lib/oboe_metal.so')
-    so_file = File.expand_path('ext/oboe_metal/oboe_metal.so')
 
+    File.delete symlink if File.exist? symlink
     Dir.chdir ext_dir
     sh '/usr/bin/env make clean'
 
     Dir.chdir pwd
   else
-    puts "== Nothing to do under JRuby."
+    puts '== Nothing to do under JRuby.'
   end
 end
 
-desc "Remove all built files and extensions"
+desc 'Remove all built files and extensions'
 task :distclean do
-  unless defined?(JRUBY_VERSION)
+  if !defined?(JRUBY_VERSION)
     pwd     = Dir.pwd
     ext_dir = File.expand_path('ext/oboe_metal')
-    lib_dir = File.expand_path('lib')
     symlink = File.expand_path('lib/oboe_metal.so')
-    so_file = File.expand_path('ext/oboe_metal/oboe_metal.so')
     mkmf_log = File.expand_path('ext/oboe_metal/mkmf.log')
 
-    if File.exists? mkmf_log
+    if File.exist? mkmf_log
       File.delete symlink if File.exist? symlink
       Dir.chdir ext_dir
       sh '/usr/bin/env make distclean'
 
       Dir.chdir pwd
     else
-      puts "Nothing to distclean. (nothing built yet?)"
+      puts 'Nothing to distclean. (nothing built yet?)'
     end
   else
-    puts "== Nothing to do under JRuby."
+    puts '== Nothing to do under JRuby.'
   end
 end
 
 desc "Rebuild the gem's c extension"
-task :recompile => [ :distclean, :compile ]
+task :recompile => [:distclean, :compile]
 
 task :environment do
   ENV['TRACEVIEW_GEM_VERBOSE'] = 'true'
@@ -146,6 +143,6 @@ task :console => :environment do
 end
 
 # Used when testing Resque locally
-task "resque:setup" => :environment do
+task 'resque:setup' => :environment do
   require 'resque/tasks'
 end

data/examples/DNT.md

@@ -3,7 +3,7 @@ for common static files.  Examples of such files may be images,
 javascript, pdfs and text files.
 
 This is done by using the regular expression stored in
-`Oboe::Config[:dnt_regexp]`:
+`TraceView::Config[:dnt_regexp]`:
 
     .(jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|js|flv|swf|ttf|woff|svg|less)$
 
@@ -14,7 +14,7 @@ To replace the pattern in use, you can update this regular expression
 string.  Here are some examples.
 
 If you prefer that you want your javascript and CSS files instrumented,
-you can update `Oboe::Config[:dnt_regexp]` with an updated regexp
+you can update `TraceView::Config[:dnt_regexp]` with an updated regexp
 pattern (without the "js" and "css" entries):
 
     .(jpg|jpeg|gif|png|ico|zip|tgz|gz|rar|bz2|pdf|txt|tar|wav|bmp|rtf|flv|swf|ttf|woff|svg|less)$
@@ -26,7 +26,7 @@ regexp [negative
 look-behind](http://www.regular-expressions.info/lookaround.html) that
 isn't supported in Ruby 1.8):
 
-    Oboe::Config[:dnt_regexp] = "(\.js$)(?<!show.js)"
+    TraceView::Config[:dnt_regexp] = "(\.js$)(?<!show.js)"
 
 Since this pattern is used with the standard Ruby Regexp class, you can
 use any Regexp supported pattern.  See the documentation on Ruby Regexp

data/examples/carrying_context.rb

@@ -9,23 +9,23 @@
 # in the TraceView dashboard.
 #
 # Tracing context is non-existent until established by calling
-# `Oboe::API.start_trace` or `Oboe::API.log_start`.  Those methods
+# `TraceView::API.start_trace` or `TraceView::API.log_start`.  Those methods
 # are part of the high-level and low-level API respectively.
 #
 # After a tracing context is established, that context can be
-# continued by calling `Oboe::API.trace` or `Oboe::API.log_entry`.
+# continued by calling `TraceView::API.trace` or `TraceView::API.log_entry`.
 # These methods will advance an existing context but not start
 # new one.
 #
 # For example, when a web request comes into a stack, a tracing
-# context is established using `Oboe::API.log_start` as the request
-# enters through the rack middleware via `::Oboe::Rack`.
+# context is established using `TraceView::API.log_start` as the request
+# enters through the rack middleware via `::TraceView::Rack`.
 #
-# That tracing context is then continued using `Oboe::API.trace` or
-# `Oboe::API.log_entry` for each subsequent layer such as Rails,
+# That tracing context is then continued using `TraceView::API.trace` or
+# `TraceView::API.log_entry` for each subsequent layer such as Rails,
 # ActiveRecord, Redis, Memcache, ActionView, Mongo (etc...) until
 # finally request processing is complete and the tracing context
-# is cleared (Oboe::Context.clear)
+# is cleared (TraceView::Context.clear)
 #
 
 ###############################################################
@@ -33,9 +33,9 @@
 ###############################################################
 #
 # The tracing context exists in the form of an X-Trace string and
-# can be retrieved using 'Oboe::Context.toString'
+# can be retrieved using 'TraceView::Context.toString'
 #
-# xtrace = Oboe::Context.toString
+# xtrace = TraceView::Context.toString
 #
 # => "1B4EDAB9E028CA3C81BCD57CC4644B4C4AE239C7B713F0BCB9FAD6D562"
 #
@@ -44,7 +44,7 @@
 #
 # xtrace = "1B4EDAB9E028CA3C81BCD57CC4644B4C4AE239C7B713F0BCB9FAD6D562"
 #
-# Oboe::Context.fromString(xtrace)
+# TraceView::Context.fromString(xtrace)
 #
 # With these two methods, context can be passed across threads,
 # processes (via fork) and in requests (such as external HTTP
@@ -81,25 +81,23 @@
 # Thread - with separated traces
 ###############################################################
 
-Oboe::API.log_start('parent')
+TraceView::API.log_start('parent')
 
 # Get the work to be done
 job = get_work
 
 Thread.new do
   # This is a new thread so there is no pre-existing context so
-  # we'll call `Oboe::API.log_start` to start a new trace context.
-  Oboe::API.log_start('worker_thread', { :job_id => job.id })
+  # we'll call `TraceView::API.log_start` to start a new trace context.
+  TraceView::API.log_start('worker_thread', :job_id => job.id)
 
   # Do the work
   do_the_work(job)
 
-  Oboe::API.log_end('worker_thread')
+  TraceView::API.log_end('worker_thread')
 end
 
-Oboe::API.log_end('parent')
-
-
+TraceView::API.log_end('parent')
 
 ###############################################################
 #
@@ -122,27 +120,27 @@ Oboe::API.log_end('parent')
 # trace generated in that thread to be asynchronous using
 # the `Async` flag.
 
-Oboe::API.log_start('parent')
+TraceView::API.log_start('parent')
 
 # Save the context to be imported in spawned thread
-tracing_context = Oboe::Context.toString
+tracing_context = TraceView::Context.toString
 
 # Get the work to be done
 job = get_work
 
 Thread.new do
   # Restore context
-  Oboe::Context.fromString(tracing_context)
+  TraceView::Context.fromString(tracing_context)
 
-  Oboe::API.log_entry('worker_thread')
+  TraceView::API.log_entry('worker_thread')
 
   # Do the work
   do_the_work(job)
 
-  Oboe::API.log_exit('worker_thread', { 'Async' => 1 })
+  TraceView::API.log_exit('worker_thread', :Async => 1)
 end
 
-Oboe::API.log_end('parent')
+TraceView::API.log_end('parent')
 
 ###############################################################
 #
@@ -161,8 +159,7 @@ Oboe::API.log_end('parent')
 # Process via fork - with separated traces
 ###############################################################
 
-Oboe::API.start_trace('parent_process') do
-
+TraceView::API.start_trace('parent_process') do
   # Get some work to process
   job = get_job
 
@@ -170,9 +167,9 @@ Oboe::API.start_trace('parent_process') do
   fork do
     # Since fork does a complete process copy, the tracing_context still exists
     # so we have to clear it and start again.
-    Oboe::Context.clear
+    TraceView::Context.clear
 
-    Oboe::API.start_trace('worker_process', nil, { :job_id => job.id }) do
+    TraceView::API.start_trace('worker_process', nil, :job_id => job.id) do
       do_work(job)
     end
   end
@@ -193,8 +190,7 @@ end
 # Process via fork - with linked asynchronous traces
 ###############################################################
 
-Oboe::API.start_trace('parent_process') do
-
+TraceView::API.start_trace('parent_process') do
   # Get some work to process
   job = get_job
 
@@ -204,11 +200,10 @@ Oboe::API.start_trace('parent_process') do
     # although we'll have to mark these traces as asynchronous to denote
     # that it has split off from the main program flow
 
-    Oboe::API.trace('worker_process', { 'Async' => 1 }) do
+    TraceView::API.trace('worker_process', :Async => 1) do
       do_work(job)
     end
   end
-
 end
 
 ###############################################################

data/examples/instrumenting_metal_controller.rb

@@ -3,6 +3,6 @@ class MetalController < ActionController::Metal
     self.response_body = 'Hello Metal!'
   end
 
-  include OboeMethodProfiling
+  include TraceViewMethodProfiling
   profile_method :index, 'metal-index'
 end

data/examples/puma_on_heroku_config.rb

@@ -9,9 +9,9 @@ port        ENV['PORT']     || 3000
 environment ENV['RACK_ENV'] || 'development'
 
 on_worker_boot do
-  ::Oboe.reconnect! if defined?(::Oboe)
+  ::TraceView.reconnect! if defined?(::TraceView)
 end
 
 on_worker_shutdown do
-  ::Oboe.disconnect! if defined?(::Oboe)
-end
+  ::TraceView.disconnect! if defined?(::TraceView)
+end

data/examples/tracing_async_threads.rb

@@ -6,35 +6,34 @@
 require 'math'
 require 'oboe'
 
-Oboe::Config[:tracing_mode] = :always
-Oboe::Config[:verbose] = true
+TraceView::Config[:tracing_mode] = :always
+TraceView::Config[:verbose] = true
 
 # The parent process/loop which collects data
-while true do
+Kernel.loop do
 
   # For each loop, we instrument the work retrieval.  These traces
   # will show up as layer 'get_the_work'.
-  Oboe::API.start_trace('get_the_work') do
-
+  TraceView::API.start_trace('get_the_work') do
     work = get_the_work
 
     # Loop through work and pass to `do_the_work` method
     # that spawns a thread each time
     work.each do |j|
 
-      # In the new Thread block, the Oboe tracing context isn't there
+      # In the new Thread block, the TraceView tracing context isn't there
       # so we carry it over manually and pass it to the `start_trace`
       # method.
 
       # In the TraceView dashboard, this will show up as parent traces
       # (layer 'get_the_work') with child traces (layer 'do_the_work').
 
-      tracing_context = Oboe::Context.toString
+      tracing_context = TraceView::Context.toString
 
       Thread.new do
         result = nil
 
-        Oboe::API.start_trace('do_the_work', tracing_context, { 'Async' => 1 }) do
+        TraceView::API.start_trace('do_the_work', tracing_context, :Async => 1) do
           result = do_the_work(j)
         end
 
@@ -42,6 +41,7 @@ while true do
       end
     end
   end
+  sleep 5
 end
 
 
@@ -112,7 +112,7 @@ end
 #      Thread.new do
 #        result = nil
 #
-#        Oboe::API.start_trace('do_the_work') do
+#        TraceView::API.start_trace('do_the_work') do
 #          result = do_the_work(j)
 #        end
 #

data/examples/tracing_background_jobs.rb

@@ -8,7 +8,7 @@ Bundler.require
 require 'oboe'
 
 # Tracing mode can be 'never', 'through' (to follow upstream) or 'always'
-Oboe::Config[:tracing_mode] = 'always'
+TraceView::Config[:tracing_mode] = 'always'
 
 #
 # Update April 9, 2015 - this is done automagically now
@@ -16,14 +16,14 @@ Oboe::Config[:tracing_mode] = 'always'
 #
 # Load library instrumentation to auto-capture stuff we know about...
 # e.g. ActiveRecord, Cassandra, Dalli, Redis, memcache, mongo
-# Oboe::Ruby.load
+# TraceView::Ruby.load
 
 # Some KVs to report to the dashboard
 report_kvs = {}
 report_kvs[:command_line_params] = ARGV.to_s
 report_kvs[:user_id] = `whoami`
 
-Oboe::API.start_trace('my_background_job', nil, report_kvs ) do
+TraceView::API.start_trace('my_background_job', nil, report_kvs) do
   #
   # Initialization code
   #
@@ -35,7 +35,7 @@ Oboe::API.start_trace('my_background_job', nil, report_kvs ) do
     # work for each task.  In the TV dashboard, this will show
     # up as a large 'my_background_job' parent layer with many
     # child 'task" layers.
-    Oboe::API.trace('task', { :task_id => t.id }) do
+    TraceView::API.trace('task', :task_id => t.id) do
       t.perform
     end
   end
@@ -47,6 +47,4 @@ end
 # Note that we use 'start_trace' in the outer block and 'trace' for
 # any sub-blocks of code we wish to instrument.  The arguments for
 # both methods vary slightly.  Details in RubyDoc:
-# https://www.omniref.com/ruby/gems/oboe/2.7.10.1/symbols/Oboe::API::Tracing#tab=Methods
-
-
+# https://www.omniref.com/ruby/gems/oboe/2.7.10.1/symbols/TraceView::API::Tracing#tab=Methods