appsignal 4.0.0.beta.1-java → 4.0.0-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d422d1bb2beb74439829a1e4bff0078abe9c6f12bc623bf8d489528861a2e38
-  data.tar.gz: 37e732954a981ad21f73d6baabea1857f21566e9534044a6c164b53b3277c123
+  metadata.gz: 8b24fff89ddabacc2b97eedd0f2350e332084c31c4e879dab2b9f13e02f631e2
+  data.tar.gz: ec09dc858c399b9004cebb9afcdb1e041ba4f0efd068f173c6177e2bb5d10b1c
 SHA512:
-  metadata.gz: 680d24e0eead21082e16a27ae2db66022dc22e6dbcd941a9bb86ebc869a0e6ee2acb85b7b86baf0817eeb09b5aa43a4343d10b9a798a81732639fc3c4bb9110c
-  data.tar.gz: d006348ba01d732dfe2abd6bb09fa9d2b0128577011eb54df402ed43a4f04df300472e374d4f851d921be24e98800bbe6e0c6c636e0b30146e5d2c0e17f982c8
+  metadata.gz: 0ff5785db46ea54a79b993742b1f2730cae2bb236069c331414782732ed47de3a0c28a95e3bb8c9db45adcf2a402083af88f909d5065d839551d9f52bc560e64
+  data.tar.gz: 6da6a43068a8edf31158269f956be507f2125ec61dd8374192f228582c730862a5a659d5b2f530e7c995264e571d2e27daf049367089608dcdbbb63b5db16ef9

data/CHANGELOG.md

@@ -1,5 +1,25 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.0.0
+
+_Published on 2024-08-23._
+
+### Changed
+
+- Release the final package version. See the pre-release changelog entries for the changes in this version. (major)
+
+### Removed
+
+- Remove the `Transaction.new` method Transaction ID argument. The Transaction ID will always be automatically generated. (major [bb938a9f](https://github.com/appsignal/appsignal-ruby/commit/bb938a9f79b8b51e4c47d3f268326f89c137df6f))
+
+## 4.0.0.beta.2
+
+_Published on 2024-08-19._
+
+### Added
+
+- Add a helper for parameters sample data to be unset. This is a private method until we stabilize it. (patch [e9336363](https://github.com/appsignal/appsignal-ruby/commit/e9336363fa869c88ab925f57e86ead45e8e18c29))
+
 ## 4.0.0.beta.1
 
 _Published on 2024-08-19._
@@ -113,6 +133,22 @@ _Published on 2024-08-19._
 
 - Fix an issue where, when setting several errors for the same transaction, error causes from a different error would be shown for an error that has no causes. (patch [d54ce8b9](https://github.com/appsignal/appsignal-ruby/commit/d54ce8b947c9316756c4191155e8d255a8e25a8c))
 
+## 3.13.1
+
+_Published on 2024-08-23._
+
+### Changed
+
+- Release the final package version. See the pre-release changelog entries for the changes in this version. (patch)
+
+## 3.13.1.alpha.1
+
+_Published on 2024-08-22._
+
+### Changed
+
+- Ignore `Errno::EPIPE` errors when instrumenting response bodies. We've noticed this error gets reported when the connection is broken between server and client. This happens in normal scenarios so we'll ignore this error in this scenario to avoid error reports from errors that cannot be resolved. (patch [8ad8a057](https://github.com/appsignal/appsignal-ruby/commit/8ad8a05787dcb12a5c7febc64559e7f145a59096))
+
 ## 3.13.0
 
 _Published on 2024-08-14._

data/README.md

@@ -42,7 +42,7 @@ request.
 begin
   config = File.read("config.yml")
 rescue => e
-  Appsignal.set_error(e)
+  Appsignal.report_error(e)
   # Load alternative config
   config = { :name => ENV["NAME"] }
 end
@@ -56,9 +56,9 @@ Need more information with errors and performance issues? Add tags to your
 requests to identify common factors for problems.
 
 ```ruby
-Appsignal.tag_request(
-  user: current_user.id,
-  locale: I18n.locale
+Appsignal.add_tags(
+  :user => current_user.id,
+  :locale => I18n.locale
 )
 ```
 
@@ -143,11 +143,6 @@ anything.
 For more detailed information and examples please visit our
 [integrations] page.
 
-### Front-end monitoring (Beta)
-
-We have a [Front-end monitoring program][front-end-monitoring] running in Beta
-currently. Be sure to check it out!
-
 ## Supported systems
 
 Currently the AppSignal agent works on most Unix-like operating systems, such
@@ -304,11 +299,11 @@ Also see our [SUPPORT.md file](SUPPORT.md).
 [ruby-doc]: https://www.rubydoc.info/gems/appsignal
 [contributing-guide]: https://docs.appsignal.com/appsignal/contributing.html
 [supported-systems]: https://docs.appsignal.com/support/operating-systems.html
-[integrations]: https://docs.appsignal.com/ruby/integrations/index.html
-[custom-instrumentation]: https://docs.appsignal.com/ruby/instrumentation/
-[front-end-monitoring]: https://docs.appsignal.com/front-end/error-handling.html
+[integrations]: https://docs.appsignal.com/ruby/integrations.html
+[custom-instrumentation]: https://docs.appsignal.com/ruby/instrumentation.html
+[front-end-monitoring]: https://docs.appsignal.com/front-end.html
 [exception-handling]: https://docs.appsignal.com/ruby/instrumentation/exception-handling.html
-[tagging]: https://docs.appsignal.com/ruby/instrumentation/tagging.html
+[tagging]: https://docs.appsignal.com/guides/custom-data/tagging-request.html
 [host-metrics]: https://docs.appsignal.com/metrics/host.html
 [custom-metrics]: https://docs.appsignal.com/metrics/custom.html
 

data/benchmark.rake

@@ -65,10 +65,11 @@ def start_agent
 end
 
 def monitor_transaction(transaction_id)
-  transaction = Appsignal::Transaction.create(
-    transaction_id,
-    Appsignal::Transaction::HTTP_REQUEST
+  transaction = Appsignal::Transaction.new(
+    Appsignal::Transaction::HTTP_REQUEST,
+    :id => transaction_id
   )
+  Appsignal::Transaction.set_current_transaction(transaction)
   transaction.set_action("HomeController#show")
   transaction.add_params(:id => 1)
 

data/lib/appsignal/helpers/instrumentation.rb

@@ -88,6 +88,7 @@ module Appsignal
       #     end
       #   end
       #
+      # @since 3.11.0
       # @param namespace [String/Symbol] The namespace to set on the new
       #   transaction.
       #   Defaults to the 'web' namespace.
@@ -105,10 +106,10 @@ module Appsignal
       # @raise [Exception] Any exception that occurs within the given block is
       #   re-raised by this method.
       # @return [Object] The value of the given block is returned.
-      # @since 3.11.0
-      def monitor(
-        action:, namespace: nil
-      )
+      #
+      # @see https://docs.appsignal.com/ruby/instrumentation/background-jobs.html
+      #   Monitor guide
+      def monitor(action:, namespace: nil)
         return yield unless active?
 
         has_parent_transaction = Appsignal::Transaction.current?
@@ -160,6 +161,8 @@ module Appsignal
 
       # Send an error to AppSignal regardless of the context.
       #
+      # **We recommend using the {#report_error} helper instead.**
+      #
       # Records and send the exception to AppSignal.
       #
       # This instrumentation helper does not require a transaction to be
@@ -186,6 +189,7 @@ module Appsignal
       #     Appsignal.add_tags(:key => "value")
       #   end
       #
+      # @since 0.6.0
       # @param error [Exception] The error to send to AppSignal.
       # @yield [transaction] yields block to allow modification of the
       #   transaction before it's send.
@@ -193,12 +197,8 @@ module Appsignal
       #   used to send the error.
       # @return [void]
       #
-      # @see Transaction#report_error
       # @see https://docs.appsignal.com/ruby/instrumentation/exception-handling.html
       #   Exception handling guide
-      # @see https://docs.appsignal.com/ruby/instrumentation/tagging.html
-      #   Tagging guide
-      # @since 0.6.0
       def send_error(error, &block)
         return unless active?
 
@@ -208,10 +208,8 @@ module Appsignal
           return
         end
 
-        transaction = Appsignal::Transaction.new(
-          SecureRandom.uuid,
-          Appsignal::Transaction::HTTP_REQUEST
-        )
+        transaction =
+          Appsignal::Transaction.new(Appsignal::Transaction::HTTP_REQUEST)
         transaction.set_error(error, &block)
 
         transaction.complete
@@ -220,6 +218,8 @@ module Appsignal
 
       # Set an error on the current transaction.
       #
+      # **We recommend using the {#report_error} helper instead.**
+      #
       # **Note**: Does not do anything if AppSignal is not active, no
       # transaction is currently active or when the "error" is not a class
       # extended from Ruby's Exception class.
@@ -253,6 +253,7 @@ module Appsignal
       #     Appsignal.add_tags(:key => "value")
       #   end
       #
+      # @since 0.6.6
       # @param exception [Exception] The error to add to the current
       #   transaction.
       # @yield [transaction] yields block to allow modification of the
@@ -261,11 +262,8 @@ module Appsignal
       #   used to store the error.
       # @return [void]
       #
-      # @see Transaction#set_error
-      # @see Transaction#report_error
       # @see https://docs.appsignal.com/ruby/instrumentation/exception-handling.html
       #   Exception handling guide
-      # @since 0.6.6
       def set_error(exception)
         unless exception.is_a?(Exception)
           internal_logger.error "Appsignal.set_error: Cannot set error. " \
@@ -281,12 +279,21 @@ module Appsignal
       alias :set_exception :set_error
       alias :add_exception :set_error
 
-      # Report an error.
+      # Report an error to AppSignal.
       #
       # If a transaction is currently active, it will report the error on the
       # current transaction. If no transaction is active, it will report the
       # error on a new transaction.
       #
+      # If a transaction is active and the transaction already has an error
+      # reported on it, it will report multiple errors, up to a maximum of 10
+      # errors.
+      #
+      # If a block is given to this method, the metadata set in this block will
+      # only be applied to the transaction created for the given error. The
+      # block will be called when the transaction is completed, which can be
+      # much later than when {#report_error} is called.
+      #
       # **Note**: If AppSignal is not active, no error is reported.
       #
       # **Note**: If the given exception argument is not an Exception subclass,
@@ -309,6 +316,7 @@ module Appsignal
       #     Appsignal.add_tags(:key => "value")
       #   end
       #
+      # @since 4.0.0
       # @param exception [Exception] The error to add to the current
       #   transaction.
       # @yield [transaction] yields block to allow modification of the
@@ -319,7 +327,6 @@ module Appsignal
       #
       # @see https://docs.appsignal.com/ruby/instrumentation/exception-handling.html
       #   Exception handling guide
-      # @since 3.10.0
       def report_error(exception, &block)
         unless exception.is_a?(Exception)
           internal_logger.error "Appsignal.report_error: Cannot add error. " \
@@ -333,10 +340,7 @@ module Appsignal
           if has_parent_transaction
             Appsignal::Transaction.current
           else
-            Appsignal::Transaction.new(
-              SecureRandom.uuid,
-              Appsignal::Transaction::HTTP_REQUEST
-            )
+            Appsignal::Transaction.new(Appsignal::Transaction::HTTP_REQUEST)
           end
 
         transaction.add_error(exception, &block)
@@ -363,10 +367,9 @@ module Appsignal
       #     end
       #   end
       #
+      # @since 2.2.0
       # @param action [String]
       # @return [void]
-      # @see Transaction#set_action
-      # @since 2.2.0
       def set_action(action)
         return if !active? ||
           !Appsignal::Transaction.current? ||
@@ -403,10 +406,12 @@ module Appsignal
       #     end
       #   end
       #
+      # @since 2.2.0
       # @param namespace [String]
       # @return [void]
-      # @see Transaction#set_namespace
-      # @since 2.2.0
+      #
+      # @see https://docs.appsignal.com/guides/namespaces.html
+      #   Grouping with namespaces guide
       def set_namespace(namespace)
         return if !active? ||
           !Appsignal::Transaction.current? ||
@@ -452,7 +457,6 @@ module Appsignal
       # @param data [Hash/Array] Custom data to add to the transaction.
       # @return [void]
       #
-      # @see Transaction#add_custom_data
       # @see https://docs.appsignal.com/guides/custom-data/sample-data.html
       #   Sample data guide
       def add_custom_data(data)
@@ -497,7 +501,6 @@ module Appsignal
       #   The name of the tag as a String.
       # @return [void]
       #
-      # @see Transaction#add_tags
       # @see https://docs.appsignal.com/ruby/instrumentation/tagging.html
       #   Tagging guide
       def add_tags(tags = {})
@@ -542,7 +545,6 @@ module Appsignal
       #   Sample data guide
       # @see https://docs.appsignal.com/guides/filter-data/filter-parameters.html
       #   Parameter filtering guide
-      # @see Transaction#add_params
       def add_params(params = nil, &block)
         return unless active?
         return unless Appsignal::Transaction.current?
@@ -552,6 +554,21 @@ module Appsignal
       end
       alias :set_params :add_params
 
+      # Mark the parameters sample data to be set as an empty value.
+      #
+      # @api private
+      # @since 4.0.0
+      # @return [void]
+      #
+      # @see Helpers::Instrumentation#set_empty_params!
+      def set_empty_params!
+        return unless active?
+        return unless Appsignal::Transaction.current?
+
+        transaction = Appsignal::Transaction.current
+        transaction.set_empty_params!
+      end
+
       # Add session data to the current transaction.
       #
       # Session data is automatically added by most of our integrations. It
@@ -584,7 +601,6 @@ module Appsignal
       #   Sample data guide
       # @see https://docs.appsignal.com/guides/filter-data/filter-session-data.html
       #   Session data filtering guide
-      # @see Transaction#add_session_data
       def add_session_data(session_data = nil, &block)
         return unless active?
         return unless Appsignal::Transaction.current?
@@ -626,7 +642,6 @@ module Appsignal
       #   Sample data guide
       # @see https://docs.appsignal.com/guides/filter-data/filter-headers.html
       #   Request headers filtering guide
-      # @see Transaction#add_headers
       def add_headers(headers = nil, &block)
         return unless active?
         return unless Appsignal::Transaction.current?
@@ -663,6 +678,7 @@ module Appsignal
       #     "User closed modal without actions"
       #   )
       #
+      # @since 2.12.0
       # @param category [String] category of breadcrumb
       #   e.g. "UI", "Network", "Navigation", "Console".
       # @param action [String] name of breadcrumb
@@ -672,10 +688,8 @@ module Appsignal
       # @option time [Time] time of breadcrumb, should respond to `.to_i` defaults to `Time.now.utc`
       # @return [void]
       #
-      # @see Transaction#add_breadcrumb
       # @see https://docs.appsignal.com/ruby/instrumentation/breadcrumbs.html
       #   Breadcrumb reference
-      # @since 2.12.0
       def add_breadcrumb(category, action, message = "", metadata = {}, time = Time.now.utc)
         return unless active?
         return unless Appsignal::Transaction.current?
@@ -703,6 +717,7 @@ module Appsignal
       #     # To be instrumented code
       #   end
       #
+      # @since 1.3.0
       # @param name [String] Name of the instrumented event. Read our event
       #   naming guide listed under "See also".
       # @param title [String, nil] Human readable name of the event.
@@ -716,13 +731,11 @@ module Appsignal
       #   event.
       # @return [Object] Returns the block's return value.
       #
-      # @see Appsignal::Transaction#instrument
       # @see .instrument_sql
       # @see https://docs.appsignal.com/ruby/instrumentation/instrumentation.html
       #   AppSignal custom instrumentation guide
       # @see https://docs.appsignal.com/api/event-names.html
       #   AppSignal event naming guide
-      # @since 1.3.0
       def instrument(
         name,
         title = nil,
@@ -750,6 +763,7 @@ module Appsignal
       #     # query value will replace 'foo..' with a question mark `?`.
       #   end
       #
+      # @since 2.0.0
       # @param name [String] Name of the instrumented event. Read our event
       #   naming guide listed under "See also".
       # @param title [String, nil] Human readable name of the event.
@@ -763,7 +777,6 @@ module Appsignal
       #   AppSignal custom instrumentation guide
       # @see https://docs.appsignal.com/api/event-names.html
       #   AppSignal event naming guide
-      # @since 2.0.0
       def instrument_sql(name, title = nil, body = nil, &block)
         instrument(
           name,
@@ -796,9 +809,10 @@ module Appsignal
       #
       #   # Only the "my_event.my_group" instrumentation event is reported.
       #
+      # @since 3.10.0
       # @yield block of code that shouldn't be instrumented.
       # @return [Object] Returns the return value of the block.
-      # @since 3.10.0
+      #
       # @see https://docs.appsignal.com/ruby/instrumentation/ignore-instrumentation.html
       #   Ignore instrumentation guide
       def ignore_instrumentation_events

data/lib/appsignal/helpers/metrics.rb

@@ -3,37 +3,70 @@
 module Appsignal
   module Helpers
     module Metrics
-      def set_gauge(key, value, tags = {})
+      # Report a gauge metric.
+      #
+      # @since 2.6.0
+      # @param name [String, Symbol] The name of the metric.
+      # @param value [Integer, Float] The value of the metric.
+      # @param tags [Hash] The tags for the metric. The Hash keys can be either
+      #   a String or a Symbol. The tag values can be a String, Symbol,
+      #   Integer, Float, TrueClass or FalseClass.
+      #
+      # @see https://docs.appsignal.com/metrics/custom.html
+      #   Metrics documentation
+      def set_gauge(name, value, tags = {})
         Appsignal::Extension.set_gauge(
-          key.to_s,
+          name.to_s,
           value.to_f,
           Appsignal::Utils::Data.generate(tags)
         )
       rescue RangeError
         Appsignal.internal_logger
-          .warn("Gauge value #{value} for key '#{key}' is too big")
+          .warn("The gauge value '#{value}' for metric '#{name}' is too big")
       end
 
-      def increment_counter(key, value = 1.0, tags = {})
+      # Report a counter metric.
+      #
+      # @since 2.6.0
+      # @param name [String, Symbol] The name of the metric.
+      # @param value [Integer, Float] The value of the metric.
+      # @param tags [Hash] The tags for the metric. The Hash keys can be either
+      #   a String or a Symbol. The tag values can be a String, Symbol,
+      #   Integer, Float, TrueClass or FalseClass.
+      #
+      # @see https://docs.appsignal.com/metrics/custom.html
+      #   Metrics documentation
+      def increment_counter(name, value = 1.0, tags = {})
         Appsignal::Extension.increment_counter(
-          key.to_s,
+          name.to_s,
           value.to_f,
           Appsignal::Utils::Data.generate(tags)
         )
       rescue RangeError
         Appsignal.internal_logger
-          .warn("Counter value #{value} for key '#{key}' is too big")
+          .warn("The counter value '#{value}' for metric '#{name}' is too big")
       end
 
-      def add_distribution_value(key, value, tags = {})
+      # Report a distribution metric.
+      #
+      # @since 2.6.0
+      # @param name [String, Symbol] The name of the metric.
+      # @param value [Integer, Float] The value of the metric.
+      # @param tags [Hash] The tags for the metric. The Hash keys can be either
+      #   a String or a Symbol. The tag values can be a String, Symbol,
+      #   Integer, Float, TrueClass or FalseClass.
+      #
+      # @see https://docs.appsignal.com/metrics/custom.html
+      #   Metrics documentation
+      def add_distribution_value(name, value, tags = {})
         Appsignal::Extension.add_distribution_value(
-          key.to_s,
+          name.to_s,
           value.to_f,
           Appsignal::Utils::Data.generate(tags)
         )
       rescue RangeError
         Appsignal.internal_logger
-          .warn("Distribution value #{value} for key '#{key}' is too big")
+          .warn("The distribution value '#{value}' for metric '#{name}' is too big")
       end
     end
   end

data/lib/appsignal/rack/body_wrapper.rb

@@ -4,6 +4,8 @@ module Appsignal
   module Rack
     # @api private
     class BodyWrapper
+      IGNORED_ERRORS = [Errno::EPIPE].freeze
+
       def self.wrap(original_body, appsignal_transaction)
         # The logic of how Rack treats a response body differs based on which methods
         # the body responds to. This means that to support the Rack 3.x spec in full
@@ -49,6 +51,8 @@ module Appsignal
           Appsignal.instrument("close_response_body.rack") { @body.close }
         end
         @body_already_closed = true
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error
@@ -75,6 +79,8 @@ module Appsignal
         Appsignal.instrument("process_response_body.rack", "Process Rack response body (#each)") do
           @body.each(&blk)
         end
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error
@@ -94,6 +100,8 @@ module Appsignal
         Appsignal.instrument("process_response_body.rack", "Process Rack response body (#call)") do
           @body.call(stream)
         end
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error
@@ -118,6 +126,8 @@ module Appsignal
         ) do
           @body.to_ary
         end
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error
@@ -134,6 +144,8 @@ module Appsignal
         ) do
           @body.to_path
         end
+      rescue *IGNORED_ERRORS # Do not report
+        raise
       rescue Exception => error # rubocop:disable Lint/RescueException
         @transaction.set_error(error)
         raise error

data/lib/appsignal/sample_data.rb

@@ -7,9 +7,11 @@ module Appsignal
       @key = key
       @accepted_type = accepted_type
       @blocks = []
+      @empty = false
     end
 
     def add(data = nil, &block)
+      @empty = false
       if block_given?
         @blocks << block
       elsif accepted_type?(data)
@@ -19,6 +21,12 @@ module Appsignal
       end
     end
 
+    # @api private
+    def set_empty_value!
+      @empty = true
+      @blocks.clear
+    end
+
     def value
       value = nil
       @blocks.map! do |block_or_value|
@@ -44,6 +52,11 @@ module Appsignal
       @blocks.any?
     end
 
+    # @api private
+    def empty?
+      @empty
+    end
+
     protected
 
     attr_reader :blocks

data/lib/appsignal/transaction.rb

@@ -30,9 +30,7 @@ module Appsignal
         # Check if we already have a running transaction
         if Thread.current[:appsignal_transaction].nil?
           # If not, start a new transaction
-          set_current_transaction(
-            Appsignal::Transaction.new(SecureRandom.uuid, namespace)
-          )
+          set_current_transaction(Appsignal::Transaction.new(namespace))
         else
           # Otherwise, log the issue about trying to start another transaction
           Appsignal.internal_logger.warn(
@@ -109,24 +107,22 @@ module Appsignal
     end
 
     # @api private
-    attr_reader :ext, :transaction_id, :action, :namespace, :request, :paused, :tags, :options,
-      :breadcrumbs, :is_duplicate, :error_blocks
+    attr_reader :transaction_id, :action, :namespace
 
     # Use {.create} to create new transactions.
     #
-    # @param transaction_id [String] ID of the to be created transaction.
     # @param namespace [String] Namespace of the to be created transaction.
     # @see create
     # @api private
-    def initialize(transaction_id, namespace, ext: nil)
-      @transaction_id = transaction_id
+    def initialize(namespace, id: SecureRandom.uuid, ext: nil)
+      @transaction_id = id
       @action = nil
       @namespace = namespace
       @paused = false
       @discarded = false
       @tags = {}
       @breadcrumbs = []
-      @store = Hash.new({})
+      @store = Hash.new { |hash, key| hash[key] = {} }
       @error_blocks = Hash.new { |hash, key| hash[key] = [] }
       @is_duplicate = false
       @error_set = nil
@@ -143,10 +139,17 @@ module Appsignal
       ) || Appsignal::Extension::MockTransaction.new
     end
 
+    # @api private
+    def duplicate?
+      @is_duplicate
+    end
+
+    # @api private
     def nil_transaction?
       false
     end
 
+    # @api private
     def complete
       if discarded?
         Appsignal.internal_logger.debug "Skipping transaction '#{transaction_id}' " \
@@ -161,9 +164,9 @@ module Appsignal
       # create duplicates for errors, which are always sampled.
       should_sample = true
 
-      unless is_duplicate
+      unless duplicate?
         self.class.last_errors = @error_blocks.keys
-        should_sample = ext.finish(0)
+        should_sample = @ext.finish(0)
       end
 
       @error_blocks.each do |error, blocks|
@@ -190,7 +193,7 @@ module Appsignal
         end
       end
       sample_data if should_sample
-      ext.complete
+      @ext.complete
     end
 
     # @api private
@@ -240,12 +243,24 @@ module Appsignal
     # @yield This block is called when the transaction is sampled. The block's
     #   return value will become the new parameters.
     # @return [void]
+    #
     # @see Helpers::Instrumentation#add_params
+    # @see https://docs.appsignal.com/guides/custom-data/sample-data.html
+    #   Sample data guide
     def add_params(given_params = nil, &block)
       @params.add(given_params, &block)
     end
     alias :set_params :add_params
 
+    # @api private
+    # @since 4.0.0
+    # @return [void]
+    #
+    # @see Helpers::Instrumentation#set_empty_params!
+    def set_empty_params!
+      @params.set_empty_value!
+    end
+
     # Add parameters to the transaction if not already set.
     #
     # @api private
@@ -257,7 +272,7 @@ module Appsignal
     #
     # @see #add_params
     def add_params_if_nil(given_params = nil, &block)
-      add_params(given_params, &block) unless @params.value?
+      add_params(given_params, &block) if !@params.value? && !@params.empty?
     end
     alias :set_params_if_nil :add_params_if_nil
 
@@ -265,6 +280,7 @@ module Appsignal
     #
     # When this method is called multiple times, it will merge the tags.
     #
+    # @since 4.0.0
     # @param given_tags [Hash] Collection of tags.
     # @option given_tags [String, Symbol, Integer] :any
     #   The name of the tag as a Symbol.
@@ -278,7 +294,7 @@ module Appsignal
     def add_tags(given_tags = {})
       @tags.merge!(given_tags)
     end
-    alias :set_tags add_tags
+    alias :set_tags :add_tags
 
     # Add session data to the transaction.
     #
@@ -287,12 +303,12 @@ module Appsignal
     # When both the `given_session_data` and a block is given to this method,
     # the block is leading and the argument will _not_ be used.
     #
+    # @since 4.0.0
     # @param given_session_data [Hash] A hash containing session data.
     # @yield This block is called when the transaction is sampled. The block's
     #   return value will become the new session data.
     # @return [void]
     #
-    # @since 4.0.0
     # @see Helpers::Instrumentation#add_session_data
     # @see https://docs.appsignal.com/guides/custom-data/sample-data.html
     #   Sample data guide
@@ -307,13 +323,13 @@ module Appsignal
     # the `given_session_data` argument is leading and the block will _not_ be
     # called.
     #
+    # @api private
+    # @since 4.0.0
     # @param given_session_data [Hash] A hash containing session data.
     # @yield This block is called when the transaction is sampled. The block's
     #   return value will become the new session data.
     # @return [void]
     #
-    # @api private
-    # @since 4.0.0
     # @see #add_session_data
     # @see https://docs.appsignal.com/guides/custom-data/sample-data.html
     #   Sample data guide
@@ -324,12 +340,12 @@ module Appsignal
 
     # Add headers to the transaction.
     #
+    # @since 4.0.0
     # @param given_headers [Hash] A hash containing headers.
     # @yield This block is called when the transaction is sampled. The block's
     #   return value will become the new headers.
     # @return [void]
     #
-    # @since 4.0.0
     # @see Helpers::Instrumentation#add_headers
     # @see https://docs.appsignal.com/guides/custom-data/sample-data.html
     #   Sample data guide
@@ -343,13 +359,13 @@ module Appsignal
     # When both the `given_headers` and a block is given to this method,
     # the block is leading and the argument will _not_ be used.
     #
+    # @api private
+    # @since 4.0.0
     # @param given_headers [Hash] A hash containing headers.
     # @yield This block is called when the transaction is sampled. The block's
     #   return value will become the new headers.
     # @return [void]
     #
-    # @api private
-    # @since 4.0.0
     # @see #add_headers
     # @see https://docs.appsignal.com/guides/custom-data/sample-data.html
     #   Sample data guide
@@ -361,11 +377,12 @@ module Appsignal
     # Add custom data to the transaction.
     #
     # @since 4.0.0
+    # @param data [Hash/Array]
+    # @return [void]
+    #
     # @see Helpers::Instrumentation#add_custom_data
     # @see https://docs.appsignal.com/guides/custom-data/sample-data.html
     #   Sample data guide
-    # @param data [Hash/Array]
-    # @return [void]
     def add_custom_data(data)
       @custom_data.add(data)
     end
@@ -407,11 +424,11 @@ module Appsignal
     # An action name is used to identify the location of a certain sample;
     # error and performance issues.
     #
+    # @since 2.2.0
     # @param action [String] the action name to set.
     # @return [void]
-    # @see Appsignal.set_action
-    # @see #set_action_if_nil
-    # @since 2.2.0
+    #
+    # @see Appsignal::Helpers::Instrumentation#set_action
     def set_action(action)
       return unless action
 
@@ -429,10 +446,12 @@ module Appsignal
     #   Appsignal.set_action_if_nil("bar")
     #   # Transaction action will be "foo"
     #
+    # @api private
+    # @since 2.2.0
     # @param action [String]
     # @return [void]
+    #
     # @see #set_action
-    # @since 2.2.0
     def set_action_if_nil(action)
       return if @action
 
@@ -451,9 +470,13 @@ module Appsignal
     # @example
     #   transaction.set_namespace("background")
     #
+    # @since 2.2.0
     # @param namespace [String] namespace name to use for this transaction.
     # @return [void]
-    # @since 2.2.0
+    #
+    # @see Appsignal::Helpers::Instrumentation#set_namespace
+    # @see https://docs.appsignal.com/guides/namespaces.html
+    #   Grouping with namespaces guide
     def set_namespace(namespace)
       return unless namespace
 
@@ -485,7 +508,8 @@ module Appsignal
       @ext.set_metadata(key, value)
     end
 
-    # @see Appsignal::Helpers::Instrumentation#add_error
+    # @api private
+    # @see Appsignal::Helpers::Instrumentation#report_error
     def add_error(error, &block)
       unless error.is_a?(Exception)
         Appsignal.internal_logger.error "Appsignal::Transaction#add_error: Cannot add error. " \
@@ -508,21 +532,19 @@ module Appsignal
       @error_blocks[error] << block
       @error_blocks[error].compact!
     end
-
     alias :set_error :add_error
-
     alias_method :add_exception, :add_error
 
-    # @see Helpers::Instrumentation#instrument
     # @api private
+    # @see Helpers::Instrumentation#instrument
     def start_event
       return if paused?
 
       @ext.start_event(0)
     end
 
-    # @see Helpers::Instrumentation#instrument
     # @api private
+    # @see Helpers::Instrumentation#instrument
     def finish_event(name, title, body, body_format = Appsignal::EventFormatter::DEFAULT)
       return if paused?
 
@@ -535,8 +557,8 @@ module Appsignal
       )
     end
 
-    # @see Helpers::Instrumentation#instrument
     # @api private
+    # @see Helpers::Instrumentation#instrument
     def record_event(name, title, body, duration, body_format = Appsignal::EventFormatter::DEFAULT)
       return if paused?
 
@@ -550,6 +572,7 @@ module Appsignal
       )
     end
 
+    # @api private
     # @see Helpers::Instrumentation#instrument
     def instrument(name, title = nil, body = nil, body_format = Appsignal::EventFormatter::DEFAULT)
       start_event
@@ -566,10 +589,13 @@ module Appsignal
 
     protected
 
-    attr_writer :is_duplicate, :tags, :custom_data, :breadcrumbs, :params, :session_data, :headers
+    attr_writer :is_duplicate, :tags, :custom_data, :breadcrumbs, :params,
+      :session_data, :headers
 
     private
 
+    attr_reader :breadcrumbs
+
     def _set_error(error)
       backtrace = cleaned_backtrace(error.backtrace)
       @ext.set_error(
@@ -655,11 +681,10 @@ module Appsignal
 
     def duplicate
       new_transaction_id = SecureRandom.uuid
-
       self.class.new(
-        new_transaction_id,
         namespace,
-        :ext => ext.duplicate(new_transaction_id)
+        :id => new_transaction_id,
+        :ext => @ext.duplicate(new_transaction_id)
       ).tap do |transaction|
         transaction.is_duplicate = true
         transaction.tags = @tags.dup
@@ -671,7 +696,6 @@ module Appsignal
       end
     end
 
-    # @api private
     def params
       @params.value
     rescue => e

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "4.0.0.beta.1"
+  VERSION = "4.0.0"
 end

data/lib/appsignal.rb

@@ -44,6 +44,7 @@ module Appsignal
     # @see Extension
     # @see extension_loaded?
     attr_accessor :extension_loaded
+
     # @!attribute [rw] internal_logger
     #   Accessor for the internal AppSignal logger.
     #

data/spec/lib/appsignal/cli/diagnose_spec.rb

@@ -937,6 +937,13 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
                     "      loaders: \"MyApp\"\n" \
                     "      file:    \"TestApp\"\n"
                 )
+                # Outputs values from the DSL
+                expect(output).to include(
+                  "  ignore_actions: [\"Action from DSL\"]\n" \
+                    "    Sources:\n" \
+                    "      default: []\n" \
+                    "      dsl:     [\"Action from DSL\"]\n"
+                )
 
                 expect(received_report["app"]["rails"]).to be(true)
                 expect(received_report["config"]["sources"]).to include(
@@ -947,6 +954,12 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
                     "name" => "MyApp"
                   }
                 )
+                # Includes values from the DSL
+                expect(received_report["config"]["sources"]).to include(
+                  "dsl" => {
+                    "ignore_actions" => ["Action from DSL"]
+                  }
+                )
               end
 
               context "when there's a problem loading the app" do
@@ -963,7 +976,6 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
                       "ExampleStandardError: error message"
                   )
 
-                  pp received_report["app"]
                   expect(received_report["app"]["load_error"])
                     .to eq("ExampleStandardError: error message\nline 1\nline 2")
                 end

data/spec/lib/appsignal/rack/body_wrapper_spec.rb

@@ -72,6 +72,18 @@ describe Appsignal::Rack::BodyWrapper do
       expect(transaction).to have_error("ExampleException", "error message")
     end
 
+    it "doesn't report EPIPE error" do
+      fake_body = double
+      expect(fake_body).to receive(:each).once.and_raise(Errno::EPIPE)
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(Errno::EPIPE)
+
+      expect(transaction).to_not have_error
+    end
+
     it "closes the body and tracks an instrumentation event when it gets closed" do
       fake_body = double(:close => nil)
       expect(fake_body).to receive(:each).once.and_yield("a").and_yield("b").and_yield("c")
@@ -134,6 +146,17 @@ describe Appsignal::Rack::BodyWrapper do
       expect(transaction).to have_error("ExampleException", "error message")
     end
 
+    it "doesn't report EPIPE error" do
+      expect(fake_body).to receive(:each).once.and_raise(Errno::EPIPE)
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        expect { |b| wrapped.each(&b) }.to yield_control
+      end.to raise_error(Errno::EPIPE)
+
+      expect(transaction).to_not have_error
+    end
+
     it "reads out the body in full using to_ary" do
       expect(fake_body).to receive(:to_ary).and_return(["one", "two", "three"])
 
@@ -207,6 +230,17 @@ describe Appsignal::Rack::BodyWrapper do
       expect(transaction).to have_error("ExampleException", "error message")
     end
 
+    it "doesn't report EPIPE error" do
+      expect(fake_body).to receive(:to_path).once.and_raise(Errno::EPIPE)
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        wrapped.to_path
+      end.to raise_error(Errno::EPIPE)
+
+      expect(transaction).to_not have_error
+    end
+
     it "exposes to_path to the sender" do
       allow(fake_body).to receive(:to_path).and_return("/tmp/file.bin")
 
@@ -259,5 +293,19 @@ describe Appsignal::Rack::BodyWrapper do
 
       expect(transaction).to have_error("ExampleException", "error message")
     end
+
+    it "doesn't report EPIPE error" do
+      fake_rack_stream = double
+      expect(fake_body).to receive(:call)
+        .with(fake_rack_stream)
+        .and_raise(Errno::EPIPE)
+
+      wrapped = described_class.wrap(fake_body, transaction)
+      expect do
+        wrapped.call(fake_rack_stream)
+      end.to raise_error(Errno::EPIPE)
+
+      expect(transaction).to_not have_error
+    end
   end
 end

data/spec/lib/appsignal/sample_data_spec.rb

@@ -142,6 +142,45 @@ describe Appsignal::SampleData do
     end
   end
 
+  describe "#set_empty_value!" do
+    it "clears the set values" do
+      data.add(["abc"])
+      data.add(["def"])
+      data.set_empty_value!
+
+      expect(data.value).to be_nil
+    end
+
+    it "allows values to be added afterwards" do
+      data.add(["abc"])
+      data.set_empty_value!
+
+      expect(data.value).to be_nil
+
+      data.add(["def"])
+      expect(data.value).to eq(["def"])
+    end
+  end
+
+  describe "#cleared?" do
+    it "returns false if not cleared" do
+      expect(data.empty?).to be(false)
+    end
+
+    it "returns true if cleared" do
+      data.set_empty_value!
+
+      expect(data.empty?).to be(true)
+    end
+
+    it "returns false if cleared and then new values were added" do
+      data.set_empty_value!
+      data.add(["abc"])
+
+      expect(data.empty?).to be(false)
+    end
+  end
+
   describe "#duplicate" do
     it "duplicates the internal Hash state without modifying the original" do
       data = described_class.new(:my_key, Hash)

data/spec/lib/appsignal/transaction_spec.rb

@@ -39,7 +39,7 @@ describe Appsignal::Transaction do
       let(:ext) { "some_ext" }
 
       it "assigns the extension transaction to the transaction" do
-        expect(new_transaction(:ext => ext).ext).to be(ext)
+        expect(described_class.new("web", :ext => ext).ext).to be(ext)
       end
     end
 
@@ -338,11 +338,11 @@ describe Appsignal::Transaction do
           expect(original_transaction.ext).to_not eq(duplicate_transaction.ext)
         end
 
-        it "sets is_duplicate set to true on the duplicate transaction" do
+        it "marks transaction as duplicate on the duplicate transaction" do
           original_transaction, duplicate_transaction = created_transactions
 
-          expect(original_transaction.is_duplicate).to be(false)
-          expect(duplicate_transaction.is_duplicate).to be(true)
+          expect(original_transaction.duplicate?).to be(false)
+          expect(duplicate_transaction.duplicate?).to be(true)
         end
       end
 
@@ -517,7 +517,7 @@ describe Appsignal::Transaction do
       it "changes the pause flag to true" do
         expect do
           transaction.pause!
-        end.to change(transaction, :paused).from(false).to(true)
+        end.to change(transaction, :paused?).from(false).to(true)
       end
     end
 
@@ -527,7 +527,7 @@ describe Appsignal::Transaction do
       it "changes the pause flag to false" do
         expect do
           transaction.resume!
-        end.to change(transaction, :paused).from(true).to(false)
+        end.to change(transaction, :paused?).from(true).to(false)
       end
     end
 
@@ -590,6 +590,13 @@ describe Appsignal::Transaction do
 
       expect(transaction.store("test")).to eql("transaction" => "value")
     end
+
+    it "has a default value of a Hash for store values" do
+      transaction.store("abc")["def"] = "123"
+
+      expect(transaction.store("abc")).to eq("def" => "123")
+      expect(transaction.store("xyz")).to eq({})
+    end
   end
 
   describe "#add_params" do
@@ -732,6 +739,17 @@ describe Appsignal::Transaction do
         expect(transaction).to include_params(preset_params)
       end
     end
+
+    context "when the params were set as an empty value" do
+      it "does not set params on the transaction" do
+        transaction.add_params("key1" => "value")
+        transaction.set_empty_params!
+        transaction.add_params_if_nil("key2" => "value")
+
+        transaction._sample
+        expect(transaction).to_not include_params
+      end
+    end
   end
 
   describe "#add_session_data" do

data/spec/lib/appsignal_spec.rb

@@ -935,6 +935,23 @@ describe Appsignal do
       end
     end
 
+    describe ".set_empty_params!" do
+      before { start_agent }
+
+      context "with transaction" do
+        let(:transaction) { http_request_transaction }
+        before { set_current_transaction(transaction) }
+
+        it "marks parameters to be sent as an empty value" do
+          Appsignal.add_params("key1" => "value")
+          Appsignal.set_empty_params!
+
+          transaction._sample
+          expect(transaction).to_not include_params
+        end
+      end
+    end
+
     describe ".add_session_data" do
       before { start_agent }
 
@@ -1140,7 +1157,7 @@ describe Appsignal do
             Appsignal::Extension.data_map_new
           ).and_raise(RangeError)
           expect(Appsignal.internal_logger).to receive(:warn)
-            .with("Gauge value 10 for key 'key' is too big")
+            .with("The gauge value '10' for metric 'key' is too big")
 
           Appsignal.set_gauge("key", 10)
         end
@@ -1175,7 +1192,7 @@ describe Appsignal do
           expect(Appsignal::Extension).to receive(:increment_counter)
             .with("key", 10, Appsignal::Extension.data_map_new).and_raise(RangeError)
           expect(Appsignal.internal_logger).to receive(:warn)
-            .with("Counter value 10 for key 'key' is too big")
+            .with("The counter value '10' for metric 'key' is too big")
 
           Appsignal.increment_counter("key", 10)
         end
@@ -1204,7 +1221,7 @@ describe Appsignal do
           expect(Appsignal::Extension).to receive(:add_distribution_value)
             .with("key", 10, Appsignal::Extension.data_map_new).and_raise(RangeError)
           expect(Appsignal.internal_logger).to receive(:warn)
-            .with("Distribution value 10 for key 'key' is too big")
+            .with("The distribution value '10' for metric 'key' is too big")
 
           Appsignal.add_distribution_value("key", 10)
         end

data/spec/support/fixtures/projects/valid_with_rails_app/config/environment.rb

@@ -3,3 +3,8 @@ require_relative "application"
 
 # Initialize the Rails application.
 MyApp::Application.initialize!
+
+# Asserted from the diagnose spec
+Appsignal.configure do |config|
+  config.ignore_actions = ["Action from DSL"]
+end

data/spec/support/helpers/transaction_helpers.rb

@@ -16,7 +16,7 @@ module TransactionHelpers
   end
 
   def new_transaction(namespace = default_namespace, ext: nil)
-    Appsignal::Transaction.new(SecureRandom.uuid, namespace, :ext => ext)
+    Appsignal::Transaction.new(namespace, :ext => ext)
   end
 
   def rack_request(env)

data/spec/support/testing.rb

@@ -167,6 +167,10 @@ end
 module AppsignalTest
   module Transaction
     module ClassMethods
+      def self.extended(base)
+        base.attr_reader :ext, :error_blocks
+      end
+
       # Override the {Appsignal::Transaction.new} method so we can track which
       # transactions are created on the {Appsignal::Testing.transactions} list.
       #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.0.0.beta.1
+  version: 4.0.0
 platform: java
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-19 00:00:00.000000000 Z
+date: 2024-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack