appsignal 3.10.0 → 3.12.0

data/lib/appsignal/config.rb

@@ -10,6 +10,17 @@ module Appsignal
   class Config
     include Appsignal::Utils::StdoutAndLoggerMessage
 
+    # @api private
+    def self.loader_defaults
+      @loader_defaults ||= []
+    end
+
+    # @api private
+    def self.add_loader_defaults(name, options)
+      loader_defaults << [name, options]
+    end
+
+    # @api private
     DEFAULT_CONFIG = {
       :activejob_report_errors => "all",
       :ca_file_path => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
@@ -67,15 +78,31 @@ module Appsignal
       "trace" => ::Logger::DEBUG
     }.freeze
 
-    ENV_TO_KEY_MAPPING = {
-      "APPSIGNAL_ACTIVE" => :active,
+    # @api private
+    ENV_STRING_KEYS = {
       "APPSIGNAL_ACTIVEJOB_REPORT_ERRORS" => :activejob_report_errors,
       "APPSIGNAL_APP_NAME" => :name,
       "APPSIGNAL_BIND_ADDRESS" => :bind_address,
       "APPSIGNAL_CA_FILE_PATH" => :ca_file_path,
-      "APPSIGNAL_CPU_COUNT" => :cpu_count,
+      "APPSIGNAL_HOSTNAME" => :hostname,
+      "APPSIGNAL_HOST_ROLE" => :host_role,
+      "APPSIGNAL_HTTP_PROXY" => :http_proxy,
+      "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_SIDEKIQ_REPORT_ERRORS" => :sidekiq_report_errors,
+      "APPSIGNAL_STATSD_PORT" => :statsd_port,
+      "APPSIGNAL_WORKING_DIRECTORY_PATH" => :working_directory_path,
+      "APPSIGNAL_WORKING_DIR_PATH" => :working_dir_path,
+      "APP_REVISION" => :revision
+    }.freeze
+    # @api private
+    ENV_BOOLEAN_KEYS = {
+      "APPSIGNAL_ACTIVE" => :active,
       "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,
@@ -87,100 +114,33 @@ module Appsignal
       "APPSIGNAL_ENABLE_RAKE_PERFORMANCE_INSTRUMENTATION" =>
         :enable_rake_performance_instrumentation,
       "APPSIGNAL_FILES_WORLD_ACCESSIBLE" => :files_world_accessible,
-      "APPSIGNAL_FILTER_METADATA" => :filter_metadata,
-      "APPSIGNAL_FILTER_PARAMETERS" => :filter_parameters,
-      "APPSIGNAL_FILTER_SESSION_DATA" => :filter_session_data,
-      "APPSIGNAL_HOSTNAME" => :hostname,
-      "APPSIGNAL_HOST_ROLE" => :host_role,
-      "APPSIGNAL_HTTP_PROXY" => :http_proxy,
-      "APPSIGNAL_IGNORE_ACTIONS" => :ignore_actions,
-      "APPSIGNAL_IGNORE_ERRORS" => :ignore_errors,
-      "APPSIGNAL_IGNORE_LOGS" => :ignore_logs,
-      "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_SIDEKIQ_REPORT_ERRORS" => :sidekiq_report_errors,
       "APPSIGNAL_SKIP_SESSION_DATA" => :skip_session_data,
-      "APPSIGNAL_STATSD_PORT" => :statsd_port,
-      "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_TRANSACTION_DEBUG_MODE" => :transaction_debug_mode
     }.freeze
     # @api private
-    ENV_STRING_KEYS = %w[
-      APPSIGNAL_ACTIVEJOB_REPORT_ERRORS
-      APPSIGNAL_APP_NAME
-      APPSIGNAL_BIND_ADDRESS
-      APPSIGNAL_CA_FILE_PATH
-      APPSIGNAL_HOSTNAME
-      APPSIGNAL_HOST_ROLE
-      APPSIGNAL_HTTP_PROXY
-      APPSIGNAL_LOG
-      APPSIGNAL_LOG_LEVEL
-      APPSIGNAL_LOG_PATH
-      APPSIGNAL_LOGGING_ENDPOINT
-      APPSIGNAL_PUSH_API_ENDPOINT
-      APPSIGNAL_PUSH_API_KEY
-      APPSIGNAL_SIDEKIQ_REPORT_ERRORS
-      APPSIGNAL_STATSD_PORT
-      APPSIGNAL_WORKING_DIRECTORY_PATH
-      APPSIGNAL_WORKING_DIR_PATH
-      APP_REVISION
-    ].freeze
-    # @api private
-    ENV_BOOLEAN_KEYS = %w[
-      APPSIGNAL_ACTIVE
-      APPSIGNAL_DEBUG
-      APPSIGNAL_ENABLE_ALLOCATION_TRACKING
-      APPSIGNAL_ENABLE_HOST_METRICS
-      APPSIGNAL_ENABLE_MINUTELY_PROBES
-      APPSIGNAL_ENABLE_STATSD
-      APPSIGNAL_ENABLE_NGINX_METRICS
-      APPSIGNAL_ENABLE_GVL_GLOBAL_TIMER
-      APPSIGNAL_ENABLE_GVL_WAITING_THREADS
-      APPSIGNAL_ENABLE_RAILS_ERROR_REPORTER
-      APPSIGNAL_ENABLE_RAKE_PERFORMANCE_INSTRUMENTATION
-      APPSIGNAL_FILES_WORLD_ACCESSIBLE
-      APPSIGNAL_INSTRUMENT_HTTP_RB
-      APPSIGNAL_INSTRUMENT_NET_HTTP
-      APPSIGNAL_INSTRUMENT_REDIS
-      APPSIGNAL_INSTRUMENT_SEQUEL
-      APPSIGNAL_RUNNING_IN_CONTAINER
-      APPSIGNAL_SEND_ENVIRONMENT_METADATA
-      APPSIGNAL_SEND_PARAMS
-      APPSIGNAL_SEND_SESSION_DATA
-      APPSIGNAL_SKIP_SESSION_DATA
-      APPSIGNAL_TRANSACTION_DEBUG_MODE
-    ].freeze
+    ENV_ARRAY_KEYS = {
+      "APPSIGNAL_DNS_SERVERS" => :dns_servers,
+      "APPSIGNAL_FILTER_METADATA" => :filter_metadata,
+      "APPSIGNAL_FILTER_PARAMETERS" => :filter_parameters,
+      "APPSIGNAL_FILTER_SESSION_DATA" => :filter_session_data,
+      "APPSIGNAL_IGNORE_ACTIONS" => :ignore_actions,
+      "APPSIGNAL_IGNORE_ERRORS" => :ignore_errors,
+      "APPSIGNAL_IGNORE_LOGS" => :ignore_logs,
+      "APPSIGNAL_IGNORE_NAMESPACES" => :ignore_namespaces,
+      "APPSIGNAL_REQUEST_HEADERS" => :request_headers
+    }.freeze
     # @api private
-    ENV_ARRAY_KEYS = %w[
-      APPSIGNAL_DNS_SERVERS
-      APPSIGNAL_FILTER_METADATA
-      APPSIGNAL_FILTER_PARAMETERS
-      APPSIGNAL_FILTER_SESSION_DATA
-      APPSIGNAL_IGNORE_ACTIONS
-      APPSIGNAL_IGNORE_ERRORS
-      APPSIGNAL_IGNORE_LOGS
-      APPSIGNAL_IGNORE_NAMESPACES
-      APPSIGNAL_REQUEST_HEADERS
-    ].freeze
-    ENV_FLOAT_KEYS = %w[
-      APPSIGNAL_CPU_COUNT
-    ].freeze
+    ENV_FLOAT_KEYS = {
+      "APPSIGNAL_CPU_COUNT" => :cpu_count
+    }.freeze
 
     # @attribute [r] system_config
     #   Config detected on the system level.
@@ -211,23 +171,15 @@ module Appsignal
     #   @api private
     #   @return [Hash]
 
-    attr_reader :root_path, :env, :config_hash, :system_config,
-      :initial_config, :file_config, :env_config, :override_config
+    # @api private
+    attr_accessor :root_path, :env, :config_hash
+    attr_reader :system_config, :initial_config, :file_config, :env_config,
+      :override_config, :dsl_config
+    # @api private
     attr_accessor :logger
 
     # Initialize a new configuration object for AppSignal.
     #
-    # If this is manually initialized, and not by {Appsignal.start}, it needs
-    # to be assigned to the {Appsignal.config} attribute.
-    #
-    # @example
-    #   require "appsignal"
-    #   Appsignal.config = Appsignal::Config.new(
-    #     app_path,
-    #     "production"
-    #   )
-    #   Appsignal.start
-    #
     # @param root_path [String] Root path of the app.
     # @param env [String] The environment to load when AppSignal is started. It
     #   will look for an environment with this name in the `config/appsignal.yml`
@@ -241,55 +193,90 @@ module Appsignal
     # @param config_file [String] Custom config file location. Default
     #   `config/appsignal.yml`.
     #
+    # @api private
     # @see https://docs.appsignal.com/ruby/configuration/
     #   Configuration documentation
     # @see https://docs.appsignal.com/ruby/configuration/load-order.html
     #   Configuration load order
     # @see https://docs.appsignal.com/ruby/instrumentation/integrating-appsignal.html
     #   How to integrate AppSignal manually
-    def initialize(
+    def initialize( # rubocop:disable Metrics/ParameterLists
       root_path,
-      env,
+      initial_env,
       initial_config = {},
       logger = Appsignal.internal_logger,
-      config_file = nil
+      config_file = nil,
+      load_on_new = true # rubocop:disable Style/OptionalBooleanParameter
     )
-      @config_file_error = false
       @root_path = root_path
+      @config_file_error = false
       @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")
-          env_loaded_from_env = ENV["APPSIGNAL_APP_ENV"]
-        else
-          env_loaded_from_initial
-        end
+
+      @initial_env = initial_env
+      @env = initial_env.to_s
+      @config_hash = {}
+      @system_config = {}
+      @initial_config = initial_config
+      @file_config = {}
+      @env_config = {}
+      @override_config = {}
+      @dsl_config = {} # Can be set using `Appsignal.configure`
+
+      return unless load_on_new
+
+      # Determine starting environment
+      @env = ENV["APPSIGNAL_APP_ENV"] if ENV.key?("APPSIGNAL_APP_ENV")
+      load_config
+      validate
+    end
+
+    # @api private
+    def load_config
+      # Set defaults
+      # Deep duplicate each frozen default value
+      merge(DEFAULT_CONFIG.transform_values(&:dup))
 
       # Set config based on the system
       @system_config = detect_from_system
       merge(system_config)
-      # Initial config
-      @initial_config = initial_config
+
+      # Set defaults from loaders in reverse order so the first register
+      # loader's defaults overwrite all others
+      self.class.loader_defaults.reverse.each do |(_loader_name, loader_defaults)|
+        defaults = loader_defaults.compact.dup
+        # Overwrite root path
+        loader_path = defaults.delete(:root_path)
+        @root_path = loader_path if loader_path
+        # Overwrite env
+        loader_env = defaults.delete(:env)
+        @env = loader_env.to_s if loader_env
+        # Merge with the config loaded so far
+        merge(defaults)
+      end
+
       merge(initial_config)
+      # Track origin of env
+      @initial_config[:env] = @initial_env.to_s
+
       # Load the config file if it exists
       @file_config = load_from_disk || {}
       merge(file_config)
+
       # Load config from environment variables
       @env_config = load_from_environment
       merge(env_config)
+      # Track origin of env
+      env_loaded_from_env = ENV.fetch("APPSIGNAL_APP_ENV", nil)
+      @env_config[:env] = env_loaded_from_env if env_loaded_from_env
+
       # Load config overrides
       @override_config = determine_overrides
       merge(override_config)
+
       # Handle deprecated config options
       maintain_backwards_compatibility
-      # Validate that we have a correct config
-      validate
-      # Track origin of env
-      @initial_config[:env] = env_loaded_from_initial if env_loaded_from_initial
-      @env_config[:env] = env_loaded_from_env if env_loaded_from_env
     end
 
     # @api private
@@ -302,6 +289,7 @@ module Appsignal
       end
     end
 
+    # @api private
     def [](key)
       config_hash[key]
     end
@@ -316,6 +304,7 @@ module Appsignal
       config_hash[key] = value
     end
 
+    # @api private
     def log_level
       level = ::Logger::DEBUG if config_hash[:debug] || config_hash[:transaction_debug_mode]
       option = config_hash[:log_level]
@@ -326,6 +315,7 @@ module Appsignal
       level.nil? ? Appsignal::Config::DEFAULT_LOG_LEVEL : level
     end
 
+    # @api private
     def log_file_path
       return @log_file_path if defined? @log_file_path
 
@@ -360,6 +350,7 @@ module Appsignal
       @valid && config_hash[:active]
     end
 
+    # @api private
     def write_to_environment # rubocop:disable Metrics/AbcSize
       ENV["_APPSIGNAL_ACTIVE"]                       = active?.to_s
       ENV["_APPSIGNAL_AGENT_PATH"]                   = File.expand_path("../../ext", __dir__).to_s
@@ -405,6 +396,13 @@ module Appsignal
       ENV["_APP_REVISION"] = config_hash[:revision].to_s
     end
 
+    # @api private
+    def merge_dsl_options(options)
+      @dsl_options = options
+      merge(options)
+    end
+
+    # @api private
     def validate
       # Strip path from endpoint so we're backwards compatible with
       # earlier versions of the gem.
@@ -503,35 +501,35 @@ module Appsignal
       config = {}
 
       # Configuration with string type
-      ENV_STRING_KEYS.each do |var|
-        env_var = ENV.fetch(var, nil)
+      ENV_STRING_KEYS.each do |env_key, option|
+        env_var = ENV.fetch(env_key, nil)
         next unless env_var
 
-        config[ENV_TO_KEY_MAPPING[var]] = env_var
+        config[option] = env_var
       end
 
       # Configuration with boolean type
-      ENV_BOOLEAN_KEYS.each do |var|
-        env_var = ENV.fetch(var, nil)
+      ENV_BOOLEAN_KEYS.each do |env_key, option|
+        env_var = ENV.fetch(env_key, nil)
         next unless env_var
 
-        config[ENV_TO_KEY_MAPPING[var]] = env_var.casecmp("true").zero?
+        config[option] = env_var.casecmp("true").zero?
       end
 
       # Configuration with array of strings type
-      ENV_ARRAY_KEYS.each do |var|
-        env_var = ENV.fetch(var, nil)
+      ENV_ARRAY_KEYS.each do |env_key, option|
+        env_var = ENV.fetch(env_key, nil)
         next unless env_var
 
-        config[ENV_TO_KEY_MAPPING[var]] = env_var.split(",")
+        config[option] = env_var.split(",")
       end
 
       # Configuration with float type
-      ENV_FLOAT_KEYS.each do |var|
-        env_var = ENV.fetch(var, nil)
+      ENV_FLOAT_KEYS.each do |env_key, option|
+        env_var = ENV.fetch(env_key, nil)
         next unless env_var
 
-        config[ENV_TO_KEY_MAPPING[var]] = env_var.to_f
+        config[option] = env_var.to_f
       end
 
       config
@@ -590,5 +588,81 @@ module Appsignal
       value = ENV.fetch("APPSIGNAL_INACTIVE_ON_CONFIG_FILE_ERROR", false)
       ["1", "true"].include?(value)
     end
+
+    # @api private
+    class ConfigDSL
+      attr_reader :dsl_options
+
+      def initialize(config)
+        @config = config
+        @dsl_options = {}
+      end
+
+      def app_path
+        @config.root_path
+      end
+
+      def app_path=(path)
+        @config.root_path = path
+      end
+
+      def env
+        @config.env
+      end
+
+      Appsignal::Config::ENV_STRING_KEYS.each_value do |option|
+        define_method(option) do
+          fetch_option(option)
+        end
+
+        define_method("#{option}=") do |value|
+          update_option(option, value.to_s)
+        end
+      end
+
+      Appsignal::Config::ENV_BOOLEAN_KEYS.each_value do |option|
+        define_method(option) do
+          fetch_option(option)
+        end
+
+        define_method("#{option}=") do |value|
+          update_option(option, !!value)
+        end
+      end
+
+      Appsignal::Config::ENV_ARRAY_KEYS.each_value do |option|
+        define_method(option) do
+          fetch_option(option)
+        end
+
+        define_method("#{option}=") do |value|
+          update_option(option, value.to_a)
+        end
+      end
+
+      Appsignal::Config::ENV_FLOAT_KEYS.each_value do |option|
+        define_method(option) do
+          fetch_option(option)
+        end
+
+        define_method("#{option}=") do |value|
+          update_option(option, value.to_f)
+        end
+      end
+
+      private
+
+      def fetch_option(key)
+        if @dsl_options.key?(key)
+          @dsl_options[key]
+        else
+          @dsl_options[key] = @config[key].dup
+        end
+      end
+
+      def update_option(key, value)
+        @dsl_options[key] = value
+      end
+    end
   end
 end

data/lib/appsignal/demo.rb

@@ -6,12 +6,7 @@ module Appsignal
   # {Appsignal::Demo} is a way to send demonstration / test samples for a
   # exception and a performance issue.
   #
-  # @example Loading config automatically
-  #   Appsignal::Demo.transmit
-  #
-  # @example With custom config
-  #   # If another configuration should be used, set it beforehand.
-  #   Appsignal.config = Appsignal::Config.new(Dir.pwd, "production")
+  # @example Send example transactions
   #   Appsignal::Demo.transmit
   #
   # @since 2.0.0
@@ -39,18 +34,15 @@ module Appsignal
       private
 
       def create_example_error_request
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::HTTP_REQUEST,
-          rack_request
-        )
+        transaction = Appsignal::Transaction.create(Appsignal::Transaction::HTTP_REQUEST)
         begin
           raise TestError,
             "Hello world! This is an error used for demonstration purposes."
         rescue => error
           Appsignal.set_error(error)
         end
-        transaction.set_http_or_background_queue_start
+        add_params_to(transaction)
+        add_headers_to(transaction)
         transaction.set_metadata("path", "/hello")
         transaction.set_metadata("method", "GET")
         transaction.set_action("DemoController#hello")
@@ -59,16 +51,13 @@ module Appsignal
       end
 
       def create_example_performance_request
-        transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
-          Appsignal::Transaction::HTTP_REQUEST,
-          rack_request
-        )
+        transaction = Appsignal::Transaction.create(Appsignal::Transaction::HTTP_REQUEST)
         Appsignal.instrument "action_view.render", "Render hello.html.erb",
           "<h1>Hello world!</h1>" do
           sleep 2
         end
-        transaction.set_http_or_background_queue_start
+        add_params_to(transaction)
+        add_headers_to(transaction)
         transaction.set_metadata("path", "/hello")
         transaction.set_metadata("method", "GET")
         transaction.set_action("DemoController#hello")
@@ -80,13 +69,15 @@ module Appsignal
         transaction.set_metadata("demo_sample", "true")
       end
 
-      def rack_request
-        env = ::Rack::MockRequest.env_for(
-          "/demo",
-          :params => {
-            "controller" => "demo",
-            "action" => "hello"
-          },
+      def add_params_to(transaction)
+        transaction.set_params(
+          "controller" => "demo",
+          "action" => "hello"
+        )
+      end
+
+      def add_headers_to(transaction)
+        transaction.set_headers(
           "REMOTE_ADDR" => "127.0.0.1",
           "REQUEST_METHOD" => "GET",
           "SERVER_NAME" => "localhost",
@@ -102,7 +93,6 @@ module Appsignal
           "HTTP_USER_AGENT" => "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_0)",
           "HTTP_REFERER" => "http://appsignal.com/accounts"
         )
-        ::Rack::Request.new(env)
       end
     end
   end

data/lib/appsignal/event_formatter/rom/sql_formatter.rb

@@ -2,6 +2,7 @@
 
 module Appsignal
   class EventFormatter
+    # @api private
     module Rom
       class SqlFormatter
         def format(payload)

data/lib/appsignal/event_formatter.rb

@@ -10,14 +10,14 @@ module Appsignal
   # event, the same object will be called intermittently in a threaded environment.
   # So only keep global configuration as state and pass the payload around as an
   # argument if you need to use helper methods.
-  #
-  # @api private
   class EventFormatter
     class << self
+      # @api private
       def formatters
         @formatters ||= {}
       end
 
+      # @api private
       def formatter_classes
         @formatter_classes ||= {}
       end
@@ -49,6 +49,7 @@ module Appsignal
         end
       end
 
+      # @api private
       def format(name, payload)
         formatter = formatters[name]
         formatter&.format(payload)