appsignal 3.10.0 → 3.12.0

data/lib/appsignal/utils/integration_memory_logger.rb

@@ -4,7 +4,6 @@ require "logger"
 
 module Appsignal
   module Utils
-    # @api private
     class IntegrationMemoryLogger
       LEVELS = {
         Logger::DEBUG => :DEBUG,
@@ -35,18 +34,6 @@ module Appsignal
         add(:WARN, message)
       end
 
-      def seen_keys
-        @seen_keys ||= Set.new
-      end
-
-      def warn_once_then_debug(key, message)
-        if seen_keys.add?(key).nil?
-          debug message
-        else
-          warn message
-        end
-      end
-
       def error(message)
         add(:ERROR, message)
       end

data/lib/appsignal/utils/json.rb

@@ -2,7 +2,6 @@
 
 module Appsignal
   module Utils
-    # @api private
     class JSON
       class << self
         def generate(body)

data/lib/appsignal/utils/query_params_sanitizer.rb

@@ -2,7 +2,6 @@
 
 module Appsignal
   module Utils
-    # @api private
     class QueryParamsSanitizer
       REPLACEMENT_KEY = "?"
 

data/lib/appsignal/utils/stdout_and_logger_message.rb

@@ -2,7 +2,6 @@
 
 module Appsignal
   module Utils
-    # @api private
     module StdoutAndLoggerMessage
       def self.warning(message, logger = Appsignal.internal_logger)
         Kernel.warn "appsignal WARNING: #{message}"

data/lib/appsignal/utils.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+module Appsignal
+  # @api private
+  module Utils
+  end
+end
+
 require "appsignal/utils/integration_memory_logger"
 require "appsignal/utils/stdout_and_logger_message"
 require "appsignal/utils/data"

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.10.0"
+  VERSION = "3.12.0"
 end

data/lib/appsignal.rb

@@ -22,8 +22,8 @@ module Appsignal
     include Helpers::Instrumentation
     include Helpers::Metrics
 
-    # Accessor for the AppSignal configuration.
-    # Return the current AppSignal configuration.
+    # The loaded AppSignal configuration.
+    # Returns the current AppSignal configuration.
     #
     # Can return `nil` if no configuration has been set or automatically loaded
     # by an automatic integration or by calling {.start}.
@@ -31,12 +31,31 @@ module Appsignal
     # @example
     #   Appsignal.config
     #
-    # @example Setting the configuration
-    #   Appsignal.config = Appsignal::Config.new(Dir.pwd, "production")
-    #
     # @return [Config, nil]
+    # @see configure
+    # @see Config
+    attr_reader :config
+
+    # Set the AppSignal config.
+    #
+    # @deprecated Use {Appsignal.configure} instead.
+    # @param conf [Appsignal::Config]
+    # @return [void]
     # @see Config
-    attr_accessor :config
+    def config=(conf)
+      Appsignal::Utils::StdoutAndLoggerMessage.warning \
+        "Configuring AppSignal with `Appsignal.config=` is deprecated. " \
+          "Use `Appsignal.configure { |config| ... }` to configure AppSignal. " \
+          "https://docs.appsignal.com/ruby/configuration.html\n" \
+          "#{caller.first}"
+      @config = conf
+    end
+
+    # @api private
+    def _config=(conf)
+      @config = conf
+    end
+
     # Accessor for toggle if the AppSignal C-extension is loaded.
     #
     # Can be `nil` if extension has not been loaded yet. See
@@ -47,7 +66,7 @@ module Appsignal
     # @see Extension
     # @see extension_loaded?
     attr_accessor :extension_loaded
-    # @!attribute [rw] logger
+    # @!attribute [rw] internal_logger
     #   Accessor for the internal AppSignal logger.
     #
     #   Not to be confused with our logging feature.
@@ -59,10 +78,8 @@ module Appsignal
     #   {.start}) the contents of the "in memory logger" is written to the new
     #   logger.
     #
-    #   @note some classes may have options to set custom loggers. Their
-    #     defaults are pointed to this attribute.
     #   @api private
-    #   @return [Logger]
+    #   @return [Utils::IntegrationLogger or Utils::IntegrationMemoryLogger]
     #   @see start
     attr_writer :internal_logger
 
@@ -89,7 +106,9 @@ module Appsignal
     #   Appsignal.start
     #
     # @example with custom loaded configuration
-    #   Appsignal.config = Appsignal::Config.new(Dir.pwd, "production")
+    #   Appsignal.configure(:production) do |config|
+    #     config.ignore_actions = ["My action"]
+    #   end
     #   Appsignal.start
     #
     # @return [void]
@@ -111,11 +130,13 @@ module Appsignal
 
       if config.valid?
         if config.active?
+          @started = true
           internal_logger.info "Starting AppSignal #{Appsignal::VERSION} " \
             "(#{$PROGRAM_NAME}, Ruby #{RUBY_VERSION}, #{RUBY_PLATFORM})"
           config.write_to_environment
           Appsignal::Extension.start
           Appsignal::Hooks.load_hooks
+          Appsignal::Loaders.start
 
           if config[:enable_allocation_tracking] && !Appsignal::System.jruby?
             Appsignal::Extension.install_allocation_event_hook
@@ -149,14 +170,102 @@ module Appsignal
     # @since 1.0.0
     def stop(called_by = nil)
       if called_by
-        internal_logger.debug("Stopping appsignal (#{called_by})")
+        internal_logger.debug("Stopping AppSignal (#{called_by})")
       else
-        internal_logger.debug("Stopping appsignal")
+        internal_logger.debug("Stopping AppSignal")
       end
       Appsignal::Extension.stop
       Appsignal::Probes.stop
     end
 
+    # Configure the AppSignal Ruby gem using a DSL.
+    #
+    # Pass a block to the configure method to configure the Ruby gem.
+    #
+    # Each config option defined in our docs can be fetched, set and modified
+    # via a helper method in the given block.
+    #
+    # After AppSignal has started using {start}, the configuration can not be
+    # modified. Any calls to this helper will be ignored.
+    #
+    # This helper should not be used to configure multiple environments, like
+    # done in the YAML file. Configure the environment you want active when the
+    # application starts.
+    #
+    # @example Configure AppSignal for the application
+    #   Appsignal.configure do |config|
+    #     config.path = "/the/app/path"
+    #     config.active = ENV["APP_ACTIVE"] == "true"
+    #     config.push_api_key = File.read("appsignal_key.txt").chomp
+    #     config.ignore_actions = ENDPOINTS.select { |e| e.public? }.map(&:name)
+    #     config.request_headers << "MY_CUSTOM_HEADER"
+    #   end
+    #
+    # @example Configure AppSignal for the application and select the environment
+    #   Appsignal.configure(:production) do |config|
+    #     config.active = true
+    #   end
+    #
+    # @example Automatically detects the app environment
+    #   # Tries to determine the app environment automatically from the
+    #   # environment and the libraries it integrates with.
+    #   ENV["RACK_ENV"] = "production"
+    #
+    #   Appsignal.configure do |config|
+    #     config.env # => "production"
+    #   end
+    #
+    # @example Calling configure multiple times for different environments resets the configuration
+    #   Appsignal.configure(:development) do |config|
+    #     config.ignore_actions = ["My action"]
+    #   end
+    #
+    #   Appsignal.configure(:production) do |config|
+    #     config.ignore_actions # => []
+    #   end
+    #
+    # @example Load config without a block
+    #   # This will require either ENV vars being set
+    #   # or the config/appsignal.yml being present
+    #   Appsignal.configure
+    #   # Or for the environment given as an argument
+    #   Appsignal.configure(:production)
+    #
+    # @yield [Config] Gives the {Config} instance to the block.
+    # @return [void]
+    # @see config
+    # @see Config
+    # @see https://docs.appsignal.com/ruby/configuration.html Configuration guide
+    # @see https://docs.appsignal.com/ruby/configuration/options.html Configuration options
+    def configure(env = nil)
+      if Appsignal.started?
+        Appsignal.internal_logger
+          .warn("AppSignal is already started. Ignoring `Appsignal.configure` call.")
+        return
+      end
+
+      if config && config.env == env.to_s
+        config
+      else
+        self._config = Appsignal::Config.new(
+          Dir.pwd,
+          env || ENV["APPSIGNAL_APP_ENV"] || ENV["RAILS_ENV"] || ENV.fetch("RACK_ENV", nil),
+          {},
+          Appsignal.internal_logger,
+          nil,
+          false
+        )
+        config.load_config
+      end
+
+      config_dsl = Appsignal::Config::ConfigDSL.new(config)
+      if block_given?
+        yield config_dsl
+        config.merge_dsl_options(config_dsl.dsl_options)
+      end
+      config.validate
+    end
+
     def forked
       return unless active?
 
@@ -165,10 +274,44 @@ module Appsignal
       Appsignal::Extension.start
     end
 
+    # Load an AppSignal integration.
+    #
+    # Load one of the supported integrations via our loader system.
+    # This will set config defaults and integratie with the library if
+    # AppSignal is active upon start.
+    #
+    # @example Load Sinatra integrations
+    #   # First load the integration
+    #   Appsignal.load(:sinatra)
+    #   # Start AppSignal
+    #   Appsignal.start
+    #
+    # @example Load Sinatra integrations and define custom config
+    #   # First load the integration
+    #   Appsignal.load(:sinatra)
+    #
+    #   # Customize config
+    #   Appsignal.configure do |config|
+    #     config.ignore_actions = ["GET /ping"]
+    #   end
+    #
+    #
+    #   # Start AppSignal
+    #   Appsignal.start
+    #
+    # @param integration_name [String, Symbol] Name of the integration to load.
+    # @return [void]
+    # @since 3.12.0
+    def load(integration_name)
+      Loaders.load(integration_name)
+    end
+
+    # @api private
     def get_server_state(key)
       Appsignal::Extension.get_server_state(key)
     end
 
+    # @api private
     def in_memory_logger
       @in_memory_logger ||=
         Appsignal::Utils::IntegrationMemoryLogger.new.tap do |l|
@@ -176,6 +319,7 @@ module Appsignal
         end
     end
 
+    # @api private
     def internal_logger
       @internal_logger ||= in_memory_logger
     end
@@ -195,7 +339,7 @@ module Appsignal
     def start_logger
       callers = caller
       Appsignal::Utils::StdoutAndLoggerMessage.warning \
-        "Callng 'Appsignal.start_logger' is deprecated. " \
+        "Calling 'Appsignal.start_logger' is deprecated. " \
           "The logger will be started when calling 'Appsignal.start'. " \
           "Remove the 'Appsignal.start_logger' call in the following file to " \
           "remove this message.\n#{callers.first}"
@@ -237,6 +381,16 @@ module Appsignal
       !!extension_loaded
     end
 
+    # Returns if {.start} has been called before with a valid config to start
+    # AppSignal.
+    #
+    # @return [Boolean]
+    # @see Extension
+    # @since 3.12.0
+    def started?
+      defined?(@started) ? @started : false
+    end
+
     # Returns the active state of the AppSignal integration.
     #
     # Conditions apply for AppSignal to be marked as active:
@@ -313,6 +467,7 @@ module Appsignal
   end
 end
 
+require "appsignal/loaders"
 require "appsignal/environment"
 require "appsignal/system"
 require "appsignal/utils"

data/spec/lib/appsignal/capistrano2_spec.rb

@@ -17,7 +17,7 @@ if DependencyHelper.capistrano2_present?
         c.dry_run = false
       end
     end
-    before { Appsignal::Capistrano.tasks(capistrano_config) }
+    before { Appsignal::Integrations::Capistrano.tasks(capistrano_config) }
 
     def run
       capture_stdout(out_stream) do

data/spec/lib/appsignal/cli/demo_spec.rb

@@ -13,7 +13,6 @@ describe Appsignal::CLI::Demo do
     ENV.delete("RACK_ENV")
     stub_api_request config, "auth"
   end
-  after { Appsignal.config = nil }
 
   def run
     run_within_dir project_fixture_path

data/spec/lib/appsignal/cli/diagnose/paths_spec.rb

@@ -4,7 +4,7 @@ require "appsignal/cli/diagnose/paths"
 
 describe Appsignal::CLI::Diagnose::Paths do
   describe "#paths" do
-    before { Appsignal.config = project_fixture_config }
+    before { start_agent }
 
     it "returns gem installation path as package_install_path" do
       expect(described_class.new.paths[:package_install_path]).to eq(

data/spec/lib/appsignal/cli/diagnose_spec.rb

@@ -67,7 +67,6 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
       capture_diagnatics_report_request
     end
     before(:send_report => :no_cli_option) { options["no-send-report"] = nil }
-    after { Appsignal.config = nil }
 
     def capture_diagnatics_report_request
       stub_diagnostics_report_request.to_rack(DiagnosticsReportEndpoint)