site24x7_apminsight 1.5.3 → 1.6.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-This License Agreement details the policy for license of ManageEngine APM Insight Ruby Agent ("Licensed Software")
+This License Agreement details the policy for license of Site24x7 APM Insight Ruby Agent ("Licensed Software")
 Please read the following license carefully, before either (i) downloading the Licensed Software from an authorized website, or (ii) installing the Licensed Software. You acknowledge that you have read this License Agreement, have understood it, and agree to be bound by its terms. If you do not agree to the terms and conditions of this Agreement, do not download or install the Licensed Software.
 
 1. LICENSE GRANT

data/README.rdoc

@@ -1,5 +1,5 @@
 APM Insight Ruby Agent
-	Applications Manager's Ruby agent gives you end-to-end web-transaction awareness enabling you to isolate performance issues and resolve them quickly.Applications Manager requires a monitoring agent (ruby gem) to be deployed in your application server to monitor Ruby application performance. Download the latest Ruby Agent(apminsight.gem) and deploy it in your application server. The agent collects application performance metrics and sends it to the central Applications Manager server at fixed intervals i.e. every 60 seconds.
+	Site24x7 APM Insight Ruby agent gives you end-to-end web-transaction awareness enabling you to isolate performance issues and resolve them quickly. Site24x7 APM Insight requires a monitoring agent (ruby gem) to be deployed in your application server to monitor Ruby application performance. Download the latest Ruby Agent(site24x7_apminsight.gem) and deploy it in your application server. The agent collects application performance metrics and sends it to the central Site24x7 server at fixed intervals i.e. every 60 seconds. You can view them at https://site24x7.com in your accounts page.
  
 Installing APM Insight Agent
 
@@ -7,13 +7,13 @@ Installing APM Insight Agent
 
     	* Install from RubyGems by using the following command in the system where Ruby is installed : 
 		
-			gem install apminsight
+		gem install site24x7_apminsight
     				
 			OR
 
-	    * Download the apminsight.gem file directly from our website or the RubyGems website and run the command 
+	* Download the site24x7_apminsight.gem file from your accounts page in https://site24x7.com (after sign in) or the RubyGems website and run the command 
 		
-			gem install apminsight.gem
+			gem install site24x7_apminsight.gem
 
 Configuration
 
@@ -21,30 +21,28 @@ Configuration
 
     	For each of your applications, add the following line to the application gemfile:
 
-        	gem 'apminsight'
+        	gem 'site24x7_apminsight'
 		
 				OR
 
     	For each of your applications, add the following line to the application initializer block:
 
-        	require 'apminsight'
+        	require 'site24x7_apminsight'
 
-	A copy of the configuration file apminsight.conf will be available in the <Gem Installed folder> /apminsight/conf/. Configure the class name in the configuration file(include.packages), so that all the methods in that class can be instrumented and details will be reported in tracedata.
+	A copy of the configuration file apminsight.conf will be available in the <Gem Installed folder> /site24x7_apminsight/conf/. Configure the class name in the configuration file(include.packages), so that all the methods in that class can be instrumented and details will be reported in tracedata.
  
 
 The following configuration options are mandatory and should be provided for the agent to be initialized:
 
-    application.name - The application's name to be displayed in Applications Manager.
+    application.name - The application's name to be displayed in Site24x7 server.
 
-    apm.host - The host where Applications Manager is running.
-
-    apm.port - The HTTP port of Applications Manager.
+    license.key - The license api key from your account page after sign in (https://site24x7.com)
 
     behind.proxy - The proxy network under which the agent is installed
 
     agent.server.port - The HTTP listening port of the Application Server.
 
-More configuration options of APM Insight Ruby Agent can be found here.
+More configuration options of APM Insight Ruby Agent can be found here. https://www.site24x7.com/help/apm/apm-insight-configuration.html
  
 Supported Environments :
 
@@ -54,16 +52,16 @@ Supported Environments :
 
 References
 
-	* Download link for Applications Manager
-
-		http://www.manageengine.com/products/applications_manager/
+	* Create an apminsight account in Site24x7 server (https://www.site24x7.com)
 
-	* Download link for apminsight 
+	* Download link for site24x7_apminsight gem 
 
-		http://www.manageengine.com/products/applications_manager/
-		http://rubygems.org/gems/apminsight
+		From your account page after valid sign in
+			or
+		http://rubygems.org/gems/site24x7_apminsight
 
 	* Help Documentation for apminsight
 
-		http://www.manageengine.com/products/applications_manager/help/APMInsight/installing-transaction-agent.html
-		
+		https://www.site24x7.com/help/apm/ruby-agent.html
+		https://support.site24x7.com/portal/helpcenter/site24x7/apm-insight/ruby-monitoring
+

data/Rakefile

@@ -14,13 +14,13 @@ require 'rake'
 require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "apminsight"
-  gem.homepage = "http://www.manageengine.com/products/applications_manager/ruby-webtransaction-monitoring.html"
+  gem.name = "site24x7_apminsight"
+  gem.homepage = "https://www.site24x7.com/help/apm/ruby-agent.html"
   gem.license = "MIT"
   gem.summary = %Q{Application Performace Monitor}
   gem.description = %Q{Application Performace Monitor : Monitor the web tranasactions}
   gem.email = "apm-insight@zohocorp.com"
-  gem.authors = ["Sabarinathan P"]
+  gem.authors = ["Rajalakshmi Ezhilan"]
   gem.files=Dir.glob('lib/**/*.*')
   # dependencies defined in Gemfile
 end
@@ -48,7 +48,7 @@ Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "apminsight #{version}"
+  rdoc.title = "site24x7_apminsight #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.*')
   rdoc.rdoc_files.include('lib/agent/**/*.*')

data/lib/agent/api/custom_tracker.rb

@@ -0,0 +1,79 @@
+require 'agent/handler/custom_api_handler'
+
+module APMInsight
+  module API
+    module CustomTracker
+      
+      def self.included clazz
+        clazz.extend CustomMethodTracker
+      end
+      
+      module CustomMethodTracker
+        # @api public
+        def track_method(method_name)
+          
+          # Check whether the method exists
+          return unless method_defined?(method_name) || private_method_defined?(method_name)
+          
+          # Check whether the method is already instrumented
+          return if is_instrumented?(method_name)
+          
+          # Injecting code into the class
+          class_eval(get_instrumentation_code(method_name), __FILE__, __LINE__)
+          
+          # Setting alias to invoke agent methods
+          alias_method "original_#{method_name}", "#{method_name}"
+          alias_method "#{method_name}", "apminsight_#{method_name}"
+          
+          # TODO: set visibility 
+  #        visibility = instance_method_visibility(self, method_name)
+  #        send visibility, method_name
+  #        send visibility, "apminsight_#{method_name}"
+        end
+        
+        
+        def is_instrumented?(method_name)
+          method_name = "apminsight_#{method_name}"
+          return method_defined?(method_name)
+        end
+        
+        # TODO: Capture exception, attach tracker
+        # TODO: Create agent handler and call respective methods like in java agent
+        def get_instrumentation_code(method_name)
+          "def apminsight_#{method_name}(*args, &block)
+              tracker = ::APMInsight::API::CustomAPIHandler.invokeTracker \"\#{self.class.name}.#{method_name}\"
+              begin
+                original_#{method_name}(*args, &block)
+              rescue Exception=>e
+                if tracker != nil
+                  tracker.setError e
+                end
+                raise e
+              ensure
+                ::APMInsight::API::CustomAPIHandler.exitTracker tracker
+              end
+          end"
+        end
+        
+#        def instance_method_visibility(klass, method_name)
+#          if klass.private_instance_methods.map{|s|s.to_sym}.include? method_name.to_sym
+#            :private
+#          elsif klass.protected_instance_methods.map{|s|s.to_sym}.include? method_name.to_sym
+#            :protected
+#          else
+#            :public
+#          end
+#        end
+      end #CustomMethodTracker
+      
+      def self.trackException(exception)
+        return unless exception != nil
+        
+        # Check for active transaction
+        # Associate exception to current transaction
+        ::APMInsight::API::CustomAPIHandler.track_exception(exception)
+      end
+      
+    end #CustomTracker
+  end #API
+end

data/lib/agent/configuration/am_configuration.rb

@@ -1,13 +1,13 @@
 require 'rubygems'
 require 'json'
 require 'socket'
-#require 'rails'
+require 'net/http'
 require 'agent/am_objectholder'
 require 'version'
 
 module ManageEngine
 	class APMConfig
-		attr_reader :agenthost,:agentport,:instance_id,:alreadyconnected,:apmhost,:apmport,:license_key,:site24x7, :site24x7url
+		attr_reader :agenthost,:agentport,:instance_id,:alreadyconnected,:apmhost,:apmport,:license_key,:site24x7, :site24x7url, :hostType
 		attr_reader :appname,:proxyneeded, :apdex_t, :trans_trace, :trans_trace_t, :sql_capture, :sql_capture_params, :sql_trace_t,:proxy_user,:proxy_pass, :metric_overflow_t, :trace_overflow_t, :dbmetric_overflow_t
 		attr_reader :proxy_host,:proxy_port ,:is_secured, :logs_dir ,:connection_retry,:agent_enabled,:connect_interval,:db_operations,:txn_skip_listen, :url_merge_pattern
 		attr_accessor :app_db,:app_dispatcher,:lastupdatedtime
@@ -28,12 +28,14 @@ module ManageEngine
 			end
 			@db_operations =["select","insert","update","delete"]
 			urlMergePattern
+			@hostType = getHostType
 			@obj.log.info "@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@"
 			@obj.log.info "APP HOME #{File.absolute_path(".")} "
 			@obj.log.info "APP HOME #{Dir.pwd} "
 			@obj.log.info "Agent Version : #{ManageEngine::APMInsight::VERSION}"
 			@obj.log.info "Configuration : "
 			@obj.log.info "Hostname : #{@agenthost}"
+			@obj.log.info "Host Type: #{@hostType}"
 			@obj.log.info "Agent Already Connected : #{@alreadyconnected}"
 			@obj.log.info "Agent Enabled : #{@agent_enabled}"
 			@obj.log.info "Allowed DB Operations : #{@db_operations}"
@@ -210,10 +212,37 @@ module ManageEngine
 			end
 		end
 
+		def getHostType
+		  begin
+  		  # Check for AWS environment
+  		  response = Net::HTTP.get_response(URI('http://169.254.169.254/latest/meta-data/'))
+  		  if (response.kind_of? Net::HTTPOK)
+  		    @hostType = "AWS"
+  		    return @hostType
+  		  end
+      rescue Exception => e
+      end
+      
+      begin
+  		  #Check for Azure environment
+        response = Net::HTTP.get_response(URI('http://169.254.169.254/metadata/v1/maintenance'))
+        if (response.kind_of? Net::HTTPOK)
+          @hostType = "AZURE"
+          return @hostType
+        end
+		  rescue Exception => e
+		  end
+		  
+      @hostType = nil
+		end
+		
 		def getAgentInfo
 			data =  Hash.new
 			agentdata = Hash.new
 			agentdata = {"application.type"=>"RUBY","application.name"=>@appname,"hostname"=>@agenthost,"port"=>@agentport,"agent.version"=>ManageEngine::APMInsight::MAJOR_VERSION}
+		  if (@hostType != nil)
+		    agentdata["host.type"]=@hostType
+		  end
 			data["agent_info"]=agentdata
 			data["environment"]=getEnvData
 			data["custom_config_info"]=getAgentConfigData

data/lib/agent/handler/custom_api_handler.rb

@@ -0,0 +1,40 @@
+require 'agent/handler/sequence_book'
+
+module APMInsight
+  module API
+    class CustomAPIHandler
+      
+      ## Create tracker for custom instrumented methods and send them to tracker handler
+      def self.invokeTracker name
+        begin
+#          @obj = ManageEngine::APMObjectHolder.instance
+                  
+          if Thread.current[:apminsight] != nil
+            tracker = ManageEngine::Tracker::DefaultTracker.new(name)
+            tracker = ManageEngine::Agent::TrackerHandler.invokeTracker(tracker)
+            return tracker
+          end
+          
+          return nil
+        rescue Exception=>e
+          return nil
+        end
+      end
+      
+      def self.exitTracker tracker
+        if tracker != nil
+          tracker.finish
+          ManageEngine::Agent::TrackerHandler.exitTracker(tracker)
+        end
+      end
+      
+      def self.track_exception exception
+        seqBook = Thread.current[:apminsight]
+        if seqBook != nil
+          seqBook.addExceptionInfo exception
+        end
+      end
+      
+    end #class CustomAPIhandler
+  end #module API
+end

data/lib/agent/handler/sequence_book.rb

@@ -0,0 +1,115 @@
+require 'agent/metrics/exception_record'
+
+module APMInsight
+  module Agent
+    class SequenceBook
+      attr_reader :openTracker, :closedTracker, :rootTracker, :trackerCount, :exceptionBag, :listenFlag
+      
+      def initialize
+        @rootTracker = createDummyTracker()
+        @closedTracker = @rootTracker
+        @openTracker = nil
+        
+        @trackerCount = 0
+        @listenFlag = -1
+#        @exceptionBag = Array.new
+      end
+      
+      def attachTracker tracker
+        if tracker == nil
+          return nil
+        end
+        
+        # If RootTracker is not set, check type and set
+        if @rootTracker == @closedTracker
+          if !tracker.is_a?(ManageEngine::Tracker::RootTracker)
+            closeSequence()
+            return nil
+          end
+          @rootTracker = tracker
+          
+          updateListenFlag()
+        end
+        
+        
+        # Attach tracker as Sibling or Child and set nominee
+        if @closedTracker != nil
+          tracker.sibling = @closedTracker
+          @closedTracker.sibling = tracker # Nominee - if dropped/corrupted, defaults to this tracker
+          @openTracker = tracker
+          @closedTracker = nil
+        else
+          if tracker.equal?(@openTracker)
+            return nil
+          end
+          
+          @openTracker.child = tracker
+          tracker.sibling = @openTracker
+          @openTracker = tracker
+        end
+        
+        checkAndArrestSequence()
+        
+        return tracker
+      end
+      
+      def closeTracker tracker
+        @closedTracker = tracker
+        tracker.sibling = nil
+        @openTracker = nil
+        
+        # Marks end of transaction
+        if @rootTracker == tracker
+          if @listenFlag < 1 || (@listenFlag >= 1 && @trackerCount > 1)
+            
+            sequenceBag = Hash.new
+            sequenceBag["roottracker"] = @rootTracker
+            sequenceBag["exceptions"] = @exceptionBag
+            
+            ManageEngine::APMObjectHolder.instance.collector.updateTransaction(@rootTracker.url, sequenceBag)
+          end
+          closeSequence()
+        end
+      end
+      
+      def closeSequence
+        @rootTracker = nil
+        @openTracker = @closedTracker = nil
+        @trackerCount = 0
+        Thread.current[:apminsight] = nil
+      end
+      
+      def addExceptionInfo(exception)
+        begin
+          if @exceptionBag == nil
+            @exceptionBag = Set.new
+          end
+          exceptionRecord = ::APMInsight::Errors::ExceptionRecord.new(exception)
+          @exceptionBag.add(exceptionRecord)
+        rescue Exception=>e
+        end
+      end
+      
+      def updateListenFlag
+        if !ManageEngine::APMObjectHolder.instance.txn_util.listen?(@rootTracker.url())
+          @listenFlag = 1
+        end
+        
+        ## Check for sampling factor & for bg txn chk if enabled
+      end
+      
+      def checkAndArrestSequence
+        if ++@trackerCount == 1000
+          @listenFlag = 1
+        end
+        
+        ## Can check for timeout
+      end
+      
+      def createDummyTracker
+        return ManageEngine::Tracker::DefaultTracker.new("dummy")
+      end
+      
+    end
+  end
+end

data/lib/agent/handler/tracker_handler.rb

@@ -0,0 +1,56 @@
+require 'agent/handler/sequence_book'
+
+module ManageEngine
+  module Agent
+    class TrackerHandler
+      
+      def self.invokeTracker tracker
+        begin
+          @obj = ManageEngine::APMObjectHolder.instance
+          
+          if !@obj.config.agent_enabled || tracker == nil
+            return nil
+          end
+          
+          seqBook = Thread.current[:apminsight]
+          if seqBook != nil
+            if seqBook.listenFlag == 1
+              return nil
+            end
+          else
+            seqBook = ::APMInsight::Agent::SequenceBook.new
+            Thread.current[:apminsight] = seqBook
+          end
+          
+          tracker = seqBook.attachTracker(tracker)
+          
+          return tracker
+        rescue Exception=>ex
+          # Logging to be done here, Not sure whether its safe to do
+          if (@obj != nil)
+            @obj.log.logException "[TrackerHandler] Exception occurred at invoketracker.", ex
+          end
+          return nil
+        end
+      end
+      
+      
+      # Closes tracker properly and set everything ready to process next tracker
+      # If roottracker closes, sequence book is cleaned and data are push to store
+      def self.exitTracker tracker
+        begin
+          if tracker != nil
+            seqBook = Thread.current[:apminsight]
+            seqBook.closeTracker tracker
+          end
+        rescue Exception=>ex
+          if (@obj != nil)
+            @obj.log.logException "[TrackerHandler] Exception occurred at exittracker.", ex
+          end
+        end
+      end
+      
+    end # Class TrackerHandler
+    
+  end # module Agent
+end

data/lib/agent/metrics/am_metricsformatter.rb

@@ -163,14 +163,17 @@ module ManageEngine
 			begin
 				pl = d["td"]
 				dbl = d["db"]
+				exc = d["exception"]
 
 				rt = pl["rt"].round(2)
 				path = @obj.constants.mf_transaction + @obj.constants.mf_separator + pl["path"]
 
 
 				apx_stat =  nil
+				additionalInfo = nil
 				if(@transaction.has_key?(path))
 					apx_stat = @transaction[path][0]
+					additionalInfo = @transaction[path][1]
 				else
 					if @transaction.length == @obj.config.metric_overflow_t
 					  @obj.log.debug "Metricstore overflow. Current Size: #{@obj.config.metric_overflow_t} #{path}"
@@ -178,6 +181,7 @@ module ManageEngine
 					end
 					apx_stat = Array.new
 					apx_stat = [0,0,0,0,0,0,0,0,0]
+					additionalInfo = Hash.new
 				end
 				
 				if (pl.has_key?("error"))
@@ -186,9 +190,15 @@ module ManageEngine
 				  apx_stat = apxarray apx_stat,rt
 				end
 				
-				additionalInfo = Hash.new
-				if (pl.has_key?("exception"))
-				  additionalInfo[@obj.constants.mf_logmetric] = pl["exception"]
+				if (exc != nil)
+				  logmetric = additionalInfo[@obj.constants.mf_logmetric]
+				  if (logmetric == nil)
+            additionalInfo[@obj.constants.mf_logmetric] = exc
+				  else
+            exc.each do |name, count|
+              logmetric[name] = logmetric[name].to_i + count
+            end
+          end
 				end
 				
 				@transaction[path] = [apx_stat, additionalInfo]
@@ -272,7 +282,7 @@ module ManageEngine
 					stat = Array.new
 					stat = [0,rt,rt,0,0]
 				end
-				if (pl["error"] != nil)
+				if (pl.has_key?("error"))
 				  stat[4] += 1
 				else
 				  stat = updatert stat,rt