appsignal 4.2.3 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d2ac6979db9fc2191b0add9f9471012e1a8017ef127643dcff60ff430bc9c63
-  data.tar.gz: 41664ff55a4afcf2b0d2bf8f0c5869e72490998305450169095020b48b33d7b9
+  metadata.gz: '081e260c387fb860c32850116461ca61e1839ee33cd6114f1685fa4892971788'
+  data.tar.gz: ccfb167b163279e59d1e1dfacc4e95b16577828d2b6b57b136ec85a92f26e4d6
 SHA512:
-  metadata.gz: 95ecd66382fd4f46d8d0d5119704c0e82a36cb50ee6575bd7e706fda24f6f5975cf275939fd8c96aa0981d695e780ed125d0d5682b9599d31c79281b66aa3788
-  data.tar.gz: 37fc851eda0c8e730ba962239d6962cc1939bfb0109f7fd0c372a8635381fd986aeb4ec12711b5f82c7ca861b53c23ca73893b566449442bd3da1e6e5a93fe0d
+  metadata.gz: 6c68050b6ac9451ca3206b1ebf22df5783354f03df248c32290ede34778eb8c4303ffc9a0e7512c88d2ab74ba2eae614c1bafd8ec2716478ed4769f323a5f5d2
+  data.tar.gz: 79c5a466dc6b9c162db83488a506add62ed1cf189d5bec4021a530b5cf82cd23c60ec05537ba04043c4b9565e479cb0e8c28e46228f7a9e319404fe41a6ca9fb

data/CHANGELOG.md

@@ -1,5 +1,72 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.3.0
+
+_Published on 2024-12-20._
+
+### Added
+
+- Add logger broadcasting. This change implements an alternative within `Appsignal::Logger` to `ActiveSupport::BroadcastLogger`, following the same interface. This enables a proper workaround to the issues with `ActiveSupport::BroadcastLogger` (([#49745](https://github.com/rails/rails/issues/49745), [#51883](https://github.com/rails/rails/issues/51883))) when used alongside tagged logging.
+
+  For example, to use tagged logging both in logs emitted by the default `Rails.logger` and in logs sent to AppSignal, replace the `Rails.logger` with an AppSignal logger that broadcasts to the default `Rails.logger`:
+
+  ```ruby
+  appsignal_logger = Appsignal::Logger.new("app")
+  appsignal_logger.broadcast_to(Rails.logger)
+  Rails.logger = ActiveSupport::TaggedLogging.new(appsignal_logger)
+  ```
+
+  (minor [5cb1464b](https://github.com/appsignal/appsignal-ruby/commit/5cb1464bcf12f043774fb55850e6b82aeba9c1ca))
+
+### Removed
+
+- Remove tagged logging support from `Appsignal::Logger`.
+
+  Tagged logging is still supported by wrapping an instance of `Appsignal::Logger` with `ActiveSupport::TaggedLogging`:
+
+  ```ruby
+  appsignal_logger = Appsignal::Logger.new("rails")
+  tagged_logger = ActiveSupport::TaggedLogging.new(appsignal_logger)
+  Rails.logger = tagged_logger
+  ```
+
+  Removing this functionality allows for a workaround to issues within Rails ([#49745](https://github.com/rails/rails/issues/49745), [#51883](https://github.com/rails/rails/issues/51883)), where using the broadcast logger to log to more than one tagged logger results in incorrect behaviour of the tagged logging methods, resulting in breakage throughout Rails' internals:
+
+  ```ruby
+  # We use the built-in request ID middleware as an example that triggers
+  # the issue:
+  Rails.config.log_tags = [:request_id]
+
+  appsignal_logger = Appsignal::Logger.new("rails")
+  tagged_logger = ActiveSupport::TaggedLogging.new(appsignal_logger)
+
+  # This does not work correctly, because the default `Rails.logger` is a
+  # broadcast logger that is already broadcasting to a tagged logger.
+  # When asked to broadcast to a second tagged logger, the return value of
+  # `Rails.logger.tagged { ... }` will be incorrect, in turn causing the
+  # `RequestID` middleware, which uses it internally, to return broken
+  # Rack responses.
+  Rails.logger.broadcast_to(tagged_logger)
+  ```
+
+  By reverting the changes to our logger so that it is no longer a tagged logger, we enable a workaround to this issue:
+
+  ```ruby
+  Rails.config.log_tags = [:request_id]
+
+  appsignal_logger = Appsignal::Logger.new("rails")
+
+  # This works correctly, because `appsignal_logger` is not a tagged logger.
+  # Note that `appsignal_logger` will not have the `request_id` tags.
+  Rails.logger.broadcast_to(appsignal_logger)
+  ```
+
+  (patch [c061aa4e](https://github.com/appsignal/appsignal-ruby/commit/c061aa4e3f9485a1549ea90316534cddd36e238e))
+
+### Fixed
+
+- Fix `#silence` implementation for `Appsignal::Logger`. (patch [d08a1cec](https://github.com/appsignal/appsignal-ruby/commit/d08a1cec705db71999afa9c4af36e244a7b6483a))
+
 ## 4.2.3
 
 _Published on 2024-12-17._

data/lib/appsignal/logger.rb

@@ -38,7 +38,7 @@ module Appsignal
       @mutex = Mutex.new
       @default_attributes = attributes
       @appsignal_attributes = {}
-      @tags = []
+      @loggers = []
     end
 
     # We support the various methods in the Ruby
@@ -59,13 +59,14 @@ module Appsignal
       end
       return if message.nil?
 
-      if @tags.any?
-        formatted_tags = @tags.map { |tag| "[#{tag}]" }
-        message = "#{formatted_tags.join(" ")} #{message}"
-      end
-
       message = formatter.call(severity, Time.now, group, message) if formatter
 
+      @loggers.each do |logger|
+        logger.add(severity, message, group)
+      rescue
+        nil
+      end
+
       unless message.is_a?(String)
         Appsignal.internal_logger.warn(
           "Logger message was ignored, because it was not a String: #{message.inspect}"
@@ -150,41 +151,23 @@ module Appsignal
       add_with_attributes(FATAL, message, @group, attributes)
     end
 
-    # Listen to ActiveSupport tagged logging tags set with `Rails.logger.tagged`.
-    def tagged(tags)
-      @tags.append(*tags)
-      yield self
-    ensure
-      @tags.pop(tags.length)
-    end
-
-    # Listen to ActiveSupport tagged logging tags set with `Rails.config.log_tags`.
-    def push_tags(*tags)
-      @tags.append(*tags)
-    end
-
-    # Remove a set of ActiveSupport tagged logging tags set with `Rails.config.log_tags`.
-    def pop_tags(count = 1)
-      @tags.pop(count)
-    end
-
-    # Remove all ActiveSupport tagged logging tags set with `Rails.config.log_tags`.
-    def clear_tags!
-      @tags.clear
-    end
-
     # When using ActiveSupport::TaggedLogging without the broadcast feature,
     # the passed logger is required to respond to the `silence` method.
-    # In our case it behaves as the broadcast feature of the Rails logger, but
-    # we don't have to check if the parent logger has the `silence` method defined
-    # as our logger directly inherits from Ruby base logger.
     #
-    # Links:
+    # Reference links:
     #
     # - https://github.com/rails/rails/blob/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/activesupport/lib/active_support/logger.rb#L60-L76
-    # - https://github.com/rails/rails/blob/main/activesupport/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/active_support/logger_silence.rb
-    def silence(_severity = ERROR, &block)
-      block.call
+    # - https://github.com/rails/rails/blob/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/activesupport/lib/active_support/logger_silence.rb
+    def silence(severity = ERROR, &block)
+      previous_level = @level
+      @level = severity
+      block.call(self)
+    ensure
+      @level = previous_level
+    end
+
+    def broadcast_to(logger)
+      @loggers << logger
     end
 
     private

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "4.2.3"
+  VERSION = "4.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.2.3
+  version: 4.3.0
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-17 00:00:00.000000000 Z
+date: 2024-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logger