appsignal 2.10.10 → 2.11.0.beta.3

data/ext/appsignal_extension.c

@@ -639,6 +639,14 @@ static VALUE running_in_container() {
   return appsignal_running_in_container() == 1 ? Qtrue : Qfalse;
 }
 
+static VALUE set_environment_metadata(VALUE self, VALUE key, VALUE value) {
+  appsignal_set_environment_metadata(
+      make_appsignal_string(key),
+      make_appsignal_string(value)
+  );
+  return Qnil;
+}
+
 void Init_appsignal_extension(void) {
   Appsignal = rb_define_module("Appsignal");
   Extension = rb_define_class_under(Appsignal, "Extension", rb_cObject);
@@ -697,9 +705,10 @@ void Init_appsignal_extension(void) {
   // Get JSON content of a data
   rb_define_method(Data, "to_s", data_to_s, 0);
 
-  // Event hook installation
+  // Other helper methods
   rb_define_singleton_method(Extension, "install_allocation_event_hook", install_allocation_event_hook, 0);
   rb_define_singleton_method(Extension, "running_in_container?", running_in_container, 0);
+  rb_define_singleton_method(Extension, "set_environment_metadata", set_environment_metadata, 2);
 
   // Metrics
   rb_define_singleton_method(Extension, "set_gauge",              set_gauge,              3);

data/gemfiles/padrino.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'padrino', '~> 0.13.0'
-gem 'rack', '~> 1.6'
+gem 'padrino', "~> 0.15"
+gem 'rack'
 
 gemspec :path => '../'

data/gemfiles/rails-4.2.gemfile

@@ -3,8 +3,15 @@ source 'https://rubygems.org'
 gem 'rails', '~> 4.2.0'
 gem 'mime-types', '~> 2.6'
 
-gemspec :path => '../'
+ruby_version = Gem::Version.new(RUBY_VERSION)
+if ruby_version < Gem::Version.new("2.3.0")
+  gem "sidekiq", "~> 4.0"
+else
+  gem "sidekiq"
+end
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.1.0")
+if ruby_version < Gem::Version.new("2.1.0")
   gem 'nokogiri', '~> 1.6.0'
 end
+
+gemspec :path => '../'

data/gemfiles/rails-5.0.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 5.0.0'
+gem "sidekiq"
 
 gemspec :path => '../'

data/gemfiles/rails-5.1.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 5.1.0'
+gem "sidekiq"
 
 gemspec :path => '../'

data/gemfiles/rails-5.2.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 5.2.0'
+gem "sidekiq"
 
 gemspec :path => '../'

data/gemfiles/rails-6.0.gemfile

@@ -1,5 +1,6 @@
 source 'https://rubygems.org'
 
 gem 'rails', '~> 6.0.0'
+gem "sidekiq"
 
 gemspec :path => '../'

data/gemfiles/resque-1.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'resque', "~> 1.27.0"
+gem 'sinatra'
+gem 'mime-types', '~> 2.6'
+
+gemspec :path => '../'

data/gemfiles/{resque.gemfile → resque-2.gemfile}

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'resque'
+gem 'resque', "~> 2.0"
 gem 'sinatra'
 gem 'mime-types', '~> 2.6'
 

data/lib/appsignal.rb

@@ -134,11 +134,17 @@ module Appsignal
 
           if config[:enable_allocation_tracking] && !Appsignal::System.jruby?
             Appsignal::Extension.install_allocation_event_hook
+            Appsignal::Environment.report_enabled("allocation_tracking")
           end
 
-          GC::Profiler.enable if config[:enable_gc_instrumentation]
+          if config[:enable_gc_instrumentation]
+            GC::Profiler.enable
+            Appsignal::Environment.report_enabled("gc_instrumentation")
+          end
 
           Appsignal::Minutely.start if config[:enable_minutely_probes]
+
+          collect_environment_metadata
         else
           logger.info("Not starting, not active for #{config.env}")
         end
@@ -309,9 +315,23 @@ module Appsignal
       logger.warn "Unable to start logger with log path '#{path}'."
       logger.warn error
     end
+
+    def collect_environment_metadata
+      Appsignal::Environment.report("ruby_version") do
+        "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}"
+      end
+      Appsignal::Environment.report("ruby_engine") { RUBY_ENGINE }
+      if defined?(RUBY_ENGINE_VERSION)
+        Appsignal::Environment.report("ruby_engine_version") do
+          RUBY_ENGINE_VERSION
+        end
+      end
+      Appsignal::Environment.report_supported_gems
+    end
   end
 end
 
+require "appsignal/environment"
 require "appsignal/system"
 require "appsignal/utils"
 require "appsignal/extension"

data/lib/appsignal/capistrano.rb

@@ -3,6 +3,8 @@
 require "appsignal"
 require "capistrano/version"
 
+Appsignal::Environment.report_enabled("capistrano")
+
 if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION) >= Gem::Version.new(3)
   # Capistrano 3+
   load File.expand_path("../integrations/capistrano/appsignal.cap", __FILE__)

data/lib/appsignal/config.rb

@@ -18,6 +18,7 @@ module Appsignal
       :ignore_namespaces              => [],
       :filter_parameters              => [],
       :filter_session_data            => [],
+      :send_environment_metadata      => true,
       :send_params                    => true,
       :request_headers                => %w[
         HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING
@@ -62,6 +63,7 @@ module Appsignal
       "APPSIGNAL_IGNORE_NAMESPACES"              => :ignore_namespaces,
       "APPSIGNAL_FILTER_PARAMETERS"              => :filter_parameters,
       "APPSIGNAL_FILTER_SESSION_DATA"            => :filter_session_data,
+      "APPSIGNAL_SEND_ENVIRONMENT_METADATA"      => :send_environment_metadata,
       "APPSIGNAL_SEND_PARAMS"                    => :send_params,
       "APPSIGNAL_HTTP_PROXY"                     => :http_proxy,
       "APPSIGNAL_ENABLE_ALLOCATION_TRACKING"     => :enable_allocation_tracking,
@@ -222,6 +224,7 @@ module Appsignal
       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["_APPSIGNAL_SEND_ENVIRONMENT_METADATA"]    = config_hash[:send_environment_metadata].to_s
       ENV["_APP_REVISION"]                           = config_hash[:revision].to_s
     end
 
@@ -337,8 +340,9 @@ module Appsignal
          APPSIGNAL_SKIP_SESSION_DATA APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING
          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 APPSIGNAL_TRANSACTION_DEBUG_MODE].each do |var|
+         APPSIGNAL_SEND_ENVIRONMENT_METADATA APPSIGNAL_SEND_PARAMS
+         APPSIGNAL_ENABLE_MINUTELY_PROBES 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/environment.rb

@@ -0,0 +1,126 @@
+module Appsignal
+  # @api private
+  class Environment
+    # Add environment metadata.
+    #
+    # The key and value of the environment metadata must be a String, even if
+    # it's actually of another type.
+    #
+    # The value of the environment metadata is given as a block that captures
+    # errors that might be raised while fetching the value. It will not
+    # re-raise errors, but instead log them using the {Appsignal.logger}. This
+    # ensures AppSignal will not cause an error in the application when
+    # collecting this metadata.
+    #
+    # @example Reporting a key and value
+    #   Appsignal::Environment.report("ruby_version") { RUBY_VERSION }
+    #
+    # @example When a value is nil
+    #   Appsignal::Environment.report("ruby_version") { nil }
+    #   # Key and value do not get reported. A warning gets logged instead.
+    #
+    # @example When an error occurs
+    #   Appsignal::Environment.report("ruby_version") { raise "uh oh" }
+    #   # Error does not get reraised. A warning gets logged instead.
+    #
+    # @param key [String] The name of the key of the environment metadata value.
+    # @yieldreturn [String] The value of the key of the environment metadata.
+    # @return [void]
+    def self.report(key)
+      key =
+        case key
+        when String
+          key
+        else
+          Appsignal.logger.error "Unable to report on environment metadata: " \
+            "Unsupported value type for #{key.inspect}"
+          return
+        end
+
+      yielded_value =
+        begin
+          yield
+        rescue => e
+          Appsignal.logger.error \
+            "Unable to report on environment metadata #{key.inspect}:\n" \
+              "#{e.class}: #{e}"
+          return
+        end
+
+      value =
+        case yielded_value
+        when TrueClass, FalseClass
+          yielded_value.to_s
+        when String
+          yielded_value
+        else
+          Appsignal.logger.error "Unable to report on environment metadata " \
+            "#{key.inspect}: Unsupported value type for " \
+            "#{yielded_value.inspect}"
+          return
+        end
+
+      Appsignal::Extension.set_environment_metadata(key, value)
+    rescue => e
+      Appsignal.logger.error "Unable to report on environment metadata:\n" \
+        "#{e.class}: #{e}"
+    end
+
+    # @see report_supported_gems
+    SUPPORTED_GEMS = %w[
+      actioncable
+      activejob
+      capistrano
+      celluloid
+      data_mapper
+      delayed_job
+      mongo_ruby_driver
+      padrino
+      passenger
+      puma
+      que
+      rack
+      rails
+      rake
+      redis
+      resque
+      sequel
+      shoryuken
+      sidekiq
+      sinatra
+      unicorn
+      webmachine
+    ].freeze
+
+    # Report on the list of AppSignal supported gems
+    #
+    # This list is used to report if which AppSignal supported gems are present
+    # in this app and what version. This data will help AppSignal improve its
+    # support by knowing what gems and versions of gems it still needs to
+    # support or can drop support for.
+    #
+    # It will ask Bundler to report name and version information from the gems
+    # that are present in the app bundle.
+    def self.report_supported_gems
+      return unless defined?(Bundler) # Do nothing if Bundler is not present
+
+      bundle_gem_specs = ::Bundler.rubygems.all_specs
+      SUPPORTED_GEMS.each do |gem_name|
+        gem_spec = bundle_gem_specs.find { |spec| spec.name == gem_name }
+        next unless gem_spec
+
+        report("ruby_#{gem_name}_version") { gem_spec.version.to_s }
+      end
+    rescue => e
+      Appsignal.logger.error "Unable to report supported gems:\n" \
+        "#{e.class}: #{e}"
+    end
+
+    def self.report_enabled(feature)
+      Appsignal::Environment.report("ruby_#{feature}_enabled") { true }
+    rescue => e
+      Appsignal.logger.error "Unable to report integration enabled:\n" \
+        "#{e.class}: #{e}"
+    end
+  end
+end

data/lib/appsignal/extension/jruby.rb

@@ -60,6 +60,9 @@ module Appsignal
           [:appsignal_string],
           :appsignal_string
         attach_function :appsignal_running_in_container, [], :bool
+        attach_function :appsignal_set_environment_metadata,
+          [:appsignal_string, :appsignal_string],
+          :void
 
         # Metrics methods
         attach_function :appsignal_set_gauge,
@@ -224,6 +227,13 @@ module Appsignal
         appsignal_running_in_container
       end
 
+      def set_environment_metadata(key, value)
+        appsignal_set_environment_metadata(
+          make_appsignal_string(key),
+          make_appsignal_string(value)
+        )
+      end
+
       def set_gauge(key, value, tags)
         appsignal_set_gauge(make_appsignal_string(key), value, tags.pointer)
       end

data/lib/appsignal/hooks.rb

@@ -73,6 +73,7 @@ module Appsignal
 end
 
 require "appsignal/hooks/action_cable"
+require "appsignal/hooks/active_job"
 require "appsignal/hooks/active_support_notifications"
 require "appsignal/hooks/celluloid"
 require "appsignal/hooks/delayed_job"
@@ -81,6 +82,7 @@ require "appsignal/hooks/passenger"
 require "appsignal/hooks/puma"
 require "appsignal/hooks/rake"
 require "appsignal/hooks/redis"
+require "appsignal/hooks/resque"
 require "appsignal/hooks/sequel"
 require "appsignal/hooks/shoryuken"
 require "appsignal/hooks/sidekiq"

data/lib/appsignal/hooks/active_job.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Appsignal
+  class Hooks
+    # @api private
+    class ActiveJobHook < Appsignal::Hooks::Hook
+      register :active_job
+
+      def dependencies_present?
+        defined?(::ActiveJob)
+      end
+
+      def install
+        ::ActiveJob::Base
+          .extend ::Appsignal::Hooks::ActiveJobHook::ActiveJobClassInstrumentation
+      end
+
+      module ActiveJobClassInstrumentation
+        def execute(job)
+          job_status = nil
+          current_transaction = Appsignal::Transaction.current
+          transaction =
+            if current_transaction.nil_transaction?
+              # No standalone integration started before ActiveJob integration.
+              # We don't have a separate integration for this QueueAdapter like
+              # we do for Sidekiq.
+              #
+              # Prefer job_id from provider, instead of ActiveJob's internal ID.
+              Appsignal::Transaction.create(
+                job["provider_job_id"] || job["job_id"],
+                Appsignal::Transaction::BACKGROUND_JOB,
+                Appsignal::Transaction::GenericRequest.new({})
+              )
+            else
+              current_transaction
+            end
+
+          super
+        rescue Exception => exception # rubocop:disable Lint/RescueException
+          job_status = :failed
+          transaction.set_error(exception)
+          raise exception
+        ensure
+          tags = {}
+          queue = job["queue_name"]
+          tags[:queue] = queue if queue
+          priority = job["priority"]
+          tags[:priority] = priority if priority
+
+          if transaction
+            transaction.params =
+              Appsignal::Utils::HashSanitizer.sanitize(
+                job["arguments"],
+                Appsignal.config[:filter_parameters]
+              )
+
+            transaction_tags = tags
+            provider_job_id = job["provider_job_id"]
+            if provider_job_id
+              transaction_tags[:provider_job_id] = provider_job_id
+            end
+            transaction.set_tags(transaction_tags)
+
+            transaction.set_action_if_nil(ActiveJobHelpers.action_name(job))
+            enqueued_at = job["enqueued_at"]
+            if enqueued_at # Present in Rails 6 and up
+              transaction.set_queue_start((Time.parse(enqueued_at).to_f * 1_000).to_i)
+            end
+
+            if current_transaction.nil_transaction?
+              # Only complete transaction if ActiveJob is not wrapped in
+              # another supported integration, such as Sidekiq.
+              Appsignal::Transaction.complete_current!
+            end
+          end
+
+          if job_status
+            ActiveJobHelpers.increment_counter "queue_job_count", 1,
+              tags.merge(:status => job_status)
+          end
+          ActiveJobHelpers.increment_counter "queue_job_count", 1,
+            tags.merge(:status => :processed)
+        end
+      end
+
+      module ActiveJobHelpers
+        ACTION_MAILER_CLASSES = [
+          "ActionMailer::DeliveryJob",
+          "ActionMailer::Parameterized::DeliveryJob",
+          "ActionMailer::MailDeliveryJob"
+        ].freeze
+
+        def self.action_name(job)
+          case job["job_class"]
+          when *ACTION_MAILER_CLASSES
+            job["arguments"][0..1].join("#")
+          else
+            "#{job["job_class"]}#perform"
+          end
+        end
+
+        def self.increment_counter(key, value, tags = {})
+          Appsignal.increment_counter "active_job_#{key}", value, tags
+        end
+      end
+    end
+  end
+end