oboe-heroku 0.9.16.1 → 0.9.17.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc6c39cb8e4cc43a47e7efbe89d3a8094f32640e
-  data.tar.gz: d1d5f2fe48c8143d07055e9616c030553b7dae3c
+  metadata.gz: 44fb09878a1844337597bbd10291f887293e3558
+  data.tar.gz: 8a251a5e9e3c1c52396726c9671ab2c5ad3fc1fd
 SHA512:
-  metadata.gz: df68a3e633f1464ff52e27815857dd6200282c4a805a4704bab14231218ea949c051d77f952d88e13eace53e0fe03cf5f3c3d078b173abaf89f80b49ab4afa36
-  data.tar.gz: 42322e7bf47284592a572761f7a8ffef1af8bd3147e07e93c0b1ec97571b7930c418569821f0460cf48d2869647630976a2708db1abd7d5c6df3cfcf77531c91
+  metadata.gz: 1f4752f07ae1be38a7283fd77e37c573d89745422b561cc18aead3dad60f1d4d0dd46529bf5ee96ee48995265e8e292ca1184ad1f2516e34b5c1600024361d94
+  data.tar.gz: 5d38de87fdcf816d9f1bff92fb63beb29c05d7e69ed9ba4c5b6a87e11326aa7ebf459ad0e8689987e4f960dbc1c7bc0498fbc21c85ed1521cb7d04908ba0ffb0

data/HEROKU_README.md

@@ -0,0 +1,262 @@
+<!---
+The origin for this document is: https://github.com/tracelytics/oboe-ruby-heroku/blob/master/HEROKU_README.md
+-->
+![Ruby TraceView](https://s3.amazonaws.com/pglombardo/oboe-ruby-header.png)
+
+[TraceView](http://addons.heroku.com/traceview) is an
+[add-on](http://addons.heroku.com) for full-stack application
+performance insight.
+
+Adding TraceView to an application provides deep performance monitoring.
+
+* Understand application architecture, and issues’ root cause, in a
+  single glance.
+* Isolate interesting calls and drill down to line of code and dyno it
+  ran on.
+* Drill down on spikes in latency, even if the cause is only a single
+  outlying request.
+
+TraceView is integrated tightly with Heroku for easy access via your
+Heroku account and supports Ruby-based applications on Heroku.
+(Elsewhere, we also support Java, PHP, and Python.)
+
+__Note: Our addon currently has an issue on the Heroku `cedar-14` stack where no performance metrics are generated.  Users on the Heroku `cedar` stack are unaffected.  We're working on this issue and plan to have a fix out soon.  If you have any questions, please open a support ticket or contact us directly at traceviewsupport@appneta.com.__
+
+## Provisioning the add-on
+
+TraceView can be added to your application via the [add-on marketplace](https://addons.heroku.com/traceview), or via the CLI.
+
+### CLI
+TraceView can be added to a Heroku application via the CLI:
+
+A list of all plans available can be found
+[here](http://addons.heroku.com/traceview).
+
+    $ heroku addons:add traceview:beaker
+    -----> Adding traceview to sharp-mountain-4005... done, v18 (free)
+
+After adding TraceView add-on to the application, it should be
+configured to fully integrate with the add-on.
+
+## Using with Rails 2.3 - 4.x
+
+Ruby on Rails applications will need to add the following entry into
+their `Gemfile` specifying the TraceView instrumentation gem.
+
+    gem 'oboe-heroku'
+
+Update application dependencies with bundler.
+
+    $ bundle install
+    $ git commit -am "Update Gemfile for Appneta's TraceView addon."
+    $ git push heroku master
+
+And that's it!
+
+_Note: If you're running a forking webserver such as Unicorn, remember
+that there is an [extra step](#forking-webservers)!_
+
+## Using with Sinatra
+
+You can instrument your Sinatra application by adding the
+following code to your `config.ru` Rackup file:
+
+```ruby
+# If you're not using Bundler.require.  Make sure this
+# is done after the Sinatra require directive.
+require 'oboe-heroku'
+
+# You may want to replace the Oboe.logger with whichever
+# logger you are using
+# Oboe.logger = Sinatra.logger
+```
+
+Make sure that the oboe gem is loaded _after_ Sinatra either by listing
+`gem 'oboe-heroku'` after Sinatra in your Gemfile or calling the
+`require 'oboe-heroku'` directive after Sinatra is loaded.
+
+With this, the oboe-heroku gem will automatically detect Sinatra on boot
+and instrument key components.
+
+_Note: If you're running a forking webserver such as Unicorn, remember
+that there is an [extra step](#forking-webservers)!_
+
+## Using with Padrino
+
+As long as the oboe-heroku gem is in your `Gemfile` (inserted after the
+`gem 'padrino'` directive) and you are calling `Bundler.require`, the
+oboe-heroku gem will automatically instrument Padrino applications.
+
+If you need to set `Oboe::Config` values on stack boot, you can do so by
+adding the following to your `config/boot.rb` file:
+
+```ruby
+Padrino.before_load do
+  # The oboe Ruby client has the ability to sanitize
+  # query literals from SQL statements.  By default
+  # this is disabled.  Enable to avoid collecting and
+  # reporting query literals to TraceView.
+  # Oboe::Config[:sanitize_sql] = true
+
+  # Verbose output
+  Oboe::Config[:verbose] = true
+end
+```
+_Note: If you're running a forking webserver such as Unicorn, remember
+that there is an [extra step](#forking-webservers)!_
+
+## Need to profile a custom bit of code?
+
+The TraceView Ruby instrumentation offers the ability to profile any
+arbitrary block of code using the following code pattern:
+
+```ruby
+# A layer name that will identify this performance
+# data in the TraceView dashboard
+layer = "code_block_1"
+
+# You can report any related data by populating
+# a hash with key-value pairs
+report_kvs = { :id => @id }
+
+Oboe::API.trace(layer, nil, report_kvs) do
+  x = "This is a string"
+  y = x.reverse
+  z = y.reverse
+  puts z
+end
+```
+
+More details can be found
+[here](https://github.com/appneta/oboe-ruby#custom-tracing).
+
+## Accessing the TraceView Dashboard
+
+TraceView collects performance information about your application, then
+makes it available in real-time.  To see the data, you can head to your
+[Heroku app manager](http://heroku.com/myapps), or use the CLI.
+
+### Heroku app manager
+
+Simply visit the [Heroku apps web interface](http://heroku.com/myapps)
+and selecting the application in question. Select TraceView from the
+Add-ons menu.
+
+### CLI
+
+To open TraceView from your Heroku CLI tools:
+
+    $ heroku addons:open traceview
+    Opening traceview for sharp-mountain-4005...
+
+## Forking Webservers 
+
+### Unicorn
+
+If you are using the TraceView add-on with Unicorn, you should add the
+`preload_app true` directive in your Unicorn configuration file or
+TraceView may not be able to fully initialize and instrument your
+application.
+
+You should also add in before and after hooks so that TraceView can
+instrument properly after a fork operation.  This involves simply
+calling `::Oboe.disconnect!` and `::Oboe.reconnect!` in the
+`before_fork` and `after_fork` hooks respectively.
+
+An example Unicorn configuration file can be found in this Github
+[gist](https://gist.github.com/pglombardo/5884933).
+
+## Deploy Hooks
+
+To help understand the correlation between system events and performance
+trends, TraceView provides the ability to log arbitrary events to your
+TraceView dashboard.  You can use Heroku’s [Deploy Hooks add-on](https://addons.heroku.com/deployhooks) to automatically log
+deployment annotations in TraceView every time you push new code to
+Heroku.
+
+See [this post](http://www.appneta.com/blog/heroku-deployment-hook/) for
+details on how to quickly add this functionality to your
+Heroku/TraceView application.
+
+## Troubleshooting
+
+Having trouble getting set up with TraceView?  Not seeing something you
+expected, or seeing something you didn't?  Here's three ways to get
+help:
+
+* The TraceView [Knowledge Base](http://support.tv.appneta.com) has
+  documentation covering the [Ruby instrumentation and common
+questions](https://support.tv.appneta.com/support/solutions/articles/86393-installing-ruby-instrumentation-for-ruby-rails-sinatra-or).
+* You can reach our support engineers via email or IRC:
+  [traceviewsupport@appneta.com](mailto:traceviewsupport@appneta.com) or
+on Freenode at #appneta .
+* TraceView Ruby instrumentation is open-source!  Contact us on
+  [Github](https://github.com/appneta/oboe-ruby), browse the code, view
+commit history and/or file an issue in our [oboe-ruby repository](https://github.com/appneta/oboe-ruby/issues).
+
+To double-check that the add-on is installed, you can run the `heroku
+addons` CLI command for your application:
+
+```sh
+$ heroku addons
+=== pwpush Configured Add-ons
+traceview:einstein
+```
+
+## Selecting the right TraceView plan
+
+![Solvay Conference
+1927](https://s3.amazonaws.com/pglombardo/salvay-conference-1927.png)
+
+TraceView plans are based on the number of dynos being monitored.  The
+plans start with the free Beaker plan (up to 3 dynos), which is
+full-featured except for limited data retention (1 hour) and no
+alerting.  The other plans, named for scientists more famous (or at
+least more professional) than
+[Beaker](http://en.wikipedia.org/wiki/Beaker_\(Muppet\)) are
+full-featured with 45 days of data retention and alerting.
+
+The plans are priced based on the number of dynos your application uses.
+We provide a number of tiers of service, each covering up to a certain
+number of dynos.  You can match up the number of dynos your application
+uses to find the appropriate plan tier.
+
+**If you're autoscaling, or wish to monitor a large number of dynos,
+please [contact us](mailto:traceview@appneta.com) - we have plans for
+that.**
+
+Full plan descriptions are available on the [add-on page](http://addons.heroku.com/traceview).
+
+Section [image source](https://en.wikipedia.org/wiki/File:Solvay_conference_1927.jpg).
+
+### Migrating plans
+
+As you adjust the number of dynos your application uses, you may wish to
+upgrade or downgrade your TraceView plan.
+
+Use the `heroku addons:upgrade` command to migrate to a new plan.
+
+    $ heroku addons:upgrade traceview:feynman
+    -----> Upgrading traceview:feynman to sharp-mountain-4005... done, v18 ($49/mo)
+           Your plan has been updated to: traceview:enterprise
+
+## Removing the add-on
+
+TraceView can be removed via the  CLI.
+
+    $ heroku addons:remove traceview
+    -----> Removing traceview from sharp-mountain-4005... done, v20 (free)
+
+**Your TraceView data will only be available for a short time after
+add-on removal.  Re-adding the add-on will re-enable access.**
+
+Before removing TraceView you can export collected performance data
+using the [Data API](http://dev.appneta.com/docs/api-v2/).
+
+## Support
+
+Any support issues or product feedback?  Reach out via email or IRC:
+[traceviewsupport@appneta.com](mailto:traceviewsupport@appneta.com) or
+on Freenode at #appneta .  Documentation is available at [TraceView Support](http://support.tv.appneta.com/) 
+and in the [Github repository](https://github.com/appneta/oboe-ruby).
+

data/lib/oboe-heroku.rb

@@ -1,13 +1,16 @@
 # Copyright (c) 2013 by Tracelytics, Inc.
 # All rights reserved.
 
+module OboeHeroku; end
+
 begin
+  require "oboe-heroku/thread_local"
+  require 'oboe-heroku/base'
+
   # TRACEVIEW_URL env var is standard with the Heroku addon.  We
   # use it to determine if we are actually running in Heroku or not.
-  if ENV.has_key?('TRACEVIEW_URL') and ENV['RAILS_GROUP'] != 'assets'
+  if ENV.key?('TRACEVIEW_URL')
 
-    require "oboe-heroku/thread_local"
-    require 'oboe-heroku/base'
     require 'oboe_metal.so'
     require 'heroku_metal'
 
@@ -20,15 +23,15 @@ begin
     ::OboeHeroku::Loading.configure if Oboe.loaded
   end
 rescue LoadError => e
-  Oboe.loaded = false
   $stderr.puts "[oboe-heroku/error] Failed to load support libs: #{e.message}"
+  Oboe.loaded = false
 
   if ENV.has_key?('TRACEVIEW_DEBUG_LEVEL') and (ENV['TRACEVIEW_DEBUG_LEVEL'].to_i > 1)
     $stderr.puts e.backtrace.join("\n")
   end
 rescue Exception => e
-  Oboe.loaded = false
   $stderr.puts "[oboe-heroku/error] #{e.message}"
+  Oboe.loaded = false
 
   if ENV.has_key?('TRACEVIEW_DEBUG_LEVEL') and (ENV['TRACEVIEW_DEBUG_LEVEL'].to_i > 1)
     $stderr.puts e.backtrace.join("\n")

data/lib/oboe-heroku/base.rb

@@ -30,16 +30,84 @@ module OboeBase
   extend ::Oboe::ThreadLocal
 
   attr_accessor :reporter
-  attr_accessor :collector
   attr_accessor :loaded
-  thread_local  :sample_source
-  thread_local  :sample_rate
-  thread_local  :layer_op
+  attr_accessor :sample_source
+  attr_accessor :sample_rate
+  thread_local :layer_op
 
-  def self.included(_)
-    self.loaded = true
+  # The following accessors indicate the incoming tracing state received
+  # by the rack layer.  These are primarily used to identify state
+  # between the Ruby and JOboe instrumentation under JRuby.
+  #
+  # This is because that even though there may be an incoming
+  # X-Trace request header, tracing may have already been started
+  # by Joboe.  Such a scenario occurs when the application is being
+  # hosted by a Java container (such as Tomcat or Glassfish) and
+  # JOboe has already initiated tracing.  In this case, we shouldn't
+  # pickup the X-Trace context in the X-Trace header and we shouldn't
+  # set the outgoing response X-Trace header or clear context.
+  # Yeah I know.  Yuck.
+
+  # Occurs only on Jruby.  Indicates that Joboe (the java instrumentation)
+  # has already started tracing before it hit the JRuby instrumentation.
+  thread_local :has_incoming_context
+
+  # Indicates the existence of a valid X-Trace request header
+  thread_local :has_xtrace_header
+
+  # This indicates that this trace was continued from
+  # an incoming X-Trace request header or in the case
+  # of JRuby, a trace already started by JOboe.
+  thread_local :is_continued_trace
+
+  ##
+  # extended
+  #
+  # Invoked when this module is extended.
+  # e.g. extend OboeBase
+  #
+  def self.extended(cls)
+    cls.loaded = true
+
+    # This gives us pretty accessors with questions marks at the end
+    # e.g. is_continued_trace --> is_continued_trace?
+    Oboe.methods.select{ |m| m =~ /^is_|^has_/ }.each do |c|
+      unless c =~ /\?$|=$/
+        # Oboe.logger.debug "aliasing #{c}? to #{c}"
+        alias_method "#{c}?", c
+      end
+    end
   end
 
+  ##
+  # pickup_context
+  #
+  # Determines whether we should pickup context
+  # from an incoming X-Trace request header.  The answer
+  # is generally yes but there are cases in JRuby under
+  # Tomcat (or Glassfish etc.) where tracing may have
+  # been already started by the Java instrumentation (Joboe)
+  # in which case we don't want to do this.
+  #
+  def pickup_context?(xtrace)
+    return false unless Oboe::XTrace.valid?(xtrace)
+
+    if defined?(JRUBY_VERSION) && Oboe.tracing?
+      return false
+    else
+      return true
+    end
+  end
+
+  ##
+  # tracing_layer_op?
+  #
+  # Queries the thread local variable about the current
+  # operation being traced.  This is used in cases of recursive
+  # operation tracing or one instrumented operation calling another.
+  #
+  # In such cases, we only want to trace the outermost operation.
+  #
   def tracing_layer_op?(operation)
     if operation.is_a?(Array)
       return operation.include?(Oboe.layer_op)
@@ -96,7 +164,7 @@ module OboeBase
   end
 
   def heroku?
-    ENV['TRACEVIEW_URL']
+    ENV.key?('TRACEVIEW_URL')
   end
 
   ##
@@ -138,3 +206,4 @@ end
 module Oboe
   extend OboeBase
 end
+

data/lib/oboe-heroku/loading.rb

@@ -5,9 +5,9 @@ module OboeHeroku
       # OBOE_TRACE_NEVER   0
       # OBOE_TRACE_ALWAYS  1
       # OBOE_TRACE_THROUGH 2
-      
+
       if defined?(Oboe::Config)
-        
+
         case Oboe::Config[:tracing_mode].to_s.downcase.to_sym
         when :never
           # OBOE_TRACE_NEVER

data/lib/oboe-heroku/version.rb

@@ -2,8 +2,8 @@ module OboeHeroku
   module Version
     MAJOR = 0
     MINOR = 9
-    PATCH = 16
-    BUILD = 1
+    PATCH = 17
+    BUILD = 3
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
   end

data/oboe-heroku.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
 
   s.extensions = ['ext/oboe_metal/extconf.rb']
 
-  s.add_dependency(%q<oboe>, [">= 2.7.2.2"])
+  s.add_dependency(%q<oboe>, [">= 2.7.6.2"])
 
   s.add_development_dependency 'rake', '>= 0'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oboe-heroku
 version: !ruby/object:Gem::Version
-  version: 0.9.16.1
+  version: 0.9.17.3
 platform: ruby
 authors:
 - Peter Giacomo Lombardo
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-26 00:00:00.000000000 Z
+date: 2014-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oboe
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.2.2
+        version: 2.7.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.7.2.2
+        version: 2.7.6.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -51,6 +51,7 @@ files:
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
+- HEROKU_README.md
 - LICENSE
 - README.md
 - Rakefile
@@ -110,4 +111,3 @@ signing_key:
 specification_version: 4
 summary: AppNeta TraceView performance instrumentation gem for the Heroku platform
 test_files: []
-has_rdoc: