traceview 3.0.0-java

data/lib/traceview/inst/typhoeus.rb

@@ -0,0 +1,102 @@
+# Copyright (c) 2015 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  module Inst
+    module TyphoeusRequestOps
+
+      def self.included(klass)
+        ::TraceView::Util.method_alias(klass, :run, ::Typhoeus::Request::Operations)
+      end
+
+      def run_with_traceview
+        return run_without_traceview unless TraceView.tracing?
+
+        TraceView::API.log_entry('typhoeus')
+
+        # Prepare X-Trace header handling
+        blacklisted = TraceView::API.blacklisted?(url)
+        context = TraceView::Context.toString
+        task_id = TraceView::XTrace.task_id(context)
+        options[:headers]['X-Trace'] = context unless blacklisted
+
+        response = run_without_traceview
+
+        if response.code == 0
+          TraceView::API.log('typhoeus', 'error', { :ErrorClass => response.return_code,
+                                               :ErrorMsg => response.return_message })
+        end
+
+        kvs = {}
+        kvs['IsService'] = 1
+        kvs[:HTTPStatus] = response.code
+        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
+        else
+          kvs['RemoteURL'] = uri.to_s.split('?').first
+        end
+
+        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
+        unless blacklisted
+          xtrace = response.headers['X-Trace']
+
+          if xtrace && TraceView::XTrace.valid?(xtrace) && TraceView.tracing?
+
+            # Assure that we received back a valid X-Trace with the same task_id
+            if task_id == TraceView::XTrace.task_id(xtrace)
+              TraceView::Context.fromString(xtrace)
+            else
+              TraceView.logger.debug "Mismatched returned X-Trace ID: #{xtrace}"
+            end
+          end
+        end
+
+        TraceView::API.log('typhoeus', 'info', kvs)
+        response
+      rescue => e
+        TraceView::API.log_exception('typhoeus', e)
+        raise e
+      ensure
+        TraceView::API.log_exit('typhoeus')
+      end
+    end
+
+    module TyphoeusHydraRunnable
+      def self.included(klass)
+        ::TraceView::Util.method_alias(klass, :run, ::Typhoeus::Hydra)
+      end
+
+      def run_with_traceview
+        kvs = {}
+
+        kvs[:queued_requests] = queued_requests.count
+        kvs[:max_concurrency] = max_concurrency
+
+        # 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
+          run_without_traceview
+        end
+      end
+    end
+
+  end
+end
+
+if TraceView::Config[:typhoeus][:enabled]
+  if defined?(::Typhoeus)
+    TraceView.logger.info '[traceview/loading] Instrumenting typhoeus' if TraceView::Config[:verbose]
+    ::TraceView::Util.send_include(::Typhoeus::Request::Operations, ::TraceView::Inst::TyphoeusRequestOps)
+    ::TraceView::Util.send_include(::Typhoeus::Hydra, ::TraceView::Inst::TyphoeusHydraRunnable)
+  end
+end

data/lib/traceview/instrumentation.rb

@@ -0,0 +1,21 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+module TraceView
+  ##
+  # The Inst module holds all of the instrumentation extensions for various
+  # libraries suchs as Redis, Dalli and Resque.
+  module Inst
+    def self.load_instrumentation
+      # Load the general instrumentation
+      pattern = File.join(File.dirname(__FILE__), 'inst', '*.rb')
+      Dir.glob(pattern) do |f|
+        begin
+          require f
+        rescue => e
+          TraceView.logger.error "[traceview/loading] Error loading instrumentation file '#{f}' : #{e}"
+        end
+      end
+    end
+  end
+end

data/lib/traceview/loading.rb

@@ -0,0 +1,94 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+require 'digest/sha1'
+
+module TraceView
+  module Util
+    ##
+    # This module is used solely for RUM ID calculation
+    #
+    module Base64URL
+      module_function
+
+      def encode(bin)
+        c = [bin].pack('m0').gsub(/\=+\Z/, '').tr('+/', '-_').rstrip
+        m = c.size % 4
+        c += '=' * (4 - m) if m != 0
+        c
+      end
+
+      def decode(bin)
+        m = bin.size % 4
+        bin += '=' * (4 - m) if m != 0
+        bin.tr('-_', '+/').unpack('m0').first
+      end
+    end
+  end
+
+  ##
+  # This module houses all of the loading functionality for the traceview gem.
+  #
+  # Note that this does not necessarily _have_ to include initialization routines
+  # (although it can).
+  #
+  # Actual initialization is often separated out as it can be dependent on on the state
+  # of the stack boot process.  e.g. code requiring that initializers, frameworks or
+  # instrumented libraries are already loaded...
+  #
+  module Loading
+    ##
+    # Load the TraceView access key (either from system configuration file
+    # or environment variable) and calculate internal RUM ID
+    #
+    def self.load_access_key
+      if ENV.key?('TRACEVIEW_CUUID')
+        # Preferably get access key from environment (e.g. Heroku)
+        TraceView::Config[:access_key] = ENV['TRACEVIEW_CUUID']
+        TraceView::Config[:rum_id] = TraceView::Util::Base64URL.encode(Digest::SHA1.digest('RUM' + TraceView::Config[:access_key]))
+      else
+        # ..else read from system-wide configuration file
+        if TraceView::Config.access_key.empty?
+          config_file = '/etc/tracelytics.conf'
+          return unless File.exist?(config_file)
+
+          File.open(config_file).each do |line|
+            if line =~ /^tracelyzer.access_key=/ || line =~ /^access_key/
+              bits = line.split(/=/)
+              TraceView::Config[:access_key] = bits[1].strip
+              TraceView::Config[:rum_id] = TraceView::Util::Base64URL.encode(Digest::SHA1.digest('RUM' + TraceView::Config[:access_key]))
+              break
+            end
+          end
+        end
+      end
+    rescue StandardError => e
+      TraceView.logger.error "Trouble obtaining access_key and rum_id: #{e.inspect}"
+    end
+
+    ##
+    # Load the traceview tracing API
+    #
+    def self.require_api
+      pattern = File.join(File.dirname(__FILE__), 'api', '*.rb')
+      Dir.glob(pattern) do |f|
+        require f
+      end
+      require 'traceview/api'
+
+      begin
+        TraceView::API.extend_with_tracing
+      rescue LoadError => e
+        TraceView.logger.fatal "[traceview/error] Couldn't load api: #{e.message}"
+      end
+    end
+  end
+end
+
+TraceView::Loading.require_api
+
+# Auto-start the Reporter unless we running Unicorn on Heroku
+# In that case, we start the reporters after fork
+unless TraceView.heroku? && TraceView.forking_webserver?
+  TraceView::Reporter.start if TraceView.loaded
+end

data/lib/traceview/logger.rb

@@ -0,0 +1,41 @@
+# Copyright (c) 2013 AppNeta, Inc.
+# All rights reserved.
+
+require 'logger'
+
+module TraceView
+  class << self
+    attr_accessor :logger
+  end
+
+  class Logger
+    # Fatal message
+    def fatal(string, exception = nil)
+      TraceView.logger.fatal(string) if TraceView.logger
+    end
+
+    # Error message
+    def error(msg, exception = nil)
+      TraceView.logger.error(string) if TraceView.logger
+    end
+
+    # Warn message
+    def warn(msg, exception = nil)
+      TraceView.logger.warn(string) if TraceView.logger
+    end
+
+    # Info message
+    def info(msg, exception = nil)
+      TraceView.logger.info(string) if TraceView.logger
+    end
+
+    # Debug message
+    def debug(msg, exception = nil)
+      TraceView.logger.debug(string) if TraceView.logger
+    end
+
+  end
+end
+
+TraceView.logger = Logger.new(STDERR)
+

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