appsignal 2.10.7 → 2.11.0.alpha.2

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/ext/base.rb

@@ -32,7 +32,8 @@ def report
           "version" => "#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"
         },
         "download" => {
-          "checksum" => "unverified"
+          "checksum" => "unverified",
+          "http_proxy" => http_proxy
         },
         "build" => {
           "time" => Time.now.utc,
@@ -126,7 +127,11 @@ def download_archive(type)
     report["download"]["download_url"] = download_url
 
     begin
-      return open(download_url, :ssl_ca_cert => CA_CERT_PATH)
+      return open(
+        download_url,
+        :ssl_ca_cert => CA_CERT_PATH,
+        :proxy => http_proxy
+      )
     rescue
       next
     end
@@ -142,14 +147,16 @@ def download_archive(type)
 end
 
 def verify_archive(archive, type)
-  if Digest::SHA256.hexdigest(archive.read) == ARCH_CONFIG[type]["checksum"]
+  expected_checksum = ARCH_CONFIG[type]["checksum"]
+  actual_checksum = Digest::SHA256.hexdigest(archive.read)
+  if actual_checksum == expected_checksum
     report["download"]["checksum"] = "verified"
     true
   else
     report["download"]["checksum"] = "invalid"
     abort_installation(
       "Checksum of downloaded archive could not be verified: " \
-        "Expected '#{ARCH_CONFIG[type]["checksum"]}', got '#{checksum}'."
+        "Expected '#{expected_checksum}', got '#{actual_checksum}'."
     )
   end
 end
@@ -172,3 +179,7 @@ def store_download_version_on_report
   path = File.expand_path(File.join(File.dirname(__FILE__), "appsignal.version"))
   report["build"]["agent_version"] = File.read(path).strip
 end
+
+def http_proxy
+  Gem.configuration[:http_proxy] || ENV["http_proxy"] || ENV["HTTP_PROXY"]
+end

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/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/net_http.rb

@@ -25,6 +25,8 @@ module Appsignal
             end
           end
         end
+
+        Appsignal::Environment.report_enabled("net_http")
       end
     end
   end

data/lib/appsignal/hooks/puma.rb

@@ -24,7 +24,8 @@ module Appsignal
           # runs in the Puma main process.
           # For more information:
           # https://docs.appsignal.com/ruby/integrations/puma.html
-          Appsignal::Minutely.probes.register :puma, PumaProbe
+          require "appsignal/probes/puma"
+          Appsignal::Minutely.probes.register :puma, ::Appsignal::Probes::PumaProbe
         end
 
         return unless defined?(::Puma::Cluster)
@@ -39,62 +40,5 @@ module Appsignal
         end
       end
     end
-
-    class PumaProbe
-      def initialize
-        @hostname = Appsignal.config[:hostname] || Socket.gethostname
-      end
-
-      def call
-        puma_stats = fetch_puma_stats
-        return unless puma_stats
-
-        stats = JSON.parse puma_stats, :symbolize_names => true
-        counts = {}
-        count_keys = [:backlog, :running, :pool_capacity, :max_threads]
-
-        if stats[:worker_status] # Multiple workers
-          stats[:worker_status].each do |worker|
-            stat = worker[:last_status]
-            count_keys.each do |key|
-              count_if_present counts, key, stat
-            end
-          end
-
-          gauge(:workers, stats[:workers], :type => :count)
-          gauge(:workers, stats[:booted_workers], :type => :booted)
-          gauge(:workers, stats[:old_workers], :type => :old)
-        else # Single worker
-          count_keys.each do |key|
-            count_if_present counts, key, stats
-          end
-        end
-
-        gauge(:connection_backlog, counts[:backlog]) if counts[:backlog]
-        gauge(:pool_capacity, counts[:pool_capacity]) if counts[:pool_capacity]
-        gauge(:threads, counts[:running], :type => :running) if counts[:running]
-        gauge(:threads, counts[:max_threads], :type => :max) if counts[:max_threads]
-      end
-
-      private
-
-      attr_reader :hostname
-
-      def gauge(field, count, tags = {})
-        Appsignal.set_gauge("puma_#{field}", count, tags.merge(:hostname => hostname))
-      end
-
-      def count_if_present(counts, key, stats)
-        stat_value = stats[key]
-        return unless stat_value
-        counts[key] ||= 0
-        counts[key] += stat_value
-      end
-
-      def fetch_puma_stats
-        ::Puma.stats
-      rescue NoMethodError # rubocop:disable Lint/HandleExceptions
-      end
-    end
   end
 end

data/lib/appsignal/hooks/redis.rb

@@ -26,6 +26,8 @@ module Appsignal
             end
           end
         end
+
+        Appsignal::Environment.report_enabled("redis")
       end
     end
   end

data/lib/appsignal/hooks/sequel.rb

@@ -56,6 +56,8 @@ module Appsignal
 
         # ... and automatically add it to future instances.
         ::Sequel::Database.extension(:appsignal_integration)
+
+        Appsignal::Environment.report_enabled("sequel")
       end
     end
   end

data/lib/appsignal/hooks/sidekiq.rb

@@ -12,7 +12,8 @@ module Appsignal
       end
 
       def install
-        Appsignal::Minutely.probes.register :sidekiq, SidekiqProbe
+        require "appsignal/probes/sidekiq"
+        Appsignal::Minutely.probes.register :sidekiq, Appsignal::Probes::SidekiqProbe
 
         ::Sidekiq.configure_server do |config|
           config.server_middleware do |chain|
@@ -22,104 +23,6 @@ module Appsignal
       end
     end
 
-    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
-        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 "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
-        gauge "job_count", stats.retry_size, :status => :retry_queue
-        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
-          # Convert latency from seconds to milliseconds
-          gauge "queue_latency", queue.latency * 1_000.0, :queue => queue.name
-        end
-      end
-
-      # Track a gauge metric with the `sidekiq_` prefix
-      def gauge(key, value, tags = {})
-        tags[:hostname] = hostname if hostname
-        Appsignal.set_gauge "sidekiq_#{key}", value, tags
-      end
-
-      # Track the delta of two values for a gauge metric
-      #
-      # First call will store the data for the metric and the second call will
-      # set a gauge metric with the difference. This is used for absolute
-      # counter values which we want to track as gauges.
-      #
-      # @example
-      #   gauge_delta :my_cache_key, "my_gauge", 10
-      #   gauge_delta :my_cache_key, "my_gauge", 15
-      #   # Creates a gauge with the value `5`
-      # @see #gauge
-      def gauge_delta(cache_key, key, value, tags = {})
-        previous_value = cache[cache_key]
-        cache[cache_key] = value
-        return unless previous_value
-        new_value = value - previous_value
-        gauge key, new_value, tags
-      end
-
-      def hostname
-        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
-
     # @api private
     class SidekiqPlugin # rubocop:disable Metrics/ClassLength
       include Appsignal::Hooks::Helpers