appsignal 2.11.0.beta.4 → 2.11.0.beta.5

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: a5b5db2
+version: c8f8185
 mirrors:
 - https://appsignal-agent-releases.global.ssl.fastly.net
 - https://d135dj0rjqvssy.cloudfront.net
 triples:
   x86_64-darwin:
     static:
-      checksum: 60236d6cfe998d5d9e8a8d1c493b0be956c35b449dd16c47c1b9d4dada73c57e
+      checksum: 8fad088047d8c73e5c0cf9213c20873ad591881d4f7059b178d8eeb89255f73e
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: e69a6fab6b854345bcecba2eb06de38f00d8a9fc67bb04502feab13e987699b4
+      checksum: 9a26f0dc170d38b068f66aaa016772f9e32e5fea99dc57bb9dfbc5f0a41dec89
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   universal-darwin:
     static:
-      checksum: 60236d6cfe998d5d9e8a8d1c493b0be956c35b449dd16c47c1b9d4dada73c57e
+      checksum: 8fad088047d8c73e5c0cf9213c20873ad591881d4f7059b178d8eeb89255f73e
       filename: appsignal-x86_64-darwin-all-static.tar.gz
     dynamic:
-      checksum: e69a6fab6b854345bcecba2eb06de38f00d8a9fc67bb04502feab13e987699b4
+      checksum: 9a26f0dc170d38b068f66aaa016772f9e32e5fea99dc57bb9dfbc5f0a41dec89
       filename: appsignal-x86_64-darwin-all-dynamic.tar.gz
   i686-linux:
     static:
-      checksum: 31d4400ec70ab05a1cf960b7e3bd46c3e8b3e0d4e2cf3be9bd20ed97ff5291e6
+      checksum: 0e8c4436684824a325fa1b581f6fad88598c529307b2b5ad0cc2620d22d2782f
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: a2625de08adbf2804230774bb9d7ad7b4c568a5525a5300d41a450334c4b5528
+      checksum: d0fc35643b36b368a985961ea1c68c3204927f9fed412fde64d81b04081651ff
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   x86-linux:
     static:
-      checksum: 31d4400ec70ab05a1cf960b7e3bd46c3e8b3e0d4e2cf3be9bd20ed97ff5291e6
+      checksum: 0e8c4436684824a325fa1b581f6fad88598c529307b2b5ad0cc2620d22d2782f
       filename: appsignal-i686-linux-all-static.tar.gz
     dynamic:
-      checksum: a2625de08adbf2804230774bb9d7ad7b4c568a5525a5300d41a450334c4b5528
+      checksum: d0fc35643b36b368a985961ea1c68c3204927f9fed412fde64d81b04081651ff
       filename: appsignal-i686-linux-all-dynamic.tar.gz
   i686-linux-musl:
     static:
-      checksum: 18a5648c469718676e0c4b2925fbdd04a6d9b916ff778571a48d4ff0ffa944b6
+      checksum: 28b69e895da6b2a30402eed29cf8c3bbc4f647d6ce9cc5e0b11b4a771d7a1021
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86-linux-musl:
     static:
-      checksum: 18a5648c469718676e0c4b2925fbdd04a6d9b916ff778571a48d4ff0ffa944b6
+      checksum: 28b69e895da6b2a30402eed29cf8c3bbc4f647d6ce9cc5e0b11b4a771d7a1021
       filename: appsignal-i686-linux-musl-all-static.tar.gz
   x86_64-linux:
     static:
-      checksum: df100f661e19266fe92a19ae44407f413e14f1bb975261542e3b738c5215889a
+      checksum: fb457dc39e005bb8f241e1e260bb9ea0460cf922db5e30f514dda8afa0bd57bc
       filename: appsignal-x86_64-linux-all-static.tar.gz
     dynamic:
-      checksum: 4d988176e9419fe553cbab10ebc4eab617fdd3806682cbb35ab01d1f02bcd297
+      checksum: 55b26406ab0309905d5ad3aa34d1910fcc473f2a475ed5b3073d160a7ea68852
       filename: appsignal-x86_64-linux-all-dynamic.tar.gz
   x86_64-linux-musl:
     static:
-      checksum: 265d42b764789b105cc5a8b5117ec1dbc07265f870e936661a8b6211c04de05a
+      checksum: cf469d6e3ee1dc6ccb9762a996355ecc407b9a906b9c0a0b6742363347ec9494
       filename: appsignal-x86_64-linux-musl-all-static.tar.gz
     dynamic:
-      checksum: 0b96c3f03b6c2943b2b51bfcdd56aa90e0869a5890dedf7ce30df9a8fe4f6d9a
+      checksum: '0938eab03f2b00583a9b730743c68d3d350090a0ff96866b960a9c78a486a992'
       filename: appsignal-x86_64-linux-musl-all-dynamic.tar.gz
   x86_64-freebsd:
     static:
-      checksum: 0ffbe3fa91e5b1687693fa9af8e9c6bdccb98ffd6122d8ccd86bb81fbea91e3f
+      checksum: 5c50e4776dbd0defe7d99015650e85d7983222ea27bd7b586b4c92f7b8336eee
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: d0f02acf08c3ab4601b2a1e26c899bc14274b742d6af1b5701646781c6c0e50c
+      checksum: 02cd3b26317100290a2cfac014db026a2607723127955da1e4ddd5b76591003a
       filename: appsignal-x86_64-freebsd-all-dynamic.tar.gz
   amd64-freebsd:
     static:
-      checksum: 0ffbe3fa91e5b1687693fa9af8e9c6bdccb98ffd6122d8ccd86bb81fbea91e3f
+      checksum: 5c50e4776dbd0defe7d99015650e85d7983222ea27bd7b586b4c92f7b8336eee
       filename: appsignal-x86_64-freebsd-all-static.tar.gz
     dynamic:
-      checksum: d0f02acf08c3ab4601b2a1e26c899bc14274b742d6af1b5701646781c6c0e50c
+      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

@@ -121,8 +121,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 +321,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

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
 

data/lib/appsignal/hooks/active_job.rb

@@ -41,8 +41,6 @@ module Appsignal
           transaction.set_error(exception)
           raise exception
         ensure
-          tags = ActiveJobHelpers.tags_for_job(job)
-
           if transaction
             transaction.params =
               Appsignal::Utils::HashSanitizer.sanitize(
@@ -50,7 +48,7 @@ module Appsignal
                 Appsignal.config[:filter_parameters]
               )
 
-            transaction_tags = tags.dup
+            transaction_tags = ActiveJobHelpers.transaction_tags_for(job)
             transaction_tags["active_job_id"] = job["job_id"]
             provider_job_id = job["provider_job_id"]
             if provider_job_id
@@ -71,12 +69,15 @@ module Appsignal
             end
           end
 
-          if job_status
-            ActiveJobHelpers.increment_counter "queue_job_count", 1,
-              tags.merge(:status => job_status)
+          metrics = ActiveJobHelpers.metrics_for(job)
+          metrics.each do |(metric_name, tags)|
+            if job_status
+              ActiveJobHelpers.increment_counter metric_name, 1,
+                tags.merge(:status => job_status)
+            end
+            ActiveJobHelpers.increment_counter metric_name, 1,
+              tags.merge(:status => :processed)
           end
-          ActiveJobHelpers.increment_counter "queue_job_count", 1,
-            tags.merge(:status => :processed)
         end
       end
 
@@ -96,7 +97,29 @@ module Appsignal
           end
         end
 
-        def self.tags_for_job(job)
+        # Returns an array of metrics with tags used to report the job metrics
+        #
+        # If job ONLY has a queue, it will return `queue_job_count` with tags.
+        # If job has a queue AND priority, it will ALSO return
+        # `queue_priority_job_count` with tags.
+        #
+        # @return [Array] Array of metrics with tags to report.
+        def self.metrics_for(job)
+          tags = { :queue => job["queue_name"] }
+          metrics = [["queue_job_count", tags]]
+
+          priority = job["priority"]
+          if priority
+            metrics << [
+              "queue_priority_job_count",
+              tags.merge(:priority => priority)
+            ]
+          end
+
+          metrics
+        end
+
+        def self.transaction_tags_for(job)
           tags = {}
           queue = job["queue_name"]
           tags[:queue] = queue if queue

data/lib/appsignal/hooks/puma.rb

@@ -24,7 +24,6 @@ module Appsignal
           # runs in the Puma main process.
           # For more information:
           # https://docs.appsignal.com/ruby/integrations/puma.html
-          require "appsignal/probes/puma"
           Appsignal::Minutely.probes.register :puma, ::Appsignal::Probes::PumaProbe
         end
 

data/lib/appsignal/hooks/sidekiq.rb

@@ -12,7 +12,6 @@ module Appsignal
       end
 
       def install
-        require "appsignal/probes/sidekiq"
         Appsignal::Minutely.probes.register :sidekiq, Appsignal::Probes::SidekiqProbe
 
         ::Sidekiq.configure_server do |config|