appsignal 2.11.0.beta.2 → 2.11.1.beta.2

data/spec/lib/appsignal/hooks/active_support_notifications_spec.rb

@@ -1,3 +1,5 @@
+require_relative "./active_support_notifications/instrument_shared_examples"
+
 describe Appsignal::Hooks::ActiveSupportNotificationsHook do
   if active_support_present?
     let(:notifier) { ActiveSupport::Notifications::Fanout.new }
@@ -18,148 +20,18 @@ describe Appsignal::Hooks::ActiveSupportNotificationsHook do
       it { is_expected.to be_truthy }
     end
 
-    it "instruments an ActiveSupport::Notifications.instrument event" do
-      return_value = as.instrument("sql.active_record", :sql => "SQL") do
-        "value"
-      end
-
-      expect(return_value).to eq "value"
-      expect(transaction.to_h["events"]).to match([
-        {
-          "allocation_count" => kind_of(Integer),
-          "body" => "SQL",
-          "body_format" => Appsignal::EventFormatter::SQL_BODY_FORMAT,
-          "child_allocation_count" => kind_of(Integer),
-          "child_duration" => kind_of(Float),
-          "child_gc_duration" => kind_of(Float),
-          "count" => 1,
-          "duration" => kind_of(Float),
-          "gc_duration" => kind_of(Float),
-          "name" => "sql.active_record",
-          "start" => kind_of(Float),
-          "title" => ""
-        }
-      ])
-    end
-
-    it "instruments an ActiveSupport::Notifications.instrument event with no registered formatter" do
-      return_value = as.instrument("no-registered.formatter", :key => "something") do
-        "value"
-      end
-
-      expect(return_value).to eq "value"
-      expect(transaction.to_h["events"]).to match([
-        {
-          "allocation_count" => kind_of(Integer),
-          "body" => "",
-          "body_format" => Appsignal::EventFormatter::DEFAULT,
-          "child_allocation_count" => kind_of(Integer),
-          "child_duration" => kind_of(Float),
-          "child_gc_duration" => kind_of(Float),
-          "count" => 1,
-          "duration" => kind_of(Float),
-          "gc_duration" => kind_of(Float),
-          "name" => "no-registered.formatter",
-          "start" => kind_of(Float),
-          "title" => ""
-        }
-      ])
-    end
-
-    it "converts non-string names to strings" do
-      as.instrument(:not_a_string) {}
-      expect(transaction.to_h["events"]).to match([
-        {
-          "allocation_count" => kind_of(Integer),
-          "body" => "",
-          "body_format" => Appsignal::EventFormatter::DEFAULT,
-          "child_allocation_count" => kind_of(Integer),
-          "child_duration" => kind_of(Float),
-          "child_gc_duration" => kind_of(Float),
-          "count" => 1,
-          "duration" => kind_of(Float),
-          "gc_duration" => kind_of(Float),
-          "name" => "not_a_string",
-          "start" => kind_of(Float),
-          "title" => ""
-        }
-      ])
-    end
-
-    it "does not instrument events whose name starts with a bang" do
-      expect(Appsignal::Transaction.current).not_to receive(:start_event)
-      expect(Appsignal::Transaction.current).not_to receive(:finish_event)
-
-      return_value = as.instrument("!sql.active_record", :sql => "SQL") do
-        "value"
-      end
-
-      expect(return_value).to eq "value"
-    end
-
-    context "when an error is raised in an instrumented block" do
-      it "instruments an ActiveSupport::Notifications.instrument event" do
-        expect do
-          as.instrument("sql.active_record", :sql => "SQL") do
-            raise ExampleException, "foo"
-          end
-        end.to raise_error(ExampleException, "foo")
-
-        expect(transaction.to_h["events"]).to match([
-          {
-            "allocation_count" => kind_of(Integer),
-            "body" => "SQL",
-            "body_format" => Appsignal::EventFormatter::SQL_BODY_FORMAT,
-            "child_allocation_count" => kind_of(Integer),
-            "child_duration" => kind_of(Float),
-            "child_gc_duration" => kind_of(Float),
-            "count" => 1,
-            "duration" => kind_of(Float),
-            "gc_duration" => kind_of(Float),
-            "name" => "sql.active_record",
-            "start" => kind_of(Float),
-            "title" => ""
-          }
-        ])
-      end
-    end
+    it_behaves_like "activesupport instrument override"
 
-    context "when a message is thrown in an instrumented block" do
-      it "instruments an ActiveSupport::Notifications.instrument event" do
-        expect do
-          as.instrument("sql.active_record", :sql => "SQL") do
-            throw :foo
-          end
-        end.to throw_symbol(:foo)
+    if ::ActiveSupport::Notifications::Instrumenter.method_defined?(:start)
+      require_relative "./active_support_notifications/start_finish_shared_examples"
 
-        expect(transaction.to_h["events"]).to match([
-          {
-            "allocation_count" => kind_of(Integer),
-            "body" => "SQL",
-            "body_format" => Appsignal::EventFormatter::SQL_BODY_FORMAT,
-            "child_allocation_count" => kind_of(Integer),
-            "child_duration" => kind_of(Float),
-            "child_gc_duration" => kind_of(Float),
-            "count" => 1,
-            "duration" => kind_of(Float),
-            "gc_duration" => kind_of(Float),
-            "name" => "sql.active_record",
-            "start" => kind_of(Float),
-            "title" => ""
-          }
-        ])
-      end
+      it_behaves_like "activesupport start finish override"
     end
 
-    context "when a transaction is completed in an instrumented block" do
-      it "does not complete the ActiveSupport::Notifications.instrument event" do
-        expect(transaction).to receive(:complete)
-        as.instrument("sql.active_record", :sql => "SQL") do
-          Appsignal::Transaction.complete_current!
-        end
+    if ::ActiveSupport::Notifications::Instrumenter.method_defined?(:finish_with_state)
+      require_relative "./active_support_notifications/finish_with_state_shared_examples"
 
-        expect(transaction.to_h["events"]).to match([])
-      end
+      it_behaves_like "activesupport finish_with_state override"
     end
   else
     describe "#dependencies_present?" do

data/spec/lib/appsignal/hooks/activejob_spec.rb

@@ -21,7 +21,7 @@ if DependencyHelper.active_job_present?
 
     describe "#install" do
       it "extends ActiveJob::Base with the AppSignal ActiveJob plugin" do
-        described_class.new.install
+        start_agent
 
         path, _line_number = ActiveJob::Base.method(:execute).source_location
         expect(path).to end_with("/lib/appsignal/hooks/active_job.rb")
@@ -32,6 +32,7 @@ if DependencyHelper.active_job_present?
   describe Appsignal::Hooks::ActiveJobHook::ActiveJobClassInstrumentation do
     let(:time) { Time.parse("2001-01-01 10:00:00UTC") }
     let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
+    let(:queue) { "default" }
     let(:log) { StringIO.new }
     let(:parameterized_given_args) do
       {
@@ -78,14 +79,26 @@ if DependencyHelper.active_job_present?
           raise "uh oh"
         end
       end
+
+      class ActiveJobCustomQueueTestJob < ActiveJob::Base
+        queue_as :custom_queue
+
+        def perform(*_args)
+        end
+      end
     end
     around { |example| keep_transactions { example.run } }
     after do
       Object.send(:remove_const, :ActiveJobTestJob)
       Object.send(:remove_const, :ActiveJobErrorTestJob)
+      Object.send(:remove_const, :ActiveJobCustomQueueTestJob)
     end
 
     it "reports the name from the ActiveJob integration" do
+      tags = { :queue => queue }
+      expect(Appsignal).to receive(:increment_counter)
+        .with("active_job_queue_job_count", 1, tags.merge(:status => :processed))
+
       perform_job(ActiveJobTestJob)
 
       transaction = last_transaction
@@ -98,7 +111,8 @@ if DependencyHelper.active_job_present?
         "sample_data" => hash_including(
           "params" => [],
           "tags" => {
-            "queue" => "default"
+            "active_job_id" => kind_of(String),
+            "queue" => queue
           }
         )
       )
@@ -108,8 +122,66 @@ if DependencyHelper.active_job_present?
       expect(events).to eq(["perform_start.active_job", "perform.active_job"])
     end
 
+    context "with custom queue" do
+      it "reports the custom queue as tag on the transaction" do
+        tags = { :queue => "custom_queue" }
+        expect(Appsignal).to receive(:increment_counter)
+          .with("active_job_queue_job_count", 1, tags.merge(:status => :processed))
+        perform_job(ActiveJobCustomQueueTestJob)
+
+        transaction = last_transaction
+        transaction_hash = transaction.to_h
+        expect(transaction_hash).to include(
+          "sample_data" => hash_including(
+            "tags" => hash_including("queue" => "custom_queue")
+          )
+        )
+      end
+    end
+
+    if DependencyHelper.rails_version >= Gem::Version.new("5.0.0")
+      context "with priority" do
+        before do
+          class ActiveJobPriorityTestJob < ActiveJob::Base
+            queue_with_priority 10
+
+            def perform(*_args)
+            end
+          end
+        end
+        after do
+          Object.send(:remove_const, :ActiveJobPriorityTestJob)
+        end
+
+        it "reports the priority as tag on the transaction" do
+          tags = { :queue => queue }
+          expect(Appsignal).to receive(:increment_counter)
+            .with("active_job_queue_job_count", 1, tags.merge(:status => :processed))
+          expect(Appsignal).to receive(:increment_counter)
+            .with("active_job_queue_priority_job_count", 1, tags.merge(:priority => 10, :status => :processed))
+
+          perform_job(ActiveJobPriorityTestJob)
+
+          transaction = last_transaction
+          transaction_hash = transaction.to_h
+          expect(transaction_hash).to include(
+            "sample_data" => hash_including(
+              "tags" => hash_including("queue" => queue, "priority" => 10)
+            )
+          )
+        end
+      end
+    end
+
     context "with error" do
       it "reports the error on the transaction from the ActiveRecord integration" do
+        allow(Appsignal).to receive(:increment_counter) # Other calls we're testing in another test
+        tags = { :queue => queue }
+        expect(Appsignal).to receive(:increment_counter)
+          .with("active_job_queue_job_count", 1, tags.merge(:status => :failed))
+        expect(Appsignal).to receive(:increment_counter)
+          .with("active_job_queue_job_count", 1, tags.merge(:status => :processed))
+
         expect do
           perform_job(ActiveJobErrorTestJob)
         end.to raise_error(RuntimeError, "uh oh")
@@ -128,7 +200,8 @@ if DependencyHelper.active_job_present?
           "sample_data" => hash_including(
             "params" => [],
             "tags" => {
-              "queue" => "default"
+              "active_job_id" => kind_of(String),
+              "queue" => queue
             }
           )
         )
@@ -137,6 +210,47 @@ if DependencyHelper.active_job_present?
           .map { |event| event["name"] }
         expect(events).to eq(["perform_start.active_job", "perform.active_job"])
       end
+
+      if DependencyHelper.rails_version >= Gem::Version.new("5.0.0")
+        context "with priority" do
+          before do
+            class ActiveJobErrorPriorityTestJob < ActiveJob::Base
+              queue_with_priority 10
+
+              def perform(*_args)
+                raise "uh oh"
+              end
+            end
+          end
+          after do
+            Object.send(:remove_const, :ActiveJobErrorPriorityTestJob)
+          end
+
+          it "reports the priority as tag on the transaction" do
+            tags = { :queue => queue }
+            expect(Appsignal).to receive(:increment_counter)
+              .with("active_job_queue_job_count", 1, tags.merge(:status => :processed))
+            expect(Appsignal).to receive(:increment_counter)
+              .with("active_job_queue_job_count", 1, tags.merge(:status => :failed))
+            expect(Appsignal).to receive(:increment_counter)
+              .with("active_job_queue_priority_job_count", 1, tags.merge(:priority => 10, :status => :processed))
+            expect(Appsignal).to receive(:increment_counter)
+              .with("active_job_queue_priority_job_count", 1, tags.merge(:priority => 10, :status => :failed))
+
+            expect do
+              perform_job(ActiveJobErrorPriorityTestJob)
+            end.to raise_error(RuntimeError, "uh oh")
+
+            transaction = last_transaction
+            transaction_hash = transaction.to_h
+            expect(transaction_hash).to include(
+              "sample_data" => hash_including(
+                "tags" => hash_including("queue" => queue, "priority" => 10)
+              )
+            )
+          end
+        end
+      end
     end
 
     context "when wrapped in another transaction" do
@@ -163,7 +277,8 @@ if DependencyHelper.active_job_present?
           "sample_data" => hash_including(
             "params" => [],
             "tags" => {
-              "queue" => "default"
+              "active_job_id" => kind_of(String),
+              "queue" => queue
             }
           )
         )
@@ -300,7 +415,10 @@ if DependencyHelper.active_job_present?
             "action" => "ActionMailerTestJob#welcome",
             "sample_data" => hash_including(
               "params" => ["ActionMailerTestJob", "welcome", "deliver_now"],
-              "tags" => { "queue" => "mailers" }
+              "tags" => {
+                "active_job_id" => kind_of(String),
+                "queue" => "mailers"
+              }
             )
           )
         end
@@ -316,7 +434,10 @@ if DependencyHelper.active_job_present?
             "action" => "ActionMailerTestJob#welcome",
             "sample_data" => hash_including(
               "params" => ["ActionMailerTestJob", "welcome", "deliver_now"] + method_expected_args,
-              "tags" => { "queue" => "mailers" }
+              "tags" => {
+                "active_job_id" => kind_of(String),
+                "queue" => "mailers"
+              }
             )
           )
         end
@@ -333,7 +454,10 @@ if DependencyHelper.active_job_present?
               "action" => "ActionMailerTestJob#welcome",
               "sample_data" => hash_including(
                 "params" => ["ActionMailerTestJob", "welcome", "deliver_now", parameterized_expected_args],
-                "tags" => { "queue" => "mailers" }
+                "tags" => {
+                  "active_job_id" => kind_of(String),
+                  "queue" => "mailers"
+                }
               )
             )
           end
@@ -371,7 +495,10 @@ if DependencyHelper.active_job_present?
                 "deliver_now",
                 { active_job_internal_key => ["args"], "args" => [] }
               ],
-              "tags" => { "queue" => "mailers" }
+              "tags" => {
+                "active_job_id" => kind_of(String),
+                "queue" => "mailers"
+              }
             )
           )
         end
@@ -394,7 +521,10 @@ if DependencyHelper.active_job_present?
                     "args" => method_expected_args
                   }
                 ],
-                "tags" => { "queue" => "mailers" }
+                "tags" => {
+                  "active_job_id" => kind_of(String),
+                  "queue" => "mailers"
+                }
               )
             )
           end
@@ -419,7 +549,10 @@ if DependencyHelper.active_job_present?
                     "params" => parameterized_expected_args
                   }
                 ],
-                "tags" => { "queue" => "mailers" }
+                "tags" => {
+                  "active_job_id" => kind_of(String),
+                  "queue" => "mailers"
+                }
               )
             )
           end

data/spec/lib/appsignal/hooks/delayed_job_spec.rb

@@ -227,25 +227,14 @@ describe Appsignal::Hooks::DelayedJobHook do
           end
         end
 
-        context "without job name" do
-          let(:job_data) do
-            { :name => "", :payload_object => payload_object }
-          end
-
-          it "wraps it in a transaction using the class method job name" do
-            perform
-            expect(last_transaction.to_h["action"]).to eql("unknown")
-          end
-        end
-
-        context "with invalid job name" do
+        context "with only job class name" do
           let(:job_data) do
             { :name => "Banana", :payload_object => payload_object }
           end
 
-          it "wraps it in a transaction using the class method job name" do
+          it "appends #perform to the class name" do
             perform
-            expect(last_transaction.to_h["action"]).to eql("unknown")
+            expect(last_transaction.to_h["action"]).to eql("Banana#perform")
           end
         end
 

data/spec/lib/appsignal/hooks/sidekiq_spec.rb

@@ -76,9 +76,10 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
     ]
   end
   let(:job_class) { "TestClass" }
+  let(:jid) { "b4a577edbccf1d805744efa9" }
   let(:item) do
     {
-      "jid"         => "b4a577edbccf1d805744efa9",
+      "jid"         => jid,
       "class"       => job_class,
       "retry_count" => 0,
       "queue"       => "default",
@@ -151,7 +152,7 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
   context "when using the Sidekiq delayed extension" do
     let(:item) do
       {
-        "jid" => "efb140489485999d32b5504c",
+        "jid" => jid,
         "class" => "Sidekiq::Extensions::DelayedClass",
         "queue" => "default",
         "args" => [
@@ -191,7 +192,7 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
   context "when using the Sidekiq ActiveRecord instance delayed extension" do
     let(:item) do
       {
-        "jid" => "efb140489485999d32b5504c",
+        "jid" => jid,
         "class" => "Sidekiq::Extensions::DelayedModel",
         "queue" => "default",
         "args" => [
@@ -243,7 +244,7 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
 
       transaction_hash = transaction.to_h
       expect(transaction_hash).to include(
-        "id" => kind_of(String),
+        "id" => jid,
         "action" => "TestClass#perform",
         "error" => {
           "name" => "ExampleException",
@@ -277,7 +278,7 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
 
       transaction_hash = transaction.to_h
       expect(transaction_hash).to include(
-        "id" => kind_of(String),
+        "id" => jid,
         "action" => "TestClass#perform",
         "error" => nil,
         "metadata" => {
@@ -361,6 +362,7 @@ if DependencyHelper.active_job_present?
     end
     let(:expected_tags) do
       {}.tap do |hash|
+        hash["active_job_id"] = kind_of(String)
         if DependencyHelper.rails_version >= Gem::Version.new("5.0.0")
           hash["provider_job_id"] = kind_of(String)
         end