appsignal 2.9.2.alpha.1 → 2.9.18.beta.2

data/lib/appsignal/cli/notify_of_deploy.rb

@@ -60,6 +60,8 @@ module Appsignal
     #   Terminology: Deploy marker
     class NotifyOfDeploy
       class << self
+        include Appsignal::Utils::DeprecationMessage
+
         # @param options [Hash]
         # @option options :environment [String] environment to load
         #   configuration for.
@@ -85,6 +87,14 @@ module Appsignal
             },
             config
           ).transmit
+
+          puts
+          message = "This command (appsignal notify_of_deploy) has been " \
+            "deprecated in favor of the `revision` config option. Please " \
+            "see our documentation for more information on the recommended " \
+            "method: " \
+            "https://docs.appsignal.com/application/markers/deploy-markers.html"
+          deprecation_message message, Appsignal.logger
         end
 
         private

data/lib/appsignal/config.rb

@@ -39,7 +39,8 @@ module Appsignal
       :enable_minutely_probes         => true,
       :ca_file_path                   => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
       :dns_servers                    => [],
-      :files_world_accessible         => true
+      :files_world_accessible         => true,
+      :transaction_debug_mode         => false
     }.freeze
 
     ENV_TO_KEY_MAPPING = {
@@ -75,6 +76,7 @@ module Appsignal
       "APPSIGNAL_DNS_SERVERS"                    => :dns_servers,
       "APPSIGNAL_FILES_WORLD_ACCESSIBLE"         => :files_world_accessible,
       "APPSIGNAL_REQUEST_HEADERS"                => :request_headers,
+      "APPSIGNAL_TRANSACTION_DEBUG_MODE"         => :transaction_debug_mode,
       "APP_REVISION"                             => :revision
     }.freeze
 
@@ -219,6 +221,7 @@ module Appsignal
       ENV["_APPSIGNAL_CA_FILE_PATH"]                 = config_hash[:ca_file_path].to_s
       ENV["_APPSIGNAL_DNS_SERVERS"]                  = config_hash[:dns_servers].join(",")
       ENV["_APPSIGNAL_FILES_WORLD_ACCESSIBLE"]       = config_hash[:files_world_accessible].to_s
+      ENV["_APPSIGNAL_TRANSACTION_DEBUG_MODE"]       = config_hash[:transaction_debug_mode].to_s
       ENV["_APP_REVISION"]                           = config_hash[:revision].to_s
     end
 
@@ -324,7 +327,7 @@ module Appsignal
          APPSIGNAL_ENABLE_ALLOCATION_TRACKING APPSIGNAL_ENABLE_GC_INSTRUMENTATION
          APPSIGNAL_RUNNING_IN_CONTAINER APPSIGNAL_ENABLE_HOST_METRICS
          APPSIGNAL_SEND_PARAMS APPSIGNAL_ENABLE_MINUTELY_PROBES
-         APPSIGNAL_FILES_WORLD_ACCESSIBLE].each do |var|
+         APPSIGNAL_FILES_WORLD_ACCESSIBLE APPSIGNAL_TRANSACTION_DEBUG_MODE].each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var.casecmp("true").zero?

data/lib/appsignal/event_formatter/action_view/render_formatter.rb

@@ -22,11 +22,13 @@ module Appsignal
   end
 end
 
-Appsignal::EventFormatter.register(
-  "render_partial.action_view",
-  Appsignal::EventFormatter::ActionView::RenderFormatter
-)
-Appsignal::EventFormatter.register(
-  "render_template.action_view",
-  Appsignal::EventFormatter::ActionView::RenderFormatter
-)
+if defined?(Rails)
+  Appsignal::EventFormatter.register(
+    "render_partial.action_view",
+    Appsignal::EventFormatter::ActionView::RenderFormatter
+  )
+  Appsignal::EventFormatter.register(
+    "render_template.action_view",
+    Appsignal::EventFormatter::ActionView::RenderFormatter
+  )
+end

data/lib/appsignal/helpers/instrumentation.rb

@@ -2,7 +2,6 @@
 
 module Appsignal
   module Helpers
-    # @api private
     module Instrumentation # rubocop:disable Metrics/ModuleLength
       # Creates an AppSignal transaction for the given block.
       #
@@ -57,8 +56,9 @@ module Appsignal
       # @return [Object] the value of the given block is returned.
       # @since 0.10.0
       def monitor_transaction(name, env = {})
-        return yield unless active?
-
+        # Always verify input, even when Appsignal is not active.
+        # This makes it more likely invalid arguments get flagged in test/dev
+        # environments.
         if name.start_with?("perform_job".freeze)
           namespace = Appsignal::Transaction::BACKGROUND_JOB
           request   = Appsignal::Transaction::GenericRequest.new(env)
@@ -66,9 +66,14 @@ module Appsignal
           namespace = Appsignal::Transaction::HTTP_REQUEST
           request   = ::Rack::Request.new(env)
         else
-          logger.error("Unrecognized name '#{name}'")
-          return
+          logger.error "Unrecognized name '#{name}': names must start with " \
+            "either 'perform_job' (for jobs and tasks) or 'process_action' " \
+            "(for HTTP requests)"
+          return yield
         end
+
+        return yield unless active?
+
         transaction = Appsignal::Transaction.create(
           SecureRandom.uuid,
           namespace,
@@ -196,7 +201,8 @@ module Appsignal
       )
         return unless active?
         unless error.is_a?(Exception)
-          logger.error("Can't send error, given value is not an exception")
+          logger.error "Appsignal.send_error: Cannot send error. The given " \
+            "value is not an exception: #{error.inspect}"
           return
         end
         transaction = Appsignal::Transaction.new(
@@ -251,9 +257,12 @@ module Appsignal
       #   Exception handling guide
       # @since 0.6.6
       def set_error(exception, tags = nil, namespace = nil)
-        return if !active? ||
-            Appsignal::Transaction.current.nil? ||
-            exception.nil?
+        unless exception.is_a?(Exception)
+          logger.error "Appsignal.set_error: Cannot set error. The given " \
+            "value is not an exception: #{exception.inspect}"
+          return
+        end
+        return if !active? || Appsignal::Transaction.current.nil?
         transaction = Appsignal::Transaction.current
         transaction.set_error(exception)
         transaction.set_tags(tags) if tags

data/lib/appsignal/helpers/metrics.rb

@@ -2,7 +2,6 @@
 
 module Appsignal
   module Helpers
-    # @api private
     module Metrics
       def set_gauge(key, value, tags = {})
         Appsignal::Extension.set_gauge(

data/lib/appsignal/hooks.rb

@@ -37,7 +37,9 @@ module Appsignal
           install
           @installed = true
         rescue => ex
-          Appsignal.logger.error("Error while installing #{name} hook: #{ex}")
+          logger = Appsignal.logger
+          logger.error("Error while installing #{name} hook: #{ex}")
+          logger.debug ex.backtrace.join("\n")
         end
       end
 

data/lib/appsignal/hooks/active_support_notifications.rb

@@ -30,16 +30,13 @@ module Appsignal
             # Events that start with a bang are internal to Rails
             instrument_this = name[0] != BANG
 
-            if instrument_this
-              transaction = Appsignal::Transaction.current
-              transaction.start_event
-            end
+            Appsignal::Transaction.current.start_event if instrument_this
 
             instrument_without_appsignal(name, payload, &block)
           ensure
             if instrument_this
               title, body, body_format = Appsignal::EventFormatter.format(name, payload)
-              transaction.finish_event(
+              Appsignal::Transaction.current.finish_event(
                 name.to_s,
                 title,
                 body,

data/lib/appsignal/hooks/puma.rb

@@ -11,22 +11,24 @@ module Appsignal
       end
 
       def install
-        if ::Puma.respond_to?(:stats)
+        if ::Puma.respond_to?(:stats) && !defined?(APPSIGNAL_PUMA_PLUGIN_LOADED)
+          # Only install the minutely probe if a user isn't using our Puma
+          # plugin, which lives in `lib/puma/appsignal.rb`. This plugin defines
+          # the {APPSIGNAL_PUMA_PLUGIN_LOADED} constant.
+          #
+          # We prefer people use the AppSignal Puma plugin. This fallback is
+          # only there when users relied on our *magic* integration.
+          #
+          # Using the Puma plugin, the minutely probe thread will still run in
+          # Puma workers, for other non-Puma probes, but the Puma probe only
+          # runs in the Puma main process.
+          # For more information:
+          # https://docs.appsignal.com/ruby/integrations/puma.html
           Appsignal::Minutely.probes.register :puma, PumaProbe
         end
 
-        if ::Puma.respond_to?(:cli_config) && ::Puma.cli_config
-          ::Puma.cli_config.options[:before_worker_boot] ||= []
-          ::Puma.cli_config.options[:before_worker_boot] << proc do |_id|
-            Appsignal.forked
-          end
-
-          ::Puma.cli_config.options[:before_worker_shutdown] ||= []
-          ::Puma.cli_config.options[:before_worker_shutdown] << proc do |_id|
-            Appsignal.stop("puma before_worker_shutdown")
-          end
-        end
-
+        return unless defined?(::Puma::Cluster)
+        # For clustered mode with multiple workers
         ::Puma::Cluster.class_eval do
           alias stop_workers_without_appsignal stop_workers
 

data/lib/appsignal/hooks/sequel.rb

@@ -42,7 +42,7 @@ module Appsignal
 
       def install
         # Register the extension...
-        if ::Sequel::MAJOR >= 4 && ::Sequel::MINOR >= 35
+        if (::Sequel::MAJOR >= 4 && ::Sequel::MINOR >= 35) || ::Sequel::MAJOR >= 5
           ::Sequel::Database.register_extension(
             :appsignal_integration,
             Appsignal::Hooks::SequelLogConnectionExtension

data/lib/appsignal/hooks/sidekiq.rb

@@ -25,20 +25,42 @@ module Appsignal
     class SidekiqProbe
       attr_reader :config
 
+      def self.dependencies_present?
+        Gem::Version.new(::Redis::VERSION) >= Gem::Version.new("3.3.5")
+      end
+
       def initialize(config = {})
         @config = config
         @cache = {}
+        config_string = " with config: #{config}" unless config.empty?
+        Appsignal.logger.debug("Initializing Sidekiq probe#{config_string}")
         require "sidekiq/api"
       end
 
       def call
-        stats = ::Sidekiq::Stats.new
+        track_redis_info
+        track_stats
+        track_queues
+      end
+
+      private
+
+      attr_reader :cache
+
+      def track_redis_info
+        return unless ::Sidekiq.respond_to?(:redis_info)
         redis_info = ::Sidekiq.redis_info
-        gauge "worker_count", stats.workers_size
-        gauge "process_count", stats.processes_size
+
         gauge "connection_count", redis_info.fetch("connected_clients")
         gauge "memory_usage", redis_info.fetch("used_memory")
         gauge "memory_usage_rss", redis_info.fetch("used_memory_rss")
+      end
+
+      def track_stats
+        stats = ::Sidekiq::Stats.new
+
+        gauge "worker_count", stats.workers_size
+        gauge "process_count", stats.processes_size
         gauge_delta :jobs_processed, "job_count", stats.processed,
           :status => :processed
         gauge_delta :jobs_failed, "job_count", stats.failed, :status => :failed
@@ -46,17 +68,16 @@ module Appsignal
         gauge_delta :jobs_dead, "job_count", stats.dead_size, :status => :died
         gauge "job_count", stats.scheduled_size, :status => :scheduled
         gauge "job_count", stats.enqueued, :status => :enqueued
+      end
 
+      def track_queues
         ::Sidekiq::Queue.all.each do |queue|
           gauge "queue_length", queue.size, :queue => queue.name
-          gauge "queue_latency", queue.latency, :queue => queue.name
+          # Convert latency from seconds to milliseconds
+          gauge "queue_latency", queue.latency * 1_000.0, :queue => queue.name
         end
       end
 
-      private
-
-      attr_reader :cache
-
       # Track a gauge metric with the `sidekiq_` prefix
       def gauge(key, value, tags = {})
         tags[:hostname] = hostname if hostname
@@ -86,11 +107,15 @@ module Appsignal
         return @hostname if defined?(@hostname)
         if config.key?(:hostname)
           @hostname = config[:hostname]
+          Appsignal.logger.debug "Sidekiq probe: Using hostname config " \
+            "option #{@hostname.inspect} as hostname"
           return @hostname
         end
 
         host = nil
         ::Sidekiq.redis { |c| host = c.connection[:host] }
+        Appsignal.logger.debug "Sidekiq probe: Using Redis server hostname " \
+          "#{host.inspect} as hostname"
         @hostname = host
       end
     end

data/lib/appsignal/integrations/que.rb

@@ -5,16 +5,17 @@ module Appsignal
     module QuePlugin
       def self.included(base)
         base.class_eval do
-          def _run_with_appsignal
+          def _run_with_appsignal(*)
+            local_attrs = respond_to?(:que_attrs) ? que_attrs : attrs
             env = {
               :metadata    => {
-                :id        => attrs[:job_id],
-                :queue     => attrs[:queue],
-                :run_at    => attrs[:run_at].to_s,
-                :priority  => attrs[:priority],
-                :attempts  => attrs[:error_count].to_i
+                :id        => local_attrs[:job_id] || local_attrs[:id],
+                :queue     => local_attrs[:queue],
+                :run_at    => local_attrs[:run_at].to_s,
+                :priority  => local_attrs[:priority],
+                :attempts  => local_attrs[:error_count].to_i
               },
-              :params => attrs[:args]
+              :params => local_attrs[:args]
             }
 
             request = Appsignal::Transaction::GenericRequest.new(env)
@@ -31,7 +32,7 @@ module Appsignal
               transaction.set_error(error)
               raise error
             ensure
-              transaction.set_action "#{attrs[:job_class]}#run"
+              transaction.set_action "#{local_attrs[:job_class]}#run"
               Appsignal::Transaction.complete_current!
             end
           end

data/lib/appsignal/minutely.rb

@@ -135,20 +135,22 @@ module Appsignal
       # @api private
       def start
         stop
-        initialize_probes
         @@thread = Thread.new do
+          sleep initial_wait_time
+          initialize_probes
           loop do
             logger = Appsignal.logger
-            logger.debug("Gathering minutely metrics with #{probes.count} probes")
+            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.error "Error in minutely probe '#{name}': #{ex}"
+                logger.debug ex.backtrace.join("\n")
               end
             end
-            sleep(Appsignal::Minutely.wait_time)
+            sleep wait_time
           end
         end
       end
@@ -164,30 +166,47 @@ module Appsignal
         60 - Time.now.sec
       end
 
-      # @api private
-      def register_garbage_collection_probe
-        probes.register :garbage_collection, GCProbe.new
-      end
-
       private
 
+      def initial_wait_time
+        remaining_seconds = 60 - Time.now.sec
+        return remaining_seconds if remaining_seconds > 30
+        remaining_seconds + 60
+      end
+
       def initialize_probes
         probes.each do |name, probe|
-          instance = probe.respond_to?(:new) ? probe.new : probe
-          probe_instances[name] = instance
+          initialize_probe(name, probe)
         end
       end
 
-      def probe_instances
-        @@probe_instances ||= {}
+      def initialize_probe(name, probe)
+        if probe.respond_to? :new
+          instance = probe.new
+          klass = probe
+        else
+          instance = probe
+          klass = instance.class
+        end
+        unless dependencies_present?(klass)
+          Appsignal.logger.debug "Skipping '#{name}' probe, " \
+            "#{klass}.dependency_present? returned falsy"
+          return
+        end
+        probe_instances[name] = instance
+      rescue => error
+        logger = Appsignal.logger
+        logger.error "Error while initializing minutely probe '#{name}': #{error}"
+        logger.debug error.backtrace.join("\n")
       end
-    end
 
-    class GCProbe
-      def call
-        GC.stat.each do |key, value|
-          Appsignal.set_process_gauge("gc.#{key}", value)
-        end
+      def dependencies_present?(probe)
+        return true unless probe.respond_to? :dependencies_present?
+        probe.dependencies_present?
+      end
+
+      def probe_instances
+        @@probe_instances ||= {}
       end
     end
   end

data/lib/appsignal/transaction.rb

@@ -264,6 +264,11 @@ module Appsignal
     end
 
     def set_error(error)
+      unless error.is_a?(Exception)
+        Appsignal.logger.error "Appsignal::Transaction#set_error: Cannot set error. " \
+          "The given value is not an exception: #{error.inspect}"
+        return
+      end
       return unless error
       return unless Appsignal.active?