appsignal 1.4.0.alpha.2 → 1.4.0.beta.1

data/ext/extconf.rb

@@ -78,12 +78,10 @@ def install
 
   logger.info "Creating makefile"
   require 'mkmf'
-  if !find_library('appsignal', 'appsignal_start', EXT_PATH)
-    installation_failed 'Aborting installation, libappsignal not found'
+  if !have_library('appsignal', 'appsignal_start', 'appsignal.h')
+    installation_failed 'Aborting installation, libappsignal.a or appsignal.h not found'
   elsif !find_executable('appsignal-agent', EXT_PATH)
     installation_failed 'Aborting installation, appsignal-agent not found'
-  elsif !find_header('appsignal.h', EXT_PATH)
-    installation_failed 'Aborting installation, appsignal.h not found'
   else
     create_makefile 'appsignal_extension'
     logger.info 'Successfully created Makefile for appsignal extension'

data/gemfiles/resque.gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 
 gem 'resque'
 gem 'rails', '~> 4.2.0'
+gem 'sinatra'
 gem 'mime-types', '~> 2.6'
 
 gemspec :path => '../'

data/lib/appsignal.rb

@@ -2,20 +2,9 @@ require 'json'
 require 'logger'
 require 'securerandom'
 
-# Make sure we have the notification system
-begin
-  require 'active_support/notifications'
-  ActiveSupport::Notifications::Fanout::Subscribers::Timed # See it it's recent enough
-rescue LoadError
-  require 'vendor/active_support/notifications'
-rescue NameError
-  require 'appsignal/update_active_support'
-  Appsignal::UpdateActiveSupport.run
-end
-
 module Appsignal
   class << self
-    attr_accessor :config, :subscriber, :agent, :extension_loaded
+    attr_accessor :config, :agent, :extension_loaded
     attr_writer :logger, :in_memory_log
 
     def extensions
@@ -58,13 +47,17 @@ module Appsignal
           Appsignal::Hooks.load_hooks
           Appsignal::EventFormatter.initialize_formatters
           initialize_extensions
-          Appsignal::Extension.install_allocation_event_hook if config[:enable_allocation_tracking]
+
+          if config[:enable_allocation_tracking]
+            Appsignal::Extension.install_allocation_event_hook
+          end
+
           if config[:enable_gc_instrumentation]
-            Appsignal::Extension.install_gc_event_hooks
+            GC::Profiler.enable
             Appsignal::Minutely.add_gc_probe
           end
+
           Appsignal::Minutely.start if config[:enable_minutely_probes]
-          @subscriber = Appsignal::Subscriber.new
         else
           logger.info("Not starting, not active for #{config.env}")
         end
@@ -95,7 +88,6 @@ module Appsignal
       Appsignal.start_logger
       logger.debug('Forked process, resubscribing and restarting extension')
       Appsignal::Extension.start
-      @subscriber.resubscribe
     end
 
     def get_server_state(key)
@@ -123,7 +115,7 @@ module Appsignal
         request
       )
       begin
-        ActiveSupport::Notifications.instrument(name) do
+        Appsignal.instrument(name) do
           yield
         end
       rescue => error
@@ -192,9 +184,13 @@ module Appsignal
 
     def instrument(name, title=nil, body=nil, body_format=Appsignal::EventFormatter::DEFAULT)
       Appsignal::Transaction.current.start_event
-      r = yield
+      return_value = yield
       Appsignal::Transaction.current.finish_event(name, title, body, body_format)
-      r
+      return_value
+    end
+
+    def instrument_sql(name, title=nil, body=nil, &block)
+      instrument(name, title, body, Appsignal::EventFormatter::SQL_BODY_FORMAT, &block)
     end
 
     def set_gauge(key, value)
@@ -235,22 +231,26 @@ module Appsignal
     end
 
     def log_formatter
-        proc do |severity, datetime, progname, msg|
-          "[#{datetime.strftime('%Y-%m-%dT%H:%M:%S')} (process) ##{Process.pid}][#{severity}] #{msg}\n"
-        end
+      proc do |severity, datetime, progname, msg|
+        "[#{datetime.strftime('%Y-%m-%dT%H:%M:%S')} (process) ##{Process.pid}][#{severity}] #{msg}\n"
+      end
     end
 
     def start_logger(path_arg=nil)
       path = Appsignal.config ? Appsignal.config.log_file_path : nil
-      if path && !ENV['DYNO']
-        @logger = Logger.new(path)
-        @logger.formatter = log_formatter
-      else
-        @logger = Logger.new($stdout)
-        @logger.formatter = lambda do |severity, datetime, progname, msg|
-          "appsignal: #{msg}\n"
+      if path && !Appsignal::System.heroku?
+        begin
+          @logger = Logger.new(path)
+          @logger.formatter = log_formatter
+        rescue SystemCallError => error
+          start_stdout_logger
+          logger.warn "appsignal: Unable to start logger with log path '#{path}'."
+          logger.warn "appsignal: #{error}"
         end
+      else
+        start_stdout_logger
       end
+
       if config && config[:debug]
         @logger.level = Logger::DEBUG
       else
@@ -292,6 +292,15 @@ module Appsignal
     ensure
       Appsignal::Transaction.current.resume! if Appsignal::Transaction.current
     end
+
+    private
+
+    def start_stdout_logger
+      @logger = Logger.new($stdout)
+      @logger.formatter = lambda do |severity, datetime, progname, msg|
+        "appsignal: #{msg}\n"
+      end
+    end
   end
 end
 
@@ -304,13 +313,14 @@ require 'appsignal/hooks'
 require 'appsignal/marker'
 require 'appsignal/minutely'
 require 'appsignal/params_sanitizer'
+require 'appsignal/garbage_collection_profiler'
 require 'appsignal/integrations/railtie' if defined?(::Rails)
 require 'appsignal/integrations/resque'
 require 'appsignal/integrations/resque_active_job'
-require 'appsignal/subscriber'
 require 'appsignal/transaction'
 require 'appsignal/version'
 require 'appsignal/rack/generic_instrumentation'
 require 'appsignal/rack/js_exception_catcher'
 require 'appsignal/js_exception_transaction'
 require 'appsignal/transmitter'
+require 'appsignal/system'

data/lib/appsignal/auth_check.rb

@@ -26,7 +26,7 @@ module Appsignal
                    "#{status.nil? ? 'nil' : status}"
         end
         [status, result]
-      rescue Exception => e
+      rescue => e
         result = 'Something went wrong while trying to '\
                  "authenticate with AppSignal: #{e}"
         [nil, result]

data/lib/appsignal/cli/diagnose.rb

@@ -26,6 +26,7 @@ module Appsignal
 
         def config
           start_appsignal
+          puts "Environment: #{Appsignal.config.env}"
           Appsignal.config.config_hash.each do |key, val|
             puts "Config #{key}: #{val}"
           end
@@ -60,12 +61,12 @@ module Appsignal
         def check_ext_install
           require 'bundler/cli'
           require "bundler/cli/common"
-          path     = Bundler::CLI::Common.select_spec('appsignal').full_gem_path
-          install_log_path = "#{path.strip}/ext/install.log"
+          path = Bundler::CLI::Common.select_spec('appsignal').full_gem_path.strip
+          install_log_path = "#{path}/ext/install.log"
           puts "Showing last lines of extension install log: #{install_log_path}"
           puts File.read(install_log_path)
           puts "\n"
-          mkmf_log_path = "#{path.strip}/ext/mkmf.log"
+          mkmf_log_path = "#{path}/ext/mkmf.log"
           if File.exist?(mkmf_log_path)
             puts "Showing last lines of extension compilation log: #{mkmf_log_path}"
             puts File.read(mkmf_log_path)

data/lib/appsignal/cli/install.rb

@@ -93,11 +93,6 @@ module Appsignal
           puts
           puts "  require 'appsignal/integrations/sinatra'"
           press_any_key
-          puts "Configure subclass apps"
-          puts "  If your app is a subclass of Sinatra::Base you need to use this middleware:"
-          puts
-          puts "  use Appsignal::Rack::SinatraInstrumentation"
-          press_any_key
           done_notice
         end
 
@@ -136,6 +131,21 @@ module Appsignal
           done_notice
         end
 
+        def install_for_capistrano
+          capfile = File.join(Dir.pwd, 'Capfile')
+          return unless File.exist?(capfile)
+          return if File.read(capfile) =~ %r{require ['|"]appsignal/capistrano}
+
+          puts 'Installing for Capistrano'
+          print '  Adding AppSignal integration to Capfile'
+          File.open(capfile, 'a') do |f|
+            f.write "\nrequire 'appsignal/capistrano'\n"
+          end
+          periods
+          puts
+          puts
+        end
+
         def colorize(text, color)
           return text if Gem.win_platform?
           color_code = case color
@@ -187,16 +197,7 @@ module Appsignal
         end
 
         def configure(config, environments, name_overwritten)
-          deploy_rb_file = File.join(Dir.pwd, 'config/deploy.rb')
-          if File.exist?(deploy_rb_file) && (File.read(deploy_rb_file) =~ /require (\'|\").\/appsignal\/capistrano/).nil?
-            print 'Adding AppSignal integration to deploy.rb'
-            File.open(deploy_rb_file, 'a') do |f|
-              f.write "\nrequire 'appsignal/capistrano'\n"
-            end
-            periods
-            puts
-            puts
-          end
+          install_for_capistrano
 
           puts "How do you want to configure AppSignal?"
           puts "  (1) a config file"

data/lib/appsignal/config.rb

@@ -5,6 +5,7 @@ require 'socket'
 
 module Appsignal
   class Config
+    SYSTEM_TMP_DIR = '/tmp'
     DEFAULT_CONFIG = {
       :debug                          => false,
       :ignore_errors                  => [],
@@ -23,7 +24,8 @@ module Appsignal
       :running_in_container           => false,
       :enable_host_metrics            => true,
       :enable_minutely_probes         => false,
-      :hostname                       => ::Socket.gethostname
+      :hostname                       => ::Socket.gethostname,
+      :ca_file_path                   => File.expand_path(File.join('../../../resources/cacert.pem'), __FILE__)
     }.freeze
 
     ENV_TO_KEY_MAPPING = {
@@ -50,7 +52,8 @@ module Appsignal
       'APPSIGNAL_WORKING_DIR_PATH'               => :working_dir_path,
       'APPSIGNAL_ENABLE_HOST_METRICS'            => :enable_host_metrics,
       'APPSIGNAL_ENABLE_MINUTELY_PROBES'         => :enable_minutely_probes,
-      'APPSIGNAL_HOSTNAME'                       => :hostname
+      'APPSIGNAL_HOSTNAME'                       => :hostname,
+      'APPSIGNAL_CA_FILE_PATH'                   => :ca_file_path
     }.freeze
 
     attr_reader :root_path, :env, :initial_config, :config_hash
@@ -62,18 +65,16 @@ module Appsignal
       @initial_config = initial_config
       @logger         = logger
       @valid          = false
+      @config_hash    = Hash[DEFAULT_CONFIG]
 
+      # Set config based on the system
+      detect_from_system
       # Initial config
-      @config_hash = DEFAULT_CONFIG.merge(initial_config)
-
+      merge(@config_hash, initial_config)
+      # Load the config file if it exists
+      load_from_disk
       # Load config from environment variables
       load_from_environment
-
-      # Load the config file if it exists
-      if config_file && File.exist?(config_file)
-        load_from_disk
-      end
-
       # Validate that we have a correct config
       validate
     end
@@ -89,12 +90,19 @@ module Appsignal
     def log_file_path
       path = config_hash[:log_path] || root_path
       if path && File.writable?(path)
-        File.join(File.realpath(path), 'appsignal.log')
+        return File.join(File.realpath(path), 'appsignal.log')
+      end
+
+      if File.writable? SYSTEM_TMP_DIR
+        $stdout.puts "appsignal: Unable to log to '#{path}'. Logging to "\
+          "'#{SYSTEM_TMP_DIR}' instead. Please check the "\
+          "permissions for the application's log directory."
+        File.join(SYSTEM_TMP_DIR, 'appsignal.log')
       else
-        '/tmp/appsignal.log'
+        $stdout.puts "appsignal: Unable to log to '#{path}' or the "\
+          "'#{SYSTEM_TMP_DIR}' fallback. Please check the permissions "\
+          "for the application's (log) directory."
       end
-    rescue Errno::ENOENT
-      '/tmp/appsignal.log'
     end
 
     def valid?
@@ -102,7 +110,7 @@ module Appsignal
     end
 
     def active?
-      @valid && self[:active]
+      @valid && config_hash[:active]
     end
 
     def write_to_environment
@@ -127,6 +135,7 @@ module Appsignal
       ENV['APPSIGNAL_ENABLE_MINUTELY_PROBES']       = config_hash[:enable_minutely_probes].to_s
       ENV['APPSIGNAL_HOSTNAME']                     = config_hash[:hostname].to_s
       ENV['APPSIGNAL_PROCESS_NAME']                 = $0
+      ENV['APPSIGNAL_CA_FILE_PATH']                 = config_hash[:ca_file_path].to_s
     end
 
     protected
@@ -136,7 +145,13 @@ module Appsignal
         root_path.nil? ? nil : File.join(root_path, 'config', 'appsignal.yml')
     end
 
+    def detect_from_system
+      self[:running_in_container] = true if Appsignal::System.container?
+    end
+
     def load_from_disk
+      return if !config_file || !File.exist?(config_file)
+
       configurations = YAML.load(ERB.new(IO.read(config_file)).result)
       config_for_this_env = configurations[env]
       if config_for_this_env
@@ -167,15 +182,10 @@ module Appsignal
         config[:active] = true
       end
 
-      # Heroku is a container based system
-      if ENV['DYNO']
-        config[:running_in_container] = true
-      end
-
       # Configuration with string type
       %w(APPSIGNAL_PUSH_API_KEY APPSIGNAL_APP_NAME APPSIGNAL_PUSH_API_ENDPOINT
          APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH APPSIGNAL_HTTP_PROXY APPSIGNAL_LOG_PATH
-         APPSIGNAL_WORKING_DIR_PATH APPSIGNAL_HOSTNAME).each do |var|
+         APPSIGNAL_WORKING_DIR_PATH APPSIGNAL_HOSTNAME APPSIGNAL_CA_FILE_PATH).each do |var|
         if env_var = ENV[var]
           config[ENV_TO_KEY_MAPPING[var]] = env_var
         end
@@ -229,15 +239,5 @@ module Appsignal
         @logger.error "Push api key not set after loading config"
       end
     end
-
-    def load_default_config_with_push_api_key_and_name_from_env(key)
-      # Get base config by doing the default merge and adding the push api key.
-      @config_hash = merge_config(
-        :push_api_key => key,
-        :active => true
-      )
-      @config_hash[:name]   = ENV['APPSIGNAL_APP_NAME'] if ENV['APPSIGNAL_APP_NAME']
-      @config_hash[:active] = ENV['APPSIGNAL_ACTIVE'] == 'true' if ENV['APPSIGNAL_ACTIVE']
-    end
   end
 end

data/lib/appsignal/event_formatter.rb

@@ -46,7 +46,7 @@ module Appsignal
             else
               raise "#{f} does not have a format(payload) method"
             end
-          rescue Exception => ex
+          rescue => ex
             formatter_classes.delete(name)
             formatters.delete(name)
             Appsignal.logger.debug("'#{ex.message}' when initializing #{name} event formatter")

data/lib/appsignal/extension.rb

@@ -28,5 +28,11 @@ module Appsignal
         # Do nothing if the extension methods are not loaded
       end
     end
+
+    class Data
+      def inspect
+        "#<#{self.class.name}:#{object_id} #{to_s}>"
+      end
+    end
   end
 end

data/lib/appsignal/garbage_collection_profiler.rb

@@ -0,0 +1,47 @@
+module Appsignal
+  # Appsignal::GarbageCollectionProfiler wraps Ruby's GC::Profiler to be able
+  # to track garbage collection time for multiple transactions, while
+  # constantly clearing GC::Profiler's total_time to make sure it doesn't leak
+  # memory by keeping garbage collection run samples in memory.
+
+  class GarbageCollectionProfiler
+    def initialize
+      @total_time = 0
+    end
+
+    # Whenever #total_time is called, the current GC::Profiler.total_time gets
+    # added to @total_time, after which GC::Profiler.clear is called to prevent
+    # it from leaking memory. A class-level lock is used to make sure garbage
+    # collection time is never counted more than once.
+    #
+    # Whenever @total_time gets above two billion milliseconds (about 23 days),
+    # it's reset to make sure the result fits in a signed 32-bit integer.
+
+    def total_time
+      lock.synchronize do
+        @total_time += (internal_profiler.total_time * 1000).round
+        internal_profiler.clear
+      end
+
+      if @total_time > 2_000_000_000
+        @total_time = 0
+      end
+
+      @total_time
+    end
+
+    private
+
+    def self.lock
+      @lock ||= Mutex.new
+    end
+
+    def internal_profiler
+      GC::Profiler
+    end
+
+    def lock
+      self.class.lock
+    end
+  end
+end