appsignal 4.5.17 → 4.6.0

data/lib/appsignal/probes/mri.rb

@@ -2,11 +2,11 @@
 
 module Appsignal
   module Probes
-    # @api private
+    # @!visibility private
     class MriProbe
       include Helpers
 
-      # @api private
+      # @!visibility private
       def self.dependencies_present?
         defined?(::RubyVM) && ::RubyVM.respond_to?(:stat)
       end
@@ -17,7 +17,7 @@ module Appsignal
         @gc_profiler = gc_profiler
       end
 
-      # @api private
+      # @!visibility private
       def call
         stat = RubyVM.stat
 

data/lib/appsignal/probes/sidekiq.rb

@@ -2,7 +2,7 @@
 
 module Appsignal
   module Probes
-    # @api private
+    # @!visibility private
     class SidekiqProbe
       include Helpers
 
@@ -38,14 +38,15 @@ module Appsignal
         end
       end
 
-      # @api private
+      # @!visibility private
       attr_reader :config
 
+      # @!visibility private
       def self.sidekiq7_and_greater?
         Gem::Version.new(::Sidekiq::VERSION) >= Gem::Version.new("7.0.0")
       end
 
-      # @api private
+      # @!visibility private
       def self.dependencies_present?
         return true if sidekiq7_and_greater?
         return false unless defined?(::Redis::VERSION) # Sidekiq <= 6

data/lib/appsignal/probes.rb

@@ -2,10 +2,11 @@
 
 module Appsignal
   module Probes
-    # @api private
+    # @return [Integer]
+    # @!visibility private
     ITERATION_IN_SECONDS = 60
 
-    # @api private
+    # @!visibility private
     class ProbeCollection
       def initialize
         @probes = {}
@@ -23,13 +24,12 @@ module Appsignal
       end
 
       # Fetch a probe using its name.
-      # @param key [Symbol/String] The name of the probe to fetch.
+      # @param key [Symbol, String] The name of the probe to fetch.
       # @return [Object] Returns the registered probe.
       def [](key)
         probes[key]
       end
 
-      # @api private
       def internal_register(name, probe)
         if probes.key?(name)
           logger.debug "A probe with the name `#{name}` is already " \
@@ -38,12 +38,10 @@ module Appsignal
         probes[name] = probe
       end
 
-      # @api private
       def unregister(name)
         probes.delete(name)
       end
 
-      # @api private
       def each(&block)
         probes.each(&block)
       end
@@ -58,14 +56,14 @@ module Appsignal
     end
 
     class << self
-      # @api private
+      # @!visibility private
       def mutex
         @mutex ||= Thread::Mutex.new
       end
 
       # @see ProbeCollection
       # @return [ProbeCollection] Returns list of probes.
-      # @api private
+      # @!visibility private
       def probes
         @probes ||= ProbeCollection.new
       end
@@ -129,7 +127,7 @@ module Appsignal
       #   # "started" # Printed on Appsignal::Probes.start
       #   # "called" # Repeated every minute
       #
-      # @param name [Symbol/String] Name of the probe. Can be used with
+      # @param name [Symbol, String] Name of the probe. Can be used with
       #   {ProbeCollection#[]}. This name will be used in errors in the log and
       #   allows overwriting of probes by registering new ones with the same
       #   name.
@@ -153,7 +151,7 @@ module Appsignal
       #   # Then unregister a probe if needed
       #   Appsignal::Probes.unregister :my_probe
       #
-      # @param name [Symbol/String] Name of the probe used to {register} the
+      # @param name [Symbol, String] Name of the probe used to {register} the
       #   probe.
       # @return [void]
       def unregister(name)
@@ -162,6 +160,7 @@ module Appsignal
         uninitialize_probe(name)
       end
 
+      # @return [void]
       # @api private
       def start
         stop
@@ -184,8 +183,10 @@ module Appsignal
                 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")
+                logger.error(
+                  "Error in minutely probe '#{name}': #{ex.class}: #{ex.message}\n" \
+                    "#{ex.backtrace.join("\n")}"
+                )
               end
             end
             end_time = Time.now
@@ -212,13 +213,15 @@ module Appsignal
 
       # Stop the minutely probes mechanism. Stop the thread and clear all probe
       # instances.
+      #
+      # @return [void]
       def stop
         defined?(@thread) && @thread.kill
         @started = false
         probe_instances.clear
       end
 
-      # @api private
+      # @!visibility private
       def wait_time
         ITERATION_IN_SECONDS - Time.now.sec
       end
@@ -256,8 +259,10 @@ module Appsignal
         end
       rescue => error
         logger = Appsignal.internal_logger
-        logger.error "Error while initializing minutely probe '#{name}': #{error}"
-        logger.debug error.backtrace.join("\n")
+        logger.error(
+          "Error while initializing minutely probe '#{name}': #{error.class}: #{error.message}\n" \
+            "#{error.backtrace.join("\n")}"
+        )
       end
 
       def uninitialize_probe(name)

data/lib/appsignal/rack.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Appsignal
-  # @api private
+  # @!visibility private
   module Rack
     APPSIGNAL_TRANSACTION = "appsignal.transaction"
     APPSIGNAL_EVENT_HANDLER_ID = "appsignal.event_handler_id"

data/lib/appsignal/sample_data.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Appsignal
-  # @api private
+  # @!visibility private
   class SampleData
     def initialize(key, accepted_type = nil)
       @key = key
@@ -21,7 +21,6 @@ module Appsignal
       end
     end
 
-    # @api private
     def set_empty_value!
       @empty = true
       @blocks.clear
@@ -36,12 +35,18 @@ module Appsignal
           else
             block_or_value
           end
+
         unless accepted_type?(new_value)
           log_unsupported_data_type(new_value)
           next
         end
 
-        value = merge_values(value, new_value)
+        # Before trying to merge values, convert them to Ruby classes
+        # This way we don't need to check if something is of a type often
+        value_new = convert_to_ruby_class(new_value)
+        value_original = convert_to_ruby_class(value)
+
+        value = merge_values(value_original, value_new)
         new_value
       end
 
@@ -52,7 +57,6 @@ module Appsignal
       @blocks.any?
     end
 
-    # @api private
     def empty?
       @empty
     end
@@ -81,15 +85,19 @@ module Appsignal
       end
     end
 
+    def mergable?(value_original, value_new)
+      value_new.instance_of?(value_original.class)
+    end
+
     def merge_values(value_original, value_new)
-      unless value_new.instance_of?(value_original.class)
-        unless value_original == UNSET_VALUE
-          Appsignal.internal_logger.warn(
-            "The sample data '#{@key}' changed type from " \
-              "'#{value_original.class}' to '#{value_new.class}'. " \
-              "These types can not be merged. Using new '#{value_new.class}' type."
-          )
-        end
+      return value_new if value_original == UNSET_VALUE
+
+      unless mergable?(value_original, value_new)
+        Appsignal.internal_logger.warn(
+          "The sample data '#{@key}' changed type from " \
+            "'#{value_original.class}' to '#{value_new.class}'. " \
+            "These types can not be merged. Using new '#{value_new.class}' type."
+        )
         return value_new
       end
 
@@ -103,6 +111,17 @@ module Appsignal
       end
     end
 
+    # Convert any subclasses of Hash to a Ruby Hash class, so we don't have to
+    # account for the original value being a value that's not a pure Hash or
+    # Array object.
+    def convert_to_ruby_class(value)
+      if value.is_a? Hash
+        value.to_h
+      else
+        value
+      end
+    end
+
     def log_unsupported_data_type(value)
       Appsignal.internal_logger.error(
         "Sample data '#{@key}': Unsupported data type '#{value.class}' received: #{value.inspect}"

data/lib/appsignal/span.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Appsignal
-  # @api private
+  # @!visibility private
   class Span
     def initialize(namespace = nil, ext = nil)
       @ext = ext || Appsignal::Extension::Span.root(namespace || "")

data/lib/appsignal/system.rb

@@ -5,7 +5,7 @@ module Appsignal
   #
   # Provides useful methods to find out more about the host system.
   #
-  # @api private
+  # @!visibility private
   module System
     LINUX_TARGET = "linux"
     LINUX_ARM_ARCHITECTURE = "aarch64"
@@ -13,6 +13,9 @@ module Appsignal
     FREEBSD_TARGET = "freebsd"
     GEM_EXT_PATH = File.expand_path("../../ext", __dir__).freeze
 
+    # Returns if system is recognized as a Heroku dyno.
+    #
+    # @return [Boolean]
     def self.heroku?
       ENV.key? "DYNO"
     end
@@ -27,7 +30,6 @@ module Appsignal
     # - Use `export APPSIGNAL_BUILD_FOR_LINUX_ARM=1` to enable the experimental
     #   Linux ARM build.
     #
-    # @api private
     # @return [String]
     def self.agent_platform
       return LINUX_TARGET if force_linux_arm_build?
@@ -63,7 +65,6 @@ module Appsignal
     # - Use `export APPSIGNAL_BUILD_FOR_LINUX_ARM=1` to enable the experimental
     #   Linux ARM build.
     #
-    # @api private
     # @return [String]
     def self.agent_architecture
       return LINUX_ARM_ARCHITECTURE if force_linux_arm_build?
@@ -74,34 +75,34 @@ module Appsignal
 
     # Returns whether or not the musl build was forced by the user.
     #
-    # @api private
+    # @return [Boolean]
     def self.force_musl_build?
       %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
+    # @return [Boolean]
     def self.force_linux_arm_build?
       %w[true 1].include?(ENV.fetch("APPSIGNAL_BUILD_FOR_LINUX_ARM", nil))
     end
 
-    # @api private
     def self.versionify(version)
       Gem::Version.new(version)
     end
 
-    # @api private
     def self.ldd_version_output
       `ldd --version 2>&1`
     end
 
-    # @api private
     def self.extract_ldd_version(string)
       ldd_version = string.match(/\d+\.\d+/)
       ldd_version && ldd_version[0]
     end
 
+    # Returns if the app is recognized as a JRuby app.
+    #
+    # @return [Boolean]
     def self.jruby?
       RUBY_PLATFORM == "java"
     end