Merge pull request #3839 from DataDog/lograge-rails

Author: marcotc

lib/datadog/tracing/contrib/lograge/patcher.rb

@@ -20,6 +20,22 @@ def target_version
 
           # patch applies our patch
           def patch
+            # ActiveSupport::TaggedLogging is the default Rails logger since Rails 5
+            if defined?(::ActiveSupport::TaggedLogging::Formatter) &&
+                ::Lograge::LogSubscribers::ActionController
+                    .logger&.formatter.is_a?(::ActiveSupport::TaggedLogging::Formatter)
+
+              Datadog.logger.error(
+                'Lograge and ActiveSupport::TaggedLogging (the default Rails log formatter) are not compatible: ' \
+                  'Lograge does not account for Rails log tags, creating polluted logs and breaking log formatting. ' \
+                  'Traces and Logs correlation may not work. ' \
+                  'Either: 1. Disable tagged logging in your Rails configuration ' \
+                  '`config.logger = ActiveSupport::Logger.new(STDOUT); ' \
+                  'config.active_job.logger = ActiveSupport::Logger.new(STDOUT)` ' \
+                  'or 2. Use the `semantic_logger` gem instead of `lograge`.'
+              )
+            end
+
             ::Lograge::LogSubscribers::Base.include(Instrumentation)
           end
         end

spec/datadog/tracing/contrib/lograge/patcher_spec.rb

@@ -5,10 +5,31 @@
 
 RSpec.describe Datadog::Tracing::Contrib::Lograge::Patcher do
   describe '.patch' do
+    before { described_class.instance_variable_get(:@patch_only_once)&.send(:reset_ran_once_state_for_tests) }
+
     it 'adds Instrumentation to ancestors of LogSubscribers::Base class' do
       described_class.patch
 
       expect(Lograge::LogSubscribers::Base.ancestors).to include(Datadog::Tracing::Contrib::Lograge::Instrumentation)
     end
+
+    context 'without Rails tagged logging' do
+      it 'does not log incompatibility error' do
+        expect(Datadog.logger).to_not receive(:error)
+
+        described_class.patch
+      end
+    end
+
+    context 'with Rails tagged logging' do
+      it 'logs an incompatibility error' do
+        logger = ActiveSupport::TaggedLogging.new(Logger.new(File::NULL))
+        stub_const('Lograge::LogSubscribers::ActionController', double('controller', logger: logger))
+
+        expect(Datadog.logger).to receive(:error).with(/ActiveSupport::TaggedLogging/)
+
+        described_class.patch
+      end
+    end
   end
 end