oboe 2.1.1 → 2.1.3

data/LICENSE

@@ -1,4 +1,199 @@
-Copyright (c) 2012 Tracelytics, Inc.  All Rights Reserved.  The
-software made available to you by Tracelytics, Inc. and/or through
-your use of tracelytics.com is licensed pursuant to the Terms of
-Service: http://www.tracelytics.com/terms-of-service/
+AppNeta Open License, Version 1.0
+
+AppNeta Open License
+Version 1.0, April, 2013
+
+http://www.appneta.com/appneta-license
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and 
+distribution as defined by Sections 1 through 11 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright 
+owner that is granting the License.  Licensor can include AppNeta as an 
+original contributor to the Work as defined below.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities 
+that control, are controlled by, or are under common control with that entity. 
+For the purposes of this definition, "control" means (i) the power, direct or 
+indirect, to cause the direction or management of such entity, whether by 
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the 
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising 
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including 
+but not limited to software source code, documentation source, and 
+configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or 
+translation of a Source form, including but not limited to compiled object 
+code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, 
+made available under the License, as indicated by a copyright notice that is 
+included in or attached to the work (an example is provided in the Appendix 
+below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that 
+is based on (or derived from) the Work and for which the editorial revisions, 
+annotations, elaborations, or other modifications represent, as a whole, an 
+original work of authorship. For the purposes of this License, Derivative Works 
+shall not include works that remain separable from, or merely link (or bind by 
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original 
+version of the Work and any modifications or additions to that Work or 
+Derivative Works thereof, that is intentionally submitted to Licensor for 
+inclusion in the Work by the copyright owner or by an individual or Legal 
+Entity authorized to submit on behalf of the copyright owner. For the purposes 
+of this definition, "submitted" means any form of electronic, verbal, or 
+written communication sent to the Licensor or its representatives, including 
+but not limited to communication on electronic mailing lists, source code 
+control systems, and issue tracking systems that are managed by, or on behalf 
+of, the Licensor for the purpose of discussing and improving the Work, but 
+excluding communication that is conspicuously marked or otherwise designated in 
+writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf 
+of whom a Contribution has been received by Licensor and subsequently 
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby 
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 
+irrevocable copyright license to reproduce, prepare Derivative Works of, 
+publicly display, publicly perform, sublicense, and distribute the Work and 
+such Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby 
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 
+irrevocable (except as stated in this section) patent license to make, have 
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where 
+such license applies only to those patent claims licensable by such Contributor 
+that are necessarily infringed by their Contribution(s) alone or by combination 
+of their Contribution(s) with the Work to which such Contribution(s) was 
+submitted. If You institute patent litigation against any entity (including a 
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a 
+Contribution incorporated within the Work constitutes direct or contributory 
+patent infringement, then any patent licenses granted to You under this License 
+for that Work shall terminate as of the date such litigation is filed.
+
+Each time You convey a covered Work, the recipient automatically receives a 
+license from the original Licensor(s), to run, modify and propagate that work, 
+subject to this License. You are not responsible for enforcing compliance by 
+third parties with this License.
+
+You may not impose any further restrictions on the exercise of the rights 
+granted or affirmed under this License. For example, you may not impose a 
+license fee, royalty, or other charge for exercise of rights granted under this 
+License, and you may not initiate litigation (including a cross-claim or 
+counterclaim in a lawsuit) alleging that any patent claim is infringed by 
+making, using, selling, offering for sale, or importing the Work or any portion 
+of it.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof 
+in any medium, with or without modifications, and in Source or Object form, 
+provided that You meet the following conditions:
+
+  1. You must give any other recipients of the Work or Derivative Works a copy 
+of this License; and
+  2. You must cause any modified files to carry prominent notices stating that 
+You changed the files; and
+  3. You must retain, in the Source form of any Derivative Works that You 
+distribute, all copyright, patent, trademark, and attribution notices from the 
+Source form of the Work, excluding those notices that do not pertain to any 
+part of the Derivative Works; and
+  4. If the Work includes a "NOTICE" text file as part of its distribution, 
+then any Derivative Works that You distribute must include a readable copy of 
+the attribution notices contained within such NOTICE file, excluding those 
+notices that do not pertain to any part of the Derivative Works, in at least 
+one of the following places: within a NOTICE text file distributed as part of 
+the Derivative Works; within the Source form or documentation, if provided 
+along with the Derivative Works; or, within a display generated by the 
+Derivative Works, if and wherever such third-party notices normally appear. The 
+contents of the NOTICE file are for informational purposes only and do not 
+modify the License. You may add Your own attribution notices within Derivative 
+Works that You distribute, alongside or as an addendum to the NOTICE text from 
+the Work, provided that such additional attribution notices cannot be construed 
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide 
+additional or different license terms and conditions for use, reproduction, or 
+distribution of Your modifications, or for any such Derivative Works as a 
+whole, provided Your use, reproduction, and distribution of the Work otherwise 
+complies with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted 
+for inclusion in the Work by You to the Licensor shall be under the terms and 
+conditions of this License, without any additional terms or conditions. 
+Notwithstanding the above, nothing herein shall supersede or modify the terms 
+of any separate license agreement you may have executed with Licensor regarding 
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks, 
+service marks, or product names of the Licensor, except as required for 
+reasonable and customary use in describing the origin of the Work and 
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides 
+the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, 
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, 
+including, without limitation, any warranties or conditions of TITLE, 
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are 
+solely responsible for determining the appropriateness of using or 
+redistributing the Work and assume any risks associated with Your exercise of 
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence), 
+contract, or otherwise, unless required by applicable law (such as deliberate 
+and grossly negligent acts) or agreed to in writing, shall any Contributor be 
+liable to You for damages, including any direct, indirect, special, incidental, 
+or consequential damages of any character arising as a result of this License 
+or out of the use or inability to use the Work (including but not limited to 
+damages for loss of goodwill, work stoppage, computer failure or malfunction, 
+or any and all other commercial damages or losses), even if such Contributor 
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to 
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or 
+other liability obligations and/or rights consistent with this License. 
+However, in accepting such obligations, You may act only on Your own behalf and 
+on Your sole responsibility, not on behalf of any other Contributor, and only 
+if You agree to indemnify, defend, and hold each Contributor harmless for any 
+liability incurred by, or claims asserted against, such Contributor by reason 
+of your accepting any such warranty or additional liability.
+
+10. Noncompetition
+
+You may install and execute the Work only in conjunction with the direct use of 
+AppNeta software.  This Work, any file or any derivative thereof shall not be 
+used in conjunction with any product that competes with any AppNeta software.
+
+11. Termination
+
+The License stated above is automatically terminated and revoked if you exceed 
+its scope or violate any of the terms of this License or any related License or 
+notice.
+
+END OF TERMS AND CONDITIONS
+

data/lib/oboe/api/util.rb

@@ -27,6 +27,11 @@ module Oboe
         trim_backtrace(Kernel.caller).join("\r\n")
       end
 
+      # Internal: Trim a backtrace to a manageable size
+      #
+      # backtrace - the backtrace (an array of stack frames/from Kernel.caller)
+      #
+      # Returns a trimmed backtrace
       def trim_backtrace(backtrace)
         return backtrace unless backtrace.is_a?(Array)
 
@@ -39,6 +44,28 @@ module Oboe
         end
         trimmed
       end
+
+      # Internal: Check if a host is blacklisted from tracing
+      #
+      # addr_port - the addr_port from Net::HTTP although this method
+      # can be used from any component in reality
+      #
+      # Returns a boolean on blacklisted state
+      def blacklisted?(addr_port)
+        return false unless Oboe::Config.blacklist
+
+        # Ensure that the blacklist is an array 
+        unless Oboe::Config.blacklist.is_a?(Array)
+          val = Oboe::Config[:blacklist]
+          Oboe::Config[:blacklist] = [ val.to_s ]
+        end
+
+        Oboe::Config.blacklist.each do |h|
+          return true if addr_port.to_s.match(h.to_s)
+        end
+
+        false
+      end
     end
   end
 end

data/lib/oboe/config.rb

@@ -30,6 +30,9 @@ module Oboe
       #                 (Default: false)
       @@config[:resque][:link_workers] = false
 
+      # Setup an empty host blacklist (see: Oboe::API::Util.blacklisted?)
+      @@config[:blacklist] = []
+
       update!(data)
     end
 

data/lib/oboe/inst/http.rb

@@ -5,32 +5,38 @@ require 'net/http'
 
 Net::HTTP.class_eval do
   def request_with_oboe(*args, &block)
-    unless started?
-      return request_without_oboe(*args, &block)
+    unless started? 
+      return request_without_oboe(*args, &block) 
     end
 
-    Oboe::API.trace('net-http') do
-        opts = {}
-        if args.length and args[0]
-          req = args[0]
-
-          opts['IsService'] = 1
-          opts['RemoteProtocol'] = use_ssl? ? 'HTTPS' : 'HTTP'
-          opts['RemoteHost'] = addr_port
-          opts['ServiceArg'] = req.path
-          opts['Method'] = req.method
-        
-          Oboe::API.log('net-http', 'info', opts)
-          req['X-Trace'] = Oboe::Context.toString()
-        end
-
-        resp = request_without_oboe(*args, &block)
+    # Avoid cross host tracing for blacklisted domains
+    blacklisted = Oboe::API.blacklisted?(addr_port)
 
+    Oboe::API.trace('net-http') do
+      opts = {}
+      if args.length and args[0]
+        req = args[0]
+
+        opts['IsService'] = 1
+        opts['RemoteProtocol'] = use_ssl? ? 'HTTPS' : 'HTTP'
+        opts['RemoteHost'] = addr_port
+        opts['ServiceArg'] = req.path
+        opts['Method'] = req.method
+        opts['Blacklisted'] = true if blacklisted
+      
+        Oboe::API.log('net-http', 'info', opts)
+        req['X-Trace'] = Oboe::Context.toString() unless blacklisted
+      end
+
+      resp = request_without_oboe(*args, &block)
+
+      unless blacklisted
         xtrace = resp.get_fields('X-Trace')
-        if xtrace and xtrace.size and Oboe.tracing?
+        if xtrace and xtrace.size and Oboe.tracing? 
           Oboe::Context.fromString(xtrace[0])
         end
-        next resp
+      end
+      next resp
     end
   end
 

data/lib/oboe/loading.rb

@@ -31,22 +31,29 @@ module Oboe
     end
 
     def self.load_access_key
-      unless Oboe::Config.access_key
-        config_file = '/etc/tracelytics.conf'
-        return unless File.exists?(config_file)
-        
-        begin
-          File.open(config_file).each do |line|
-            if line =~ /^tracelyzer.access_key=/ or line =~ /^access_key/
-              bits = line.split(/=/)
-              Oboe::Config[:access_key] = bits[1].strip
-              Oboe::Config[:rum_id] = Oboe::Util::Base64URL.encode(Digest::SHA1.digest("RUM" + Oboe::Config[:access_key]))
-              break
+      begin
+        if ENV.has_key?('TRACEVIEW_CUUID')
+          # Preferably get access key from environment (e.g. Heroku)
+          Oboe::Config[:access_key] = ENV['TRACEVIEW_CUUID']
+          Oboe::Config[:rum_id] = Oboe::Util::Base64URL.encode(Digest::SHA1.digest("RUM" + Oboe::Config[:access_key]))
+        else
+          # ..else read from system-wide configuration file
+          unless Oboe::Config.access_key
+            config_file = '/etc/tracelytics.conf'
+            return unless File.exists?(config_file)
+            
+            File.open(config_file).each do |line|
+              if line =~ /^tracelyzer.access_key=/ or line =~ /^access_key/
+                bits = line.split(/=/)
+                Oboe::Config[:access_key] = bits[1].strip
+                Oboe::Config[:rum_id] = Oboe::Util::Base64URL.encode(Digest::SHA1.digest("RUM" + Oboe::Config[:access_key]))
+                break
+              end
             end
           end
-        rescue
-          Oboe.logger.error "Having trouble parsing #{config_file}..."
         end
+      rescue Exception => e
+        Oboe.logger.error "Trouble obtaining access_key and rum_id: #{e.inspect}"
       end
     end
 

data/lib/oboe/version.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: oboe
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 13
   prerelease: 
   segments: 
   - 2
   - 1
-  - 1
-  version: 2.1.1
+  - 3
+  version: 2.1.3
 platform: ruby
 authors: 
 - Tracelytics, Inc.
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-06-27 00:00:00 Z
+date: 2013-07-11 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake