traceview 3.0.0

data/lib/traceview/method_profiling.rb

@@ -0,0 +1,84 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+##
+# Provides the methods necessary for method profiling.  Profiling
+# results are sent to the TraceView dashboard.
+#
+# Example usage:
+# class MyApp
+#   include TraceViewMethodProfiling
+#
+#   def process_request()
+#     # The hard work
+#   end
+#
+#   # call syntax: profile_method <method>, <profile_name>
+#   profile_method :process_request, 'request_processor'
+# end
+module TraceViewMethodProfiling
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def profile_method(method_name, profile_name, store_args = false, store_return = false, *_)
+      begin
+        # this only gets file and line where profiling is turned on, presumably
+        # right after the function definition. ruby 1.9 and 2.0 has nice introspection (Method.source_location)
+        # but its appears no such luck for ruby 1.8
+        file = ''
+        line = ''
+        if RUBY_VERSION >= '1.9'
+          info = instance_method(method_name).source_location
+          unless info.nil?
+            file = info[0].to_s
+            line = info[1].to_s
+          end
+        else
+          info = Kernel.caller[0].split(':')
+          file = info.first.to_s
+          line = info.last.to_s
+        end
+
+        # Safety:  Make sure there are no quotes or double quotes to break the class_eval
+        file = file.gsub(/[\'\"]/, '')
+        line = line.gsub(/[\'\"]/, '')
+
+        # profiling via ruby-prof, is it possible to get return value of profiled code?
+        code = "def _traceview_profiled_#{method_name}(*args, &block)
+                  entry_kvs                  = {}
+                  entry_kvs['Language']      = 'ruby'
+                  entry_kvs['ProfileName']   = '#{TraceView::Util.prettify(profile_name)}'
+                  entry_kvs['FunctionName']  = '#{TraceView::Util.prettify(method_name)}'
+                  entry_kvs['File']          = '#{file}'
+                  entry_kvs['LineNumber']    = '#{line}'
+                  entry_kvs['Args']          = TraceView::API.pps(*args) if #{store_args}
+                  entry_kvs.merge!(::TraceView::API.get_class_name(self))
+
+                  TraceView::API.log(nil, 'profile_entry', entry_kvs)
+
+                  ret = _traceview_orig_#{method_name}(*args, &block)
+
+                  exit_kvs =  {}
+                  exit_kvs['Language'] = 'ruby'
+                  exit_kvs['ProfileName'] = '#{TraceView::Util.prettify(profile_name)}'
+                  exit_kvs['ReturnValue'] = TraceView::API.pps(ret) if #{store_return}
+
+                  TraceView::API.log(nil, 'profile_exit', exit_kvs)
+                  ret
+                end"
+      rescue => e
+        TraceView.logger.warn "[traceview/warn] profile_method: #{e.inspect}"
+      end
+
+      begin
+        class_eval code, __FILE__, __LINE__
+        alias_method "_traceview_orig_#{method_name}", method_name
+        alias_method method_name, "_traceview_profiled_#{method_name}"
+      rescue => e
+        TraceView.logger.warn "[traceview/warn] Fatal error profiling method (#{method_name}): #{e.inspect}" if TraceView::Config[:verbose]
+      end
+    end
+  end
+end

data/lib/traceview/ruby.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  ##
+  # This module provides a method to manually initialize the
+  # Ruby instrumentation.  Normally this is done by detecting
+  # frameworks at load time and inserting initialization hooks.
+  module Ruby
+    class << self
+      def initialize
+        load
+      end
+
+      ##
+      # The core method to load Ruby instrumentation.  Call this
+      # from raw Ruby scripts or in Ruby applications where a
+      # supported framework isn't being used.  Supported frameworks
+      # will instead be detected at load time and initialization is
+      # automatic.
+      def load
+        # In case some apps call this manually, make sure
+        # that the gem is fully loaded and not in no-op
+        # mode (e.g. on unsupported platforms etc.)
+        if TraceView.loaded
+          TraceView::Loading.load_access_key
+          TraceView::Inst.load_instrumentation
+        end
+      end
+    end
+  end
+end
+
+if TraceView.loaded and !TraceView.framework?
+  ::TraceView::Ruby.load
+end

data/lib/traceview/support.rb

@@ -0,0 +1,113 @@
+# Copyright (c) 2014 AppNeta, Inc.
+# All rights reserved.
+
+require 'rbconfig'
+
+module TraceView
+  ##
+  # This module is used to debug problematic setups and/or environments.
+  # Depending on the environment, output may be to stdout or the framework
+  # log file (e.g. log/production.log)
+
+  ##
+  # yesno
+  #
+  # Utility method to translate value/nil to "yes"/"no" strings
+  def self.yesno(x)
+    x ? "yes" : "no"
+  end
+
+  def self.support_report
+    TraceView.logger.warn "********************************************************"
+    TraceView.logger.warn "* BEGIN TraceView Support Report"
+    TraceView.logger.warn "*   Please email the output of this report to traceviewsupport@appneta.com"
+    TraceView.logger.warn "********************************************************"
+    TraceView.logger.warn "Ruby: #{RUBY_DESCRIPTION}"
+    TraceView.logger.warn "$0: #{$0}"
+    TraceView.logger.warn "$1: #{$1}" unless $1.nil?
+    TraceView.logger.warn "$2: #{$2}" unless $2.nil?
+    TraceView.logger.warn "$3: #{$3}" unless $3.nil?
+    TraceView.logger.warn "$4: #{$4}" unless $4.nil?
+    TraceView.logger.warn "TraceView.loaded == #{TraceView.loaded}"
+
+    using_jruby = defined?(JRUBY_VERSION)
+    TraceView.logger.warn "Using JRuby?: #{yesno(using_jruby)}"
+    if using_jruby
+      TraceView.logger.warn "Jtraceview Agent Status: #{Java::ComTracelyticsAgent::Agent.getStatus}"
+    end
+
+    on_heroku = TraceView.heroku?
+    TraceView.logger.warn "On Heroku?: #{yesno(on_heroku)}"
+    if on_heroku
+      TraceView.logger.warn "TRACEVIEW_URL: #{ENV['TRACEVIEW_URL']}"
+    end
+
+    TraceView.logger.warn "TraceView::Ruby defined?: #{yesno(defined?(TraceView::Ruby))}"
+    TraceView.logger.warn "TraceView.reporter: #{TraceView.reporter}"
+
+    TraceView.logger.warn "********************************************************"
+    TraceView.logger.warn "* Frameworks"
+    TraceView.logger.warn "********************************************************"
+
+    using_rails = defined?(::Rails)
+    TraceView.logger.warn "Using Rails?: #{yesno(using_rails)}"
+    if using_rails
+      TraceView.logger.warn "TraceView::Rails loaded?: #{yesno(defined?(::TraceView::Rails))}"
+    end
+
+    using_sinatra = defined?(::Sinatra)
+    TraceView.logger.warn "Using Sinatra?: #{yesno(using_sinatra)}"
+
+    using_padrino = defined?(::Padrino)
+    TraceView.logger.warn "Using Padrino?: #{yesno(using_padrino)}"
+
+    using_grape = defined?(::Grape)
+    TraceView.logger.warn "Using Grape?: #{yesno(using_grape)}"
+
+    TraceView.logger.warn "********************************************************"
+    TraceView.logger.warn "* TraceView Libraries"
+    TraceView.logger.warn "********************************************************"
+    files = Dir.glob('/usr/lib/liboboe*')
+    if files.empty?
+      TraceView.logger.warn "Error: No liboboe libs!"
+    else
+      files.each { |f|
+        TraceView.logger.warn f
+      }
+    end
+
+    TraceView.logger.warn "********************************************************"
+    TraceView.logger.warn "* TraceView::Config Values"
+    TraceView.logger.warn "********************************************************"
+    TraceView::Config.show.each { |k,v|
+      TraceView.logger.warn "#{k}: #{v}"
+    }
+
+    TraceView.logger.warn "********************************************************"
+    TraceView.logger.warn "* OS, Platform + Env"
+    TraceView.logger.warn "********************************************************"
+    TraceView.logger.warn RbConfig::CONFIG['host_os']
+    TraceView.logger.warn RbConfig::CONFIG['sitearch']
+    TraceView.logger.warn RbConfig::CONFIG['arch']
+    TraceView.logger.warn RUBY_PLATFORM
+    TraceView.logger.warn "RACK_ENV: #{ENV['RACK_ENV']}"
+    TraceView.logger.warn "RAILS_ENV: #{ENV['RAILS_ENV']}" if using_rails
+
+    TraceView.logger.warn "********************************************************"
+    TraceView.logger.warn "* Raw __Init KVs"
+    TraceView.logger.warn "********************************************************"
+    platform_info = TraceView::Util.build_init_report
+    platform_info.each { |k,v|
+      TraceView.logger.warn "#{k}: #{v}"
+    }
+
+    TraceView.logger.warn "********************************************************"
+    TraceView.logger.warn "* END TraceView Support Report"
+    TraceView.logger.warn "*   Support Email: traceviewsupport@appneta.com"
+    TraceView.logger.warn "*   Support Portal: https://support.tv.appneta.com"
+    TraceView.logger.warn "*   Freenode IRC: #appneta"
+    TraceView.logger.warn "*   Github: https://github.com/appneta/traceview-ruby"
+    TraceView.logger.warn "********************************************************"
+    nil
+  end
+end

data/lib/traceview/thread_local.rb

@@ -0,0 +1,26 @@
+# Copyright (c) 2014 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  ##
+  # Provides thread local storage for TraceView.
+  #
+  # Example usage:
+  # module TraceViewBase
+  #   extend ::TraceView::ThreadLocal
+  #   thread_local :layer_op
+  # end
+  module ThreadLocal
+    def thread_local(name)
+      key = "__#{self}_#{name}__".intern
+
+      define_method(name) do
+        Thread.current[key]
+      end
+
+      define_method(name.to_s + '=') do |value|
+        Thread.current[key] = value
+      end
+    end
+  end
+end

data/lib/traceview/util.rb

@@ -0,0 +1,250 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  ##
+  # Provides utility methods for use while in the business
+  # of instrumenting code
+  module Util
+    class << self
+      def contextual_name(cls)
+        # Attempt to infer a contextual name if not indicated
+        #
+        # For example:
+        # ::ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter.to_s.split(/::/).last
+        # => "AbstractMysqlAdapter"
+        #
+        cls.to_s.split(/::/).last
+      rescue
+        cls
+      end
+
+      ##
+      # method_alias
+      #
+      # Centralized utility method to alias a method on an arbitrary
+      # class or module.
+      #
+      def method_alias(cls, method, name = nil)
+        name ||= contextual_name(cls)
+
+        if cls.method_defined?(method.to_sym) || cls.private_method_defined?(method.to_sym)
+
+          # Strip '!' or '?' from method if present
+          safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
+          safe_method_name ||= method
+
+          without_traceview = "#{safe_method_name}_without_traceview"
+          with_traceview    = "#{safe_method_name}_with_traceview"
+
+          # Only alias if we haven't done so already
+          unless cls.method_defined?(without_traceview.to_sym) ||
+            cls.private_method_defined?(without_traceview.to_sym)
+
+            cls.class_eval do
+              alias_method without_traceview, "#{method}"
+              alias_method "#{method}", with_traceview
+            end
+          end
+        else
+          TraceView.logger.warn "[traceview/loading] Couldn't properly instrument #{name}.#{method}.  Partial traces may occur."
+        end
+      end
+
+      ##
+      # class_method_alias
+      #
+      # Centralized utility method to alias a class method on an arbitrary
+      # class or module
+      #
+      def class_method_alias(cls, method, name = nil)
+        name ||= contextual_name(cls)
+
+        if cls.singleton_methods.include? method.to_sym
+
+          # Strip '!' or '?' from method if present
+          safe_method_name = method.to_s.chop if method.to_s =~ /\?$|\!$/
+          safe_method_name ||= method
+
+          without_traceview = "#{safe_method_name}_without_traceview"
+          with_traceview    = "#{safe_method_name}_with_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)
+          end
+        else TraceView.logger.warn "[traceview/loading] Couldn't properly instrument #{name}.  Partial traces may occur."
+        end
+      end
+
+      ##
+      # send_extend
+      #
+      # Centralized utility method to send an extend call for an
+      # arbitrary class
+      def send_extend(target_cls, cls)
+        target_cls.send(:extend, cls) if defined?(target_cls)
+      end
+
+      ##
+      # send_include
+      #
+      # Centralized utility method to send a include call for an
+      # arbitrary class
+      def send_include(target_cls, cls)
+        target_cls.send(:include, cls) if defined?(target_cls)
+      end
+
+      ##
+      # static_asset?
+      #
+      # Given a path, this method determines whether it is a static asset or not (based
+      # solely on filename)
+      #
+      def static_asset?(path)
+        (path =~ Regexp.new(TraceView::Config[:dnt_regexp], TraceView::Config[:dnt_opts]))
+      end
+
+      ##
+      # prettify
+      #
+      # Even to my surprise, 'prettify' is a real word:
+      # transitive v. To make pretty or prettier, especially in a superficial or insubstantial way.
+      #   from The American Heritage Dictionary of the English Language, 4th Edition
+      #
+      # This method makes things 'purty' for reporting.
+      def prettify(x)
+        if (x.to_s =~ /^#</) == 0
+          x.class.to_s
+        else
+          x.to_s
+        end
+      end
+
+      ##
+      # upcase
+      #
+      # Occasionally, we want to send some values in all caps.  This is true
+      # for things like HTTP scheme or method.  This takes anything and does
+      # it's best to safely convert it to a string (if needed) and convert it
+      # to all uppercase.
+      def upcase(o)
+        if o.is_a?(String) || o.respond_to?(:to_s)
+          o.to_s.upcase
+        else
+          TraceView.logger.debug "[traceview/debug] TraceView::Util.upcase: could not convert #{o.class}"
+          "UNKNOWN"
+        end
+      end
+
+
+      ##
+      # to_query
+      #
+      # Used under Ruby 1.8.7 to convert a hash into a URL
+      # query.  A backport of Hash#to_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) }
+        return result.sort.join('&')
+      end
+
+      ##
+      #  build_report
+      #
+      # Internal: Build a hash of KVs that reports on the status of the
+      # running environment.  This is used on stack boot in __Init reporting
+      # and for TraceView.support_report.
+      def build_init_report
+        platform_info = { '__Init' => 1 }
+
+        begin
+          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]
+
+          # 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}"
+          end
+          platform_info['Ruby.Grape.Version']    = "Grape-#{::Grape::VERSION}" if defined?(::Grape)
+          platform_info['Ruby.Cramp.Version']    = "Cramp-#{::Cramp::VERSION}" if defined?(::Cramp)
+
+          if defined?(::Padrino)
+            platform_info['Ruby.Padrino.Version'] = "Padrino-#{::Padrino::VERSION}"
+          elsif defined?(::Sinatra)
+            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.Excon.Version']      = "Excon-#{::Excon::VERSION}"           if defined?(::Excon::VERSION)
+          platform_info['Ruby.Faraday.Version']    = "Faraday-#{::Faraday::VERSION}"       if defined?(::Faraday)
+          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.RestClient.Version'] = "RestClient-#{::RestClient::VERSION}" if defined?(::RestClient::VERSION)
+          platform_info['Ruby.Typhoeus.Version']   = "Typhoeus-#{::Typhoeus::VERSION}"     if defined?(::Typhoeus::VERSION)
+
+          # Special case since the Mongo 1.x driver doesn't embed the version number in the gem directly
+          if ::Gem.loaded_specs.key?('mongo')
+            platform_info['Ruby.Mongo.Version']     = "Mongo-#{::Gem.loaded_specs['mongo'].version}"
+          end
+
+          # Report the DB adapter in use
+          platform_info['Ruby.Mysql.Version']   = Mysql::GemVersion::VERSION   if defined?(Mysql::GemVersion::VERSION)
+          platform_info['Ruby.PG.Version']      = PG::VERSION                  if defined?(PG::VERSION)
+          platform_info['Ruby.Mysql2.Version']  = Mysql2::VERSION              if defined?(Mysql2::VERSION)
+          platform_info['Ruby.Sequel.Version']  = ::Sequel::VERSION            if defined?(::Sequel::VERSION)
+
+          # Report the server in use (if possible)
+          if defined?(::Unicorn)
+            platform_info['Ruby.AppContainer.Version'] = "Unicorn-#{::Unicorn::Const::UNICORN_VERSION}"
+          elsif defined?(::Puma)
+            platform_info['Ruby.AppContainer.Version'] = "Puma-#{::Puma::Const::PUMA_VERSION} (#{::Puma::Const::CODE_NAME})"
+          elsif defined?(::PhusionPassenger)
+            platform_info['Ruby.AppContainer.Version'] = "#{::PhusionPassenger::PACKAGE_NAME}-#{::PhusionPassenger::VERSION_STRING}"
+          elsif defined?(::Thin)
+            platform_info['Ruby.AppContainer.Version'] = "Thin-#{::Thin::VERSION::STRING} (#{::Thin::VERSION::CODENAME})"
+          elsif defined?(::Mongrel)
+            platform_info['Ruby.AppContainer.Version'] = "Mongrel-#{::Mongrel::Const::MONGREL_VERSION}"
+          elsif defined?(::Mongrel2)
+            platform_info['Ruby.AppContainer.Version'] = "Mongrel2-#{::Mongrel2::VERSION}"
+          elsif defined?(::Trinidad)
+            platform_info['Ruby.AppContainer.Version'] = "Trinidad-#{::Trinidad::VERSION}"
+          elsif defined?(::WEBrick::VERSION)
+            platform_info['Ruby.AppContainer.Version'] = "WEBrick-#{::WEBrick::VERSION}"
+          else
+            platform_info['Ruby.AppContainer.Version'] = File.basename($PROGRAM_NAME)
+          end
+
+        rescue StandardError, ScriptError => e
+          # Also rescue ScriptError (aka SyntaxError) in case one of the expected
+          # version defines don't exist
+
+          platform_info['Error'] = "Error in build_report: #{e.message}"
+
+          TraceView.logger.warn "[traceview/warn] Error in build_init_report: #{e.message}"
+          TraceView.logger.debug e.backtrace
+        end
+        platform_info
+      end
+    end
+  end
+end