appsignal 2.11.0.beta.2 → 2.11.0.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31c0f5c0cd70fbd1710fb6181d4d498eff4ffd5ca07b77a99d63c7936effb4aa
-  data.tar.gz: ca2d5e18ed1b88c8a43f0384d30ef7be7905fdaab67d8b26e8fae3741593f5f1
+  metadata.gz: 8d8565582bb357410dee8c4683c62da303f2b1cbbb9dc5dcc0494b03761a7c55
+  data.tar.gz: 7270ef47a9574e21887a8044d1934abdddb75293f919ab3ebda55ce5fb4afd3b
 SHA512:
-  metadata.gz: 5fabb532b4eda9978b1dff7d6ce467c57b8526ff3a7dd2a77a576754c0b7e44484e872049a6b5c432d112cffc17d85cfaff992858a0ab73ddc4de828cfda2f42
-  data.tar.gz: b6025e9017e1fb45249efd99114f66f08ca63c780cac209822217fb19ec73c5a35a6b4508afac42a005ad41b2931881fea38af35516183fbc9037b4b95e87597
+  metadata.gz: 233fc5bb7044fab5c6743a6516be7e2058f211aa4ce94529f4a7bde232fc803f6b4833987bf308578c4f7760b86a9ea3f437edf91b796b977fb115100d1e4ee4
+  data.tar.gz: 123e21c4bd820b766d011fdbc221c243ca2b746745e8a8b9de785fe432b599315d3b17c72b8627479c25490d754947d00501d8dd796ff402758343e0fc53a06e

data/CHANGELOG.md

@@ -16,6 +16,8 @@
   integrations. PR #630
 - Fix issue with unknown events from being reported as often for long running
   agents. Commit ba9afb538f44c68b8035a8cf40a39d89bc77b021
+- Add support for Active Job priority. PR #632
+- Track Active Job job metrics for magic dashboard. PR #633
 
 # 2.10.9
 - Use http proxy if configured when downloading agent. PR #606

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,9 +37,16 @@ module Appsignal
 
           super
         rescue Exception => exception # rubocop:disable Lint/RescueException
+          job_status = :failed
           transaction.set_error(exception)
           raise exception
         ensure
+          tags = {}
+          queue = job["queue_name"]
+          tags[:queue] = queue if queue
+          priority = job["priority"]
+          tags[:priority] = priority if priority
+
           if transaction
             transaction.params =
               Appsignal::Utils::HashSanitizer.sanitize(
@@ -48,10 +54,12 @@ module Appsignal
                 Appsignal.config[:filter_parameters]
               )
 
-            tags = { :queue => job["queue_name"] }
+            transaction_tags = tags
             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 +73,13 @@ module Appsignal
               Appsignal::Transaction.complete_current!
             end
           end
+
+          if job_status
+            ActiveJobHelpers.increment_counter "queue_job_count", 1,
+              tags.merge(:status => job_status)
+          end
+          ActiveJobHelpers.increment_counter "queue_job_count", 1,
+            tags.merge(:status => :processed)
         end
       end
 
@@ -83,6 +98,10 @@ module Appsignal
             "#{job["job_class"]}#perform"
           end
         end
+
+        def self.increment_counter(key, value, tags = {})
+          Appsignal.increment_counter "active_job_#{key}", value, tags
+        end
       end
     end
   end

data/lib/appsignal/version.rb

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

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
@@ -97,9 +110,7 @@ if DependencyHelper.active_job_present?
         "metadata" => {},
         "sample_data" => hash_including(
           "params" => [],
-          "tags" => {
-            "queue" => "default"
-          }
+          "tags" => { "queue" => queue }
         )
       )
       events = transaction_hash["events"]
@@ -108,8 +119,64 @@ 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" => { "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 = { :priority => 10, :queue => queue }
+          expect(Appsignal).to receive(:increment_counter)
+            .with("active_job_queue_job_count", 1, tags.merge(:status => :processed))
+
+          perform_job(ActiveJobPriorityTestJob)
+
+          transaction = last_transaction
+          transaction_hash = transaction.to_h
+          expect(transaction_hash).to include(
+            "sample_data" => hash_including(
+              "tags" => { "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")
@@ -127,9 +194,7 @@ if DependencyHelper.active_job_present?
           "metadata" => {},
           "sample_data" => hash_including(
             "params" => [],
-            "tags" => {
-              "queue" => "default"
-            }
+            "tags" => { "queue" => queue }
           )
         )
         events = transaction_hash["events"]
@@ -162,9 +227,7 @@ if DependencyHelper.active_job_present?
           "metadata" => {},
           "sample_data" => hash_including(
             "params" => [],
-            "tags" => {
-              "queue" => "default"
-            }
+            "tags" => { "queue" => queue }
           )
         )
         events = transaction_hash["events"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.11.0.beta.2
+  version: 2.11.0.beta.3
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack