Merge pull request #3320 from newrelic/rename_activejob_segment

Rename ActiveJob segments

Author: hannahramadan

CHANGELOG.md

@@ -5,6 +5,11 @@
 - **Breaking Change: Remove support for Ruby 2.4 and 2.5**
   Support for Ruby versions 2.4 and 2.5 has been removed. The new minimum required Ruby version is now 2.6. [PR#3314](https://github.com/newrelic/newrelic-ruby-agent/pull/3314)
 
+- **Breaking Change: Rename ActiveJob metrics**
+  ActiveJob metrics have been updated to include the job's class name for more specific reporting. This is a breaking change and may require updating custom dashboards or alerts. [PR#3320](https://github.com/newrelic/newrelic-ruby-agent/pull/3320)
+    - Old format: `Ruby/ActiveJob/<QueueName>/<Method>`
+    - New format: `Ruby/ActiveJob/<ClassName>/<QueueName>/<Method>`
+
 - **Breaking Change: Rename `bin/newrelic` command to `bin/newrelic_rpm`**
   The executable file for the agent's CLI has been renamed from `bin/newrelic` to `bin/newrelic_rpm`. This change resolves a name collision with the standalone New Relic CLI tool. [PR#3323](https://github.com/newrelic/newrelic-ruby-agent/pull/3323)
 

lib/new_relic/agent/instrumentation/active_job_subscriber.rb

@@ -22,8 +22,9 @@ def metric_name(name, payload)
           job = payload[:job] || payload[:jobs].first
 
           queue = job.queue_name
+          job_class = job.class.name.include?('::') ? job.class.name[job.class.name.rindex('::') + 2..-1] : job.class.name
           method = method_from_name(name)
-          "Ruby/ActiveJob/#{queue}/#{method}"
+          "Ruby/ActiveJob/#{job_class}/#{queue}/#{method}"
         end
 
         PATTERN = /\A([^\.]+)\.active_job\z/

test/new_relic/agent/instrumentation/rails/active_job_subscriber.rb

@@ -25,18 +25,28 @@ def perform(error = nil)
     end
   end
 
+  module MyApp
+    module Jobs
+      class EmailNotificationJob < ActiveJob::Base
+        def perform(error = nil)
+          # NOOP - testing ActiveJob metric name
+        end
+      end
+    end
+  end
+
   class ActiveJobSubscriberTest < Minitest::Test
     NAME = 'perform.active_job'
     ID = 71741
     SUBSCRIBER = NewRelic::Agent::Instrumentation::ActiveJobSubscriber.new
 
     def test_segment_naming_with_unknown_method
-      assert_equal 'Ruby/ActiveJob/default/Unknown',
+      assert_equal 'Ruby/ActiveJob/TestJob/default/Unknown',
         SUBSCRIBER.send(:metric_name, 'indecipherable', {job: TestJob.new})
     end
 
     def test_segment_naming_multiple_jobs
-      assert_equal 'Ruby/ActiveJob/default/Unknown',
+      assert_equal 'Ruby/ActiveJob/TestJob/default/Unknown',
         SUBSCRIBER.send(:metric_name, 'indecipherable', {jobs: [TestJob.new, TestJob.new]})
     end
 
@@ -100,6 +110,17 @@ def test_retry_stopped_active_job
       end
     end
 
+    def test_metric_name_namespacing
+      job = MyApp::Jobs::EmailNotificationJob.new
+      in_transaction do |txn|
+        job.perform_now
+        segments = txn.segments.select { |s| s.name.start_with?('Ruby/ActiveJob') }
+        segment = segments.detect { |s| s.name == 'Ruby/ActiveJob/EmailNotificationJob/default/perform' }
+
+        assert segment
+      end
+    end
+
     private
 
     def validate_transaction(txn, methods = [])
@@ -109,7 +130,7 @@ def validate_transaction(txn, methods = [])
       refute_empty segments
 
       methods.each do |method|
-        segment = segments.detect { |s| s.name == "Ruby/ActiveJob/default/#{method}" }
+        segment = segments.detect { |s| s.name == "Ruby/ActiveJob/TestJob/default/#{method}" }
 
         assert segment