appsignal 0.12.beta.31 → 0.12.beta.32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb6deacd3b946d7291c5ea4b1e7a98a4268e2867
-  data.tar.gz: cf0d403fefc46f4957264e0b33f2b148e8ad7ae8
+  metadata.gz: 3904c5300ef30db2a6f5c8eaadce8e7a1ac7a5b6
+  data.tar.gz: dc5d9e98c1eaabaf84eacb629e490f6494819bf0
 SHA512:
-  metadata.gz: ebd6b18c154977fb7cf24b9f6c441627f06df556676fd6dd22b8c6617ec3509a379b2ac301d187e7d49c699f7d93807ef5e3bd55d7f9b10ab0af2cc2df8840cd
-  data.tar.gz: 7646f9ec281d26c0075bd313f2c9d1a2ff1c65ed6d60b167276d928c9796090a4082ba138bafe278047c9a335704c20305f3c80ab54f266a25260c5ff2b5b10c
+  metadata.gz: 66c82fe27b587026438c1608735dbd29e80ba2d475fb9057d33bb7b66b60a55c8347ee4fe92544a2b8bb74d0f8adb4e446bd392f59fb139a1ec48e715f7bf89b
+  data.tar.gz: 2e67ade5b8bb20aa9c28728590f0bf490f90806420804151c66f9952c11105e300c08e2467cf98199448738455e89a5d2217b40b81dc23e3167a873d07412408

data/CHANGELOG.md

@@ -3,6 +3,29 @@
 * Use native library and agent
 * Use API V2
 
+# 0.11.15
+* Improve Sinatra support
+
+# 0.11.14
+* Support ActiveJob wrapped jobs
+* Improve proxy support
+* Improve rake support
+
+# 0.11.13
+* Add Padrino support
+* Add Rake task monitoring
+* Add http proxy support
+* Configure Net::HTTP to only use TLS
+* Don't send queue if there is no content
+* Don't retry transmission when response code is 400 (no content)
+* Don't start Resque IPC server when AppSignal is not active
+* Display warning message when attempting to send a non-exception to `send_exception`
+* Fix capistrano 2 detection
+* Fix issue with Sinatra integration attempting to attach an exception to a transaction that doesn't exist.
+
+# 0.11.12
+* Sanitizer will no longer inspect unknown objects, since implementations of inspect sometimes trigger unexpected behavior.
+
 # 0.11.11
 * Reliably get errors in production for Sinatra
 

data/Rakefile

@@ -2,6 +2,7 @@ GEMFILES = %w(
   capistrano2
   capistrano3
   no_dependencies
+  padrino
   rails-3.0
   rails-3.1
   rails-3.2

data/benchmark.rake

@@ -7,6 +7,8 @@ end
 
 GC.disable
 
+task :default => :'benchmark:all'
+
 namespace :benchmark do
   task :all => [:run_inactive, :run_active] do
   end
@@ -37,33 +39,31 @@ def run_benchmark
   puts "Running #{no_transactions} normal transactions"
   puts(Benchmark.measure do
     no_transactions.times do |i|
-      transaction_id = "transaction_#{i}"
-      ActiveSupport::Notifications.instrumenter.instance_variable_set(:@id, transaction_id)
-      Appsignal::Transaction.create("transaction_#{i}", {})
+      request = Appsignal::Transaction::GenericRequest.new(
+        :controller => 'HomeController',
+        :action     => 'show',
+        :params     => {:id => 1}
+      )
+      Appsignal::Transaction.create("transaction_#{i}", Appsignal::Transaction::HTTP_REQUEST, request)
 
-      ActiveSupport::Notifications.instrument('sql.active_record', :sql => 'SELECT `users`.* FROM `users`
-                                                                            WHERE `users`.`id` = ?')
-      10.times do
-        ActiveSupport::Notifications.instrument('sql.active_record', :sql => 'SELECT `todos`.* FROM `todos` WHERE `todos`.`id` = ?')
-      end
+      ActiveSupport::Notifications.instrument('process_action.action_controller') do
+        ActiveSupport::Notifications.instrument('sql.active_record', :sql => 'SELECT `users`.* FROM `users`
+                                                                              WHERE `users`.`id` = ?')
+        10.times do
+          ActiveSupport::Notifications.instrument('sql.active_record', :sql => 'SELECT `todos`.* FROM `todos` WHERE `todos`.`id` = ?')
+        end
 
-      ActiveSupport::Notifications.instrument('render_template.action_view', :identifier => 'app/views/home/show.html.erb') do
-        5.times do
-          ActiveSupport::Notifications.instrument('render_partial.action_view', :identifier => 'app/views/home/_piece.html.erb') do
-            3.times do
-              ActiveSupport::Notifications.instrument('cache.read')
+        ActiveSupport::Notifications.instrument('render_template.action_view', :identifier => 'app/views/home/show.html.erb') do
+          5.times do
+            ActiveSupport::Notifications.instrument('render_partial.action_view', :identifier => 'app/views/home/_piece.html.erb') do
+              3.times do
+                ActiveSupport::Notifications.instrument('cache.read')
+              end
             end
           end
         end
       end
 
-      ActiveSupport::Notifications.instrument(
-        'process_action.action_controller',
-        :controller => 'HomeController',
-        :action     => 'show',
-        :params     => {:id => 1}
-      )
-
       Appsignal::Transaction.complete_current!
     end
     puts 'Finished'

data/ext/appsignal_extension.c

@@ -19,10 +19,10 @@ static VALUE stop_extension(VALUE self) {
   return Qnil;
 }
 
-static VALUE start_transaction(VALUE self, VALUE transaction_id) {
+static VALUE start_transaction(VALUE self, VALUE transaction_id, VALUE namespace) {
   Check_Type(transaction_id, T_STRING);
 
-  return INT2FIX(appsignal_start_transaction(StringValueCStr(transaction_id)));
+  return INT2FIX(appsignal_start_transaction(StringValueCStr(transaction_id), StringValueCStr(namespace)));
 }
 
 static VALUE start_event(VALUE self, VALUE transaction_index) {
@@ -73,16 +73,23 @@ static VALUE set_transaction_error_data(VALUE self, VALUE transaction_index, VAL
   return Qnil;
 }
 
-static VALUE set_transaction_base_data(VALUE self, VALUE transaction_index, VALUE namespace, VALUE action, VALUE queue_start) {
+static VALUE set_transaction_action(VALUE self, VALUE transaction_index, VALUE action) {
   Check_Type(transaction_index, T_FIXNUM);
-  Check_Type(namespace, T_STRING);
   Check_Type(action, T_STRING);
+
+  appsignal_set_transaction_action(
+      FIX2INT(transaction_index),
+      StringValueCStr(action)
+  );
+  return Qnil;
+}
+
+static VALUE set_transaction_queue_start(VALUE self, VALUE transaction_index, VALUE queue_start) {
+  Check_Type(transaction_index, T_FIXNUM);
   Check_Type(queue_start, T_FIXNUM);
 
-  appsignal_set_transaction_base_data(
+  appsignal_set_transaction_queue_start(
       FIX2INT(transaction_index),
-      StringValueCStr(namespace),
-      StringValueCStr(action),
       FIX2LONG(queue_start)
   );
   return Qnil;
@@ -214,24 +221,25 @@ void Init_appsignal_extension(void) {
   VALUE Extension = rb_define_class_under(Appsignal, "Extension", rb_cObject);
 
   // Transaction monitoring
-  rb_define_singleton_method(Extension, "start",                      start,                      0);
-  rb_define_singleton_method(Extension, "stop_agent",                 stop_agent,                 0);
-  rb_define_singleton_method(Extension, "stop_extension",             stop_extension,             0);
-  rb_define_singleton_method(Extension, "start_transaction",          start_transaction,          1);
-  rb_define_singleton_method(Extension, "start_event",                start_event,                1);
-  rb_define_singleton_method(Extension, "finish_event",               finish_event,               4);
-  rb_define_singleton_method(Extension, "set_transaction_error",      set_transaction_error,      3);
-  rb_define_singleton_method(Extension, "set_transaction_error_data", set_transaction_error_data, 3);
-  rb_define_singleton_method(Extension, "set_transaction_base_data",  set_transaction_base_data,  4);
-  rb_define_singleton_method(Extension, "set_transaction_metadata",   set_transaction_metadata,   3);
-  rb_define_singleton_method(Extension, "finish_transaction",         finish_transaction,         1);
+  rb_define_singleton_method(Extension, "start",                       start,                       0);
+  rb_define_singleton_method(Extension, "stop_agent",                  stop_agent,                  0);
+  rb_define_singleton_method(Extension, "stop_extension",              stop_extension,              0);
+  rb_define_singleton_method(Extension, "start_transaction",           start_transaction,           2);
+  rb_define_singleton_method(Extension, "start_event",                 start_event,                 1);
+  rb_define_singleton_method(Extension, "finish_event",                finish_event,                4);
+  rb_define_singleton_method(Extension, "set_transaction_error",       set_transaction_error,       3);
+  rb_define_singleton_method(Extension, "set_transaction_error_data",  set_transaction_error_data,  3);
+  rb_define_singleton_method(Extension, "set_transaction_action",      set_transaction_action,      2);
+  rb_define_singleton_method(Extension, "set_transaction_queue_start", set_transaction_queue_start, 2);
+  rb_define_singleton_method(Extension, "set_transaction_metadata",    set_transaction_metadata,    3);
+  rb_define_singleton_method(Extension, "finish_transaction",          finish_transaction,          1);
 
   // Metrics
-  rb_define_singleton_method(Extension, "set_gauge",                  set_gauge,                  2);
-  rb_define_singleton_method(Extension, "set_host_gauge",             set_host_gauge,             2);
-  rb_define_singleton_method(Extension, "set_process_gauge",          set_process_gauge,          2);
-  rb_define_singleton_method(Extension, "increment_counter",          increment_counter,          2);
-  rb_define_singleton_method(Extension, "add_distribution_value",     add_distribution_value,     2);
+  rb_define_singleton_method(Extension, "set_gauge",                   set_gauge,                   2);
+  rb_define_singleton_method(Extension, "set_host_gauge",              set_host_gauge,              2);
+  rb_define_singleton_method(Extension, "set_process_gauge",           set_process_gauge,           2);
+  rb_define_singleton_method(Extension, "increment_counter",           increment_counter,           2);
+  rb_define_singleton_method(Extension, "add_distribution_value",      add_distribution_value,      2);
 
   // Event hooks
   install_event_hooks();

data/gemfiles/padrino.gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'padrino', '~> 0.12.0'
+
+gem 'generator_spec'
+
+gemspec :path => '../'

data/lib/appsignal.rb

@@ -68,53 +68,74 @@ module Appsignal
       Appsignal::Extension.stop_extension
     end
 
-
-    def monitor_transaction(name, payload={})
+    def monitor_transaction(name, env={})
       unless active?
         yield
         return
       end
 
+       if name.start_with?('perform_job'.freeze)
+        namespace = Appsignal::Transaction::BACKGROUND_JOB
+        request   = Appsignal::Transaction::GenericRequest.new(env)
+      elsif name.start_with?('process_action'.freeze)
+        namespace = Appsignal::Transaction::HTTP_REQUEST
+        request   = ::Rack::Request.new(env)
+      else
+        logger.error("Unrecognized name '#{name}'") and return
+      end
+      transaction = Appsignal::Transaction.create(
+        SecureRandom.uuid,
+        namespace,
+        request
+      )
       begin
-        Appsignal::Transaction.create(SecureRandom.uuid, ENV.to_hash)
-        ActiveSupport::Notifications.instrument(name, payload) do
+        ActiveSupport::Notifications.instrument(name) do
           yield
         end
-      rescue => exception
-        Appsignal.set_exception(exception)
-        raise exception
+      rescue => error
+        transaction.set_error(error)
+        raise error
       ensure
+        transaction.set_http_or_background_action(request.env)
+        transaction.set_http_or_background_queue_start
         Appsignal::Transaction.complete_current!
       end
     end
 
-    def listen_for_exception(&block)
+    def listen_for_error(&block)
       yield
-    rescue Exception => exception
-      send_exception(exception)
-      raise exception
+    rescue => error
+      send_error(error)
+      raise error
     end
+    alias :listen_for_exception :listen_for_error
 
-    def send_exception(exception, tags=nil)
-      return if !active? || is_ignored_exception?(exception)
-      transaction = Appsignal::Transaction.create(SecureRandom.uuid, ENV.to_hash)
+    def send_error(error, tags=nil, namespace=Appsignal::Transaction::HTTP_REQUEST)
+      return if !active? || is_ignored_error?(error)
+      unless error.is_a?(Exception)
+        logger.error('Can\'t send error, given value is not an exception')
+        return
+      end
+      transaction = Appsignal::Transaction.create(
+        SecureRandom.uuid,
+        namespace,
+        Appsignal::Transaction::GenericRequest.new({})
+      )
       transaction.set_tags(tags) if tags
-      transaction.set_error(exception)
+      transaction.set_error(error)
       Appsignal::Transaction.complete_current!
     end
+    alias :send_exception :send_error
 
-    def add_exception(exception)
-      warn '[DEPRECATION] add_exception is deprecated, use set_exception instead'
-      set_exception(exception)
-    end
-
-    def set_exception(exception)
+    def set_error(exception)
       return if !active? ||
                 Appsignal::Transaction.current.nil? ||
                 exception.nil? ||
-                is_ignored_exception?(exception)
+                is_ignored_error?(exception)
       Appsignal::Transaction.current.set_error(exception)
     end
+    alias :set_exception :set_error
+    alias :add_exception :set_error
 
     def tag_request(params={})
       return unless active?
@@ -178,9 +199,10 @@ module Appsignal
       config && config.active?
     end
 
-    def is_ignored_exception?(exception)
-      Appsignal.config[:ignore_exceptions].include?(exception.class.name)
+    def is_ignored_error?(error)
+      Appsignal.config[:ignore_errors].include?(error.class.name)
     end
+    alias :is_ignored_exception? :is_ignored_error?
 
     def is_ignored_action?(action)
       Appsignal.config[:ignore_actions].include?(action)
@@ -208,8 +230,9 @@ require 'appsignal/subscriber'
 require 'appsignal/transaction'
 require 'appsignal/version'
 require 'appsignal/rack/js_exception_catcher'
-require 'appsignal/rack/listener'
-require 'appsignal/rack/instrumentation'
-require 'appsignal/integrations/rails'
 require 'appsignal/js_exception_transaction'
 require 'appsignal/transmitter'
+
+# This needs to be required immediately, that's why it's
+# not in load_integrations
+require 'appsignal/integrations/rails'

data/lib/appsignal/capistrano.rb

@@ -1,6 +1,7 @@
 require 'appsignal'
+require 'capistrano/version'
 
-if defined?(Capistrano::VERSION)
+if defined?(Capistrano::VERSION) && Gem::Version.new(Capistrano::VERSION) >= Gem::Version.new(3)
   # Capistrano 3+
   load File.expand_path('../integrations/capistrano/appsignal.cap', __FILE__)
 else

data/lib/appsignal/config.rb

@@ -8,7 +8,7 @@ module Appsignal
 
     DEFAULT_CONFIG = {
       :debug                          => false,
-      :ignore_exceptions              => [],
+      :ignore_errors                  => [],
       :ignore_actions                 => [],
       :send_params                    => true,
       :endpoint                       => 'https://push.appsignal.com',
@@ -18,6 +18,21 @@ module Appsignal
       :frontend_error_catching_path   => '/appsignal_error_catcher'
     }.freeze
 
+    ENV_TO_KEY_MAPPING = {
+      'APPSIGNAL_ACTIVE'                         => :active,
+      'APPSIGNAL_PUSH_API_KEY'                   => :push_api_key,
+      'APPSIGNAL_APP_NAME'                       => :name,
+      'APPSIGNAL_PUSH_API_ENDPOINT'              => :endpoint,
+      'APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH'   => :frontend_error_catching_path,
+      'APPSIGNAL_DEBUG'                          => :debug,
+      'APPSIGNAL_INSTRUMENT_NET_HTTP'            => :instrument_net_http,
+      'APPSIGNAL_SKIP_SESSION_DATA'              => :skip_session_data,
+      'APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING' => :enable_frontend_error_catching,
+      'APPSIGNAL_IGNORE_ERRORS'                  => :ignore_errors,
+      'APPSIGNAL_IGNORE_ACTIONS'                 => :ignore_actions,
+      'APPSIGNAL_HTTP_PROXY'                     => :http_proxy
+    }.freeze
+
     attr_reader :root_path, :env, :initial_config, :config_hash
 
     def initialize(root_path, env, initial_config={}, logger=Appsignal.logger)
@@ -25,46 +40,33 @@ module Appsignal
       @env            = env.to_s
       @initial_config = initial_config
       @logger         = logger
+      @valid          = false
+
+      # Initial config
+      @config_hash = DEFAULT_CONFIG.merge(initial_config)
 
+      # Load config from environment variables
+      load_from_environment
+
+      # Load the config file if it exists
       if File.exists?(config_file)
-        load_config_from_disk
-      elsif ENV['APPSIGNAL_PUSH_API_KEY']
-        load_default_config_with_push_api_key_and_name_from_env(
-          ENV['APPSIGNAL_PUSH_API_KEY']
-        )
-      elsif ENV['APPSIGNAL_API_KEY']
-        load_default_config_with_push_api_key_and_name_from_env(
-          ENV['APPSIGNAL_API_KEY']
-        )
-        @logger.info(
-          'The APPSIGNAL_API_KEY environment variable has been deprecated, ' \
-          'please switch to APPSIGNAL_PUSH_API_KEY'
-        )
-      else
-        carefully_log_error(
-          "Not loading: No config file found at '#{config_file}' " \
-          "and no APPSIGNAL_PUSH_API_KEY env var present"
-        )
+        load_from_disk
       end
-      if config_hash && !config_hash[:name]
-        @logger.debug(
-          "There's no application name set in your config file or in the APPSIGNAL_APP_NAME env var. " \
-          "You should set one unless your app runs on Heroku."
-        )
-      end
-    end
 
-    def loaded?
-      !! config_hash
+      # Validate that we have a correct config
+      validate
     end
 
     def [](key)
-      return unless loaded?
       config_hash[key]
     end
 
+    def valid?
+      @valid
+    end
+
     def active?
-      !! self[:active]
+      @valid && self[:active]
     end
 
     def write_to_environment
@@ -72,12 +74,14 @@ module Appsignal
       ENV['APPSIGNAL_APP_PATH']          = root_path.to_s
       ENV['APPSIGNAL_AGENT_PATH']        = File.expand_path('../../../ext', __FILE__).to_s
       ENV['APPSIGNAL_LOG_PATH']          = File.join(root_path, 'log')
+      ENV['APPSIGNAL_ENVIRONMENT']       = env
+      ENV['APPSIGNAL_AGENT_VERSION']     = Appsignal::AGENT_VERSION
       ENV['APPSIGNAL_DEBUG_LOGGING']     = config_hash[:debug].to_s
       ENV['APPSIGNAL_PUSH_API_ENDPOINT'] = config_hash[:endpoint]
       ENV['APPSIGNAL_PUSH_API_KEY']      = config_hash[:push_api_key]
       ENV['APPSIGNAL_APP_NAME']          = config_hash[:name]
-      ENV['APPSIGNAL_ENVIRONMENT']       = env
-      ENV['APPSIGNAL_AGENT_VERSION']     = Appsignal::AGENT_VERSION
+      ENV['APPSIGNAL_HTTP_PROXY']        = config_hash[:http_proxy]
+      ENV['APPSIGNAL_IGNORE_ACTIONS']    = config_hash[:ignore_actions].join(',')
     end
 
     protected
@@ -86,7 +90,7 @@ module Appsignal
       @config_file ||= File.join(root_path, 'config', 'appsignal.yml')
     end
 
-    def load_config_from_disk
+    def load_from_disk
       configurations = YAML.load(ERB.new(IO.read(config_file)).result)
       config_for_this_env = configurations[env]
       if config_for_this_env
@@ -99,10 +103,65 @@ module Appsignal
         if !config_for_this_env[:push_api_key] && config_for_this_env[:api_key]
           config_for_this_env[:push_api_key] = config_for_this_env[:api_key]
         end
+        if !config_for_this_env[:ignore_errors] && config_for_this_env[:ignore_exceptions]
+          config_for_this_env[:ignore_errors] = config_for_this_env[:ignore_exceptions]
+        end
+
+        merge(@config_hash, config_for_this_env)
+      else
+        carefully_log_error("Not loading from config file: config for '#{env}' not found")
+      end
+    end
+
+    def load_from_environment
+      config = {}
+
+      # Make active by default if APPSIGNAL_PUSH_API_KEY is present
+      if ENV['APPSIGNAL_PUSH_API_KEY']
+        config[:active] = 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).each do |var|
+        if env_var = ENV[var]
+          config[ENV_TO_KEY_MAPPING[var]] = env_var
+        end
+      end
+
+      # Configuration with boolean type
+      %w(APPSIGNAL_ACTIVE APPSIGNAL_DEBUG APPSIGNAL_INSTRUMENT_NET_HTTP
+         APPSIGNAL_SKIP_SESSION_DATA APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING).each do |var|
+        if env_var = ENV[var]
+          config[ENV_TO_KEY_MAPPING[var]] = env_var == 'true'
+        end
+      end
 
-        @config_hash = merge_config(config_for_this_env)
+      # Configuration with array of strings type
+      %w(APPSIGNAL_IGNORE_ERRORS APPSIGNAL_IGNORE_ACTIONS).each do |var|
+        if env_var = ENV[var]
+          config[ENV_TO_KEY_MAPPING[var]] = env_var.split(',')
+        end
+      end
+
+      merge(@config_hash, config)
+    end
+
+    def merge(original_config, new_config)
+      new_config.each do |key, value|
+        unless original_config[key].nil?
+          @logger.warn("Config key '#{key}' is being overwritten")
+        end
+        original_config[key] = value
+      end
+    end
+
+    def validate
+      if config_hash[:push_api_key]
+        @valid = true
       else
-        carefully_log_error("Not loading: config for '#{env}' not found")
+        @valid = false
+        carefully_log_error("Push api key not set after loading config")
       end
     end
 
@@ -115,9 +174,5 @@ module Appsignal
       @config_hash[:name]   = ENV['APPSIGNAL_APP_NAME'] if ENV['APPSIGNAL_APP_NAME']
       @config_hash[:active] = ENV['APPSIGNAL_ACTIVE'] == 'true' if ENV['APPSIGNAL_ACTIVE']
     end
-
-    def merge_config(config)
-      DEFAULT_CONFIG.merge(initial_config).merge(config)
-    end
   end
 end