stackify-ruby-apm 0.9.0 → 1.0.0

data/lib/stackify/config.rb

@@ -10,13 +10,14 @@ module StackifyRubyAPM
   # rubocop:disable Metrics/ClassLength
   # @api private
   class Config
+    include Log
     DEFAULTS = {
       config_file: 'config/stackify_apm.yml',
       environment_name: ENV['RAILS_ENV'] || ENV['RACK_ENV'],
       instrument: true,
 
       log_path: '/usr/local/stackify/stackify-ruby-apm/log/stackify-ruby-apm.log',
-      log_level: Logger::DEBUG,
+      log_level: Logger::INFO,
 
       log_trace_path: '/usr/local/stackify/stackify-ruby-apm/log/',
 
@@ -24,7 +25,13 @@ module StackifyRubyAPM
       flush_interval: 1, # interval with which transactions should be sent to the APM. Default value: 10 seconds
       
       filter_exception_types: [],
-
+      
+      tracer_logger: nil,
+      logger_byte_size: 50000000,
+      filenum_rotate: 20,
+      debugger_byte_size: 20000000,
+      debugger_filenum_rotate: 3,
+      logtime_created: 0,
       http_status: nil,
       debug_transactions: false,
       
@@ -37,7 +44,8 @@ module StackifyRubyAPM
       disabled_spies: %w[json],
 
       view_paths: [],
-      root_path: Dir.pwd
+      root_path: Dir.pwd,
+      stackify_properties_file: '/usr/local/stackify/stackify-ruby-apm/stackify.properties'
     }.freeze
 
     ENV_TO_KEY = {
@@ -67,12 +75,14 @@ module StackifyRubyAPM
       yield self if block_given?
 
       build_logger if logger.nil? || log_path
+      load_stackify_props
     end
 
     attr_accessor :config_file
     attr_accessor :environment_name
     attr_accessor :instrument
     attr_accessor :enabled_environments
+    attr_accessor :stackify_properties_file
 
     attr_accessor :application_name
     attr_accessor :hostname
@@ -80,6 +90,13 @@ module StackifyRubyAPM
     attr_accessor :log_path
     attr_accessor :log_level
     attr_accessor :logger
+    attr_accessor :logger_byte_size
+    attr_accessor :filenum_rotate
+    attr_accessor :debugger_byte_size
+    attr_accessor :debugger_filenum_rotate
+
+    attr_accessor :tracer_logger
+    attr_accessor :logtime_created
 
     attr_accessor :log_trace_path
     attr_accessor :source_lines_error_app_frames
@@ -101,6 +118,9 @@ module StackifyRubyAPM
     attr_accessor :root_path
     attr_accessor :http_status
 
+    attr_reader :clientId
+    attr_reader :deviceId
+
     def app=(app)
       case app_type?(app)
       when :rails
@@ -118,42 +138,36 @@ module StackifyRubyAPM
       nil
     end
 
-    # rubocop:disable Metrics/MethodLength
+   # rubocop:disable Metrics/MethodLength
+    # available spies to use when framework is rails
     def available_spies
       %w[
         action_dispatch
         mongo
         net_http
         httpclient
-        sinatra
+        redis
         tilt
+        httprb
       ]
     end
     # rubocop:enable Metrics/MethodLength
 
     def enabled_spies
-      available_spies - disabled_spies
-    end
-
-    def check_lastlog_needs_new(path)
-      latest_file = Dir.glob("#{path}*").grep(/([#])\w+/).max_by {|f| File.mtime(f)}
-      new_flagger = false
-
-      if latest_file.nil?
-          new_flagger = true
+      # check if the framework is rails or sinatra
+      sinatra_spies = %w[
+        sinatra
+        sinatra_activerecord/mysql_adapter
+        sinatra_activerecord/postgresql_adapter
+        sinatra_activerecord/sqlite_adapter
+      ]
+      if (defined?(::Sinatra::Base))
+        new_available_spies = available_spies + sinatra_spies
       else
-        current_kb_size = ((File.size(latest_file)) / 1000).to_f
-
-        #50000KB = 50MB
-        if current_kb_size > 50000.0
-          new_flagger = true
-        end
-      end
-      result = {
-        'latest_file' => latest_file,
-        'new_flagger' => new_flagger
-      }
-
+        new_available_spies = available_spies
+      end  
+      
+      new_available_spies - disabled_spies
     end
 
     private
@@ -207,15 +221,37 @@ module StackifyRubyAPM
     end
 
     def build_logger
-      logger = Logger.new(log_path == '-' ? $stdout : log_path)
+      debuger_logpath = log_path == '-' ? $stdout : log_path
+      logger = StackifyLogger.new(debuger_logpath, debugger_filenum_rotate, debugger_byte_size)
       logger.level = log_level
-
-      self.logger = logger
+       self.logger = logger
     end
 
     def format_name(str)
       str.gsub('::', '_')
     end
+
+    def load_stackify_props
+      @clientId = nil
+      @deviceId = nil
+      begin
+        warn "Reading the stackify.properties file"
+        IO.foreach(@stackify_properties_file) { |line|
+          case line.downcase
+          when /clientid=\d+/
+            @clientId = line.split('=')[1].strip
+          when /deviceid=\d+/
+            @deviceId = line.split('=')[1].strip
+          end
+        }
+        warn "stackify.properties: clientId=#{@clientId}, deviceId=#{@deviceId}"
+      rescue StandardError => e
+        warn "Error occured while reading the stackify.properties file."
+        warn e.inspect
+      end
+      warn "No clientId found from stackify.properties file." if @clientId.nil?
+      warn "No deviceId found from stackify.properties file." if @deviceId.nil?
+    end
   end
   # rubocop:enable Metrics/ClassLength
 end

data/lib/stackify/context/response.rb

@@ -13,12 +13,25 @@ module StackifyRubyAPM
         finished: true
       )
         @status_code = status_code
+        headers = self.make_xstackifyId_header(headers)
         @headers = headers
         @headers_sent = headers_sent
         @finished = finished
       end
 
       attr_accessor :status_code, :headers, :headers_sent, :finished
+
+      def make_xstackifyId_header(headers)
+        if (StackifyRubyAPM.agent.current_transaction &&
+          StackifyRubyAPM.agent.current_transaction.id)
+          transaction_id = StackifyRubyAPM.agent.current_transaction.id
+          clientId = StackifyRubyAPM.agent.config.clientId
+          deviceId = StackifyRubyAPM.agent.config.deviceId
+          if clientId && deviceId
+            headers['X-StackifyID'] = "V1|#{transaction_id}|C#{clientId}|CD#{deviceId}"
+          end
+        end
+      end
     end
   end
 end

data/lib/stackify/context_builder.rb

@@ -12,7 +12,6 @@ module StackifyRubyAPM
     # Creates context
     #
     def build(rack_env)
-      # puts "@stackify_ruby [lib/context_builder.rb] Loading ContextBuilder build(rack_env)"
       context = Context.new
       apply_to_request(context, rack_env)
       context
@@ -25,7 +24,6 @@ module StackifyRubyAPM
     # Request format and values are assigned to context
     #
     def apply_to_request(context, rack_env)
-      # puts "@stackify_ruby [lib/context_builder.rb] Loading ContextBuilder apply_to_request(context, rack_env)"
       req = rails_req?(rack_env) ? rack_env : Rack::Request.new(rack_env)
       context.request = Context::Request.new unless context.request
       request = context.request

data/lib/stackify/error.rb

@@ -12,7 +12,7 @@ module StackifyRubyAPM
       @id = SecureRandom.uuid
       @culprit = culprit
 
-      @timestamp = Util.micros
+      @timestamp = (Time.now).to_f * 1000
       @context = Context.new
 
       @transaction_id = nil
@@ -21,4 +21,4 @@ module StackifyRubyAPM
     attr_accessor :id, :culprit, :exception, :log, :transaction_id, :context
     attr_reader :timestamp
   end
-end
+end

data/lib/stackify/error_builder.rb

@@ -43,7 +43,7 @@ module StackifyRubyAPM
   
       def add_stacktrace(error, kind, backtrace)
         stacktrace =
-          @agent.stacktrace_builder.build(backtrace, type: :error)
+          @agent.stacktrace_builder.build(backtrace, :error)
         return unless stacktrace
   
         case kind

data/lib/stackify/instrumenter.rb

@@ -18,7 +18,7 @@ module StackifyRubyAPM
       end
 
       def current
-        # puts '@stackify_ruby [Instrumenter] [lib/instrumenter.rb] TransactionInfo.current()'
+        # puts '[Instrumenter] [lib/instrumenter.rb] TransactionInfo.current()'
         Thread.current[KEY]
       end
 
@@ -28,7 +28,7 @@ module StackifyRubyAPM
     end
 
     def initialize(agent)
-      debug '@stackify_ruby [Instrumenter] [lib/instrumenter.rb] initialize()'
+      debug '[Instrumenter] initialize()'
       @agent = agent
       @config = agent.config
 
@@ -61,7 +61,7 @@ module StackifyRubyAPM
     # Creates a new transaction or return the currently running
     #
     def transaction(*args)
-      debug "Instrumenter function transaction(*args)"
+      debug "[Instrumenter] transaction(*args)"
       unless config.instrument
         yield if block_given?
         return
@@ -103,7 +103,7 @@ module StackifyRubyAPM
     # Once the transaction is submitted it will be stored temporarily in queue
     #
     def submit_transaction(transaction)
-      debug '@stackify_ruby [Instrumenter] [lib/instrumenter.rb] submit_transaction(transaction):'
+      debug '[Instrumenter] submit_transaction(transaction):'
       debug transaction.inspect
       agent.enqueue_transaction transaction
       return unless config.debug_transactions

data/lib/stackify/logger/logger_high_version.rb

@@ -0,0 +1,65 @@
+# Starts the Monkey patch for the generated log by not including the header
+#
+# @param file
+# @removed the header of the generated log
+module StackifyRubyAPM
+
+  class StackifyLogger < Logger
+
+    def initialize(logdev, shift_age = 0, shift_size = 1048576, level: DEBUG,
+      progname: nil, formatter: nil, datetime_format: nil,
+      shift_period_suffix: '%Y%m%d')
+      super(nil) # this prevents it from initializing a LogDevice
+      @logdev = nil
+      if logdev
+        new_logdev = logdev
+        if (logdev.instance_of? String)
+          temp_filename = logdev.gsub(".log", "")
+          new_logdev = temp_filename + "-1.log"
+        end
+
+        @logdev = LogDevice.new(new_logdev, :shift_age => shift_age,
+        :shift_size => shift_size,
+        :shift_period_suffix => shift_period_suffix)
+      end
+    end
+    class LogDevice < Logger::LogDevice
+      def add_log_header(file)
+      end
+      # This is the monkeypatch of core Logger method where reformats when shifting log age the filename when creating the file log.
+      def shift_log_age
+        temp_filename = @filename.gsub(/\-([0-9]).log/,"")
+        (@shift_age-1).downto(2) do |i|
+          if FileTest.exist?("#{temp_filename}-#{i}.log")
+            File.rename("#{temp_filename}-#{i}.log", "#{temp_filename}-#{i+1}.log")
+          end
+        end
+        @dev.close rescue nil
+        File.rename("#{temp_filename}-1.log", "#{temp_filename}-2.log")
+        @dev = create_logfile(@filename)
+
+        return true
+      end
+      #  This is the monkeypatch of core Logger method where reformats the file name when creating the file log.
+      def shift_log_period(period_end)
+        suffix = period_end.strftime(@shift_period_suffix)
+        age_file = "#{@filename}.#{suffix}"
+        if FileTest.exist?(age_file)
+          # try to avoid filename crash caused by Timestamp change.
+          idx = 1
+          # .99 can be overridden; avoid too much file search with 'loop do'
+          while idx < 100
+            idx += 1
+            age_file = "#{@filename}-#{idx}.#{suffix}"
+            break unless FileTest.exist?(age_file)
+          end
+        end
+        @dev.close rescue nil
+        File.rename("#{@filename}", age_file)
+        @dev = create_logfile(@filename)
+
+        return true
+      end
+    end
+  end
+end

data/lib/stackify/logger/logger_lower_version.rb

@@ -0,0 +1,63 @@
+# Starts the Monkey patch for the generated log by not including the header
+#
+# @param file
+# @removed the header of the generated log
+module StackifyRubyAPM
+  class StackifyLogger < Logger
+
+    def initialize(logdev, shift_age = 0, shift_size = 1048576)
+      super(nil) # this prevents it from initializing a LogDevice
+      @logdev = nil
+      if logdev
+        new_logdev = logdev
+        if (logdev.instance_of? String)
+          temp_filename = logdev.gsub(".log", "")
+          new_logdev = temp_filename + "-1.log"
+        end
+
+        @logdev = LogDevice.new(new_logdev, :shift_age => shift_age,
+          :shift_size => shift_size)
+      end
+    end
+
+    class LogDevice < Logger::LogDevice
+      
+      def add_log_header(file)
+      end
+      # This is the monkeypatch of core Logger method where reformats when shifting log age the filename when creating the file log.
+      def shift_log_age
+        temp_filename = @filename.gsub(/\-([0-9]).log/,"")
+        (@shift_age-1).downto(2) do |i|
+          if FileTest.exist?("#{temp_filename}-#{i}.log")
+            File.rename("#{temp_filename}-#{i}.log", "#{temp_filename}-#{i+1}.log")
+          end
+        end
+        @dev.close rescue nil
+        File.rename("#{temp_filename}-1.log", "#{temp_filename}-2.log")
+        @dev = create_logfile(@filename)
+
+        return true
+      end
+      #  This is the monkeypatch of core Logger method where reformats the file name when creating the file log.
+      def shift_log_period(period_end)
+        suffix = period_end.strftime(@shift_period_suffix)
+        age_file = "#{@filename}.#{suffix}"
+        if FileTest.exist?(age_file)
+          # try to avoid filename crash caused by Timestamp change.
+          idx = 1
+          # .99 can be overridden; avoid too much file search with 'loop do'
+          while idx < 100
+            idx += 1
+            age_file = "#{@filename}-#{idx}.#{suffix}"
+            break unless FileTest.exist?(age_file)
+          end
+        end
+        @dev.close rescue nil
+        File.rename("#{@filename}", age_file)
+        @dev = create_logfile(@filename)
+
+        return true
+      end
+    end
+  end
+end

data/lib/stackify/middleware.rb

@@ -22,7 +22,6 @@ module StackifyRubyAPM
 
     class Middleware
       def initialize(app)
-        # puts "@stackify_ruby [Middleware] [lib/middleware.rb] initialize(app)"
         @app = app
       end
 
@@ -38,13 +37,11 @@ module StackifyRubyAPM
         end
 
         resp = @app.call env
-        # puts "@stackify_ruby [Middleware] [lib/middleware.rb] Loads call(env) in middleware module"
 
         submit_transaction(transaction, *resp) if transaction
         rescue InternalError
         raise # Don't report StackifyRubyAPM errors
         rescue ::Exception => e
-          #puts "@stackify_ruby [Middleware] [lib/middleware.rb] Error Message: #{e.message}"
           transaction.submit('500', status: 500) if transaction
         raise
         ensure
@@ -63,7 +60,6 @@ module StackifyRubyAPM
       # Start of transaction building with params: name, type, context
       #
       def build_transaction(env)
-        # puts "@stackify_ruby [Middleware] [lib/middleware.rb] middleware build transaction env"
         StackifyRubyAPM.transaction 'Rack', 'request', context: StackifyRubyAPM.build_context(env)
       end
 

data/lib/stackify/normalizers.rb

@@ -23,7 +23,6 @@ module StackifyRubyAPM # :nodoc:
     end
 
     def self.build(config)
-      # puts '@stackify_ruby [Normalizers] [lib/normalizer.rb] self.build(config)'
       normalizers = @registered.each_with_object({}) do |(name, klass), built|
         built[name] = klass.new(config)
       end