appsignal 3.0.19 → 3.0.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff92b4ae6715fa80b1910e0023b49e0032a28fa1ea13b7b64587568ceae07edf
-  data.tar.gz: 6faac0d1b0fa8abefc0908628a98918d3cbec6eae45ae4a7d275c4537eb03b59
+  metadata.gz: d9c137f49fe8b491d6f30c23f9fd6d254f9c55af83726b7eb06c6fc29d7fdb53
+  data.tar.gz: d784f570079e3fa8fb4938866d3d0dcf9b37f91c351456821921a6881065feba
 SHA512:
-  metadata.gz: 1cd66bc7159a7ce2817d5190073d4af45e5f7dcb7c5f7c5c9ebdf6b986af9f3e3b46f7149a3fabf81ce03a03c62734c87984f92b5f0a468240b9d3a7b513168f
-  data.tar.gz: cf0735657d7c4ebcaff3c28863d7ee8e5b244f8945dbe16d0d764130826d99bce49aca1c13a5adbd62a196acbf23827fcbfe8a3558843298e56585896a3a0812
+  metadata.gz: c56dfdb62892d733bbde08309bcb10461646ea98b784eb3f3391c4dd83009dac0265aa99382779c24bd71008ea9b2a452f65ec75dd350d705f49ae8f3aaf044a
+  data.tar.gz: a2d13999e2f73f8173866fba3fa6b5de0226fa966f8345bf54f25c548a0b7a6314093b69d43dc465b361e998f7919f59c71a45cb4f155cf580f4c82c094cdaa4

data/CHANGELOG.md

@@ -1,5 +1,49 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.0.22
+
+### Changed
+
+- [9762e79d](https://github.com/appsignal/appsignal-ruby/commit/9762e79d4545e50c8f3540deff825b10d77e59a5) patch - Bump agent to v-bbc830a
+  
+  - Support batched statsd messages
+  - Set start times for spans with traceparents
+  - Check duration in transactions for negative and too high value
+
+## 3.0.21
+
+### Changed
+
+- [548dd6f4](https://github.com/appsignal/appsignal-ruby/commit/548dd6f4c61ae3be24995a200dc3e5bea1a5f58c) patch - Add config override source. Track final decisions made by the Ruby gem in the configuration in the `override` config source. This will help us track new config options which are being set by their deprecated predecessors in the diagnose report.
+
+### Removed
+
+- [3f503ade](https://github.com/appsignal/appsignal-ruby/commit/3f503ade83f22f4b0d86d76ea00e5f4dd3c56b6f) patch - Remove internal `Appsignal.extensions` system. It was unused.
+
+## 3.0.21.alpha.1
+
+### Changed
+
+- [f19d9dcc](https://github.com/appsignal/appsignal-ruby/commit/f19d9dcc1c00103f5dc92951481becf4d4ade39e) patch - The MongoDB query sanitization now shows all the attributes in the query at all levels.
+  Only the actual values are filtered with a `?` character. Less MongoDB queries are now marked
+  as N+1 queries when they weren't the exact same query. This increases the number of unique events
+  AppSignal tracks for MongoDB queries.
+
+## 3.0.20
+
+### Added
+
+- [35bd83b8](https://github.com/appsignal/appsignal-ruby/commit/35bd83b84fd30f0188d9f134cfd249360b6e281d) patch - Add `send_session_data` option to configure if session data is automatically included transactions. By default this is turned on. It can be disabled by configuring `send_session_data` to `false`.
+
+### Deprecated
+
+- [35bd83b8](https://github.com/appsignal/appsignal-ruby/commit/35bd83b84fd30f0188d9f134cfd249360b6e281d) patch - Deprecate `skip_session_data` option in favor of the newly introduced `send_session_data` option. If it is configured it will print a warning on AppSignal load, but will also retain its functionality until the config option is fully removed in the next major release.
+- [e51a8fb6](https://github.com/appsignal/appsignal-ruby/commit/e51a8fb653fccc5a6b72ac7af9c9417e6827e2e9) patch - Warn about the deprecated `working_dir_path` option from all config sources. It previously only printed a warning when it was configured in the `config/appsignal.yml` file, but now also prints the warning if it's set via the Config class initialize options and environment variables. Please use the `working_directory_path` option instead.
+
+### Fixed
+
+- [c9000eee](https://github.com/appsignal/appsignal-ruby/commit/c9000eeefec722cb940b2e14f37d31a7827986d6) patch - Fix reported Ruby version in diagnose report. It would report only the first major release of the series, e.g. 2.6.0 for 2.6.1.
+
 ## 3.0.19
 
 ### Changed

data/appsignal.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.extensions            = %w[ext/extconf.rb]
 
   gem.metadata = {
+    "rubygems_mfa_required" => "true",
     "bug_tracker_uri"   => "https://github.com/appsignal/appsignal-ruby/issues",
     "changelog_uri"     =>
       "https://github.com/appsignal/appsignal-ruby/blob/main/CHANGELOG.md",

data/ext/agent.yml

@@ -3,92 +3,92 @@
 # appsignal-agent repository.
 # Modifications to this file will be overwritten with the next agent release.
 ---
-version: 15ee07b
+version: bbc830a
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: 59bb7f5aea47ccea89b48cc323371fd87609592945ae8692f36063a635970e22
+      checksum: 5e817193bb57f13ff16bacceda459d8badc2d5a04a6b131a7bb343212329304a
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: ce2d489170fdd84be1467d24e5c13782cf97912b3c7dbaaebe9e074d56e711a2
+      checksum: 641a499de4dd2a0ebc92d0d28ea98bf9c8387ee7393d093ba2f83a64d522d162
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: 59bb7f5aea47ccea89b48cc323371fd87609592945ae8692f36063a635970e22
+      checksum: 5e817193bb57f13ff16bacceda459d8badc2d5a04a6b131a7bb343212329304a
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: ce2d489170fdd84be1467d24e5c13782cf97912b3c7dbaaebe9e074d56e711a2
+      checksum: 641a499de4dd2a0ebc92d0d28ea98bf9c8387ee7393d093ba2f83a64d522d162
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   aarch64-darwin:
     static:
-      checksum: aa37596a85d65d46fc5bba25d4d059e98655709e6c44ee39e7c6ba72398ad704
+      checksum: d443e00232acd3e53cd3d3f8c525da69ad362c38230472cc596e687cf73c7d94
       filename: appsignal-aarch64-darwin-all-static.tar.gz
     dynamic:
-      checksum: b40026410702c1bb3ac974c9648d464e0551956dc933deff22543f10cca81e46
+      checksum: 750cbaf06fca0a46e0ad046823a5b55b461cdff4bd4882383d22b0c60d4e434e
       filename: appsignal-aarch64-darwin-all-dynamic.tar.gz
   arm64-darwin:
     static:
-      checksum: aa37596a85d65d46fc5bba25d4d059e98655709e6c44ee39e7c6ba72398ad704
+      checksum: d443e00232acd3e53cd3d3f8c525da69ad362c38230472cc596e687cf73c7d94
       filename: appsignal-aarch64-darwin-all-static.tar.gz
     dynamic:
-      checksum: b40026410702c1bb3ac974c9648d464e0551956dc933deff22543f10cca81e46
+      checksum: 750cbaf06fca0a46e0ad046823a5b55b461cdff4bd4882383d22b0c60d4e434e
       filename: appsignal-aarch64-darwin-all-dynamic.tar.gz
   arm-darwin:
     static:
-      checksum: aa37596a85d65d46fc5bba25d4d059e98655709e6c44ee39e7c6ba72398ad704
+      checksum: d443e00232acd3e53cd3d3f8c525da69ad362c38230472cc596e687cf73c7d94
       filename: appsignal-aarch64-darwin-all-static.tar.gz
     dynamic:
-      checksum: b40026410702c1bb3ac974c9648d464e0551956dc933deff22543f10cca81e46
+      checksum: 750cbaf06fca0a46e0ad046823a5b55b461cdff4bd4882383d22b0c60d4e434e
       filename: appsignal-aarch64-darwin-all-dynamic.tar.gz
   aarch64-linux:
     static:
-      checksum: 12c5659d5a5d67ee641bdb1c38ef842b7687811fdec1f9edf8e196a2ed596405
+      checksum: 7cd884dfd47466112d571ce49830057ffff0070383037eec4bfecf29547e3e47
       filename: appsignal-aarch64-linux-all-static.tar.gz
     dynamic:
-      checksum: 8301ab5f64af1c185860314682fbfd89027ea5e4850d8beb222613ca5455358a
+      checksum: 060c7b768c7bd81aaf0dd9a872d4bd36f1efd433972ae5cab41e2791236a3d0c
       filename: appsignal-aarch64-linux-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: afebd51e26b8d21923a8adcbc8fda7bbd29d4e12573f53895e3a650fcd84ffd5
+      checksum: 21ca02f85c438190307b2a3500642a94dbd35ada6349cd97ac32253ac7dcc9e1
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: e0ed425a1d92ad7e9beb83f5b7c896f8606773cc599337a198536a150ba76c51
+      checksum: 2cf89679e62b725374e8578bb58dcfea30c573e406bd28f42215be52a2c8f31e
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: afebd51e26b8d21923a8adcbc8fda7bbd29d4e12573f53895e3a650fcd84ffd5
+      checksum: 21ca02f85c438190307b2a3500642a94dbd35ada6349cd97ac32253ac7dcc9e1
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: e0ed425a1d92ad7e9beb83f5b7c896f8606773cc599337a198536a150ba76c51
+      checksum: 2cf89679e62b725374e8578bb58dcfea30c573e406bd28f42215be52a2c8f31e
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86_64-linux:
     static:
-      checksum: 563eb5c9daeec67a760ac236b2848aee4ec0e39dca1368150a6d99844d4d665f
+      checksum: 6feb2ed89451c6fdf6365dd1023bd419d8fa99e3c986d6a4e804f8cb68b3f401
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: 74940f06f4c92582262014a9967f298bccee3ca94e3a490ddc40787573c91ed0
+      checksum: e8dc655eaf5194dade1b5b20fc2bed0b443db84bfaf9c1828875a77dd20516c9
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 2ecad2b2bdd362d9d871322eac79370d12314e3d32a53c83be17d054e91f188d
+      checksum: 61a70bb104b7d7cbb9d51a0a5d806346a6c36deb60d1e41351eb61c4813587c1
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: 5e4c4096ca7b0c7a97fe03f684c0678396c97f24c2065dc961081d022a8ad2a7
+      checksum: cfe38530c1b1c9ab014aca25dd397540f73ca117fe48119a956d864c9d10c1e5
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: 2eaa4beeb3322ec3c6007f4a8ec483405f8ade4c372031a068bbedf05da9443d
+      checksum: 8662a282787b11a6e48dab944afbf1afca91b45ca3147de8cdadb52ef271a43a
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 4805995f0b10d4b5183e4a2430af19638372a4f290d95a123a0874b2f3878d8e
+      checksum: 4d8f0aa768aee213fd7ada877e2e86f47fb4c17269cbe54584ff759d480afc10
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: 2eaa4beeb3322ec3c6007f4a8ec483405f8ade4c372031a068bbedf05da9443d
+      checksum: 8662a282787b11a6e48dab944afbf1afca91b45ca3147de8cdadb52ef271a43a
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 4805995f0b10d4b5183e4a2430af19638372a4f290d95a123a0874b2f3878d8e
+      checksum: 4d8f0aa768aee213fd7ada877e2e86f47fb4c17269cbe54584ff759d480afc10
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz

data/ext/base.rb

@@ -31,7 +31,7 @@ def report
         },
         "language" => {
           "name" => "ruby",
-          "version" => "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"
+          "version" => "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}"
         },
         "download" => {
           "checksum" => "unverified",

data/lib/appsignal/cli/diagnose.rb

@@ -443,7 +443,7 @@ module Appsignal
             save :os, os
             puts_value "Operating System", os_label
 
-            language_version = "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"
+            language_version = "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}"
             save :language_version, language_version
             puts_format "Ruby version", language_version
 
@@ -471,7 +471,8 @@ module Appsignal
               :system => config.system_config,
               :initial => config.initial_config,
               :file => config.file_config,
-              :env => config.env_config
+              :env => config.env_config,
+              :override => config.override_config
             }
           }
           print_config_options(config)

data/lib/appsignal/config.rb

@@ -39,7 +39,6 @@ module Appsignal
       ],
       :send_environment_metadata      => true,
       :send_params                    => true,
-      :skip_session_data              => false,
       :transaction_debug_mode         => false
     }.freeze
 
@@ -88,6 +87,7 @@ module Appsignal
       "APPSIGNAL_RUNNING_IN_CONTAINER"           => :running_in_container,
       "APPSIGNAL_SEND_ENVIRONMENT_METADATA"      => :send_environment_metadata,
       "APPSIGNAL_SEND_PARAMS"                    => :send_params,
+      "APPSIGNAL_SEND_SESSION_DATA"              => :send_session_data,
       "APPSIGNAL_SKIP_SESSION_DATA"              => :skip_session_data,
       "APPSIGNAL_TRANSACTION_DEBUG_MODE"         => :transaction_debug_mode,
       "APPSIGNAL_WORKING_DIRECTORY_PATH"         => :working_directory_path,
@@ -125,6 +125,7 @@ module Appsignal
       APPSIGNAL_RUNNING_IN_CONTAINER
       APPSIGNAL_SEND_ENVIRONMENT_METADATA
       APPSIGNAL_SEND_PARAMS
+      APPSIGNAL_SEND_SESSION_DATA
       APPSIGNAL_SKIP_SESSION_DATA
       APPSIGNAL_TRANSACTION_DEBUG_MODE
     ].freeze
@@ -169,7 +170,7 @@ module Appsignal
     #   @return [Hash]
 
     attr_reader :root_path, :env, :config_hash, :system_config,
-      :initial_config, :file_config, :env_config
+      :initial_config, :file_config, :env_config, :override_config
     attr_accessor :logger
 
     # Initialize a new configuration object for AppSignal.
@@ -230,6 +231,11 @@ module Appsignal
       # Load config from environment variables
       @env_config = load_from_environment
       merge(env_config)
+      # Load config overrides
+      @override_config = determine_overrides
+      merge(override_config)
+      # Handle deprecated config options
+      maintain_backwards_compatibility
       # Validate that we have a correct config
       validate
       # Track origin of env
@@ -374,12 +380,9 @@ module Appsignal
       configurations = YAML.load(ERB.new(IO.read(config_file)).result, **read_options)
       config_for_this_env = configurations[env]
       if config_for_this_env
-        config_for_this_env =
-          config_for_this_env.each_with_object({}) do |(key, value), hash|
-            hash[key.to_sym] = value # convert keys to symbols
-          end
-
-        maintain_backwards_compatibility(config_for_this_env)
+        config_for_this_env.each_with_object({}) do |(key, value), hash|
+          hash[key.to_sym] = value # convert keys to symbols
+        end
       else
         logger.error "Not loading from config file: config for '#{env}' not found"
         nil
@@ -394,20 +397,25 @@ module Appsignal
       nil
     end
 
-    # Maintain backwards compatibility with config files generated by earlier
-    # versions of the gem
+    # Maintain backwards compatibility with deprecated config options.
     #
-    # Used by {#load_from_disk}. No compatibility for env variables or initial config currently.
-    def maintain_backwards_compatibility(configuration)
-      configuration.tap do |config|
-        if config.include?(:working_dir_path)
-          deprecation_message \
-            "'working_dir_path' is deprecated, please use " \
-            "'working_directory_path' instead and specify the " \
-            "full path to the working directory",
-            logger
-        end
-      end
+    # Add warnings for deprecated config options here if they have no
+    # replacement, or should be non-functional.
+    #
+    # Add them to {determine_overrides} if replacement config options should be
+    # set instead.
+    #
+    # Make sure to remove the contents of this method in the next major
+    # version, but the method itself with an empty body can stick around as a
+    # structure for future deprecations.
+    def maintain_backwards_compatibility
+      return unless config_hash.key?(:working_dir_path)
+
+      deprecation_message \
+        "The `working_dir_path` option is deprecated, please use " \
+        "`working_directory_path` instead and specify the " \
+        "full path to the working directory",
+        logger
     end
 
     def load_from_environment
@@ -437,6 +445,31 @@ module Appsignal
       config
     end
 
+    # Set config options based on the final user config. Fix any conflicting
+    # config or set new config options based on deprecated config options.
+    #
+    # Make sure to remove behavior for deprecated config options in this method
+    # in the next major version, but the method itself with an empty body can
+    # stick around as a structure for future deprecations.
+    def determine_overrides
+      config = {}
+      skip_session_data = config_hash[:skip_session_data]
+      send_session_data = config_hash[:send_session_data]
+      if skip_session_data.nil? # Deprecated option is not set
+        if send_session_data.nil? # Not configured by user
+          config[:send_session_data] = true # Set default value
+        end
+      else
+        deprecation_message "The `skip_session_data` config option is " \
+          "deprecated. Please use `send_session_data` instead.",
+          logger
+        # Not configured by user
+        config[:send_session_data] = !skip_session_data if send_session_data.nil?
+      end
+
+      config
+    end
+
     def merge(new_config)
       new_config.each do |key, value|
         unless config_hash[key].nil?

data/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter.rb

@@ -21,28 +21,28 @@ module Appsignal
           },
           "insert" => {
             "insert"    => :allow,
-            "documents" => :deny_array,
+            "documents" => :sanitize_document,
             "ordered"   => :allow
           },
           "update" => {
             "update"  => :allow,
-            "updates" => :sanitize_bulk,
+            "updates" => :sanitize_document,
             "ordered" => :allow
           },
           "findandmodify" => {
             "findandmodify" => :allow,
             "query"         => :sanitize_document,
-            "update"        => :deny_array,
+            "update"        => :sanitize_document,
             "new"           => :allow
           },
           "delete" => {
             "delete" => :allow,
-            "deletes" => :sanitize_bulk,
+            "deletes" => :sanitize_document,
             "ordered" => :allow
           },
           "bulk" => {
             "q"      => :sanitize_document,
-            "u"      => :deny_array,
+            "u"      => :sanitize_document,
             "limit"  => :allow,
             "multi"  => :allow,
             "upsert" => :allow
@@ -68,20 +68,9 @@ module Appsignal
         # Applies strategy on hash values based on keys
         def self.apply_strategy(strategy, val)
           case strategy
-          when :allow      then val
-          when :deny       then "?"
-          when :deny_array then "[?]"
+          when :allow then val
           when :sanitize_document
-            Appsignal::Utils::QueryParamsSanitizer.sanitize(val, true, :mongodb)
-          when :sanitize_bulk
-            if val.length > 1
-              [
-                format(:bulk, val.first),
-                "[...]"
-              ]
-            else
-              val.map { |v| format(:bulk, v) }
-            end
+            Appsignal::Utils::QueryParamsSanitizer.sanitize(val, false, :mongodb)
           else "?"
           end
         end

data/lib/appsignal/transaction.rb

@@ -476,12 +476,12 @@ module Appsignal
     #
     # The session data is sanitized by the {Appsignal::Utils::HashSanitizer}.
     #
-    # @return [nil] if `:skip_session_data` config is set to `true`.
+    # @return [nil] if `:send_session_data` config is set to `false`.
     # @return [nil] if the {#request} object doesn't respond to `#session`.
     # @return [nil] if the {#request} session data is `nil`.
     # @return [Hash<String, Object>]
     def sanitized_session_data
-      return if Appsignal.config[:skip_session_data] ||
+      return if !Appsignal.config[:send_session_data] ||
           !request.respond_to?(:session)
       session = request.session
       return unless session

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.0.19".freeze
+  VERSION = "3.0.22".freeze
 end

data/lib/appsignal.rb

@@ -58,20 +58,6 @@ module Appsignal
     #   @see start_logger
     attr_writer :logger
 
-    # @api private
-    def extensions
-      @extensions ||= []
-    end
-
-    # @api private
-    def initialize_extensions
-      Appsignal.logger.debug("Initializing extensions")
-      extensions.each do |extension|
-        Appsignal.logger.debug("Initializing #{extension}")
-        extension.initializer
-      end
-    end
-
     # @api private
     def testing?
       false
@@ -123,7 +109,6 @@ module Appsignal
           config.write_to_environment
           Appsignal::Extension.start
           Appsignal::Hooks.load_hooks
-          initialize_extensions
 
           if config[:enable_allocation_tracking] && !Appsignal::System.jruby?
             Appsignal::Extension.install_allocation_event_hook

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

@@ -258,7 +258,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           },
           "language" => {
             "name" => "ruby",
-            "version" => "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}",
+            "version" => "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}",
             "implementation" => jruby ? "jruby" : "ruby"
           },
           "download" => {
@@ -295,7 +295,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
           "  Status: success",
           "Language details",
           "  Implementation: \"#{jruby ? "jruby" : "ruby"}\"",
-          "  Ruby version: \"#{"#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"}\"",
+          "  Ruby version: \"#{"#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}"}\"",
           "Download details",
           "  Download URL: \"https://",
           "  Checksum: \"verified\"",
@@ -604,7 +604,7 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
 
     describe "host information" do
       let(:rbconfig) { RbConfig::CONFIG }
-      let(:language_version) { "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}" }
+      let(:language_version) { "#{rbconfig["RUBY_PROGRAM_VERSION"]}-p#{rbconfig["PATCHLEVEL"]}" }
 
       it "outputs host information" do
         run
@@ -769,13 +769,14 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         it "transmits validation in report" do
           default_config = hash_with_string_keys(Appsignal::Config::DEFAULT_CONFIG)
           expect(received_report["config"]).to eq(
-            "options" => default_config.merge("env" => ""),
+            "options" => default_config.merge("env" => "", "send_session_data" => true),
             "sources" => {
               "default" => default_config,
               "system" => {},
               "initial" => { "env" => "" },
               "file" => {},
-              "env" => {}
+              "env" => {},
+              "override" => { "send_session_data" => true }
             }
           )
         end
@@ -893,7 +894,8 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
               "system" => {},
               "initial" => hash_with_string_keys(config.initial_config.merge(additional_initial_config)),
               "file" => hash_with_string_keys(config.file_config),
-              "env" => {}
+              "env" => {},
+              "override" => { "send_session_data" => true }
             }
           )
         end
@@ -920,7 +922,8 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
               "system" => {},
               "initial" => hash_with_string_keys(config.initial_config),
               "file" => hash_with_string_keys(config.file_config),
-              "env" => {}
+              "env" => {},
+              "override" => { "send_session_data" => true }
             }
           )
         end

data/spec/lib/appsignal/config_spec.rb

@@ -69,8 +69,8 @@ describe Appsignal::Config do
           end
 
           it "sets the push_api_key as loaded through the env_config" do
-            expect(config.env_config).to eq(:push_api_key => "abc")
-            expect(config.system_config).to eq(:active => true)
+            expect(config.env_config).to include(:push_api_key => "abc")
+            expect(config.system_config).to include(:active => true)
           end
         end
 
@@ -82,8 +82,8 @@ describe Appsignal::Config do
           end
 
           it "sets the push_api_key as loaded through the env_config" do
-            expect(config.env_config).to eq(:push_api_key => "")
-            expect(config.system_config).to be_empty
+            expect(config.env_config).to include(:push_api_key => "")
+            expect(config.system_config).to_not have_key(:active)
           end
         end
 
@@ -95,8 +95,8 @@ describe Appsignal::Config do
           end
 
           it "sets the push_api_key as loaded through the env_config" do
-            expect(config.env_config).to eq(:push_api_key => " ")
-            expect(config.system_config).to be_empty
+            expect(config.env_config).to include(:push_api_key => " ")
+            expect(config.system_config).to_not have_key(:active)
           end
         end
       end
@@ -119,7 +119,7 @@ describe Appsignal::Config do
         end
 
         it "sets the log as loaded through the system" do
-          expect(config.system_config).to eq(:log => "stdout")
+          expect(config.system_config).to include(:log => "stdout")
         end
       end
 
@@ -129,7 +129,7 @@ describe Appsignal::Config do
         end
 
         it "does not set log as loaded through the system" do
-          expect(config.system_config).to eq({})
+          expect(config.system_config).to_not have_key(:log)
         end
       end
     end
@@ -177,7 +177,7 @@ describe Appsignal::Config do
         :revision                       => "v2.5.1",
         :send_environment_metadata      => true,
         :send_params                    => true,
-        :skip_session_data              => false,
+        :send_session_data              => true,
         :transaction_debug_mode         => false
       )
     end
@@ -434,6 +434,87 @@ describe Appsignal::Config do
     end
   end
 
+  describe "with config based on overrides" do
+    let(:log_stream) { StringIO.new }
+    let(:logger) { test_logger(log_stream) }
+    let(:logs) { log_contents(log_stream) }
+    let(:config) do
+      described_class.new(Dir.pwd, "production", config_options, logger)
+    end
+
+    describe "skip_session_data" do
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      let(:deprecation_message) do
+        "The `skip_session_data` config option is deprecated. Please use " \
+          "`send_session_data` instead."
+      end
+      before do
+        capture_std_streams(std_stream, err_stream) { config }
+      end
+
+      context "when not set" do
+        let(:config_options) { {} }
+
+        it "sets the default send_session_data value" do
+          expect(config[:skip_session_data]).to be_nil
+          expect(config[:send_session_data]).to eq(true)
+          expect(config.override_config[:send_session_data]).to eq(true)
+        end
+
+        it "does not print a deprecation warning" do
+          expect(stderr).to_not include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to_not include(deprecation_message)
+        end
+      end
+
+      context "when set to true" do
+        let(:config_options) { { :skip_session_data => true } }
+
+        it "sets send_session_data if send_session_data is not set by the user" do
+          expect(config[:skip_session_data]).to eq(true)
+          expect(config[:send_session_data]).to eq(false)
+          expect(config.override_config[:send_session_data]).to eq(false)
+        end
+
+        it "prints a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+
+      context "when set to false" do
+        let(:config_options) { { :skip_session_data => false } }
+
+        it "sets send_session_data if send_session_data is not set by the user" do
+          expect(config[:skip_session_data]).to eq(false)
+          expect(config[:send_session_data]).to eq(true)
+          expect(config.override_config[:send_session_data]).to eq(true)
+        end
+
+        it "prints a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+
+      context "when skip_session_data and send_session_data are both set" do
+        let(:config_options) { { :skip_session_data => true, :send_session_data => true } }
+
+        it "does not overwrite the send_session_data value" do
+          expect(config[:skip_session_data]).to eq(true)
+          expect(config[:send_session_data]).to eq(true)
+          expect(config.override_config[:send_session_data]).to be_nil
+        end
+
+        it "prints a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+    end
+  end
+
   describe "config keys" do
     describe ":endpoint" do
       subject { config[:endpoint] }
@@ -743,6 +824,54 @@ describe Appsignal::Config do
     end
   end
 
+  describe "#maintain_backwards_compatibility" do
+    let(:log_stream) { StringIO.new }
+    let(:logger) { test_logger(log_stream) }
+    let(:logs) { log_contents(log_stream) }
+    let(:config) do
+      described_class.new(Dir.pwd, "production", config_options, logger)
+    end
+
+    describe "working_dir_path" do
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      let(:deprecation_message) do
+        "The `working_dir_path` option is deprecated, please use " \
+          "`working_directory_path` instead and specify the " \
+          "full path to the working directory"
+      end
+      before do
+        capture_std_streams(std_stream, err_stream) { config }
+      end
+
+      context "when not set" do
+        let(:config_options) { {} }
+
+        it "sets the default working_dir_path value" do
+          expect(config[:working_dir_path]).to be_nil
+        end
+
+        it "does not print a deprecation warning" do
+          expect(stderr).to_not include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to_not include(deprecation_message)
+        end
+      end
+
+      context "when set" do
+        let(:config_options) { { :working_dir_path => "/tmp/appsignal2" } }
+
+        it "sets the default working_dir_path value" do
+          expect(config[:working_dir_path]).to eq("/tmp/appsignal2")
+        end
+
+        it "does not print a deprecation warning" do
+          expect(stderr).to include("appsignal WARNING: #{deprecation_message}")
+          expect(logs).to include(deprecation_message)
+        end
+      end
+    end
+  end
+
   describe "#validate" do
     subject { config.valid? }
     let(:config) do

data/spec/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter_spec.rb

@@ -11,8 +11,12 @@ describe Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter do
     end
 
     it "should apply a strategy for each key" do
+      # TODO: additional curly brackets required for issue
+      # https://github.com/rspec/rspec-mocks/issues/1460
+      # rubocop:disable Style/BracesAroundHashParameters
       expect(formatter).to receive(:apply_strategy)
-        .with(:sanitize_document, "_id" => 1)
+        .with(:sanitize_document, { "_id" => 1 })
+      # rubocop:enable Style/BracesAroundHashParameters
 
       expect(formatter).to receive(:apply_strategy)
         .with(:allow, "users")
@@ -47,57 +51,27 @@ describe Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter do
       end
     end
 
-    context "when strategy is deny" do
-      let(:strategy) { :deny }
-      let(:value)    { { "_id" => 1 } }
-
-      it "should return a '?'" do
-        expect(formatter.apply_strategy(strategy, value)).to eql("?")
-      end
-    end
-
-    context "when strategy is deny_array" do
-      let(:strategy) { :deny_array }
-      let(:value)    { { "_id" => 1 } }
-
-      it "should return a sanitized array string" do
-        expect(formatter.apply_strategy(strategy, value)).to eql("[?]")
-      end
-    end
-
     context "when strategy is sanitize_document" do
       let(:strategy) { :sanitize_document }
-      let(:value)    { { "_id" => 1 } }
-
-      it "should return a sanitized document" do
-        expect(formatter.apply_strategy(strategy, value)).to eql("_id" => "?")
-      end
-    end
-
-    context "when strategy is sanitize_bulk" do
-      let(:strategy) { :sanitize_bulk }
-      let(:value)    { [{ "q" => { "_id" => 1 }, "u" => [{ "foo" => "bar" }] }] }
-
-      it "should return an array of sanitized bulk documents" do
-        expect(formatter.apply_strategy(strategy, value)).to eql([
-          { "q" => { "_id" => "?" }, "u" => "[?]" }
-        ])
+      let(:value) do
+        {
+          "_id" => 1,
+          "authors" => [
+            { "name" => "BarBaz" },
+            { "name" => "FooBar" },
+            { "name" => "BarFoo", "surname" => "Baz" }
+          ]
+        }
       end
 
-      context "when bulk has more than one update" do
-        let(:value) do
-          [
-            { "q" => { "_id" => 1 }, "u" => [{ "foo" => "bar" }] },
-            { "q" => { "_id" => 2 }, "u" => [{ "foo" => "baz" }] }
+      it "should return a sanitized document" do
+        expect(formatter.apply_strategy(strategy, value)).to eql(
+          "_id" => "?",
+          "authors" => [
+            { "name" => "?" },
+            { "name" => "?", "surname" => "?" }
           ]
-        end
-
-        it "should return only the first value of sanitized bulk documents" do
-          expect(formatter.apply_strategy(strategy, value)).to eql([
-            { "q" => { "_id" => "?" }, "u" => "[?]" },
-            "[...]"
-          ])
-        end
+        )
       end
     end
 

data/spec/lib/appsignal/integrations/mongo_ruby_driver_spec.rb

@@ -17,8 +17,12 @@ describe Appsignal::Hooks::MongoMonitorSubscriber do
       end
 
       it "should sanitize command" do
+        # TODO: additional curly brackets required for issue
+        # https://github.com/rspec/rspec-mocks/issues/1460
+        # rubocop:disable Style/BracesAroundHashParameters
         expect(Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter)
-          .to receive(:format).with("find", "foo" => "bar")
+          .to receive(:format).with("find", { "foo" => "bar" })
+        # rubocop:enable Style/BracesAroundHashParameters
 
         subscriber.started(event)
       end

data/spec/lib/appsignal/integrations/padrino_spec.rb

@@ -148,7 +148,7 @@ if DependencyHelper.padrino_present?
               expect_a_transaction_to_be_created
               # Uses path for action name
               expect(transaction).to receive(:set_action_if_nil).with("PadrinoTestApp#unknown")
-              expect(response).to match_response(404, %r{^GET /404})
+              expect(response).to match_response(404, /^GET /404/)
             end
           end
 

data/spec/lib/appsignal/integrations/sidekiq_spec.rb

@@ -228,10 +228,14 @@ describe Appsignal::Integrations::SidekiqMiddleware, :with_yaml_parse_error => f
     let(:error) { ExampleException }
 
     it "creates a transaction and adds the error" do
+      # TODO: additional curly brackets required for issue
+      # https://github.com/rspec/rspec-mocks/issues/1460
+      # rubocop:disable Style/BracesAroundHashParameters
       expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :failed)
+        .with("sidekiq_queue_job_count", 1, { :queue => "default", :status => :failed })
       expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :processed)
+        .with("sidekiq_queue_job_count", 1, { :queue => "default", :status => :processed })
+      # rubocop:enable Style/BracesAroundHashParameters
 
       expect do
         perform_job { raise error, "uh oh" }
@@ -267,8 +271,12 @@ describe Appsignal::Integrations::SidekiqMiddleware, :with_yaml_parse_error => f
 
   context "without an error" do
     it "creates a transaction with events" do
+      # TODO: additional curly brackets required for issue
+      # https://github.com/rspec/rspec-mocks/issues/1460
+      # rubocop:disable Style/BracesAroundHashParameters
       expect(Appsignal).to receive(:increment_counter)
-        .with("sidekiq_queue_job_count", 1, :queue => "default", :status => :processed)
+        .with("sidekiq_queue_job_count", 1, { :queue => "default", :status => :processed })
+      # rubocop:enable Style/BracesAroundHashParameters
 
       perform_job
 

data/spec/lib/appsignal/transaction_spec.rb

@@ -1282,8 +1282,8 @@ describe Appsignal::Transaction do
           end
         end
 
-        context "when skipping session data" do
-          before { Appsignal.config[:skip_session_data] = true }
+        context "when not sending session data" do
+          before { Appsignal.config[:send_session_data] = false }
 
           it "does not set any session data on the transaction" do
             expect(subject).to be_nil

data/spec/lib/appsignal/utils/query_params_sanitizer_spec.rb

@@ -117,7 +117,7 @@ describe Appsignal::Utils::QueryParamsSanitizer do
       context "when value is an array" do
         let(:value) { %w[foo bar] }
 
-        it "should sanitize all hash values with a single questionmark" do
+        it "should sanitize all hash values with a single question mark" do
           expect(subject).to eq(["?"])
         end
       end
@@ -125,7 +125,7 @@ describe Appsignal::Utils::QueryParamsSanitizer do
       context "when value is a mixed array" do
         let(:value) { [nil, "foo", "bar"] }
 
-        it "should sanitize all hash values with a single questionmark" do
+        it "should sanitize all hash values with a single question mark" do
           expect(subject).to eq(["?"])
         end
       end

data/spec/lib/appsignal_spec.rb

@@ -5,7 +5,6 @@ describe Appsignal do
     # Make sure we have a clean state because we want to test
     # initialization here.
     Appsignal.config = nil
-    Appsignal.extensions.clear
   end
 
   let(:transaction) { http_request_transaction }
@@ -20,14 +19,6 @@ describe Appsignal do
     end
   end
 
-  describe ".extensions" do
-    it "should keep a list of extensions" do
-      expect(Appsignal.extensions).to be_empty
-      Appsignal.extensions << Appsignal::MockExtension
-      expect(Appsignal.extensions.size).to eq(1)
-    end
-  end
-
   describe ".start" do
     context "with no config set beforehand" do
       it "should do nothing when config is not set and there is no valid config in the env" do
@@ -63,15 +54,6 @@ describe Appsignal do
         Appsignal.start
       end
 
-      context "with an extension" do
-        before { Appsignal.extensions << Appsignal::MockExtension }
-
-        it "should call the extension's initializer" do
-          expect(Appsignal::MockExtension).to receive(:initializer)
-          Appsignal.start
-        end
-      end
-
       context "when allocation tracking and gc instrumentation have been enabled" do
         before do
           allow(GC::Profiler).to receive(:enable)
@@ -427,49 +409,89 @@ describe Appsignal do
     end
 
     describe ".monitor_single_transaction" do
+      around { |example| keep_transactions { example.run } }
+
       context "with a successful call" do
-        it "should call monitor_transaction and stop" do
-          expect(Appsignal).to receive(:monitor_transaction).with(
-            "perform_job.something",
-            :key => :value
-          ).and_yield
+        it "calls monitor_transaction and Appsignal.stop" do
           expect(Appsignal).to receive(:stop)
 
-          Appsignal.monitor_single_transaction("perform_job.something", :key => :value) do
+          Appsignal.monitor_single_transaction(
+            "perform_job.something",
+            :controller => :my_controller,
+            :action => :my_action
+          ) do
             # nothing
           end
+
+          transaction = last_transaction
+          transaction_hash = transaction.to_h
+          expect(transaction_hash).to include(
+            "action" => "my_controller#my_action"
+          )
+          expect(transaction_hash["events"]).to match([
+            hash_including(
+              "name" => "perform_job.something",
+              "title" => "",
+              "body" => "",
+              "body_format" => Appsignal::EventFormatter::DEFAULT
+            )
+          ])
         end
       end
 
       context "with an erroring call" do
         let(:error) { ExampleException.new }
 
-        it "should call monitor_transaction and stop and then raise the error" do
-          expect(Appsignal).to receive(:monitor_transaction).with(
-            "perform_job.something",
-            :key => :value
-          ).and_yield
+        it "calls monitor_transaction and stop and re-raises the error" do
           expect(Appsignal).to receive(:stop)
 
           expect do
-            Appsignal.monitor_single_transaction("perform_job.something", :key => :value) do
+            Appsignal.monitor_single_transaction(
+              "perform_job.something",
+              :controller => :my_controller,
+              :action => :my_action
+            ) do
               raise error
             end
           end.to raise_error(error)
+
+          transaction = last_transaction
+          transaction_hash = transaction.to_h
+          expect(transaction_hash).to include(
+            "action" => "my_controller#my_action"
+          )
+          expect(transaction_hash["events"]).to match([
+            hash_including(
+              "name" => "perform_job.something",
+              "title" => "",
+              "body" => "",
+              "body_format" => Appsignal::EventFormatter::DEFAULT
+            )
+          ])
         end
       end
     end
 
     describe ".tag_request" do
-      before { allow(Appsignal::Transaction).to receive(:current).and_return(transaction) }
+      let(:transaction) { http_request_transaction }
+      around do |example|
+        start_agent
+        with_current_transaction transaction do
+          keep_transactions { example.run }
+        end
+      end
 
       context "with transaction" do
-        let(:transaction) { double }
-        it "should call set_tags on transaction" do
-          expect(transaction).to receive(:set_tags).with("a" => "b")
-        end
+        it "calls set_tags on the current transaction" do
+          Appsignal.tag_request("a" => "b")
+          transaction.complete # Manually trigger transaction sampling
 
-        after { Appsignal.tag_request("a" => "b") }
+          expect(transaction.to_h).to include(
+            "sample_data" => hash_including(
+              "tags" => { "a" => "b" }
+            )
+          )
+        end
       end
 
       context "without transaction" do

data/spec/support/helpers/transaction_helpers.rb

@@ -56,6 +56,16 @@ module TransactionHelpers
     Thread.current[:appsignal_transaction] = nil
   end
 
+  # Set the current for the duration of the given block.
+  #
+  # Helper for {set_current_transaction} and {clear_current_transaction!}
+  def with_current_transaction(transaction)
+    set_current_transaction transaction
+    yield
+  ensure
+    clear_current_transaction!
+  end
+
   # Track the AppSignal transaction JSON when a transaction gets completed
   # ({Appsignal::Transaction.complete}).
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.0.19
+  version: 3.0.22
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-07 00:00:00.000000000 Z
+date: 2022-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -391,7 +391,6 @@ files:
 - spec/support/matchers/contains_log.rb
 - spec/support/matchers/have_colorized_text.rb
 - spec/support/mocks/fake_gc_profiler.rb
-- spec/support/mocks/mock_extension.rb
 - spec/support/mocks/mock_probe.rb
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb
@@ -405,6 +404,7 @@ homepage: https://github.com/appsignal/appsignal-ruby
 licenses:
 - MIT
 metadata:
+  rubygems_mfa_required: 'true'
   bug_tracker_uri: https://github.com/appsignal/appsignal-ruby/issues
   changelog_uri: https://github.com/appsignal/appsignal-ruby/blob/main/CHANGELOG.md
   documentation_uri: https://docs.appsignal.com/ruby/
@@ -426,7 +426,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
@@ -544,7 +544,6 @@ test_files:
 - spec/support/matchers/contains_log.rb
 - spec/support/matchers/have_colorized_text.rb
 - spec/support/mocks/fake_gc_profiler.rb
-- spec/support/mocks/mock_extension.rb
 - spec/support/mocks/mock_probe.rb
 - spec/support/rails/my_app.rb
 - spec/support/shared_examples/instrument.rb

data/spec/support/mocks/mock_extension.rb

@@ -1,6 +0,0 @@
-module Appsignal
-  module MockExtension
-    def self.initializer
-    end
-  end
-end