appsignal 3.4.0 → 3.4.1

data/lib/appsignal/integrations/sidekiq.rb

@@ -35,7 +35,7 @@ module Appsignal
     end
 
     # @api private
-    class SidekiqMiddleware # rubocop:disable Metrics/ClassLength
+    class SidekiqMiddleware
       include Appsignal::Hooks::Helpers
 
       EXCLUDED_JOB_KEYS = %w[
@@ -43,7 +43,7 @@ module Appsignal
         error_message failed_at jid retried_at retry wrapped
       ].freeze
 
-      def call(_worker, item, _queue)
+      def call(_worker, item, _queue, &block)
         job_status = nil
         transaction = Appsignal::Transaction.create(
           item["jid"],
@@ -52,23 +52,21 @@ module Appsignal
             :queue_start => item["enqueued_at"]
           )
         )
+        transaction.set_action_if_nil(formatted_action_name(item))
 
-        Appsignal.instrument "perform_job.sidekiq" do
-          yield
+        formatted_metadata(item).each do |key, value|
+          transaction.set_metadata key, value
         end
+
+        Appsignal.instrument "perform_job.sidekiq", &block
       rescue Exception => exception # rubocop:disable Lint/RescueException
         job_status = :failed
         raise exception
       ensure
         if transaction
-          transaction.set_action_if_nil(formatted_action_name(item))
-
           params = filtered_arguments(item)
           transaction.params = params if params
 
-          formatted_metadata(item).each do |key, value|
-            transaction.set_metadata key, value
-          end
           transaction.set_http_or_background_queue_start
           Appsignal::Transaction.complete_current! unless exception
 
@@ -151,9 +149,9 @@ module Appsignal
         else
           # Sidekiq Enterprise argument encryption.
           # More information: https://github.com/mperham/sidekiq/wiki/Ent-Encryption
-          if job["encrypt".freeze]
+          if job["encrypt"]
             # No point in showing 150+ bytes of random garbage
-            args[-1] = "[encrypted data]".freeze
+            args[-1] = "[encrypted data]"
           end
           args
         end

data/lib/appsignal/integrations/sinatra.rb

@@ -14,6 +14,4 @@ Appsignal.config = Appsignal::Config.new(
 Appsignal.start_logger
 Appsignal.start
 
-if Appsignal.active?
-  ::Sinatra::Base.use(Appsignal::Rack::SinatraBaseInstrumentation)
-end
+::Sinatra::Base.use(Appsignal::Rack::SinatraBaseInstrumentation) if Appsignal.active?

data/lib/appsignal/integrations/webmachine.rb

@@ -25,12 +25,10 @@ module Appsignal
 
       def handle_exceptions
         super do
-          begin
-            yield
-          rescue Exception => e # rubocop:disable Lint/RescueException
-            Appsignal.set_error(e)
-            raise e
-          end
+          yield
+        rescue Exception => e # rubocop:disable Lint/RescueException
+          Appsignal.set_error(e)
+          raise e
         end
       end
     end

data/lib/appsignal/logger.rb

@@ -2,7 +2,6 @@
 
 require "logger"
 require "set"
-require "thread"
 
 module Appsignal
   # Logger that flushes logs to the AppSignal logging service
@@ -25,6 +24,7 @@ module Appsignal
     # @return [void]
     def initialize(group, level: INFO, format: PLAINTEXT)
       raise TypeError, "group must be a string" unless group.is_a? String
+
       @group = group
       @level = level
       @format = format
@@ -37,6 +37,7 @@ module Appsignal
     def add(severity, message = nil, group = nil)
       severity ||= UNKNOWN
       return true if severity < level
+
       group = @group if group.nil?
       if message.nil?
         if block_given?
@@ -47,6 +48,7 @@ module Appsignal
         end
       end
       return if message.nil?
+
       message = formatter.call(severity, Time.now, group, message) if formatter
 
       Appsignal::Extension.log(
@@ -64,9 +66,11 @@ module Appsignal
     # @param attributes Attributes to tag the log with
     # @return [void]
     def debug(message = nil, attributes = {})
-      return if DEBUG < level
+      return if level > DEBUG
+
       message = yield if message.nil? && block_given?
       return if message.nil?
+
       add_with_attributes(DEBUG, message, @group, attributes)
     end
 
@@ -75,9 +79,11 @@ module Appsignal
     # @param attributes Attributes to tag the log with
     # @return [void]
     def info(message = nil, attributes = {})
-      return if INFO < level
+      return if level > INFO
+
       message = yield if message.nil? && block_given?
       return if message.nil?
+
       add_with_attributes(INFO, message, @group, attributes)
     end
 
@@ -86,9 +92,11 @@ module Appsignal
     # @param attributes Attributes to tag the log with
     # @return [void]
     def warn(message = nil, attributes = {})
-      return if WARN < level
+      return if level > WARN
+
       message = yield if message.nil? && block_given?
       return if message.nil?
+
       add_with_attributes(WARN, message, @group, attributes)
     end
 
@@ -97,9 +105,11 @@ module Appsignal
     # @param attributes Attributes to tag the log with
     # @return [void]
     def error(message = nil, attributes = {})
-      return if ERROR < level
+      return if level > ERROR
+
       message = yield if message.nil? && block_given?
       return if message.nil?
+
       add_with_attributes(ERROR, message, @group, attributes)
     end
 
@@ -108,12 +118,27 @@ module Appsignal
     # @param attributes Attributes to tag the log with
     # @return [void]
     def fatal(message = nil, attributes = {})
-      return if FATAL < level
+      return if level > FATAL
+
       message = yield if message.nil? && block_given?
       return if message.nil?
+
       add_with_attributes(FATAL, message, @group, attributes)
     end
 
+    # When using ActiveSupport::TaggedLogging without the broadcast feature,
+    # the passed logger is required to respond to the `silence` method.
+    # In our case it behaves as the broadcast feature of the Rails logger, but
+    # we don't have to check if the parent logger has the `silence` method defined
+    # as our logger directly inherits from Ruby base logger.
+    #
+    # Links:
+    # https://github.com/rails/rails/blob/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/activesupport/lib/active_support/logger.rb#L60-L76
+    # https://github.com/rails/rails/blob/main/activesupport/e11ebc04cfbe41c06cdfb70ee5a9fdbbd98bb263/active_support/logger_silence.rb
+    def silence(_severity = ERROR, &block)
+      block.call
+    end
+
     private
 
     def add_with_attributes(severity, message, group, attributes)

data/lib/appsignal/marker.rb

@@ -24,7 +24,7 @@ module Appsignal
   class Marker
     # Path used on the AppSignal Push API
     # https://push.appsignal.com/1/markers
-    ACTION = "markers".freeze
+    ACTION = "markers"
 
     attr_reader :marker_data, :config
 
@@ -49,13 +49,12 @@ module Appsignal
     # @return [void]
     def transmit
       transmitter = Transmitter.new(ACTION, config)
-      puts "Notifying AppSignal of deploy with: "\
+      puts "Notifying AppSignal of deploy with: " \
         "revision: #{marker_data[:revision]}, user: #{marker_data[:user]}"
 
       response = transmitter.transmit(marker_data)
-      unless response.code == "200"
-        raise "#{response.code} at #{transmitter.uri}"
-      end
+      raise "#{response.code} at #{transmitter.uri}" unless response.code == "200"
+
       puts "AppSignal has been notified of this deploy!"
     rescue => e
       puts "Something went wrong while trying to notify AppSignal: #{e}"

data/lib/appsignal/minutely.rb

@@ -135,13 +135,11 @@ module Appsignal
             logger = Appsignal.logger
             logger.debug("Gathering minutely metrics with #{probe_instances.count} probes")
             probe_instances.each do |name, probe|
-              begin
-                logger.debug("Gathering minutely metrics with '#{name}' probe")
-                probe.call
-              rescue => ex
-                logger.error "Error in minutely probe '#{name}': #{ex}"
-                logger.debug ex.backtrace.join("\n")
-              end
+              logger.debug("Gathering minutely metrics with '#{name}' probe")
+              probe.call
+            rescue => ex
+              logger.error "Error in minutely probe '#{name}': #{ex}"
+              logger.debug ex.backtrace.join("\n")
             end
             sleep wait_time
           end
@@ -164,6 +162,7 @@ module Appsignal
       def initial_wait_time
         remaining_seconds = 60 - Time.now.sec
         return remaining_seconds if remaining_seconds > 30
+
         remaining_seconds + 60
       end
 
@@ -195,6 +194,7 @@ module Appsignal
 
       def dependencies_present?(probe)
         return true unless probe.respond_to? :dependencies_present?
+
         probe.dependencies_present?
       end
 

data/lib/appsignal/probes/gvl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   module Probes
     class GvlProbe
@@ -5,7 +7,8 @@ module Appsignal
 
       # @api private
       def self.dependencies_present?
-        defined?(::GVLTools) && gvltools_0_2_or_newer? && ruby_3_2_or_newer? && !Appsignal::System.jruby?
+        defined?(::GVLTools) && gvltools_0_2_or_newer? && ruby_3_2_or_newer? &&
+          !Appsignal::System.jruby?
       end
 
       # @api private
@@ -25,7 +28,7 @@ module Appsignal
       end
 
       def call
-        probe_global_timer if @gvl_tools::GlobalTimer.enabled?
+        probe_global_timer
         probe_waiting_threads if @gvl_tools::WaitingThreads.enabled?
       end
 
@@ -34,8 +37,10 @@ module Appsignal
       def probe_global_timer
         monotonic_time_ns = @gvl_tools::GlobalTimer.monotonic_time
         gauge_delta :gvl_global_timer, monotonic_time_ns do |time_delta_ns|
-          time_delta_ms = time_delta_ns / 1_000_000
-          set_gauge_with_hostname("gvl_global_timer", time_delta_ms)
+          if time_delta_ns > 0
+            time_delta_ms = time_delta_ns / 1_000_000
+            set_gauge_with_hostname("gvl_global_timer", time_delta_ms)
+          end
         end
       end
 

data/lib/appsignal/probes/helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   module Probes
     module Helpers
@@ -42,13 +44,9 @@ module Appsignal
         return @hostname if defined?(@hostname)
 
         config = @appsignal.config
+        # Auto detect hostname as fallback. May be inaccurate.
         @hostname =
-          if config[:hostname]
-            config[:hostname]
-          else
-            # Auto detect hostname as fallback. May be inaccurate.
-            Socket.gethostname
-          end
+          config[:hostname] || Socket.gethostname
         Appsignal.logger.debug "Probe helper: Using hostname config " \
           "option '#{@hostname.inspect}' as hostname"
 

data/lib/appsignal/probes/mri.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   module Probes
     class MriProbe
@@ -37,9 +39,7 @@ module Appsignal
         end
 
         class_serial = stat[:class_serial]
-        if class_serial
-          set_gauge_with_hostname("ruby_vm", class_serial, :metric => :class_serial)
-        end
+        set_gauge_with_hostname("ruby_vm", class_serial, :metric => :class_serial) if class_serial
 
         global_constant_state =
           stat[:constant_cache] ? stat[:constant_cache].values.sum : stat[:global_constant_state]
@@ -76,8 +76,10 @@ module Appsignal
           set_gauge_with_hostname("gc_count", major_gc_count, :metric => :major_gc_count)
         end
 
-        set_gauge_with_hostname("heap_slots", gc_stats[:heap_live_slots] || gc_stats[:heap_live_slot], :metric => :heap_live)
-        set_gauge_with_hostname("heap_slots", gc_stats[:heap_free_slots] || gc_stats[:heap_free_slot], :metric => :heap_free)
+        set_gauge_with_hostname("heap_slots",
+          gc_stats[:heap_live_slots] || gc_stats[:heap_live_slot], :metric => :heap_live)
+        set_gauge_with_hostname("heap_slots",
+          gc_stats[:heap_free_slots] || gc_stats[:heap_free_slot], :metric => :heap_free)
       end
     end
   end

data/lib/appsignal/probes/sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   module Probes
     class SidekiqProbe
@@ -116,6 +118,7 @@ module Appsignal
 
       def hostname
         return @hostname if defined?(@hostname)
+
         if config.key?(:hostname)
           @hostname = config[:hostname]
           Appsignal.logger.debug "Sidekiq probe: Using hostname config " \

data/lib/appsignal/probes.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   module Probes
   end

data/lib/appsignal/rack/generic_instrumentation.rb

@@ -35,11 +35,7 @@ module Appsignal
           transaction.set_error(error)
           raise error
         ensure
-          if env["appsignal.route"]
-            transaction.set_action_if_nil(env["appsignal.route"])
-          else
-            transaction.set_action_if_nil("unknown")
-          end
+          transaction.set_action_if_nil(env["appsignal.route"] || "unknown")
           transaction.set_metadata("path", request.path)
           transaction.set_metadata("method", request.request_method)
           transaction.set_http_or_background_queue_start

data/lib/appsignal/rack/sinatra_instrumentation.rb

@@ -15,7 +15,7 @@ module Appsignal
       def initialize(app, options = {})
         @app = app
         @options = options
-        Appsignal.logger.warn "Please remove Appsignal::Rack::SinatraInstrumentation "\
+        Appsignal.logger.warn "Please remove Appsignal::Rack::SinatraInstrumentation " \
           "from your Sinatra::Base class. This is no longer needed."
       end
 
@@ -47,9 +47,7 @@ module Appsignal
       end
 
       def call_with_appsignal_monitoring(env)
-        if @options[:params_method]
-          env[:params_method] = @options[:params_method]
-        end
+        env[:params_method] = @options[:params_method] if @options[:params_method]
         request = @options.fetch(:request_class, Sinatra::Request).new(env)
         transaction = Appsignal::Transaction.create(
           SecureRandom.uuid,
@@ -82,7 +80,7 @@ module Appsignal
         return unless env["sinatra.route"]
 
         if env["SCRIPT_NAME"]
-          method, route = env["sinatra.route"].split(" ")
+          method, route = env["sinatra.route"].split
           "#{method} #{env["SCRIPT_NAME"]}#{route}"
         else
           env["sinatra.route"]

data/lib/appsignal/rack/streaming_listener.rb

@@ -31,17 +31,15 @@ module Appsignal
         # Instrument a `process_action`, to set params/action name
         status, headers, body =
           Appsignal.instrument("process_action.rack") do
-            begin
-              @app.call(env)
-            rescue Exception => e # rubocop:disable Lint/RescueException
-              transaction.set_error(e)
-              raise e
-            ensure
-              transaction.set_action_if_nil(env["appsignal.action"])
-              transaction.set_metadata("path", request.path)
-              transaction.set_metadata("method", request.request_method)
-              transaction.set_http_or_background_queue_start
-            end
+            @app.call(env)
+          rescue Exception => e # rubocop:disable Lint/RescueException
+            transaction.set_error(e)
+            raise e
+          ensure
+            transaction.set_action_if_nil(env["appsignal.action"])
+            transaction.set_metadata("path", request.path)
+            transaction.set_metadata("method", request.request_method)
+            transaction.set_http_or_background_queue_start
           end
 
         # Wrap the result body with our StreamWrapper
@@ -56,8 +54,8 @@ module Appsignal
       @transaction = transaction
     end
 
-    def each
-      @stream.each { |c| yield(c) }
+    def each(&block)
+      @stream.each(&block)
     rescue Exception => e # rubocop:disable Lint/RescueException
       @transaction.set_error(e)
       raise e

data/lib/appsignal/span.rb

@@ -1,11 +1,9 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Span
     def initialize(namespace = nil, ext = nil)
-      @ext = if ext
-               ext
-             else
-               Appsignal::Extension::Span.root(namespace || "")
-             end
+      @ext = ext || Appsignal::Extension::Span.root(namespace || "")
     end
 
     def child
@@ -34,6 +32,7 @@ module Appsignal
 
     def set_sample_data(key, data)
       return unless key && data && (data.is_a?(Array) || data.is_a?(Hash))
+
       @ext.set_sample_data(
         key.to_s,
         Appsignal::Utils::Data.generate(data)
@@ -62,6 +61,7 @@ module Appsignal
     def to_h
       json = @ext.to_json
       return unless json
+
       JSON.parse(json)
     end
 

data/lib/appsignal/system.rb

@@ -7,14 +7,14 @@ module Appsignal
   #
   # @api private
   module System
-    LINUX_TARGET = "linux".freeze
-    LINUX_ARM_ARCHITECTURE = "aarch64".freeze
-    MUSL_TARGET = "linux-musl".freeze
-    FREEBSD_TARGET = "freebsd".freeze
-    GEM_EXT_PATH = File.expand_path("../../../ext", __FILE__).freeze
+    LINUX_TARGET = "linux"
+    LINUX_ARM_ARCHITECTURE = "aarch64"
+    MUSL_TARGET = "linux-musl"
+    FREEBSD_TARGET = "freebsd"
+    GEM_EXT_PATH = File.expand_path("../../ext", __dir__).freeze
 
     def self.heroku?
-      ENV.key? "DYNO".freeze
+      ENV.key? "DYNO"
     end
 
     # Detect agent and extension platform build
@@ -48,10 +48,9 @@ module Appsignal
       if local_os =~ /linux/
         ldd_output = ldd_version_output
         return MUSL_TARGET if ldd_output.include? "musl"
+
         ldd_version = extract_ldd_version(ldd_output)
-        if ldd_version && versionify(ldd_version) < versionify("2.15")
-          return MUSL_TARGET
-        end
+        return MUSL_TARGET if ldd_version && versionify(ldd_version) < versionify("2.15")
       end
 
       local_os
@@ -77,14 +76,14 @@ module Appsignal
     #
     # @api private
     def self.force_musl_build?
-      %w[true 1].include?(ENV["APPSIGNAL_BUILD_FOR_MUSL"])
+      %w[true 1].include?(ENV.fetch("APPSIGNAL_BUILD_FOR_MUSL", nil))
     end
 
     # Returns whether or not the linux ARM build was selected by the user.
     #
     # @api private
     def self.force_linux_arm_build?
-      %w[true 1].include?(ENV["APPSIGNAL_BUILD_FOR_LINUX_ARM"])
+      %w[true 1].include?(ENV.fetch("APPSIGNAL_BUILD_FOR_LINUX_ARM", nil))
     end
 
     # @api private