appsignal 4.0.8 → 4.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05e742b53256b12c2f0f29eca8f595f2ec3208bce6fe8a20ebb8539fe05e3549
-  data.tar.gz: d618aaef77d084971875a411754e27ae943f4e49920630701197e1f49dcdb7be
+  metadata.gz: e98be4df445350c51cb3b1d3543300257051dda917d8433a4503c9eda77d2cd6
+  data.tar.gz: bca5d410c1a2fb91812d2cc63b19a04b0db6cafd18c368a1ece930915bbf0a66
 SHA512:
-  metadata.gz: 6e7bf5883a425d4bbd25d0d4707b6c1d668572217f91b0ca3df76faf9b8fb4d0ed7e2595c3e8e706c4dabbcb93f22a28d54d56ceaa7d9edf7568914777245827
-  data.tar.gz: '0932d3a6c1e36236ae43d1de915605f852a7b1f56719f70ffdab9edad4db861b8471ea890c2851633765ad10d54b3de30f7c62a40497dffd6700c22f8ec815a7'
+  metadata.gz: ca0b4443929b282883b1d74f0092526bb69b3c223a6a60af1de372cf6af2acde569e57ada8b67b8aaac6645ada48b2c253ec595c1aec72bd5c812d03b577e953
+  data.tar.gz: 5e3d0d285a6ebf6a7b8beae27fdaceec6365aa016fa1181e1572f42054fced494771eac6fd62434efb5cd4dae7ee7ca542aa1b6ac5d680139ec7d24dfd238c55

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # AppSignal for Ruby gem Changelog
 
+## 4.0.9
+
+_Published on 2024-09-17._
+
+### Changed
+
+- Add the logger gem as a dependency. This fixes the deprecation warning on Ruby 3.3. (patch [8c1d577e](https://github.com/appsignal/appsignal-ruby/commit/8c1d577e4790185db887d49577cedc7d614d8d98))
+- Do not report errors caused by `Errno::EPIPE` (broken pipe errors) when instrumenting response bodies, to avoid reporting errors that cannot be fixed by the application. (patch [1fdccba4](https://github.com/appsignal/appsignal-ruby/commit/1fdccba4ceeb8f9bb13ae077019b2c1f7d9d4fe4))
+- Normalize Rack and Rails `UploadedFile` objects. Instead of displaying the Ruby class name, it will now show object details like the filename and content type.
+
+  ```
+  # Before
+  #<Rack::Multipart::UploadedFile>
+  #<ActionDispatch::Http::UploadedFile>
+
+  # After
+  #<Rack::Multipart::UploadedFile original_filename: "uploaded_file.txt", content_type: "text/plain">
+  #<ActionDispatch::Http::UploadedFile original_filename: "uploaded_file.txt", content_type: "text/plain">
+  ```
+
+  (patch [bb50c933](https://github.com/appsignal/appsignal-ruby/commit/bb50c93387eafebe043b0e7f4083c95556b93136))
+
 ## 4.0.8
 
 _Published on 2024-09-13._

data/appsignal.gemspec

@@ -17,8 +17,8 @@ IGNORED_PATHS = [
   ".yardopts",
   "benchmark.rake",
   "mono.yml",
-  "rubocop.yml",
-  "rubocop_todo.yml"
+  ".rubocop.yml",
+  ".rubocop_todo.yml"
 ].freeze
 
 Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
@@ -56,6 +56,7 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
     "source_code_uri" => "https://github.com/appsignal/appsignal-ruby"
   }
 
+  gem.add_dependency "logger"
   gem.add_dependency "rack"
 
   gem.add_development_dependency "pry"

data/lib/appsignal/rack/body_wrapper.rb

@@ -54,7 +54,7 @@ module Appsignal
       rescue *IGNORED_ERRORS # Do not report
         raise
       rescue Exception => error # rubocop:disable Lint/RescueException
-        @transaction.set_error(error)
+        appsignal_report_error(error)
         raise error
       end
 
@@ -72,6 +72,19 @@ module Appsignal
         @body.__send__(method_name, *args, &block)
       end
       ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
+
+      private
+
+      def appsignal_report_error(error)
+        @transaction.set_error(error) if appsignal_accepted_error?(error)
+      end
+
+      def appsignal_accepted_error?(error)
+        return true unless error.cause
+        return false if IGNORED_ERRORS.include?(error.cause.class)
+
+        appsignal_accepted_error?(error.cause)
+      end
     end
 
     # The standard Rack body wrapper which exposes "each" for iterating
@@ -97,7 +110,7 @@ module Appsignal
       rescue *IGNORED_ERRORS # Do not report
         raise
       rescue Exception => error # rubocop:disable Lint/RescueException
-        @transaction.set_error(error)
+        appsignal_report_error(error)
         raise error
       end
     end
@@ -118,7 +131,7 @@ module Appsignal
       rescue *IGNORED_ERRORS # Do not report
         raise
       rescue Exception => error # rubocop:disable Lint/RescueException
-        @transaction.set_error(error)
+        appsignal_report_error(error)
         raise error
       end
     end
@@ -144,7 +157,7 @@ module Appsignal
       rescue *IGNORED_ERRORS # Do not report
         raise
       rescue Exception => error # rubocop:disable Lint/RescueException
-        @transaction.set_error(error)
+        appsignal_report_error(error)
         raise error
       end
     end
@@ -162,7 +175,7 @@ module Appsignal
       rescue *IGNORED_ERRORS # Do not report
         raise
       rescue Exception => error # rubocop:disable Lint/RescueException
-        @transaction.set_error(error)
+        appsignal_report_error(error)
         raise error
       end
     end

data/lib/appsignal/transaction.rb

@@ -707,7 +707,7 @@ module Appsignal
       return unless Appsignal.config[:send_params]
 
       filter_keys = Appsignal.config[:filter_parameters] || []
-      Appsignal::Utils::HashSanitizer.sanitize params, filter_keys
+      Appsignal::Utils::SampleDataSanitizer.sanitize(params, filter_keys)
     end
 
     def session_data
@@ -720,7 +720,8 @@ module Appsignal
 
     # Returns sanitized session data.
     #
-    # The session data is sanitized by the {Appsignal::Utils::HashSanitizer}.
+    # The session data is sanitized by the
+    # {Appsignal::Utils::SampleDataSanitizer}.
     #
     # @return [nil] if `:send_session_data` config is set to `false`.
     # @return [nil] if the {#request} object doesn't respond to `#session`.
@@ -729,8 +730,9 @@ module Appsignal
     def sanitized_session_data
       return unless Appsignal.config[:send_session_data]
 
-      Appsignal::Utils::HashSanitizer.sanitize(
-        session_data, Appsignal.config[:filter_session_data]
+      Appsignal::Utils::SampleDataSanitizer.sanitize(
+        session_data,
+        Appsignal.config[:filter_session_data]
       )
     end
 

data/lib/appsignal/utils/data.rb

@@ -25,7 +25,7 @@ module Appsignal
               # An Integer too big for C-lang longs to fit
               bigint = 1 << 63
               if value >= bigint
-                map.set_string(key, "bigint:#{value}")
+                map.set_string(key, map_bigint(value))
               else
                 map.set_integer(key, value)
               end
@@ -56,7 +56,7 @@ module Appsignal
               # An Integer too big for C-lang longs to fit
               bigint = 1 << 63
               if value >= bigint
-                array.append_string("bigint:#{value}")
+                array.append_string(map_bigint(value))
               else
                 array.append_integer(value)
               end
@@ -76,6 +76,10 @@ module Appsignal
           end
           array
         end
+
+        def map_bigint(value)
+          "bigint:#{value}"
+        end
       end
     end
   end

data/lib/appsignal/utils/{hash_sanitizer.rb → sample_data_sanitizer.rb}

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Utils
-    class HashSanitizer
+    class SampleDataSanitizer
       FILTERED = "[FILTERED]"
       RECURSIVE = "[RECURSIVE VALUE]"
 
@@ -26,7 +26,21 @@ module Appsignal
           when Date
             "#<Date: #{value.iso8601}>"
           else
-            inspected(value)
+            if defined?(::Rack::Multipart::UploadedFile) &&
+                value.is_a?(::Rack::Multipart::UploadedFile)
+              "#<Rack::Multipart::UploadedFile " \
+                "original_filename: #{value.original_filename.inspect}, " \
+                "content_type: #{value.content_type.inspect}" \
+                ">"
+            elsif defined?(::ActionDispatch::Http::UploadedFile) &&
+                value.is_a?(::ActionDispatch::Http::UploadedFile)
+              "#<ActionDispatch::Http::UploadedFile " \
+                "original_filename: #{value.original_filename.inspect}, " \
+                "content_type: #{value.content_type.inspect}" \
+                ">"
+            else
+              inspected(value)
+            end
           end
         end
 

data/lib/appsignal/utils.rb

@@ -9,7 +9,7 @@ end
 require "appsignal/utils/integration_memory_logger"
 require "appsignal/utils/stdout_and_logger_message"
 require "appsignal/utils/data"
-require "appsignal/utils/hash_sanitizer"
+require "appsignal/utils/sample_data_sanitizer"
 require "appsignal/utils/integration_logger"
 require "appsignal/utils/json"
 require "appsignal/utils/ndjson"

data/lib/appsignal/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 4.0.8
+  version: 4.0.9
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,8 +10,22 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-13 00:00:00.000000000 Z
+date: 2024-09-17 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -133,8 +147,6 @@ extensions:
 - ext/extconf.rb
 extra_rdoc_files: []
 files:
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -260,13 +272,13 @@ files:
 - lib/appsignal/transmitter.rb
 - lib/appsignal/utils.rb
 - lib/appsignal/utils/data.rb
-- lib/appsignal/utils/hash_sanitizer.rb
 - lib/appsignal/utils/integration_logger.rb
 - lib/appsignal/utils/integration_memory_logger.rb
 - lib/appsignal/utils/json.rb
 - lib/appsignal/utils/ndjson.rb
 - lib/appsignal/utils/query_params_sanitizer.rb
 - lib/appsignal/utils/rails_helper.rb
+- lib/appsignal/utils/sample_data_sanitizer.rb
 - lib/appsignal/utils/stdout_and_logger_message.rb
 - lib/appsignal/version.rb
 - lib/puma/plugin/appsignal.rb

data/.rubocop.yml

@@ -1,133 +0,0 @@
-inherit_from: .rubocop_todo.yml
-
-AllCops:
-  TargetRubyVersion: 2.7
-  NewCops: enable
-  Include:
-    - "**/*.rb"
-    - "**/*.cap"
-    - "**/*.rake"
-    - "**/Gemfile"
-    - "**/Rakefile"
-    - "appsignal.gemspec"
-  Exclude:
-    - "pkg/**/*"
-    - "tmp/**/*"
-    - "vendor/**/*"
-    - "spec/integration/diagnose/**/*"
-  DisplayCopNames: true
-  UseCache: true
-  CacheRootDirectory: ./tmp
-
-Style/RescueStandardError:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
-
-Style/HashSyntax:
-  EnforcedStyle: hash_rockets
-
-Style/EmptyMethod:
-  EnforcedStyle: expanded
-
-Style/MissingRespondToMissing:
-  Exclude:
-    - "lib/appsignal/extension.rb"
-    - "lib/appsignal/transaction.rb"
-
-Style/TrailingUnderscoreVariable:
-  Enabled: false
-
-Style/Lambda:
-  EnforcedStyle: lambda
-
-Style/WordArray:
-  Enabled: false
-
-Style/FrozenStringLiteralComment:
-  Enabled: true
-  Exclude:
-    - "spec/**/*.rb"
-
-Style/NumericPredicate:
-  Enabled: false
-
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-Style/RedundantConstantBase:
-  Enabled: false
-
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - "spec/**/*.rb"
-
-Lint/EmptyClass:
-  Exclude:
-    - "spec/**/*.rb"
-
-Lint/EmptyFile:
-  Exclude:
-    - "spec/**/*.rb"
-
-Layout/HashAlignment:
-  EnforcedLastArgumentHashStyle: ignore_implicit
-
-Layout/ArgumentAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/LineContinuationLeadingSpace:
-  Enabled: false
-
-Layout/FirstArrayElementIndentation:
-  EnforcedStyle: consistent
-
-Layout/LineEndStringConcatenationIndentation:
-  EnforcedStyle: indented
-
-Layout/ParameterAlignment:
-  EnforcedStyle: with_fixed_indentation
-
-Layout/MultilineMethodCallIndentation:
-  EnforcedStyle: indented
-
-Layout/MultilineOperationIndentation:
-  EnforcedStyle: indented
-
-Layout/LineLength:
-  Max: 100
-
-Naming/FileName:
-  Exclude:
-    - "ext/Rakefile"
-
-Naming/AccessorMethodName:
-  Exclude:
-    - "lib/appsignal/helpers/instrumentation.rb"
-    - "lib/appsignal/transaction.rb"
-
-Naming/RescuedExceptionsVariableName:
-  Enabled: false
-
-Naming/VariableNumber:
-  Enabled: false
-
-Metrics/ModuleLength:
-  Enabled: false
-
-Metrics/ClassLength:
-  Enabled: false
-
-Metrics/BlockLength:
-  Exclude:
-    - "Rakefile"
-
-Gemspec/DevelopmentDependencies:
-  Enabled: false

data/.rubocop_todo.yml

@@ -1,84 +0,0 @@
-# This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2024-06-27 09:42:06 UTC using RuboCop version 1.64.1.
-# The point is for the user to remove these configuration records
-# one by one as the offenses are removed from the code base.
-# Note that changes in the inspected code, or installation of new
-# versions of RuboCop, may require this file to be generated again.
-
-# Offense count: 2
-# Configuration parameters: AllowedParentClasses.
-Lint/MissingSuper:
-  Exclude:
-    - 'lib/appsignal/extension.rb'
-    - 'lib/appsignal/logger.rb'
-
-# Offense count: 1
-Lint/StructNewOverride:
-  Exclude:
-    - 'spec/lib/appsignal/probes/sidekiq_spec.rb'
-
-# Offense count: 63
-# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 44
-
-# Offense count: 6
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-# AllowedMethods: refine
-Metrics/BlockLength:
-  Max: 31
-
-# Offense count: 21
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/CyclomaticComplexity:
-  Max: 11
-
-# Offense count: 139
-# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
-Metrics/MethodLength:
-  Max: 56
-
-# Offense count: 18
-# Configuration parameters: AllowedMethods, AllowedPatterns.
-Metrics/PerceivedComplexity:
-  Max: 13
-
-# Offense count: 2
-Security/Open:
-  Exclude:
-    - 'ext/base.rb'
-
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Security/YAMLLoad:
-  Exclude:
-    - 'lib/appsignal/config.rb'
-    - 'lib/appsignal/integrations/sidekiq.rb'
-
-# Offense count: 7
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: prefer_alias, prefer_alias_method
-Style/Alias:
-  Exclude:
-    - 'lib/appsignal/helpers/instrumentation.rb'
-    - 'lib/appsignal/transaction.rb'
-
-# Offense count: 1
-Style/ClassVars:
-  Exclude:
-    - 'spec/lib/appsignal/event_formatter_spec.rb'
-
-# Offense count: 1
-Style/OpenStructUse:
-  Exclude:
-    - 'lib/appsignal/cli/install.rb'
-
-# Offense count: 2
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: respond_to_missing?
-Style/OptionalBooleanParameter:
-  Exclude:
-    - 'lib/appsignal/integrations/delayed_job_plugin.rb'
-    - 'lib/appsignal/utils/query_params_sanitizer.rb'