appoptics_apm_mnfst 4.5.2

data/lib/appoptics_apm/inst/twitter-cassandra.rb

@@ -0,0 +1,294 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  module Inst
+    module Cassandra
+      def extract_trace_details(op, column_family, keys, args, options = {})
+        report_kvs = {}
+
+        begin
+          report_kvs[:Op] = op.to_s
+          report_kvs[:Cf] = column_family.to_s if column_family
+          report_kvs[:Key] = keys.inspect if keys
+
+          # Open issue - how to handle multiple Cassandra servers
+          report_kvs[:RemoteHost], report_kvs[:RemotePort] = @servers.first.split(':')
+
+          report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:cassandra][:collect_backtraces]
+
+          if options.empty? && args.is_a?(Array)
+            options = args.last if args.last.is_a?(Hash)
+          end
+
+          unless options.empty?
+            [:start_key, :finish_key, :key_count, :batch_size, :columns, :count, :start,
+             :stop, :finish, :finished, :reversed, :consistency, :ttl].each do |k|
+              report_kvs[k.to_s.capitalize] = options[k] if options.key?(k)
+            end
+
+            if op == :get_indexed_slices
+              index_clause = columns_and_options[:index_clause] || {}
+              unless index_clause.empty?
+                [:column_name, :value, :comparison].each do |k|
+                  report_kvs[k.to_s.capitalize] = index_clause[k] if index_clause.key?(k)
+                end
+              end
+            end
+          end
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+        end
+
+        report_kvs
+      end
+
+      def insert_with_appoptics(column_family, key, hash, options = {})
+        return insert_without_appoptics(column_family, key, hash, options = {}) unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:insert, column_family, key, hash, options)
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          insert_without_appoptics(column_family, key, hash, options = {})
+        end
+      end
+
+      def remove_with_appoptics(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+
+        return send :remove_without_appoptics, *args unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:remove, column_family, key, columns_and_options)
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          send :remove_without_appoptics, *args
+        end
+      end
+
+      def count_columns_with_appoptics(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+
+        return send :count_columns_without_appoptics, *args unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:count_columns, column_family, key, columns_and_options)
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          send :count_columns_without_appoptics, *args
+        end
+      end
+
+      def get_columns_with_appoptics(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+
+        if AppOpticsAPM.tracing? && !AppOpticsAPM.tracing_layer_op?(:multi_get_columns)
+          report_kvs = extract_trace_details(:get_columns, column_family, key, columns_and_options)
+
+          AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+            send :get_columns_without_appoptics, *args
+          end
+        else
+          send :get_columns_without_appoptics, *args
+        end
+      end
+
+      def multi_get_columns_with_appoptics(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+
+        return send :multi_get_columns_without_appoptics, *args unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:multi_get_columns, column_family, key, columns_and_options)
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs, :multi_get_columns) do
+          send :multi_get_columns_without_appoptics, *args
+        end
+      end
+
+      def get_with_appoptics(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+
+        return send :get_without_appoptics, *args unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:get, column_family, key, columns_and_options)
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs, :get) do
+          send :get_without_appoptics, *args
+        end
+      end
+
+      def multi_get_with_appoptics(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+
+        if AppOpticsAPM.tracing? && !AppOpticsAPM.tracing_layer_op?(:get)
+          report_kvs = extract_trace_details(:multi_get, column_family, key, columns_and_options)
+
+          AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+            send :multi_get_without_appoptics, *args
+          end
+        else
+          send :multi_get_without_appoptics, *args
+        end
+      end
+
+      def exists_with_appoptics?(column_family, key, *columns_and_options)
+        args = [column_family, key] + columns_and_options
+
+        return send :exists_without_appoptics?, *args unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:exists?, column_family, key, columns_and_options)
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          send :exists_without_appoptics?, *args
+        end
+      end
+
+      def get_range_single_with_appoptics(column_family, options = {})
+        if AppOpticsAPM.tracing? && !AppOpticsAPM.tracing_layer_op?(:get_range_batch)
+          report_kvs = extract_trace_details(:get_range_single, column_family, nil, nil)
+
+          AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+            get_range_single_without_appoptics(column_family, options)
+          end
+        else
+          get_range_single_without_appoptics(column_family, options)
+        end
+      end
+
+      def get_range_batch_with_appoptics(column_family, options = {})
+        return get_range_batch_without_appoptics(column_family, options) unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:get_range_batch, column_family, nil, nil)
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs, :get_range_batch) do
+          get_range_batch_without_appoptics(column_family, options)
+        end
+      end
+
+      def get_indexed_slices_with_appoptics(column_family, index_clause, *columns_and_options)
+        args = [column_family, index_clause] + columns_and_options
+
+        return send :get_indexed_slices_without_appoptics, *args unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:get_indexed_slices, column_family, nil, columns_and_options)
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          send :get_indexed_slices_without_appoptics, *args
+        end
+      end
+
+      def create_index_with_appoptics(keyspace, column_family, column_name, validation_class)
+        unless AppOpticsAPM.tracing?
+          return create_index_without_appoptics(keyspace, column_family, column_name, validation_class)
+        end
+
+        report_kvs = extract_trace_details(:create_index, column_family, nil, nil)
+        begin
+          report_kvs[:Keyspace] = keyspace.to_s
+          report_kvs[:Column_name] = column_name.to_s
+          report_kvs[:Validation_class] = validation_class.to_s
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+        end
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          create_index_without_appoptics(keyspace, column_family, column_name, validation_class)
+        end
+      end
+
+      def drop_index_with_appoptics(keyspace, column_family, column_name)
+        return drop_index_without_appoptics(keyspace, column_family, column_name) unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:drop_index, column_family, nil, nil)
+        begin
+          report_kvs[:Keyspace] = keyspace.to_s
+          report_kvs[:Column_name] = column_name.to_s
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+        end
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          drop_index_without_appoptics(keyspace, column_family, column_name)
+        end
+      end
+
+      def add_column_family_with_appoptics(cf_def)
+        return add_column_family_without_appoptics(cf_def) unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:add_column_family, nil, nil, nil)
+        begin
+          report_kvs[:Cf] = cf_def[:name] if cf_def.is_a?(Hash) && cf_def.key?(:name)
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+        end
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          add_column_family_without_appoptics(cf_def)
+        end
+      end
+
+      def drop_column_family_with_appoptics(column_family)
+        return drop_column_family_without_appoptics(column_family) unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:drop_column_family, column_family, nil, nil)
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          drop_column_family_without_appoptics(column_family)
+        end
+      end
+
+      def add_keyspace_with_appoptics(ks_def)
+        return add_keyspace_without_appoptics(ks_def) unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:add_keyspace, nil, nil, nil)
+        report_kvs[:Name] = ks_def.name rescue ''
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          add_keyspace_without_appoptics(ks_def)
+        end
+      end
+
+      def drop_keyspace_with_appoptics(keyspace)
+        return drop_keyspace_without_appoptics(keyspace) unless AppOpticsAPM.tracing?
+
+        report_kvs = extract_trace_details(:drop_keyspace, nil, nil, nil)
+        report_kvs[:Name] = keyspace.to_s rescue ''
+
+        AppOpticsAPM::API.trace(:cassandra, report_kvs) do
+          drop_keyspace_without_appoptics(keyspace)
+        end
+      end
+    end
+  end
+end
+
+# There are two main Cassandra clients for Ruby.  This one from Twitter
+# and the other from datastax.  This one defined Cassandra as a class
+# and datastax defines it as a module.  We use this to detect
+# and differentiate between the client in use.
+
+if defined?(Cassandra) && Cassandra.is_a?(Class) && AppOpticsAPM::Config[:cassandra][:enabled]
+  AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting cassandra' if AppOpticsAPM::Config[:verbose]
+
+  class Cassandra
+    include AppOpticsAPM::Inst::Cassandra
+
+    [:insert, :remove, :count_columns, :get_columns, :multi_get_columns, :get,
+     :multi_get, :get_range_single, :get_range_batch, :get_indexed_slices,
+     :create_index, :drop_index, :add_column_family, :drop_column_family,
+     :add_keyspace, :drop_keyspace].each do |m|
+      if method_defined?(m)
+        class_eval "alias #{m}_without_appoptics #{m}"
+        class_eval "alias #{m} #{m}_with_appoptics"
+      else AppOpticsAPM.logger.warn "[appoptics_apm/loading] Couldn't properly instrument Cassandra (#{m}).  Partial traces may occur."
+      end
+    end
+
+    # Special case handler for question mark methods
+    if method_defined?(:exists?)
+      alias exists_without_appoptics? exists?
+      alias exists? exists_with_appoptics?
+    else AppOpticsAPM.logger.warn '[appoptics_apm/loading] Couldn\'t properly instrument Cassandra (exists?).  Partial traces may occur.'
+    end
+  end # class Cassandra
+end
+
+

data/lib/appoptics_apm/inst/typhoeus.rb

@@ -0,0 +1,108 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+class TyphoeusError < StandardError; end
+
+module AppOpticsAPM
+  module Inst
+    module TyphoeusRequestOps
+
+      def self.included(klass)
+        AppOpticsAPM::Util.method_alias(klass, :run, ::Typhoeus::Request::Operations)
+      end
+
+      def run_with_appoptics
+        blacklisted = AppOpticsAPM::API.blacklisted?(url)
+        unless AppOpticsAPM.tracing?
+          context = AppOpticsAPM::Context.toString
+          options[:headers]['X-Trace'] = context if AppOpticsAPM::XTrace.valid?(context) && !blacklisted
+          return run_without_appoptics
+        end
+
+        begin
+          AppOpticsAPM::API.log_entry(:typhoeus)
+
+          # Prepare X-Trace header handling
+          context = AppOpticsAPM::Context.toString
+          options[:headers]['X-Trace'] = context unless blacklisted
+
+          kvs = {}
+          kvs[:Spec] = 'rsc'
+          kvs[:IsService] = 1
+          kvs[:HTTPMethod] = AppOpticsAPM::Util.upcase(options[:method])
+
+          response = run_without_appoptics
+
+          # Re-attach edge unless it's blacklisted
+          # or if we don't have a valid X-Trace header
+          unless blacklisted
+            xtrace = response.headers['X-Trace']
+            AppOpticsAPM::XTrace.continue_service_context(context, xtrace)
+          end
+
+          if response.code == 0
+            exception = TyphoeusError.new(response.return_message)
+            exception.set_backtrace(AppOpticsAPM::API.backtrace)
+            AppOpticsAPM::API.log_exception(:typhoeus, exception)
+          end
+
+          kvs[:HTTPStatus] = response.code
+          kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:typhoeus][:collect_backtraces]
+          # Conditionally log query params
+          uri = URI(response.effective_url)
+          kvs[:RemoteURL] = AppOpticsAPM::Config[:typhoeus][:log_args] ? uri.to_s : uri.to_s.split('?').first
+          kvs[:Blacklisted] = true if blacklisted
+
+          response
+        rescue => e
+          AppOpticsAPM::API.log_exception(:typhoeus, e)
+          raise e
+        ensure
+          AppOpticsAPM::API.log_exit(:typhoeus, kvs)
+        end
+      end
+    end
+
+    module TyphoeusHydraRunnable
+      def self.included(klass)
+        AppOpticsAPM::Util.method_alias(klass, :run, ::Typhoeus::Hydra)
+      end
+
+      def run_with_appoptics
+        unless AppOpticsAPM.tracing?
+          context = AppOpticsAPM::Context.toString
+          queued_requests.map do |request|
+            blacklisted = AppOpticsAPM::API.blacklisted?(request.base_url)
+            request.options[:headers]['X-Trace'] = context if AppOpticsAPM::XTrace.valid?(context) && !blacklisted
+          end
+          return run_without_appoptics
+        end
+
+        kvs = {}
+
+        kvs[:queued_requests] = queued_requests.count
+        kvs[:max_concurrency] = max_concurrency
+        kvs[:Async] = 1
+        kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:typhoeus][:collect_backtraces]
+
+        # 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.
+        AppOpticsAPM::API.trace(:typhoeus_hydra, kvs) do
+          queued_requests.map do |request|
+            blacklisted = AppOpticsAPM::API.blacklisted?(request.base_url)
+            request.options[:headers]['X-Trace'] = AppOpticsAPM::Context.toString unless blacklisted
+          end
+
+          run_without_appoptics
+        end
+      end
+    end
+
+  end
+end
+
+if defined?(Typhoeus) && AppOpticsAPM::Config[:typhoeus][:enabled]
+  AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting typhoeus' if AppOpticsAPM::Config[:verbose]
+  AppOpticsAPM::Util.send_include(Typhoeus::Request::Operations, AppOpticsAPM::Inst::TyphoeusRequestOps)
+  AppOpticsAPM::Util.send_include(Typhoeus::Hydra, AppOpticsAPM::Inst::TyphoeusHydraRunnable)
+end

data/lib/appoptics_apm/instrumentation.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+module AppOpticsAPM
+  ##
+  # The Inst module holds all of the instrumentation extensions for various
+  # libraries such 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
+          AppOpticsAPM.logger.error "[appoptics_apm/loading] Error loading instrumentation file '#{f}' : #{e}"
+          AppOpticsAPM.logger.debug "[appoptics_apm/loading] #{e.backtrace.first}"
+        end
+      end
+    end
+  end
+end

data/lib/appoptics_apm/legacy_method_profiling.rb

@@ -0,0 +1,90 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+##
+# Provides the methods necessary for method profiling.  Profiling
+# results are sent to the AppOptics dashboard.
+#
+# Example usage:
+# class MyApp
+#   include AppOpticsAPMMethodProfiling
+#
+#   def process_request()
+#     # The hard work
+#   end
+#
+#   # call syntax: profile_method <method>, <profile_name>
+#   profile_method :process_request, 'request_processor'
+# end
+module AppOpticsAPMMethodProfiling
+  def self.included(klass)
+    klass.extend ClassMethods
+  end
+
+  module ClassMethods
+    def profile_method_noop(*args)
+      nil
+    end
+
+    def profile_method_real(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.
+        file = ''
+        line = ''
+        info = instance_method(method_name).source_location
+        unless info.nil?
+          file = info[0].to_s
+          line = info[1].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 _appoptics_profiled_#{method_name}(*args, &block)
+                  entry_kvs                  = {}
+                  entry_kvs['Language']      = 'ruby'
+                  entry_kvs['ProfileName']   = '#{AppOpticsAPM::Util.prettify(profile_name)}'
+                  entry_kvs['FunctionName']  = '#{AppOpticsAPM::Util.prettify(method_name)}'
+                  entry_kvs['File']          = '#{file}'
+                  entry_kvs['LineNumber']    = '#{line}'
+                  entry_kvs['Args']          = AppOpticsAPM::API.pps(*args) if #{store_args}
+                  entry_kvs.merge!(AppOpticsAPM::API.get_class_name(self))
+
+                  AppOpticsAPM::API.log(nil, 'profile_entry', entry_kvs)
+
+                  ret = _appoptics_orig_#{method_name}(*args, &block)
+
+                  exit_kvs =  {}
+                  exit_kvs['Language'] = 'ruby'
+                  exit_kvs['ProfileName'] = '#{AppOpticsAPM::Util.prettify(profile_name)}'
+                  exit_kvs['ReturnValue'] = AppOpticsAPM::API.pps(ret) if #{store_return}
+
+                  AppOpticsAPM::API.log(nil, 'profile_exit', exit_kvs)
+                  ret
+                end"
+      rescue => e
+        AppOpticsAPM.logger.warn "[appoptics_apm/warn] profile_method: #{e.inspect}"
+      end
+
+      begin
+        class_eval code, __FILE__, __LINE__
+        alias_method "_appoptics_orig_#{method_name}", method_name
+        alias_method method_name, "_appoptics_profiled_#{method_name}"
+      rescue => e
+        AppOpticsAPM.logger.warn "[appoptics_apm/warn] Fatal error profiling method (#{method_name}): #{e.inspect}" if AppOpticsAPM::Config[:verbose]
+      end
+    end
+
+    # This allows this module to be included and called even if the gem is in
+    # no-op mode (no base libraries).
+    if AppOpticsAPM.loaded
+      alias :profile_method :profile_method_real
+    else
+      alias :profile_method :profile_method_noop
+    end
+
+  end
+end