appsignal 2.11.0.beta.1 → 2.11.0

data/lib/appsignal/hooks/active_job.rb

@@ -15,10 +15,9 @@ module Appsignal
           .extend ::Appsignal::Hooks::ActiveJobHook::ActiveJobClassInstrumentation
       end
 
-      # @todo Add queue time support for Rails 6's enqueued_at. For both
-      #   existing and new transactions.
       module ActiveJobClassInstrumentation
         def execute(job)
+          job_status = nil
           current_transaction = Appsignal::Transaction.current
           transaction =
             if current_transaction.nil_transaction?
@@ -38,6 +37,7 @@ module Appsignal
 
           super
         rescue Exception => exception # rubocop:disable Lint/RescueException
+          job_status = :failed
           transaction.set_error(exception)
           raise exception
         ensure
@@ -48,10 +48,13 @@ module Appsignal
                 Appsignal.config[:filter_parameters]
               )
 
-            tags = { :queue => job["queue_name"] }
+            transaction_tags = ActiveJobHelpers.transaction_tags_for(job)
+            transaction_tags["active_job_id"] = job["job_id"]
             provider_job_id = job["provider_job_id"]
-            tags[:provider_job_id] = provider_job_id if provider_job_id
-            transaction.set_tags(tags)
+            if provider_job_id
+              transaction_tags[:provider_job_id] = provider_job_id
+            end
+            transaction.set_tags(transaction_tags)
 
             transaction.set_action_if_nil(ActiveJobHelpers.action_name(job))
             enqueued_at = job["enqueued_at"]
@@ -65,6 +68,16 @@ module Appsignal
               Appsignal::Transaction.complete_current!
             end
           end
+
+          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
         end
       end
 
@@ -83,6 +96,41 @@ module Appsignal
             "#{job["job_class"]}#perform"
           end
         end
+
+        # 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
+          priority = job["priority"]
+          tags[:priority] = priority if priority
+          tags
+        end
+
+        def self.increment_counter(key, value, tags = {})
+          Appsignal.increment_counter "active_job_#{key}", value, tags
+        end
       end
     end
   end

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|
@@ -35,7 +34,7 @@ module Appsignal
       def call(_worker, item, _queue)
         job_status = nil
         transaction = Appsignal::Transaction.create(
-          SecureRandom.uuid,
+          item["jid"],
           Appsignal::Transaction::BACKGROUND_JOB,
           Appsignal::Transaction::GenericRequest.new(
             :queue_start => item["enqueued_at"]

data/lib/appsignal/integrations/delayed_job_plugin.rb

@@ -64,7 +64,7 @@ module Appsignal
         dot_split = default_name.split(".")
         return default_name if dot_split.length == 2
 
-        ["unknown"]
+        "#{default_name}#perform"
       end
 
       def self.extract_value(object_or_hash, field, default_value = nil, convert_to_s = false)

data/lib/appsignal/probes.rb

@@ -0,0 +1,7 @@
+module Appsignal
+  module Probes
+  end
+end
+
+require "appsignal/probes/puma"
+require "appsignal/probes/sidekiq"

data/lib/appsignal/probes/puma.rb

@@ -1,11 +1,11 @@
 module Appsignal
   module Probes
-    # @api private
     class PumaProbe
       def initialize
         @hostname = Appsignal.config[:hostname] || Socket.gethostname
       end
 
+      # @api private
       def call
         puma_stats = fetch_puma_stats
         return unless puma_stats

data/lib/appsignal/probes/sidekiq.rb

@@ -1,9 +1,10 @@
 module Appsignal
   module Probes
-    # @api private
     class SidekiqProbe
+      # @api private
       attr_reader :config
 
+      # @api private
       def self.dependencies_present?
         Gem::Version.new(::Redis::VERSION) >= Gem::Version.new("3.3.5")
       end
@@ -16,6 +17,7 @@ module Appsignal
         require "sidekiq/api"
       end
 
+      # @api private
       def call
         track_redis_info
         track_stats

data/lib/appsignal/utils/deprecation_message.rb

@@ -2,7 +2,7 @@ module Appsignal
   module Utils
     module DeprecationMessage
       def self.message(message, logger = Appsignal.logger)
-        $stderr.puts "appsignal WARNING: #{message}"
+        Kernel.warn "appsignal WARNING: #{message}"
         logger.warn message
       end
 

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "2.11.0.beta.1".freeze
+  VERSION = "2.11.0".freeze
 end

data/spec/lib/appsignal/auth_check_spec.rb

@@ -28,6 +28,29 @@ describe Appsignal::AuthCheck do
     end.join("&")
   end
 
+  describe ".new" do
+    describe "with logger argument" do
+      let(:err_stream) { std_stream }
+      let(:stderr) { err_stream.read }
+      let(:log_stream) { std_stream }
+      let(:log) { log_contents(log_stream) }
+
+      it "logs and prints a deprecation message" do
+        Appsignal.logger = test_logger(log_stream)
+
+        capture_std_streams(std_stream, err_stream) do
+          Appsignal::AuthCheck.new(config, Appsignal.logger)
+        end
+
+        deprecation_message =
+          "`Appsignal::AuthCheck.new`'s `logger` argument " \
+          "will be removed in the next major version."
+        expect(stderr).to include "appsignal WARNING: #{deprecation_message}"
+        expect(log).to contains_log :warn, deprecation_message
+      end
+    end
+  end
+
   describe "#perform" do
     subject { auth_check.perform }
 

data/spec/lib/appsignal/capistrano2_spec.rb

@@ -10,7 +10,7 @@ if DependencyHelper.capistrano2_present?
     let(:capistrano_config) do
       Capistrano::Configuration.new.tap do |c|
         c.set(:rails_env, "production")
-        c.set(:repository, "master")
+        c.set(:repository, "main")
         c.set(:deploy_to, "/home/username/app")
         c.set(:current_release, "")
         c.set(:current_revision, "503ce0923ed177a3ce000005")

data/spec/lib/appsignal/capistrano3_spec.rb

@@ -15,7 +15,7 @@ if DependencyHelper.capistrano3_present?
         c.set(:log_level, :error)
         c.set(:logger, logger)
         c.set(:rails_env, "production")
-        c.set(:repository, "master")
+        c.set(:repository, "main")
         c.set(:deploy_to, "/home/username/app")
         c.set(:current_release, "")
         c.set(:current_revision, "503ce0923ed177a3ce000005")

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

@@ -290,6 +290,8 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         jruby = Appsignal::System.jruby?
         expect(output).to include(
           "Extension installation report",
+          "Installation result",
+          "  Status: success",
           "Language details",
           "  Implementation: #{jruby ? "jruby" : "ruby"}",
           "  Ruby version: #{"#{rbconfig["ruby_version"]}-p#{rbconfig["PATCHLEVEL"]}"}",
@@ -310,6 +312,46 @@ describe Appsignal::CLI::Diagnose, :api_stub => true, :send_report => :yes_cli_i
         )
       end
 
+      context "with error in install report" do
+        let(:error) { RuntimeError.new("some error") }
+        before do
+          allow(File).to receive(:read).and_call_original
+          expect(File).to receive(:read)
+            .with(File.expand_path("../../../../../ext/install.report", __FILE__))
+            .and_return(
+              YAML.dump(
+                "result" => {
+                  "status" => "error",
+                  "error" => "RuntimeError: some error",
+                  "backtrace" => error.backtrace
+                }
+              )
+            )
+        end
+
+        it "sends an error" do
+          run
+          expect(received_report["installation"]).to match(
+            "result" => {
+              "status" => "error",
+              "error" => "RuntimeError: some error",
+              "backtrace" => error.backtrace
+            }
+          )
+        end
+
+        it "prints the error" do
+          run
+
+          expect(output).to include(
+            "Extension installation report",
+            "Installation result",
+            "Status: error\n    Error: RuntimeError: some error"
+          )
+          expect(output).to_not include("Raw report:")
+        end
+      end
+
       context "without install report" do
         let(:error) { RuntimeError.new("foo") }
         before do

data/spec/lib/appsignal/config_spec.rb

@@ -1,4 +1,18 @@
 describe Appsignal::Config do
+  describe "config keys" do
+    it "all config keys have an environment variable version registered" do
+      config = Appsignal::Config
+      mapped_env_keys = config::ENV_TO_KEY_MAPPING.keys.sort
+      configured_env_keys = (
+        config::ENV_STRING_KEYS +
+        config::ENV_BOOLEAN_KEYS +
+        config::ENV_ARRAY_KEYS
+      ).sort
+
+      expect(mapped_env_keys).to eql(configured_env_keys)
+    end
+  end
+
   describe "#initialize" do
     describe "environment" do
       context "when environment is nil" do
@@ -244,6 +258,27 @@ describe Appsignal::Config do
       end
     end
 
+    context "with an overriden config file" do
+      let(:config) do
+        project_fixture_config("production", {}, Appsignal.logger, File.join(project_fixture_path, "config", "appsignal.yml"))
+      end
+
+      it "is valid and active" do
+        expect(config.valid?).to be_truthy
+        expect(config.active?).to be_truthy
+      end
+
+      context "with an invalid overriden config file" do
+        let(:config) do
+          project_fixture_config("production", {}, Appsignal.logger, File.join(project_fixture_path, "config", "missing.yml"))
+        end
+
+        it "is not valid" do
+          expect(config.valid?).to be_falsy
+        end
+      end
+    end
+
     context "with the config file causing an error" do
       let(:config_path) do
         File.expand_path(
@@ -397,6 +432,7 @@ describe Appsignal::Config do
         :debug => true
       )
     end
+    let(:working_directory_path) { File.join(tmp_dir, "test_working_directory_path") }
     let(:env_config) do
       {
         :running_in_container => true,
@@ -413,7 +449,8 @@ describe Appsignal::Config do
         :files_world_accessible => false,
         :request_headers => %w[accept accept-charset],
         :revision => "v2.5.1",
-        :send_environment_metadata => false
+        :send_environment_metadata => false,
+        :working_directory_path => working_directory_path
       }
     end
     before do
@@ -431,6 +468,7 @@ describe Appsignal::Config do
       ENV["APPSIGNAL_FILES_WORLD_ACCESSIBLE"]  = "false"
       ENV["APPSIGNAL_REQUEST_HEADERS"]         = "accept,accept-charset"
       ENV["APPSIGNAL_SEND_ENVIRONMENT_METADATA"] = "false"
+      ENV["APPSIGNAL_WORKING_DIRECTORY_PATH"] = working_directory_path
       ENV["APP_REVISION"] = "v2.5.1"
     end
 

data/spec/lib/appsignal/extension/jruby_spec.rb

@@ -1,42 +1,45 @@
-if Appsignal::System.jruby?
-  describe Appsignal::Extension::Jruby do
-    let(:extension) { Appsignal::Extension }
+describe "JRuby extension", :jruby do
+  let(:extension) { Appsignal::Extension }
+  let(:jruby_module) { Appsignal::Extension::Jruby }
 
-    describe "string conversions" do
-      it "keeps the same value during string type conversions" do
-        # UTF-8 string with NULL
-        # Tests if the conversions between the conversions without breaking on
-        # NULL terminated strings in C.
-        string = "Merry Christmas! \u0000 🎄"
+  it "creates a JRuby extension module" do
+    expect(Appsignal::Extension::Jruby).to be_kind_of(Module)
+  end
 
-        appsignal_string = extension.make_appsignal_string(string)
-        ruby_string = extension.make_ruby_string(appsignal_string)
+  describe "string conversions" do
+    it "keeps the same value during string type conversions" do
+      # UTF-8 string with NULL
+      # Tests if the conversions between the conversions without breaking on
+      # NULL terminated strings in C.
+      string = "Merry Christmas! \u0000 🎄"
 
-        expect(ruby_string).to eq("Merry Christmas! \u0000 🎄")
-      end
-    end
+      appsignal_string = extension.make_appsignal_string(string)
+      ruby_string = extension.make_ruby_string(appsignal_string)
 
-    it "loads libappsignal with FFI" do
-      expect(described_class.ffi_libraries.map(&:name).first).to include "libappsignal"
+      expect(ruby_string).to eq("Merry Christmas! \u0000 🎄")
     end
+  end
 
-    describe ".lib_extension" do
-      subject { described_class.lib_extension }
+  it "loads libappsignal with FFI" do
+    expect(jruby_module.ffi_libraries.map(&:name).first).to include "libappsignal"
+  end
+
+  describe ".lib_extension" do
+    subject { jruby_module.lib_extension }
 
-      context "when on a darwin system" do
-        before { expect(Appsignal::System).to receive(:agent_platform).and_return("darwin") }
+    context "when on a darwin system" do
+      before { expect(Appsignal::System).to receive(:agent_platform).and_return("darwin") }
 
-        it "returns the extension for darwin" do
-          is_expected.to eq "dylib"
-        end
+      it "returns the extension for darwin" do
+        is_expected.to eq "dylib"
       end
+    end
 
-      context "when on a linux system" do
-        before { expect(Appsignal::System).to receive(:agent_platform).and_return("linux") }
+    context "when on a linux system" do
+      before { expect(Appsignal::System).to receive(:agent_platform).and_return("linux") }
 
-        it "returns the lib extension for linux" do
-          is_expected.to eq "so"
-        end
+      it "returns the lib extension for linux" do
+        is_expected.to eq "so"
       end
     end
   end

data/spec/lib/appsignal/extension_install_failure_spec.rb

@@ -0,0 +1,23 @@
+describe Appsignal::Extension, :extension_installation_failure do
+  context "when the extension library cannot be loaded" do
+    # This test breaks the installation on purpose and is not run by default.
+    # See `rake test:failure`. If this test was run, run `rake
+    # extension:install` again to fix the extension installation.
+    it "prints and logs an error" do
+      # ENV var to make sure installation fails on purpurse
+      ENV["_TEST_APPSIGNAL_EXTENSION_FAILURE"] = "true"
+      `rake extension:install` # Run installation
+
+      require "open3"
+      _stdout, stderr, _status = Open3.capture3("bin/appsignal --version")
+      expect(stderr).to include("ERROR: AppSignal failed to load extension")
+      error_message =
+        if DependencyHelper.running_jruby?
+          "cannot open shared object file"
+        else
+          "LoadError: cannot load such file"
+        end
+      expect(stderr).to include(error_message)
+    end
+  end
+end