site24x7_apminsight 1.4 → 1.5

data/lib/agent/server/instrument/rails.rb

@@ -0,0 +1,56 @@
+module ManageEngine
+  module Instrumentation
+    class RailsFramework
+      
+      def present?
+        defined?(::Rails) && defined?(::ActionController)
+      end
+      
+      def version
+        Rails::VERSION::STRING
+      end
+      
+      def env
+        if Rails::VERSION::MAJOR >= 3 
+          ::Rails.env
+        else
+          RAILS_ENV.dup
+        end
+      end
+      
+      def name
+        'Rails'
+      end
+      
+      def instrument
+        @obj = ManageEngine::APMObjectHolder.instance
+        @obj.log.info "Instrumenting ActionController.. Rails Version: #{version}"
+        
+        ActiveSupport::Notifications.subscribe('start_processing.action_controller') do |name, start, finish, id, payload|
+          if @obj.config.agent_enabled && @obj.txn_util.listen?(payload[:path])
+            url = "#{payload[:path]} #{payload[:controller]}##{payload[:action]}"
+            railsTracker = ManageEngine::Tracker::RootTracker.new(url, start.to_f * 1000)
+            Thread.current[:apminsight] = railsTracker
+          end
+        end # subscribe
+        
+        
+        ActiveSupport::Notifications.subscribe('process_action.action_controller') do |name, start, finish, id, payload|
+          tracker = Thread.current[:apminsight]
+          if tracker != nil
+            tracker.finish(finish.to_f * 1000)
+            exception = payload[:exception_object]
+            if exception != nil
+              tracker.setError(exception)
+              tracker.setStatus(500) # By default, set 500 as status for error txns
+            end
+            ManageEngine::APMObjectHolder.instance.collector.updateTransaction(tracker.name, tracker)
+            Thread.current[:apminsight] = nil # Removing threadlocal
+          end
+        end
+        
+      end # def instrument
+      
+    end
+  end
+end

data/lib/agent/server/instrument/sinatra.rb

@@ -0,0 +1,96 @@
+require 'agent/am_objectholder'
+require 'agent/trackers/root_tracker'
+
+module ManageEngine
+  module Instrumentation
+    class SinatraFramework
+      
+      def present?
+        defined?(::Sinatra) && defined?(::Sinatra::Base)
+      end
+      
+      def version
+        ::Sinatra::VERSION
+      end
+      
+      def env
+        ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+      end
+      
+      def name
+        'Sinatra'
+      end
+      
+      def instrument
+        ManageEngine::APMObjectHolder.instance.log.info "Instrumenting Sinatra framework. Version: #{version}"
+        ::Sinatra::Base.class_eval do
+          include ManageEngine::Instrumentation::APMInsightSinatra
+          
+          alias original_route_eval route_eval
+          alias route_eval apminsight_route_eval
+          
+#          alias sinatra_exception_handler! handle_exception!
+#          alias handle_exception! apminsight_exception_handler!
+          
+        end # class_eval
+      end # def instrument
+      
+    end # class Sinatra
+    
+    module APMInsightSinatra
+              
+      def apminsight_route_eval(*args, &block)
+        
+        # http://www.rubydoc.info/github/rack/rack/master/Rack/Request
+        url = env.has_key?('sinatra.route') ? env['sinatra.route'] : @request.path
+        @obj = ManageEngine::APMObjectHolder.instance
+        
+        if !@obj.config.agent_enabled || !@obj.txn_util.listen?(url)
+          original_route_eval(*args, &block)
+        end
+        
+        sinatraTracker = ManageEngine::Tracker::RootTracker.new(url)
+        Thread.current[:apminsight] = sinatraTracker
+        # TODO: capture all additional details @request.query_string @request.params
+        
+        begin
+          original_route_eval(*args, &block)
+        
+        rescue Exception => e  # On application error, above method throws exception
+          sinatraTracker.setError(e)
+          sinatraTracker.setStatus(500) # By default, set 500 as status for error txns
+          raise e
+        
+        ensure
+          sinatraTracker.finish
+          ManageEngine::APMObjectHolder.instance.collector.updateTransaction(sinatraTracker.name, sinatraTracker)
+          Thread.current[:apminsight] = nil
+        end
+        
+      end
+      
+#      def apminsight_exception_handler!(*args, &block)
+#        begin
+#          sinatra_exception_handler!(*args, &block)
+#        ensure
+#          tracker = Thread.current[:apminsight]
+#          puts "tracker is #{(tracker == nil)}"
+#          if tracker != nil
+#            tracker.error(args[0]) # Other way, env[sinatra.error]
+#            tracker.status(@response.status)
+#            finishTracker tracker
+#          end #if
+#        end#begin
+#      end#def
+#      
+#      def finishTracker(tracker)
+#        tracker.finish
+#        #ManageEngine::APMObjectHolder.instance.collector.updateTransaction(id,stats)
+#        puts tracker.to_s
+#        Thread.current[:apminsight] = nil
+#      end
+      
+    end # module SinatraFramework
+    
+  end # module Instrumentation
+end

data/lib/agent/trackers/database_tracker.rb

@@ -0,0 +1,107 @@
+module ManageEngine
+  module Tracker
+    class DatabaseTracker < DefaultTracker
+      
+      def sql(query)
+        @query = format(query.dup)
+      end
+      
+      def params(binds = [])
+        @binds = binds
+      end
+      
+      def sqlBacktrace(backtrace)
+        @backtrace = backtrace
+      end
+      
+      def getRawQuery
+        @query
+      end
+      
+      def getObfuscatedQuery
+        ManageEngine::APMObjectHolder.instance.util.parametrizeQuery @query
+      end
+      
+      def getCompleteQuery
+        begin
+          query = @query # Maintaining the original query
+          if query != nil && @binds != nil && @binds.length > 0
+            @binds.each do |ar|
+              if query.index("?") != nil
+                query["?"]=ar.value.to_s
+              end
+            end
+            return query
+          end
+        rescue Exception=>exe
+          @logger.logException "Not severe -#{exe.message}",exe
+        end
+        @query
+      end
+      
+      # Returns array [db_operation, tablename]
+      def getQueryInfo
+        sql = @query
+        sql.strip!
+        sql.downcase!
+        sqlArr = sql.split(" ")
+        
+        begin
+          tableName = case sqlArr[0]
+                 when "select" then sqlArr[sqlArr.index("from")+1]
+                 when "insert" then sqlArr[sqlArr.index("into")+1]
+                 when "update" then sqlArr[1]
+                 when "delete" then sqlArr[sqlArr.index("from")+1]
+                 when "create" then sqlArr[1] + sqlArr[2]
+                 when "alter" then sqlArr[1] + sqlArr[2]
+                 when "drop" then sqlArr[1] + sqlArr[2]
+                 when "show" then sqlArr[1] 
+                 when "describe" then sqlArr[1] 
+                 else "-"
+                 end
+          
+          return [sqlArr[0], tableName]
+  
+        rescue Exception=>e
+          @logger.logException "#{e.message}",e
+          return [sqlArr[0], '-']
+        end
+      end
+      
+      def format s
+        s.gsub!("\"", '')
+        s.gsub!("\n", '')
+        s
+      end
+      
+      def getAdditionalInfo
+        info = super
+        begin
+          if (@query != nil)
+            if (info == nil)
+              info = Hash.new
+            end
+            
+            obj = ManageEngine::APMObjectHolder.instance
+            
+            info["query"] = !obj.config.sql_capture_params ? getCompleteQuery : getObfuscatedQuery
+            # send only one backtrace, Exception backtrace have more priority
+            if (@backtrace != nil && @error == nil)
+              info["stacktrace"] = obj.util.formatStacktrace(@backtrace)
+            end
+          end
+        rescue Exception => e
+          @logger.logException("Error updating additionalInfo in dbTracker.", e)
+        end
+                
+        info
+      end
+      
+      
+      def to_s
+        "#{@name} - #{@query}"
+      end
+      
+    end
+  end
+end

data/lib/agent/trackers/default_tracker.rb

@@ -0,0 +1,49 @@
+module ManageEngine
+  module Tracker
+    
+    class DefaultTracker
+      
+    attr_accessor :name, :error, :endtime, :starttime
+      
+      def initialize(name = "unknonwn", time = ManageEngine::APMObjectHolder.instance.util.currenttimemillis)
+        @starttime = time.to_i
+        @name = ManageEngine::APMObjectHolder.instance.txn_util.normalizeName(name)
+        @logger = ManageEngine::APMObjectHolder.instance.log
+      end
+      
+      def finish(time = ManageEngine::APMObjectHolder.instance.util.currenttimemillis)
+        @endtime = time.to_i
+      end
+      
+      def error?
+        @error != nil
+      end
+      
+      def setError(exception)
+        @error = exception
+      end
+      
+      def setName(context)
+        @name = context
+      end
+      
+      def duration
+        (@endtime - @starttime).to_i
+      end
+      
+      def to_s
+        @name
+      end
+      
+      def getAdditionalInfo
+        if error?
+          {ManageEngine::APMObjectHolder.instance.constants.mf_exception_st => ManageEngine::APMObjectHolder.instance.util.formatStacktrace(@error.backtrace)}
+        else
+          nil
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/agent/trackers/root_tracker.rb

@@ -0,0 +1,46 @@
+require 'agent/trackers/default_tracker'
+
+module ManageEngine
+  module Tracker
+    class RootTracker < DefaultTracker
+      
+      attr_accessor :children, :status
+      
+      def http_method(method)
+        @http_method = method
+      end
+      
+      def http_params(params)
+        @http_params = params
+      end
+      
+      def queryString(querystring)
+        @queryString = querystring
+      end
+      
+      def setStatus(httpcode)
+        @status = httpcode
+      end
+      
+      def addChild(tracker)
+        if @children == nil
+          @children = Array.new
+        end
+        @children.push(tracker)
+      end
+      
+      def getAdditionalInfo
+        info = super
+        if (@http_method != nil && @queryString != nil && @status != nil)
+          if (info == nil)
+            info = Hash.new
+          end
+          info["http_method_name"] = @http_method
+          info["http_query_str"] = @queryString
+          info["httpcode"] = @status
+        end
+        info
+      end
+    end
+  end
+end

data/lib/agent/util/am_constants.rb

@@ -3,7 +3,7 @@ module ManageEngine
 	class APMConstants
 
 		attr_reader :apm_gem,:s247_apm_gem,:apm_conf,:agent_conf,:connection_open_timeout,:connection_read_timeout,:connect_uri,:connect_data_uri,:connect_trace_uri,:connect_config_update_uri,:site24x7USurl, :site24x7EUurl, :mergepattern_conf
-		attr_reader :licence_exceeds,:licence_expired,:unmanage_agent,:manage_agent,:agent_config_updated,:error_notfound,:error_server,:delete_agent,:response_code,:custom_config_info
+		attr_reader :licence_exceeds,:licence_expired,:unmanage_agent,:manage_agent,:agent_config_updated,:error_notfound,:error_server,:delete_agent,:response_code,:custom_config_info, :agent_specific_info
 		attr_reader :mf_transaction,:mf_separator,:mf_db,:mf_apdex,:mf_namespace,:mf_name,:mf_all,:agent_store,:agent_lock,:mf_overflow
 		attr_reader :mf_logmetric, :mf_logmetric_warning, :mf_exception_st, :mf_err_st, :mf_loginfo, :mf_loginfo_time, :mf_loginfo_level, :mf_loginfo_str, :mf_loginfo_err_clz, :mf_loginfo_st, :mf_loginfo_level_warn
 		
@@ -63,6 +63,7 @@ module ManageEngine
 			@error_server = 500
 			@response_code = "response-code"
 			@custom_config_info = "custom_config_info"
+			@agent_specific_info = "agent_specific_info"
 
 			#Metrics Formatter -mf
 			@mf_apdex = "apdex"

data/lib/agent/util/am_util.rb

@@ -126,5 +126,26 @@ module ManageEngine
 		qry
 	end
 
+	  def formatStacktrace(stacktrace)
+      strace = Array.new;
+      begin
+        stacktrace.each do |stackelement|
+          temp = Array.new
+          temp[0] = stackelement
+          temp[1] = ""
+          temp[2] = ""
+          temp[3] = ""
+          strace.push(temp)
+          if (strace.size == 10)
+            break;
+          end
+        end
+      rescue Exception=>e
+        @obj.log.logException "Error while formatting stack trace. #{e.message}", e
+      end
+      
+      strace
+    end
+	
 	end#c
 end#m

data/lib/agent/util/transaction_util.rb

@@ -0,0 +1,35 @@
+module ManageEngine
+  class TransactionUtil
+    
+    def initialize
+      @obj = ManageEngine::APMObjectHolder.instance
+    end
+    
+    def normalizeName(txnName)
+      if (txnName != nil)
+        txnName.gsub!(/\/\d+/, "/*") # Replace all numbers with *
+        # Transaction merge patterns - provided by user
+        @obj.config.url_merge_pattern.each do |key, val|
+          if (txnName.match(key) != nil)
+            txnName=val
+            break
+          end
+        end # do
+      end # if (txnName != nil)
+      txnName
+    end # def normalizeName
+    
+    def listen?(txnName)
+      if (txnName != nil)
+        @obj.config.txn_skip_listen.each do |pattern|
+          pattern = pattern.start_with?('.*') ? pattern : ('.' + pattern)
+          if (txnName.match(pattern) != nil)
+            return false
+          end
+        end # do
+      end
+      true
+    end # def listen?
+    
+  end
+end

data/lib/version.rb

@@ -6,8 +6,8 @@
 
 module ManageEngine
   class APMInsight
-    VERSION = '1.4'
-    MAJOR_VERSION = '1.4'
+    VERSION = '1.5'
+    MAJOR_VERSION = '1.5'
     MINOR_VERSION = '0'
   end
 end