appsignal 3.4.0 → 3.4.1

data/lib/appsignal/config.rb

@@ -11,39 +11,40 @@ module Appsignal
     include Appsignal::Utils::DeprecationMessage
 
     DEFAULT_CONFIG = {
-      :ca_file_path                   => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
-      :debug                          => false,
-      :dns_servers                    => [],
-      :enable_allocation_tracking     => true,
-      :enable_host_metrics            => true,
-      :enable_minutely_probes         => true,
-      :enable_statsd                  => true,
-      :enable_nginx_metrics           => false,
-      :enable_gvl_global_timer        => true,
-      :enable_gvl_waiting_threads     => true,
-      :endpoint                       => "https://push.appsignal.com",
-      :files_world_accessible         => true,
-      :filter_parameters              => [],
-      :filter_session_data            => [],
-      :ignore_actions                 => [],
-      :ignore_errors                  => [],
-      :ignore_namespaces              => [],
-      :instrument_http_rb             => true,
-      :instrument_net_http            => true,
-      :instrument_redis               => true,
-      :instrument_sequel              => true,
-      :log                            => "file",
-      :logging_endpoint               => "https://appsignal-endpoint.net",
-      :request_headers                => %w[
+      :ca_file_path => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
+      :debug => false,
+      :dns_servers => [],
+      :enable_allocation_tracking => true,
+      :enable_host_metrics => true,
+      :enable_minutely_probes => true,
+      :enable_statsd => true,
+      :enable_nginx_metrics => false,
+      :enable_gvl_global_timer => true,
+      :enable_gvl_waiting_threads => true,
+      :enable_rails_error_reporter => true,
+      :endpoint => "https://push.appsignal.com",
+      :files_world_accessible => true,
+      :filter_parameters => [],
+      :filter_session_data => [],
+      :ignore_actions => [],
+      :ignore_errors => [],
+      :ignore_namespaces => [],
+      :instrument_http_rb => true,
+      :instrument_net_http => true,
+      :instrument_redis => true,
+      :instrument_sequel => true,
+      :log => "file",
+      :logging_endpoint => "https://appsignal-endpoint.net",
+      :request_headers => %w[
         HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING
         HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_CONNECTION
         CONTENT_LENGTH PATH_INFO HTTP_RANGE
         REQUEST_METHOD REQUEST_URI SERVER_NAME SERVER_PORT
         SERVER_PROTOCOL
       ],
-      :send_environment_metadata      => true,
-      :send_params                    => true,
-      :transaction_debug_mode         => false
+      :send_environment_metadata => true,
+      :send_params => true,
+      :transaction_debug_mode => false
     }.freeze
 
     # @api private
@@ -62,46 +63,47 @@ module Appsignal
     }.freeze
 
     ENV_TO_KEY_MAPPING = {
-      "APPSIGNAL_ACTIVE"                         => :active,
-      "APPSIGNAL_APP_NAME"                       => :name,
-      "APPSIGNAL_CA_FILE_PATH"                   => :ca_file_path,
-      "APPSIGNAL_DEBUG"                          => :debug,
-      "APPSIGNAL_DNS_SERVERS"                    => :dns_servers,
-      "APPSIGNAL_ENABLE_ALLOCATION_TRACKING"     => :enable_allocation_tracking,
-      "APPSIGNAL_ENABLE_HOST_METRICS"            => :enable_host_metrics,
-      "APPSIGNAL_ENABLE_MINUTELY_PROBES"         => :enable_minutely_probes,
-      "APPSIGNAL_ENABLE_STATSD"                  => :enable_statsd,
-      "APPSIGNAL_ENABLE_NGINX_METRICS"           => :enable_nginx_metrics,
-      "APPSIGNAL_ENABLE_GVL_GLOBAL_TIMER"        => :enable_gvl_global_timer,
-      "APPSIGNAL_ENABLE_GVL_WAITING_THREADS"     => :enable_gvl_waiting_threads,
-      "APPSIGNAL_FILES_WORLD_ACCESSIBLE"         => :files_world_accessible,
-      "APPSIGNAL_FILTER_PARAMETERS"              => :filter_parameters,
-      "APPSIGNAL_FILTER_SESSION_DATA"            => :filter_session_data,
-      "APPSIGNAL_HOSTNAME"                       => :hostname,
-      "APPSIGNAL_HTTP_PROXY"                     => :http_proxy,
-      "APPSIGNAL_IGNORE_ACTIONS"                 => :ignore_actions,
-      "APPSIGNAL_IGNORE_ERRORS"                  => :ignore_errors,
-      "APPSIGNAL_IGNORE_NAMESPACES"              => :ignore_namespaces,
-      "APPSIGNAL_INSTRUMENT_HTTP_RB"             => :instrument_http_rb,
-      "APPSIGNAL_INSTRUMENT_NET_HTTP"            => :instrument_net_http,
-      "APPSIGNAL_INSTRUMENT_REDIS"               => :instrument_redis,
-      "APPSIGNAL_INSTRUMENT_SEQUEL"              => :instrument_sequel,
-      "APPSIGNAL_LOG"                            => :log,
-      "APPSIGNAL_LOG_LEVEL"                      => :log_level,
-      "APPSIGNAL_LOG_PATH"                       => :log_path,
-      "APPSIGNAL_LOGGING_ENDPOINT"               => :logging_endpoint,
-      "APPSIGNAL_PUSH_API_ENDPOINT"              => :endpoint,
-      "APPSIGNAL_PUSH_API_KEY"                   => :push_api_key,
-      "APPSIGNAL_REQUEST_HEADERS"                => :request_headers,
-      "APPSIGNAL_RUNNING_IN_CONTAINER"           => :running_in_container,
-      "APPSIGNAL_SEND_ENVIRONMENT_METADATA"      => :send_environment_metadata,
-      "APPSIGNAL_SEND_PARAMS"                    => :send_params,
-      "APPSIGNAL_SEND_SESSION_DATA"              => :send_session_data,
-      "APPSIGNAL_SKIP_SESSION_DATA"              => :skip_session_data,
-      "APPSIGNAL_TRANSACTION_DEBUG_MODE"         => :transaction_debug_mode,
-      "APPSIGNAL_WORKING_DIRECTORY_PATH"         => :working_directory_path,
-      "APPSIGNAL_WORKING_DIR_PATH"               => :working_dir_path,
-      "APP_REVISION"                             => :revision
+      "APPSIGNAL_ACTIVE" => :active,
+      "APPSIGNAL_APP_NAME" => :name,
+      "APPSIGNAL_CA_FILE_PATH" => :ca_file_path,
+      "APPSIGNAL_DEBUG" => :debug,
+      "APPSIGNAL_DNS_SERVERS" => :dns_servers,
+      "APPSIGNAL_ENABLE_ALLOCATION_TRACKING" => :enable_allocation_tracking,
+      "APPSIGNAL_ENABLE_HOST_METRICS" => :enable_host_metrics,
+      "APPSIGNAL_ENABLE_MINUTELY_PROBES" => :enable_minutely_probes,
+      "APPSIGNAL_ENABLE_STATSD" => :enable_statsd,
+      "APPSIGNAL_ENABLE_NGINX_METRICS" => :enable_nginx_metrics,
+      "APPSIGNAL_ENABLE_GVL_GLOBAL_TIMER" => :enable_gvl_global_timer,
+      "APPSIGNAL_ENABLE_GVL_WAITING_THREADS" => :enable_gvl_waiting_threads,
+      "APPSIGNAL_ENABLE_RAILS_ERROR_REPORTER" => :enable_rails_error_reporter,
+      "APPSIGNAL_FILES_WORLD_ACCESSIBLE" => :files_world_accessible,
+      "APPSIGNAL_FILTER_PARAMETERS" => :filter_parameters,
+      "APPSIGNAL_FILTER_SESSION_DATA" => :filter_session_data,
+      "APPSIGNAL_HOSTNAME" => :hostname,
+      "APPSIGNAL_HTTP_PROXY" => :http_proxy,
+      "APPSIGNAL_IGNORE_ACTIONS" => :ignore_actions,
+      "APPSIGNAL_IGNORE_ERRORS" => :ignore_errors,
+      "APPSIGNAL_IGNORE_NAMESPACES" => :ignore_namespaces,
+      "APPSIGNAL_INSTRUMENT_HTTP_RB" => :instrument_http_rb,
+      "APPSIGNAL_INSTRUMENT_NET_HTTP" => :instrument_net_http,
+      "APPSIGNAL_INSTRUMENT_REDIS" => :instrument_redis,
+      "APPSIGNAL_INSTRUMENT_SEQUEL" => :instrument_sequel,
+      "APPSIGNAL_LOG" => :log,
+      "APPSIGNAL_LOG_LEVEL" => :log_level,
+      "APPSIGNAL_LOG_PATH" => :log_path,
+      "APPSIGNAL_LOGGING_ENDPOINT" => :logging_endpoint,
+      "APPSIGNAL_PUSH_API_ENDPOINT" => :endpoint,
+      "APPSIGNAL_PUSH_API_KEY" => :push_api_key,
+      "APPSIGNAL_REQUEST_HEADERS" => :request_headers,
+      "APPSIGNAL_RUNNING_IN_CONTAINER" => :running_in_container,
+      "APPSIGNAL_SEND_ENVIRONMENT_METADATA" => :send_environment_metadata,
+      "APPSIGNAL_SEND_PARAMS" => :send_params,
+      "APPSIGNAL_SEND_SESSION_DATA" => :send_session_data,
+      "APPSIGNAL_SKIP_SESSION_DATA" => :skip_session_data,
+      "APPSIGNAL_TRANSACTION_DEBUG_MODE" => :transaction_debug_mode,
+      "APPSIGNAL_WORKING_DIRECTORY_PATH" => :working_directory_path,
+      "APPSIGNAL_WORKING_DIR_PATH" => :working_dir_path,
+      "APP_REVISION" => :revision
     }.freeze
     # @api private
     ENV_STRING_KEYS = %w[
@@ -130,6 +132,7 @@ module Appsignal
       APPSIGNAL_ENABLE_NGINX_METRICS
       APPSIGNAL_ENABLE_GVL_GLOBAL_TIMER
       APPSIGNAL_ENABLE_GVL_WAITING_THREADS
+      APPSIGNAL_ENABLE_RAILS_ERROR_REPORTER
       APPSIGNAL_FILES_WORLD_ACCESSIBLE
       APPSIGNAL_INSTRUMENT_HTTP_RB
       APPSIGNAL_INSTRUMENT_NET_HTTP
@@ -218,16 +221,17 @@ module Appsignal
     #   Configuration load order
     # @see https://docs.appsignal.com/ruby/instrumentation/integrating-appsignal.html
     #   How to integrate AppSignal manually
-    def initialize(root_path, env, initial_config = {}, logger = Appsignal.logger, config_file = nil)
-      @root_path      = root_path
-      @config_file    = config_file
-      @logger         = logger
-      @valid          = false
-      @config_hash    = Hash[DEFAULT_CONFIG]
+    def initialize(root_path, env, initial_config = {}, logger = Appsignal.logger,
+      config_file = nil)
+      @root_path = root_path
+      @config_file = config_file
+      @logger = logger
+      @valid = false
+      @config_hash = DEFAULT_CONFIG.dup
       env_loaded_from_initial = env.to_s
       @env =
-        if ENV.key?("APPSIGNAL_APP_ENV".freeze)
-          env_loaded_from_env = ENV["APPSIGNAL_APP_ENV".freeze]
+        if ENV.key?("APPSIGNAL_APP_ENV")
+          env_loaded_from_env = ENV["APPSIGNAL_APP_ENV"]
         else
           env_loaded_from_initial
         end
@@ -275,9 +279,7 @@ module Appsignal
     end
 
     def log_level
-      if config_hash[:debug] || config_hash[:transaction_debug_mode]
-        level = ::Logger::DEBUG
-      end
+      level = ::Logger::DEBUG if config_hash[:debug] || config_hash[:transaction_debug_mode]
       option = config_hash[:log_level]
       if option
         log_level_option = LOG_LEVEL_MAP[option]
@@ -287,20 +289,18 @@ module Appsignal
     end
 
     def log_file_path
-      path = config_hash[:log_path] || root_path && File.join(root_path, "log")
-      if path && File.writable?(path)
-        return File.join(File.realpath(path), "appsignal.log")
-      end
+      path = config_hash[:log_path] || (root_path && File.join(root_path, "log"))
+      return File.join(File.realpath(path), "appsignal.log") if path && File.writable?(path)
 
       system_tmp_dir = self.class.system_tmp_dir
       if File.writable? system_tmp_dir
-        $stdout.puts "appsignal: Unable to log to '#{path}'. Logging to "\
-          "'#{system_tmp_dir}' instead. Please check the "\
+        $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
-        $stdout.puts "appsignal: Unable to log to '#{path}' or the "\
-          "'#{system_tmp_dir}' fallback. Please check the permissions "\
+        $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
     end
@@ -315,7 +315,7 @@ module Appsignal
 
     def write_to_environment # rubocop:disable Metrics/AbcSize
       ENV["_APPSIGNAL_ACTIVE"]                       = active?.to_s
-      ENV["_APPSIGNAL_AGENT_PATH"]                   = File.expand_path("../../../ext", __FILE__).to_s
+      ENV["_APPSIGNAL_AGENT_PATH"]                   = File.expand_path("../../ext", __dir__).to_s
       ENV["_APPSIGNAL_APP_NAME"]                     = config_hash[:name]
       ENV["_APPSIGNAL_APP_PATH"]                     = root_path.to_s
       ENV["_APPSIGNAL_CA_FILE_PATH"]                 = config_hash[:ca_file_path].to_s
@@ -344,9 +344,13 @@ module Appsignal
       ENV["_APPSIGNAL_RUNNING_IN_CONTAINER"]         = config_hash[:running_in_container].to_s
       ENV["_APPSIGNAL_SEND_ENVIRONMENT_METADATA"]    = config_hash[:send_environment_metadata].to_s
       ENV["_APPSIGNAL_TRANSACTION_DEBUG_MODE"]       = config_hash[:transaction_debug_mode].to_s
-      ENV["_APPSIGNAL_WORKING_DIRECTORY_PATH"]       = config_hash[:working_directory_path] if config_hash[:working_directory_path]
-      ENV["_APPSIGNAL_WORKING_DIR_PATH"]             = config_hash[:working_dir_path] if config_hash[:working_dir_path]
-      ENV["_APP_REVISION"]                           = config_hash[:revision].to_s
+      if config_hash[:working_directory_path]
+        ENV["_APPSIGNAL_WORKING_DIRECTORY_PATH"] = config_hash[:working_directory_path]
+      end
+      if config_hash[:working_dir_path]
+        ENV["_APPSIGNAL_WORKING_DIR_PATH"] = config_hash[:working_dir_path]
+      end
+      ENV["_APP_REVISION"] = config_hash[:revision].to_s
     end
 
     def validate
@@ -392,12 +396,10 @@ module Appsignal
       return if !config_file || !File.exist?(config_file)
 
       read_options = YAML::VERSION >= "4.0.0" ? { :aliases => true } : {}
-      configurations = YAML.load(ERB.new(IO.read(config_file)).result, **read_options)
+      configurations = YAML.load(ERB.new(File.read(config_file)).result, **read_options)
       config_for_this_env = configurations[env]
       if config_for_this_env
-        config_for_this_env.each_with_object({}) do |(key, value), hash|
-          hash[key.to_sym] = value # convert keys to symbols
-        end
+        config_for_this_env.transform_keys(&:to_sym)
       else
         logger.error "Not loading from config file: config for '#{env}' not found"
         nil
@@ -428,8 +430,8 @@ module Appsignal
 
       deprecation_message \
         "The `working_dir_path` option is deprecated, please use " \
-        "`working_directory_path` instead and specify the " \
-        "full path to the working directory",
+          "`working_directory_path` instead and specify the " \
+          "full path to the working directory",
         logger
     end
 
@@ -438,22 +440,25 @@ module Appsignal
 
       # Configuration with string type
       ENV_STRING_KEYS.each do |var|
-        env_var = ENV[var]
+        env_var = ENV.fetch(var, nil)
         next unless env_var
+
         config[ENV_TO_KEY_MAPPING[var]] = env_var
       end
 
       # Configuration with boolean type
       ENV_BOOLEAN_KEYS.each do |var|
-        env_var = ENV[var]
+        env_var = ENV.fetch(var, nil)
         next unless env_var
+
         config[ENV_TO_KEY_MAPPING[var]] = env_var.casecmp("true").zero?
       end
 
       # Configuration with array of strings type
       ENV_ARRAY_KEYS.each do |var|
-        env_var = ENV[var]
+        env_var = ENV.fetch(var, nil)
         next unless env_var
+
         config[ENV_TO_KEY_MAPPING[var]] = env_var.split(",")
       end
 
@@ -487,9 +492,7 @@ module Appsignal
 
     def merge(new_config)
       new_config.each do |key, value|
-        unless config_hash[key].nil?
-          @logger.debug("Config key '#{key}' is being overwritten")
-        end
+        @logger.debug("Config key '#{key}' is being overwritten") unless config_hash[key].nil?
         config_hash[key] = value
       end
     end

data/lib/appsignal/demo.rb

@@ -65,7 +65,8 @@ module Appsignal
           Appsignal::Transaction::HTTP_REQUEST,
           rack_request
         )
-        Appsignal.instrument "action_view.render", "Render hello.html.erb", "<h1>Hello world!</h1>" do
+        Appsignal.instrument "action_view.render", "Render hello.html.erb",
+          "<h1>Hello world!</h1>" do
           sleep 2
         end
         transaction.set_http_or_background_queue_start

data/lib/appsignal/environment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   # @api private
   class Environment

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

@@ -5,7 +5,7 @@ module Appsignal
     # @api private
     module ActionView
       class RenderFormatter
-        BLANK = "".freeze
+        BLANK = ""
 
         attr_reader :root_path
 
@@ -15,6 +15,7 @@ module Appsignal
 
         def format(payload)
           return nil unless payload[:identifier]
+
           [payload[:identifier].sub(root_path, BLANK), nil]
         end
       end

data/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter.rb

@@ -7,7 +7,7 @@ module Appsignal
       class QueryFormatter
         ALLOWED = {
           "find" => {
-            "find"   => :allow,
+            "find" => :allow,
             "filter" => :sanitize_document
           },
           "count" => {
@@ -16,24 +16,24 @@ module Appsignal
           },
           "distinct" => {
             "distinct" => :allow,
-            "key"      => :allow,
-            "query"    => :sanitize_document
+            "key" => :allow,
+            "query" => :sanitize_document
           },
           "insert" => {
-            "insert"    => :allow,
+            "insert" => :allow,
             "documents" => :sanitize_document,
-            "ordered"   => :allow
+            "ordered" => :allow
           },
           "update" => {
-            "update"  => :allow,
+            "update" => :allow,
             "updates" => :sanitize_document,
             "ordered" => :allow
           },
           "findandmodify" => {
             "findandmodify" => :allow,
-            "query"         => :sanitize_document,
-            "update"        => :sanitize_document,
-            "new"           => :allow
+            "query" => :sanitize_document,
+            "update" => :sanitize_document,
+            "new" => :allow
           },
           "delete" => {
             "delete" => :allow,
@@ -41,10 +41,10 @@ module Appsignal
             "ordered" => :allow
           },
           "bulk" => {
-            "q"      => :sanitize_document,
-            "u"      => :sanitize_document,
-            "limit"  => :allow,
-            "multi"  => :allow,
+            "q" => :sanitize_document,
+            "u" => :sanitize_document,
+            "limit" => :allow,
+            "multi" => :allow,
             "upsert" => :allow
           }
         }.freeze

data/lib/appsignal/event_formatter.rb

@@ -27,8 +27,8 @@ module Appsignal
       def register(name, formatter = nil)
         if registered?(name, formatter)
           logger.warn(
-            "Formatter for '#{name}' already registered, not registering "\
-            "'#{formatter.name}'"
+            "Formatter for '#{name}' already registered, not registering " \
+              "'#{formatter.name}'"
           )
           return
         end
@@ -53,7 +53,7 @@ module Appsignal
 
       def format(name, payload)
         formatter = formatters[name]
-        formatter.format(payload) unless formatter.nil?
+        formatter&.format(payload)
       end
 
       private
@@ -63,6 +63,7 @@ module Appsignal
         if !format_method || format_method.arity != 1
           raise "#{formatter} does not have a format(payload) method"
         end
+
         formatter_classes[name] = formatter
         formatters[name] = formatter.new
       rescue => ex
@@ -83,6 +84,6 @@ module Appsignal
   end
 end
 
-Dir.glob(File.expand_path("../event_formatter/**/*.rb", __FILE__)).each do |file|
+Dir.glob(File.expand_path("event_formatter/**/*.rb", __dir__)).each do |file|
   require file
 end

data/lib/appsignal/extension/jruby.rb

@@ -23,9 +23,7 @@ module Appsignal
         end
 
         def make_appsignal_string(ruby_string)
-          unless ruby_string.is_a?(String)
-            raise ArgumentError, "argument is not a string"
-          end
+          raise ArgumentError, "argument is not a string" unless ruby_string.is_a?(String)
 
           AppsignalString.new.tap do |appsignal_string|
             appsignal_string[:len] = ruby_string.bytesize
@@ -102,16 +100,19 @@ module Appsignal
           [:pointer, :long],
           :void
         attach_function :appsignal_finish_event,
-          [:pointer, :appsignal_string, :appsignal_string, :appsignal_string, :int64, :long],
+          [:pointer, :appsignal_string, :appsignal_string, :appsignal_string, :int64,
+           :long],
           :void
         attach_function :appsignal_finish_event_data,
           [:pointer, :appsignal_string, :appsignal_string, :pointer, :int64, :long],
           :void
         attach_function :appsignal_record_event,
-          [:pointer, :appsignal_string, :appsignal_string, :appsignal_string, :int64, :long, :long],
+          [:pointer, :appsignal_string, :appsignal_string, :appsignal_string, :int64,
+           :long, :long],
           :void
         attach_function :appsignal_record_event_data,
-          [:pointer, :appsignal_string, :appsignal_string, :pointer, :int64, :long, :long],
+          [:pointer, :appsignal_string, :appsignal_string, :pointer, :int64, :long,
+           :long],
           :void
         attach_function :appsignal_set_transaction_error,
           [:pointer, :appsignal_string, :appsignal_string, :pointer],
@@ -291,6 +292,7 @@ module Appsignal
         )
 
         return if !transaction || transaction.null?
+
         Transaction.new(transaction)
       end
 
@@ -333,7 +335,7 @@ module Appsignal
         appsignal_add_distribution_value(make_appsignal_string(key), value, tags.pointer)
       end
 
-      class Transaction # rubocop:disable Metrics/ClassLength
+      class Transaction
         include StringHelpers
 
         attr_reader :pointer
@@ -447,7 +449,7 @@ module Appsignal
           Extension.appsignal_complete_transaction(pointer)
         end
 
-        def to_json
+        def to_json # rubocop:disable Lint/ToJSON
           json = Extension.appsignal_transaction_to_json(pointer)
           make_ruby_string(json) if json[:len] > 0
         end
@@ -531,7 +533,7 @@ module Appsignal
           )
         end
 
-        def to_json
+        def to_json # rubocop:disable Lint/ToJSON
           json = Extension.appsignal_span_to_json(pointer)
           make_ruby_string(json) if json[:len] > 0
         end

data/lib/appsignal/extension.rb

@@ -34,7 +34,7 @@ module Appsignal
       #
       # Disabled in testing so we can make sure that we don't miss a extension
       # function implementation.
-      def method_missing(m, *args, &block)
+      def method_missing(_method, *args, &block)
         super if Appsignal.testing?
       end