appoptics_apm 4.0.2

data/lib/appoptics_apm/inst/mongo.rb

@@ -0,0 +1,242 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'json'
+
+module AppOpticsAPM
+  module Inst
+    module Mongo
+      FLAVOR = 'mongodb'
+
+      # Operations for Mongo::DB
+      DB_OPS         = [:create_collection, :drop_collection]
+
+      # Operations for Mongo::Cursor
+      CURSOR_OPS     = [:count]
+
+      # Operations for Mongo::Collection
+      COLL_WRITE_OPS = [:find_and_modify, :insert, :map_reduce, :remove, :rename, :update]
+      COLL_QUERY_OPS = [:distinct, :find, :group]
+      COLL_INDEX_OPS = [:create_index, :drop_index, :drop_indexes, :ensure_index, :index_information]
+    end
+  end
+end
+
+if defined?(::Mongo) && (Gem.loaded_specs['mongo'].version.to_s < '2.0.0') && AppOpticsAPM::Config[:mongo][:enabled]
+  AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting mongo' if AppOpticsAPM::Config[:verbose]
+
+  if defined?(::Mongo::DB)
+    module ::Mongo
+      class DB
+        include AppOpticsAPM::Inst::Mongo
+
+        # Instrument DB operations
+        AppOpticsAPM::Inst::Mongo::DB_OPS.reject { |m| !method_defined?(m) }.each do |m|
+          define_method("#{m}_with_appoptics") do |*args|
+            report_kvs = {}
+
+            begin
+              report_kvs[:Flavor] = AppOpticsAPM::Inst::Mongo::FLAVOR
+
+              report_kvs[:Database] = @name
+
+              # Mongo >= 1.10 uses @client instead of @connection
+              # Avoid the nil
+              if @connection
+                report_kvs[:RemoteHost] = @connection.host
+                report_kvs[:RemotePort] = @connection.port
+              elsif @client
+                report_kvs[:RemoteHost] = @client.host
+                report_kvs[:RemotePort] = @client.port
+              end
+
+              report_kvs[:QueryOp] = m
+
+              report_kvs[:New_Collection_Name] = args[0] if m == :create_collection
+              report_kvs[:Collection] = args[0]          if m == :drop_collection
+
+              report_kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:mongo][:collect_backtraces]
+            rescue => e
+              AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+            end
+
+            AppOpticsAPM::API.trace(:mongo, report_kvs) do
+              send("#{m}_without_appoptics", *args)
+            end
+          end
+
+          class_eval "alias #{m}_without_appoptics #{m}"
+          class_eval "alias #{m} #{m}_with_appoptics"
+        end
+      end
+    end
+  end
+
+  if defined?(::Mongo::Cursor)
+    module ::Mongo
+      class Cursor
+        include AppOpticsAPM::Inst::Mongo
+
+        # Instrument DB cursor operations
+        AppOpticsAPM::Inst::Mongo::CURSOR_OPS.reject { |m| !method_defined?(m) }.each do |m|
+          define_method("#{m}_with_appoptics") do |*args|
+            report_kvs = {}
+
+            begin
+              report_kvs[:Flavor] = AppOpticsAPM::Inst::Mongo::FLAVOR
+
+              report_kvs[:Database] = @db.name
+              report_kvs[:RemoteHost] = @connection.host
+              report_kvs[:RemotePort] = @connection.port
+
+              report_kvs[:QueryOp] = m
+              if m == :count
+                unless @selector.empty?
+                  report_kvs[:Query] = @selector.to_json
+                else
+                  report_kvs[:Query] = :all
+                end
+                report_kvs[:Limit] = @limit if @limit != 0
+              end
+            rescue => e
+              AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+            end
+
+            AppOpticsAPM::API.trace(:mongo, report_kvs) do
+              send("#{m}_without_appoptics", *args)
+            end
+          end
+
+          class_eval "alias #{m}_without_appoptics #{m}"
+          class_eval "alias #{m} #{m}_with_appoptics"
+        end
+      end
+    end
+  end
+
+  if defined?(::Mongo::Collection)
+    module ::Mongo
+      class Collection
+        include AppOpticsAPM::Inst::Mongo
+
+        def appoptics_collect(m, args)
+          kvs = {}
+          kvs[:Flavor] = AppOpticsAPM::Inst::Mongo::FLAVOR
+
+          kvs[:Database] = @db.name
+          kvs[:RemoteHost] = @db.connection.host
+          kvs[:RemotePort] = @db.connection.port
+          kvs[:Collection] = @name
+
+          kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:mongo][:collect_backtraces]
+
+          kvs[:QueryOp] = m
+          kvs[:Query] = args[0].to_json if args && !args.empty? && args[0].class == Hash
+        rescue StandardError => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] Exception in appoptics_collect KV collection: #{e.inspect}"
+        ensure
+          return kvs
+        end
+
+        # Instrument Collection write operations
+        AppOpticsAPM::Inst::Mongo::COLL_WRITE_OPS.reject { |m| !method_defined?(m) }.each do |m|
+          define_method("#{m}_with_appoptics") do |*args|
+            report_kvs = appoptics_collect(m, args)
+            args_length = args.length
+
+            begin
+              if m == :find_and_modify && args[0] && args[0].key?(:update)
+                report_kvs[:Update_Document] = args[0][:update].inspect
+              end
+
+              if m == :map_reduce
+                report_kvs[:Map_Function]    = args[0]
+                report_kvs[:Reduce_Function] = args[1]
+                report_kvs[:Limit] = args[2][:limit] if args[2] && args[2].key?(:limit)
+              end
+
+              report_kvs[:New_Collection_Name] = args[0] if m == :rename
+
+              if m == :update
+                if args_length >= 3
+                  report_kvs[:Update_Document] = args[1].to_json
+                  report_kvs[:Multi] = args[2][:multi] if args[2] && args[2].key?(:multi)
+                end
+              end
+            rescue => e
+              AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+            end
+
+            AppOpticsAPM::API.trace(:mongo, report_kvs) do
+              send("#{m}_without_appoptics", *args)
+            end
+          end
+
+          class_eval "alias #{m}_without_appoptics #{m}"
+          class_eval "alias #{m} #{m}_with_appoptics"
+        end
+
+        # Instrument Collection query operations
+        AppOpticsAPM::Inst::Mongo::COLL_QUERY_OPS.reject { |m| !method_defined?(m) }.each do |m|
+          define_method("#{m}_with_appoptics") do |*args, &blk|
+            begin
+              report_kvs = appoptics_collect(m, args)
+              args_length = args.length
+
+              if m == :distinct && args_length >= 2
+                report_kvs[:Key]   = args[0]
+                report_kvs[:Query] = args[1].to_json if args[1] && args[1].class == Hash
+              end
+
+              if m == :find && args_length > 0
+                report_kvs[:Limit] = args[0][:limit] if !args[0].nil? && args[0].key?(:limit)
+              end
+
+              if m == :group
+                unless args.empty?
+                  if args[0].is_a?(Hash)
+                    report_kvs[:Group_Key]       = args[0][:key].to_json     if args[0].key?(:key)
+                    report_kvs[:Group_Condition] = args[0][:cond].to_json    if args[0].key?(:cond)
+                    report_kvs[:Group_Initial]   = args[0][:initial].to_json if args[0].key?(:initial)
+                    report_kvs[:Group_Reduce]    = args[0][:reduce]          if args[0].key?(:reduce)
+                  end
+                end
+              end
+            rescue => e
+              AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+            end
+
+            AppOpticsAPM::API.trace(:mongo, report_kvs) do
+              send("#{m}_without_appoptics", *args, &blk)
+            end
+          end
+
+          class_eval "alias #{m}_without_appoptics #{m}"
+          class_eval "alias #{m} #{m}_with_appoptics"
+        end
+
+        # Instrument Collection index operations
+        AppOpticsAPM::Inst::Mongo::COLL_INDEX_OPS.reject { |m| !method_defined?(m) }.each do |m|
+          define_method("#{m}_with_appoptics") do |*args|
+            report_kvs = appoptics_collect(m, args)
+
+            begin
+              if [:create_index, :ensure_index, :drop_index].include?(m) && !args.empty?
+                report_kvs[:Index] = args[0].to_json
+              end
+            rescue => e
+              AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+            end
+
+            AppOpticsAPM::API.trace(:mongo, report_kvs) do
+              send("#{m}_without_appoptics", *args)
+            end
+          end
+
+          class_eval "alias #{m}_without_appoptics #{m}"
+          class_eval "alias #{m} #{m}_with_appoptics"
+        end
+      end
+    end
+  end
+end

data/lib/appoptics_apm/inst/mongo2.rb

@@ -0,0 +1,225 @@
+# Copyright (c) 2016 SolarWinds, LLC.
+# All rights reserved.
+
+require 'json'
+
+if RUBY_VERSION >= '1.9' && AppOpticsAPM::Config[:mongo][:enabled]
+  if defined?(::Mongo) && (Gem.loaded_specs['mongo'].version.to_s >= '2.0.0')
+    ::AppOpticsAPM.logger.info '[appoptics_apm/loading] Instrumenting mongo' if AppOpticsAPM::Config[:verbose]
+
+    # Collection Related Operations
+    COLL_OTHER_OPS = [:create, :drop, :insert_one, :insert_many, :bulk_write, :map_reduce].freeze
+
+    # Mongo 2.2 only ops
+    if Mongo::VERSION >= '2.1'
+      COLL_QUERY_OPS = [:find, :find_one_and_delete, :find_one_and_update, :find_one_and_replace, :update_one, :update_many, :delete_one, :delete_many, :replace_one].freeze
+    else
+      COLL_QUERY_OPS = [:find, :update_many, :delete_one].freeze
+    end
+
+    COLL_OPS = COLL_QUERY_OPS + COLL_OTHER_OPS
+
+    module Mongo
+      class Collection
+        ##
+        # collect_kvs
+        #
+        # Used to collect up information to report and build a hash
+        # with the Keys/Values to report.
+        #
+        def collect_kvs(op, args)
+          kvs = { :Flavor => :mongodb, :Database => @database.name }
+
+          kvs[:QueryOp] = op
+
+          if op == :create
+            kvs[:New_Collection_Name] = @name
+          else
+            kvs[:Collection] = @name
+          end
+
+          if op == :map_reduce
+            kvs[:Map_Function] = args[0]
+            kvs[:Reduce_Function] = args[1]
+            kvs[:Limit] = args[2][:limit] if args[2].is_a?(Hash) && args[2].key?(:limit)
+          end
+
+          if AppOpticsAPM::Config[:mongo][:log_args]
+            if COLL_QUERY_OPS.include?(op)
+              kvs[:Query] = args.first.to_json
+            end
+          end
+
+          kvs[:RemoteHost] = @database.client.cluster.addresses.first.to_s
+          kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:mongo][:collect_backtraces]
+        rescue => e
+          AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+        ensure
+          return kvs
+        end
+
+        ##
+        # Here we dynamically define wrapper methods for the operations
+        # we want to instrument in mongo
+        #
+        COLL_OPS.reject { |m| !method_defined?(m) }.each do |m|
+          define_method("#{m}_with_appoptics") do |*args|
+            begin
+              if !AppOpticsAPM.tracing? || AppOpticsAPM.tracing_layer?(:mongo)
+                mongo_skipped = true
+                return send("#{m}_without_appoptics", *args)
+              end
+
+              kvs = collect_kvs(m, args)
+              AppOpticsAPM::API.log_entry(:mongo, kvs)
+
+              send("#{m}_without_appoptics", *args)
+            rescue => e
+              AppOpticsAPM::API.log_exception(:mongo, e)
+              raise e
+            ensure
+              AppOpticsAPM::API.log_exit(:mongo) unless mongo_skipped
+            end
+          end
+          ::AppOpticsAPM::Util.method_alias(Mongo::Collection, m)
+        end
+      end
+    end
+
+    ##
+    # Mongo Collection View Instrumentation
+    #
+
+    # Collection View Related Operations
+    VIEW_QUERY_OPS = [:delete_one, :delete_many, :count, :distinct, :find_one_and_delete, :find_one_and_update,
+                      :replace_one, :update_one, :update_many].freeze
+    VIEW_OTHER_OPS = [:aggregate, :map_reduce ].freeze
+    VIEW_OPS = VIEW_QUERY_OPS + VIEW_OTHER_OPS
+
+    module Mongo
+      class Collection
+        class View
+          ##
+          # collect_kvs
+          #
+          # Used to collect up information to report and build a hash
+          # with the Keys/Values to report.
+          #
+          def collect_kvs(op, args)
+            kvs = { :Flavor => :mongodb, :Database => @collection.database.name }
+
+            kvs[:QueryOp] = op
+            kvs[:Collection] = @collection.name
+
+            if op == :map_reduce
+              kvs[:Map_Function] = args[0]
+              kvs[:Reduce_Function] = args[1]
+              kvs[:Limit] = args[2][:limit] if args[2].is_a?(Hash) && args[2].key?(:limit)
+            end
+
+            if AppOpticsAPM::Config[:mongo][:log_args]
+              if VIEW_QUERY_OPS.include?(op)
+                if defined?(filter)
+                  kvs[:Query] = filter.to_json
+                elsif defined?(selector)
+                  kvs[:Query] = selector.to_json
+                end
+              end
+            end
+
+            kvs[:RemoteHost] = @collection.database.client.cluster.addresses.first.to_s
+            kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:mongo][:collect_backtraces]
+          rescue => e
+            AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+          ensure
+            return kvs
+          end
+
+          ##
+          # Here we dynamically define wrapper methods for the operations
+          # we want to instrument in mongo
+          #
+          VIEW_OPS.reject { |m| !method_defined?(m) }.each do |m|
+            define_method("#{m}_with_appoptics") do |*args|
+              begin
+                if !AppOpticsAPM.tracing? || AppOpticsAPM.tracing_layer?(:mongo)
+                  mongo_skipped = true
+                  return send("#{m}_without_appoptics", *args)
+                end
+
+                kvs = collect_kvs(m, args)
+                AppOpticsAPM::API.log_entry(:mongo, kvs)
+
+                send("#{m}_without_appoptics", *args)
+              rescue => e
+                AppOpticsAPM::API.log_exception(:mongo, e)
+                raise e
+              ensure
+                AppOpticsAPM::API.log_exit(:mongo) unless mongo_skipped
+              end
+            end
+            ::AppOpticsAPM::Util.method_alias(Mongo::Collection::View, m)
+          end
+        end
+      end
+    end
+
+    ##
+    # Mongo Collection Index View Instrumentation
+    #
+
+    # Collection Index View Related Operations
+    INDEX_OPS = [:create_one, :create_many, :drop_one, :drop_all].freeze
+
+    module Mongo
+      module Index
+        class View
+          ##
+          # collect_kvs
+          #
+          # Used to collect up information to report and build a hash
+          # with the Keys/Values to report.
+          #
+          def collect_index_kvs(op, args)
+            kvs = { :Flavor => :mongodb, :Database => @collection.database.name }
+
+            kvs[:QueryOp] = op
+            kvs[:Collection] = @collection.name
+            kvs[:RemoteHost] = @collection.database.client.cluster.addresses.first.to_s
+            kvs[:Backtrace] = AppOpticsAPM::API.backtrace if AppOpticsAPM::Config[:mongo][:collect_backtraces]
+          rescue => e
+            AppOpticsAPM.logger.debug "[appoptics_apm/debug] #{__method__}:#{File.basename(__FILE__)}:#{__LINE__}: #{e.message}" if AppOpticsAPM::Config[:verbose]
+          ensure
+            return kvs
+          end
+
+          ##
+          # Here we dynamically define wrapper methods for the operations
+          # we want to instrument in mongo
+          #
+          INDEX_OPS.reject { |m| !method_defined?(m) }.each do |m|
+            define_method("#{m}_with_appoptics") do |*args|
+              begin
+                if !AppOpticsAPM.tracing? || AppOpticsAPM.tracing_layer?(:mongo)
+                  mongo_skipped = true
+                  return send("#{m}_without_appoptics", *args)
+                end
+
+                kvs = collect_index_kvs(m, args)
+                AppOpticsAPM::API.log_entry(:mongo, kvs)
+
+                send("#{m}_without_appoptics", *args)
+              rescue => e
+                AppOpticsAPM::API.log_exception(:mongo, e)
+                raise e
+              ensure
+                AppOpticsAPM::API.log_exit(:mongo) unless mongo_skipped
+              end
+            end
+            ::AppOpticsAPM::Util.method_alias(Mongo::Index::View, m)
+          end
+        end
+      end
+    end
+  end
+end