RT 4753 - Fix bug when the client app is using STDOUT the console logs is duplicated (#37)

Co-authored-by: Arman Ortega <aortega@stackify.com>

Author: slashd0t

lib/stackify/engine.rb

@@ -4,7 +4,32 @@ class Engine < ::Rails::Engine
 
     if Rails.version > '3.1'
       initializer 'Stackify set up of logger', group: :all do
+        if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('4.0')
+          # check if the client app is using the ActiveSupport::Logger
+          is_activesupport_logger = ::Rails.logger.is_a?(ActiveSupport::Logger)
+        elsif Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('3.0')
+          Stackify::Utils.check_buffered_logger
+        end
+
+        # Check if the log output is STDOUT
+        Stackify::Utils.check_log_output
+
+        # Proxy the client Rails logger and write logs to its default log_path.
+        # At the same time, we send the log messages to the LoggerClient.
         ::Rails.logger = ::Stackify::LoggerProxy.new ::Rails.logger
+
+        if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('6.0')
+          set_console_logs ::Rails.logger
+        elsif Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('4.0')
+          if is_activesupport_logger && Stackify.configuration.stdout_output
+            set_console_logs ::Rails.logger
+          end
+          # Another checking if the client app is using the default logger and not STDOUT
+          if Stackify.configuration.stdout_output == false
+            set_console_logs ::Rails.logger
+          end
+        end
+
         Stackify.run
       end
 
@@ -14,6 +39,16 @@ class Engine < ::Rails::Engine
         end
       end
 
+      def set_console_logs logger
+        # Handle the stdout logs from Action Controller
+        ActionController::Base.logger = logger
+
+        # Handle the stdout logs from Action View
+        ActionView::Base.logger = logger
+
+        # Handle the stdout logs from Active Record
+        ActiveRecord::Base.logger = logger
+      end
     end
 
   end

lib/stackify/logger_client.rb

@@ -19,9 +19,26 @@ def initialize
     # @param msg [Integer]        log messages
     # @param call_trace [Object]  return the current execution stack
     def log num_level, level, msg, call_trace
-      if num_level <= Logger.const_get(level.upcase).to_i
-        puts msg
+      display_log = true
+      log_appender = false
+      buffer_log = false
+      if defined? Rails
+        display_log = false if Stackify.configuration.stdout_output
+        log_appender = true if defined?(Logging)
+        buffer_log = true if Stackify.configuration.buffered_logger
+        unless buffer_log
+          if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('4.0')
+            if display_log && log_appender
+              puts msg if num_level <= Logger.const_get(level.upcase).to_i
+            elsif display_log && log_appender == false
+              puts msg if num_level <= Logger.const_get(level.upcase).to_i
+            end
+          end
+        end
+      else
+        puts msg if num_level <= Logger.const_get(level.upcase).to_i
       end
+
       return if @@transport.nil?
       task = log_message_task level, msg, call_trace
       @@transport.log level, msg, call_trace, task

lib/stackify/utils/configuration.rb

@@ -3,7 +3,7 @@ module Stackify
   class Configuration
 
     attr_accessor :api_key, :app_name, :app_location, :env, :log_level, :logger,
-                  :proxy, :mode, :base_api_url, :api_enabled, :transport, :errors, :http_endpoint
+                  :proxy, :mode, :base_api_url, :api_enabled, :transport, :errors, :http_endpoint, :stdout_output, :buffered_logger
 
     attr_reader :send_interval, :flood_limit, :queue_max_size, :agent_log_url, :unix_socket_path, :http_endpoint
 
@@ -25,6 +25,8 @@ def initialize
       @agent_log_url = '/log'
       @unix_socket_path = '/usr/local/stackify/stackify.sock'
       @http_endpoint = get_env 'STACKIFY_TRANSPORT_HTTP_ENDPOINT', 'https://localhost:10601'
+      @stdout_output = false
+      @buffered_logger = false
     end
 
     def get_env env_key, default

lib/stackify/utils/methods.rb

@@ -46,4 +46,29 @@ def self.get_app_settings
       'app_location' => Stackify.configuration.app_location || Dir.pwd
     }
   end
-end
+
+  # Check if the app is running on rails and the logger output is using STDOUT
+  def self.check_log_output
+    if defined? Rails
+      if Gem::Version.new(Rails::VERSION::STRING) >= Gem::Version.new('5.0')
+        Stackify.configuration.stdout_output = ActiveSupport::Logger.logger_outputs_to?(Rails.logger, STDOUT)
+      else
+        Stackify.configuration.stdout_output = self.logger_stdout
+      end
+    end
+  end
+
+  def self.logger_stdout
+    logdev = ::Rails.logger.instance_variable_get(:@logdev)
+    logger_source = logdev.dev if logdev.respond_to?(:dev)
+    sources = [$stdout]
+    found = sources.any? { |source| source == logger_source }
+  end
+
+  # Check if the rails version 3 and it's using the buffered logger
+  def self.check_buffered_logger
+    is_buffered_logger = false
+    is_buffered_logger = true if ::Rails.logger.is_a?(ActiveSupport::BufferedLogger)
+    Stackify.configuration.buffered_logger = is_buffered_logger
+  end
+end