appsignal 2.11.0.beta.1 → 2.11.0

data/README.md

@@ -9,7 +9,7 @@ issues.
 - [Ruby code documentation][ruby-doc]
 - [Support][contact]
 
-[![Build status](https://appsignal.semaphoreci.com/badges/appsignal-ruby/branches/master.svg)](https://appsignal.semaphoreci.com/projects/appsignal-ruby)
+[![Build status](https://appsignal.semaphoreci.com/badges/appsignal-ruby/branches/main.svg)](https://appsignal.semaphoreci.com/projects/appsignal-ruby)
 [![Gem Version](https://badge.fury.io/rb/appsignal.svg)](http://badge.fury.io/rb/appsignal)
 [![Code Climate](https://codeclimate.com/github/appsignal/appsignal.png)](https://codeclimate.com/github/appsignal/appsignal)
 
@@ -183,7 +183,7 @@ installing the AppSignal C-extension.
 # Gemfile
 gem "appsignal",
   :git => "https://github.com/appsignal/appsignal-ruby.git",
-  :branch => "master"
+  :branch => "main"
 ```
 
 When you need to use a git source of the gem in your JRuby install, you'll need
@@ -242,12 +242,12 @@ a number of different Ruby versions.
 
 This gem uses [Semantic Versioning][semver].
 
-The `master` branch corresponds to the current stable release of the gem.
+The `main` branch corresponds to the current stable release of the gem.
 
 The `develop` branch is used for development of features that will end up in
 the next minor release.
 
-Open a Pull Request on the `master` branch if you're fixing a bug. For new new
+Open a Pull Request on the `main` branch if you're fixing a bug. For new new
 features, open a Pull Request on the `develop` branch.
 
 Every stable and unstable release is tagged in git with a version tag.

data/Rakefile

@@ -70,7 +70,10 @@ namespace :build_matrix do
           job = {
             "name" => "Ruby #{ruby_version} for #{gem["gem"]}",
             "env_vars" => env,
-            "commands" => ["./support/bundler_wrapper exec rake test"]
+            "commands" => [
+              "./support/bundler_wrapper exec rake test",
+              "./support/bundler_wrapper exec rake test:failure"
+            ]
           }
           if gem["gem"] == "no_dependencies"
             ruby_primary_block["task"]["jobs"] << job
@@ -364,11 +367,20 @@ end
 
 begin
   require "rspec/core/rake_task"
+  is_jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
+  unless is_jruby
+    jruby_opts = "--exclude-pattern=spec/lib/appsignal/extension/jruby_spec.rb"
+  end
+
   desc "Run the AppSignal gem test suite."
   RSpec::Core::RakeTask.new :test do |t|
-    is_jruby = defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
-    unless is_jruby
-      t.rspec_opts = "--exclude-pattern=spec/lib/appsignal/extension/jruby_spec.rb"
+    t.rspec_opts = jruby_opts
+  end
+
+  namespace :test do
+    desc "Run the Appsignal gem test in an extension failure scenario"
+    RSpec::Core::RakeTask.new :failure do |t|
+      t.rspec_opts = "#{jruby_opts} --tag extension_installation_failure"
     end
   end
 rescue LoadError # rubocop:disable Lint/HandleExceptions

data/appsignal.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |gem| # rubocop:disable Metrics/BlockLength
   gem.metadata = {
     "bug_tracker_uri"   => "https://github.com/appsignal/appsignal-ruby/issues",
     "changelog_uri"     =>
-      "https://github.com/appsignal/appsignal-ruby/blob/master/CHANGELOG.md",
+      "https://github.com/appsignal/appsignal-ruby/blob/main/CHANGELOG.md",
     "documentation_uri" => "https://docs.appsignal.com/ruby/",
     "homepage_uri"      => "https://docs.appsignal.com/ruby/",
     "source_code_uri"   => "https://github.com/appsignal/appsignal-ruby"

data/build_matrix.yml

@@ -10,8 +10,8 @@ semaphore: # Default `.semaphore/semaphore.yml` contents
   # Cancel all running and queued workflows before this one
   auto_cancel:
     running:
-      # Ignore master AND develop branch as we want it to build all workflows
-      when: "branch != 'master' AND branch != 'develop'"
+      # Ignore main AND develop branch as we want it to build all workflows
+      when: "branch != 'main' AND branch != 'develop'"
 
   global_job_config:
     env_vars:

data/ext/Rakefile

@@ -11,6 +11,8 @@ end
 
 task :default do
   begin
+    fail_install_on_purpose_in_test!
+
     library_type = "dynamic"
     report["language"]["implementation"] = "jruby"
     report["build"]["library_type"] = library_type

data/ext/agent.yml

@@ -1,70 +1,70 @@
 ---
-version: 710d341
+version: c8f8185
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: 47f53b67d5e28e23859ed7bbcc6cde7ba3c142bf0f7c32ffa0d89c628178d4cc
+      checksum: 8fad088047d8c73e5c0cf9213c20873ad591881d4f7059b178d8eeb89255f73e
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: 0b2b1533cf5c6f400fbe367fd6a3200c60ecfe6cd8b44a6707bc2a57ef78fe4d
+      checksum: 9a26f0dc170d38b068f66aaa016772f9e32e5fea99dc57bb9dfbc5f0a41dec89
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: 47f53b67d5e28e23859ed7bbcc6cde7ba3c142bf0f7c32ffa0d89c628178d4cc
+      checksum: 8fad088047d8c73e5c0cf9213c20873ad591881d4f7059b178d8eeb89255f73e
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: 0b2b1533cf5c6f400fbe367fd6a3200c60ecfe6cd8b44a6707bc2a57ef78fe4d
+      checksum: 9a26f0dc170d38b068f66aaa016772f9e32e5fea99dc57bb9dfbc5f0a41dec89
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: d815dd40495175a83d1bed0facfb97a472a74bdfe7aafbe6f72192e66b45a559
+      checksum: 0e8c4436684824a325fa1b581f6fad88598c529307b2b5ad0cc2620d22d2782f
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: 2e785cf04d500eaad577c3391d236c38d850fed9b541a0e79803ee9bf66852aa
+      checksum: d0fc35643b36b368a985961ea1c68c3204927f9fed412fde64d81b04081651ff
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: d815dd40495175a83d1bed0facfb97a472a74bdfe7aafbe6f72192e66b45a559
+      checksum: 0e8c4436684824a325fa1b581f6fad88598c529307b2b5ad0cc2620d22d2782f
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: 2e785cf04d500eaad577c3391d236c38d850fed9b541a0e79803ee9bf66852aa
+      checksum: d0fc35643b36b368a985961ea1c68c3204927f9fed412fde64d81b04081651ff
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   i686-linux-musl:
     static:
-      checksum: 4c66f26fb7925445ba0bb353cbf753f00572ffdae16a28220f6306bcb34a686b
+      checksum: 28b69e895da6b2a30402eed29cf8c3bbc4f647d6ce9cc5e0b11b4a771d7a1021
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86-linux-musl:
     static:
-      checksum: 4c66f26fb7925445ba0bb353cbf753f00572ffdae16a28220f6306bcb34a686b
+      checksum: 28b69e895da6b2a30402eed29cf8c3bbc4f647d6ce9cc5e0b11b4a771d7a1021
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86_64-linux:
     static:
-      checksum: d59929c9b2075eb93f0b66a8f9ea4d7d90a897b996a4ff054fd68610282ed616
+      checksum: fb457dc39e005bb8f241e1e260bb9ea0460cf922db5e30f514dda8afa0bd57bc
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: b1d22b323fdf9d8dbce17194ae42d3f7ddb252342db70428aea1c6baab5e6959
+      checksum: 55b26406ab0309905d5ad3aa34d1910fcc473f2a475ed5b3073d160a7ea68852
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 7b8cd90260f6bc31ed2aa61dac8889a79a8c5b35f453b2f9d47d1e74133d2c2f
+      checksum: cf469d6e3ee1dc6ccb9762a996355ecc407b9a906b9c0a0b6742363347ec9494
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: 8922f1e3a845ea869a1553aeb87681346c709dbab96636f703dfc3bc855621d8
+      checksum: '0938eab03f2b00583a9b730743c68d3d350090a0ff96866b960a9c78a486a992'
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: bb15ae46b7df4f2851982bcd8b079cd6b5ea384c19eaed9f20cdf152e435c4ea
+      checksum: 5c50e4776dbd0defe7d99015650e85d7983222ea27bd7b586b4c92f7b8336eee
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 0be60faf18df3eddedd5d85e34fdbcccb3ce6aae52ef6faeebe881c3e0fe2022
+      checksum: 02cd3b26317100290a2cfac014db026a2607723127955da1e4ddd5b76591003a
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: bb15ae46b7df4f2851982bcd8b079cd6b5ea384c19eaed9f20cdf152e435c4ea
+      checksum: 5c50e4776dbd0defe7d99015650e85d7983222ea27bd7b586b4c92f7b8336eee
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: 0be60faf18df3eddedd5d85e34fdbcccb3ce6aae52ef6faeebe881c3e0fe2022
+      checksum: 02cd3b26317100290a2cfac014db026a2607723127955da1e4ddd5b76591003a
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz

data/ext/base.rb

@@ -183,3 +183,10 @@ end
 def http_proxy
   Gem.configuration[:http_proxy] || ENV["http_proxy"] || ENV["HTTP_PROXY"]
 end
+
+# Fail the installation on purpose in a specific test environment.
+def fail_install_on_purpose_in_test!
+  return unless ENV["_TEST_APPSIGNAL_EXTENSION_FAILURE"]
+
+  raise "AppSignal internal test failure"
+end

data/ext/extconf.rb

@@ -7,6 +7,8 @@ def local_build?
 end
 
 def install
+  fail_install_on_purpose_in_test!
+
   library_type = "static"
   report["language"]["implementation"] = "ruby"
   report["build"]["library_type"] = library_type

data/lib/appsignal.rb

@@ -339,6 +339,7 @@ require "appsignal/auth_check"
 require "appsignal/config"
 require "appsignal/event_formatter"
 require "appsignal/hooks"
+require "appsignal/probes"
 require "appsignal/marker"
 require "appsignal/minutely"
 require "appsignal/garbage_collection_profiler"

data/lib/appsignal/auth_check.rb

@@ -25,8 +25,10 @@ module Appsignal
     def initialize(config, logger = nil)
       @config = config
       if logger # rubocop:disable Style/GuardClause
-        warn "Deprecated: `logger` argument will be removed in the next " \
-          "major version."
+        Appsignal::Utils::DeprecationMessage.message \
+          "`Appsignal::AuthCheck.new`'s `logger` argument will be removed " \
+          "in the next major version. Please configure the logger " \
+          "using `Appsignal.logger`."
       end
     end
 

data/lib/appsignal/cli/diagnose.rb

@@ -371,7 +371,7 @@ module Appsignal
         end
 
         def print_installation_result_report(report)
-          report = report.fetch("download", {})
+          report = report.fetch("result", {})
           puts "  Installation result"
           puts "    Status: #{report["status"]}"
           puts "    Message: #{report["message"]}" if report["message"]

data/lib/appsignal/config.rb

@@ -81,6 +81,50 @@ module Appsignal
       "APPSIGNAL_TRANSACTION_DEBUG_MODE"         => :transaction_debug_mode,
       "APP_REVISION"                             => :revision
     }.freeze
+    # @api private
+    ENV_STRING_KEYS = %w[
+      APPSIGNAL_APP_NAME
+      APPSIGNAL_CA_FILE_PATH
+      APPSIGNAL_DNS_SERVERS
+      APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH
+      APPSIGNAL_HOSTNAME
+      APPSIGNAL_HTTP_PROXY
+      APPSIGNAL_LOG
+      APPSIGNAL_LOG_PATH
+      APPSIGNAL_PUSH_API_ENDPOINT
+      APPSIGNAL_PUSH_API_KEY
+      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_FRONTEND_ERROR_CATCHING
+      APPSIGNAL_ENABLE_GC_INSTRUMENTATION
+      APPSIGNAL_ENABLE_HOST_METRICS
+      APPSIGNAL_ENABLE_MINUTELY_PROBES
+      APPSIGNAL_FILES_WORLD_ACCESSIBLE
+      APPSIGNAL_INSTRUMENT_NET_HTTP
+      APPSIGNAL_INSTRUMENT_REDIS
+      APPSIGNAL_INSTRUMENT_SEQUEL
+      APPSIGNAL_RUNNING_IN_CONTAINER
+      APPSIGNAL_SEND_ENVIRONMENT_METADATA
+      APPSIGNAL_SEND_PARAMS
+      APPSIGNAL_SKIP_SESSION_DATA
+      APPSIGNAL_TRANSACTION_DEBUG_MODE
+    ].freeze
+    # @api private
+    ENV_ARRAY_KEYS = %w[
+      APPSIGNAL_FILTER_PARAMETERS
+      APPSIGNAL_FILTER_SESSION_DATA
+      APPSIGNAL_IGNORE_ACTIONS
+      APPSIGNAL_IGNORE_ERRORS
+      APPSIGNAL_IGNORE_NAMESPACES
+      APPSIGNAL_REQUEST_HEADERS
+    ].freeze
 
     # Mapping of old and deprecated AppSignal configuration keys
     DEPRECATED_CONFIG_KEY_MAPPING = {
@@ -121,8 +165,41 @@ module Appsignal
       :initial_config, :file_config, :env_config
     attr_accessor :logger
 
-    def initialize(root_path, env, initial_config = {}, logger = Appsignal.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`
+    #   config file.
+    # @param initial_config [Hash<String, Object>] The initial configuration to
+    #   use. This will be overwritten by the file config and environment
+    #   variables config.
+    # @param logger [Logger] The logger to use for the AppSignal gem. This is
+    #   used by the configuration class only. Default: {Appsignal.logger}. See
+    #   also {Appsignal.start_logger}.
+    # @param config_file [String] Custom config file location. Default
+    #   `config/appsignal.yml`.
+    #
+    # @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(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]
@@ -288,7 +365,7 @@ module Appsignal
         " Skipping file config.\n" \
         "File: #{config_file.inspect}\n" \
         "#{e.class.name}: #{e}"
-      $stderr.puts "appsignal: #{message}"
+      Kernel.warn "appsignal: #{message}"
       logger.error "#{message}\n#{e.backtrace.join("\n")}"
       nil
     end
@@ -325,33 +402,21 @@ module Appsignal
       config = {}
 
       # 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 APPSIGNAL_LOG_PATH APPSIGNAL_WORKING_DIR_PATH
-         APPSIGNAL_HOSTNAME APPSIGNAL_CA_FILE_PATH APP_REVISION].each do |var|
+      ENV_STRING_KEYS.each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var
       end
 
       # Configuration with boolean type
-      %w[APPSIGNAL_ACTIVE APPSIGNAL_DEBUG APPSIGNAL_INSTRUMENT_NET_HTTP
-         APPSIGNAL_INSTRUMENT_REDIS APPSIGNAL_INSTRUMENT_SEQUEL
-         APPSIGNAL_SKIP_SESSION_DATA APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING
-         APPSIGNAL_ENABLE_ALLOCATION_TRACKING APPSIGNAL_ENABLE_GC_INSTRUMENTATION
-         APPSIGNAL_RUNNING_IN_CONTAINER APPSIGNAL_ENABLE_HOST_METRICS
-         APPSIGNAL_SEND_ENVIRONMENT_METADATA APPSIGNAL_SEND_PARAMS
-         APPSIGNAL_ENABLE_MINUTELY_PROBES APPSIGNAL_FILES_WORLD_ACCESSIBLE
-         APPSIGNAL_TRANSACTION_DEBUG_MODE].each do |var|
+      ENV_BOOLEAN_KEYS.each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var.casecmp("true").zero?
       end
 
       # Configuration with array of strings type
-      %w[APPSIGNAL_IGNORE_ACTIONS APPSIGNAL_IGNORE_ERRORS
-         APPSIGNAL_IGNORE_NAMESPACES APPSIGNAL_FILTER_PARAMETERS
-         APPSIGNAL_FILTER_SESSION_DATA APPSIGNAL_REQUEST_HEADERS].each do |var|
+      ENV_ARRAY_KEYS.each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var.split(",")

data/lib/appsignal/extension.rb

@@ -10,11 +10,12 @@ begin
     require "appsignal_extension"
     Appsignal.extension_loaded = true
   end
-rescue LoadError => err
-  Appsignal.logger.error(
-    "Failed to load extension (#{err}), please run `appsignal diagnose` " \
-      "and email us at support@appsignal.com"
-  )
+rescue LoadError => error
+  error_message = "ERROR: AppSignal failed to load extension. " \
+    "Please run `appsignal diagnose` and email us at support@appsignal.com\n" \
+    "#{error.class}: #{error.message}"
+  Appsignal.logger.error(error_message)
+  Kernel.warn error_message
   Appsignal.extension_loaded = false
 end
 

data/lib/appsignal/extension/jruby.rb

@@ -179,11 +179,12 @@ module Appsignal
           :appsignal_string
 
         Appsignal.extension_loaded = true
-      rescue LoadError => err
-        Appsignal.logger.error(
-          "Failed to load extension (#{err}), please email us at " \
-          "support@appsignal.com"
-        )
+      rescue LoadError => error
+        error_message = "ERROR: AppSignal failed to load extension. " \
+          "Please run `appsignal diagnose` and email us at support@appsignal.com\n" \
+          "#{error.class}: #{error.message}"
+        Appsignal.logger.error(error_message)
+        Kernel.warn error_message
         Appsignal.extension_loaded = false
       end
 

data/lib/appsignal/hooks.rb

@@ -69,6 +69,29 @@ module Appsignal
         text.size > 200 ? "#{text[0...197]}..." : text
       end
     end
+
+    # Alias Probes constants that have moved to their own module in version
+    # 2.11.0.
+    def self.const_missing(name)
+      case name
+      when :SidekiqProbe
+        callers = caller
+        Appsignal::Utils::DeprecationMessage.message \
+          "The constant Appsignal::Hooks::SidekiqProbe has been deprecated. " \
+          "Please update the constant name to Appsignal::Probes::SidekiqProbe " \
+          "in the following file to remove this message.\n#{callers.first}"
+        Appsignal::Probes::SidekiqProbe
+      when :PumaProbe
+        callers = caller
+        Appsignal::Utils::DeprecationMessage.message \
+          "The constant Appsignal::Hooks::PumaProbe has been deprecated. " \
+          "Please update the constant name to Appsignal::Probes::PumaProbe " \
+          "in the following file to remove this message.\n#{callers.first}"
+        Appsignal::Probes::PumaProbe
+      else
+        super
+      end
+    end
   end
 end