appsignal 2.11.0.beta.3-java → 2.11.1-java

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
@@ -219,12 +219,18 @@ BUNDLE_GEMFILE=gemfiles/capistrano3.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/grape.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/no_dependencies.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/padrino.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/que.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/que_beta.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/rails-3.2.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/rails-4.0.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/rails-4.1.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/rails-4.2.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/rails-5.0.gemfile bundle exec rspec
-BUNDLE_GEMFILE=gemfiles/resque.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/rails-5.1.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/rails-5.2.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/rails-6.0.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/resque-1.gemfile bundle exec rspec
+BUNDLE_GEMFILE=gemfiles/resque-2.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/sequel-435.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/sequel.gemfile bundle exec rspec
 BUNDLE_GEMFILE=gemfiles/sinatra.gemfile bundle exec rspec
@@ -242,12 +248,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

@@ -39,6 +39,10 @@ def build_task(ruby_version, type = nil)
   }
 end
 
+def gems_with_gemfiles
+  YAML.load_file("build_matrix.yml")["matrix"]["gems"].map { |g| g["gem"] }.freeze
+end
+
 namespace :build_matrix do
   namespace :semaphore do
     task :generate do
@@ -70,7 +74,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
@@ -307,17 +314,19 @@ task :publish => [
 desc "Install the AppSignal gem, extension and all possible dependencies."
 task :install => "extension:install" do
   Bundler.with_clean_env do
-    GEMFILES.each do |gemfile|
+    gems_with_gemfiles.each do |gemfile|
       system "bundle --gemfile gemfiles/#{gemfile}.gemfile"
     end
   end
 end
 
 task :spec_all_gemfiles do
-  GEMFILES.each do |gemfile|
-    puts "Running tests for #{gemfile}"
-    unless system("env BUNDLE_GEMFILE=gemfiles/#{gemfile}.gemfile bundle exec rspec")
-      raise "Not successful"
+  Bundler.with_clean_env do
+    gems_with_gemfiles.each do |gemfile|
+      puts "Running tests for #{gemfile}"
+      unless system("env BUNDLE_GEMFILE=gemfiles/#{gemfile}.gemfile bundle exec rspec")
+        raise "Not successful"
+      end
     end
   end
 end
@@ -364,11 +373,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,62 @@
 ---
-version: a5b5db2
+version: 361340a
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: 60236d6cfe998d5d9e8a8d1c493b0be956c35b449dd16c47c1b9d4dada73c57e
+      checksum: 4e08cb0cef0ea7e30f8d507380b923f6cfa14adaea12c81804e118acd6395b57
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: e69a6fab6b854345bcecba2eb06de38f00d8a9fc67bb04502feab13e987699b4
+      checksum: 1a9c3e26bd453fe60a2f511d536e64bdeddb1f939664bda90d6a41eaeedf5250
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: 60236d6cfe998d5d9e8a8d1c493b0be956c35b449dd16c47c1b9d4dada73c57e
+      checksum: 4e08cb0cef0ea7e30f8d507380b923f6cfa14adaea12c81804e118acd6395b57
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: e69a6fab6b854345bcecba2eb06de38f00d8a9fc67bb04502feab13e987699b4
+      checksum: 1a9c3e26bd453fe60a2f511d536e64bdeddb1f939664bda90d6a41eaeedf5250
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: 31d4400ec70ab05a1cf960b7e3bd46c3e8b3e0d4e2cf3be9bd20ed97ff5291e6
+      checksum: 01c027b3e472cb39d844284fcc8ba532628c00731b912e0e9718646ed124ae6e
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: a2625de08adbf2804230774bb9d7ad7b4c568a5525a5300d41a450334c4b5528
+      checksum: 30696eac3ae5646bcb21ff86a1824dd4511a41dd323514e4a97a41b5ff09e2f8
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: 31d4400ec70ab05a1cf960b7e3bd46c3e8b3e0d4e2cf3be9bd20ed97ff5291e6
+      checksum: 01c027b3e472cb39d844284fcc8ba532628c00731b912e0e9718646ed124ae6e
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: a2625de08adbf2804230774bb9d7ad7b4c568a5525a5300d41a450334c4b5528
+      checksum: 30696eac3ae5646bcb21ff86a1824dd4511a41dd323514e4a97a41b5ff09e2f8
       filename: appsignal-i686-linux-all-dynamic.tar.gz
-  i686-linux-musl:
-    static:
-      checksum: 18a5648c469718676e0c4b2925fbdd04a6d9b916ff778571a48d4ff0ffa944b6
-      filename: appsignal-i686-linux-musl-all-static.tar.gz
-  x86-linux-musl:
-    static:
-      checksum: 18a5648c469718676e0c4b2925fbdd04a6d9b916ff778571a48d4ff0ffa944b6
-      filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86_64-linux:
     static:
-      checksum: df100f661e19266fe92a19ae44407f413e14f1bb975261542e3b738c5215889a
+      checksum: fe2038d6fa468fc23900fea6d8179d2b37d41d54f4ff33c573116183ac1cb491
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: 4d988176e9419fe553cbab10ebc4eab617fdd3806682cbb35ab01d1f02bcd297
+      checksum: bcbf9546b078fb8bbaae5e7df4ed84831346c814bc865a47d32a3a095a84acbb
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 265d42b764789b105cc5a8b5117ec1dbc07265f870e936661a8b6211c04de05a
+      checksum: b2ee5579a62b76a1d2f41f4e06749c4c549f9aaa40764862eff49c5a6a8841f1
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: 0b96c3f03b6c2943b2b51bfcdd56aa90e0869a5890dedf7ce30df9a8fe4f6d9a
+      checksum: 53cd2464853e61c2d8f911ec32ff98cb48f824293ffd575da6743bc34625a7eb
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: 0ffbe3fa91e5b1687693fa9af8e9c6bdccb98ffd6122d8ccd86bb81fbea91e3f
+      checksum: f228dd2f2cf951c9eb9f04487be50fdfdc3d29a956e639787a4022bd73f02e53
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: d0f02acf08c3ab4601b2a1e26c899bc14274b742d6af1b5701646781c6c0e50c
+      checksum: 030b322b2cb15607260cbb0424c03f6e41646dca7aacc43a30279ad63a336541
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: 0ffbe3fa91e5b1687693fa9af8e9c6bdccb98ffd6122d8ccd86bb81fbea91e3f
+      checksum: f228dd2f2cf951c9eb9f04487be50fdfdc3d29a956e639787a4022bd73f02e53
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: d0f02acf08c3ab4601b2a1e26c899bc14274b742d6af1b5701646781c6c0e50c
+      checksum: 030b322b2cb15607260cbb0424c03f6e41646dca7aacc43a30279ad63a336541
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz

data/ext/appsignal_extension.c

@@ -485,7 +485,7 @@ static VALUE data_append_boolean(VALUE self, VALUE value) {
   return Qnil;
 }
 
-static VALUE data_append_nil(VALUE self, VALUE value) {
+static VALUE data_append_nil(VALUE self) {
   appsignal_data_t* data;
 
   Data_Get_Struct(self, appsignal_data_t, data);

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