appsignal 2.5.2 → 2.5.3.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 638c33adaf9394488da292c98738966981fad1d1
-  data.tar.gz: e0450850d9a358e78d3391050a1c43bfbb1b5705
+  metadata.gz: 18e46cb221b16ec43eb3b45158ae8849dfbe0728
+  data.tar.gz: 63537221d5bbcec71aa6c9f096b732b8586d7033
 SHA512:
-  metadata.gz: 94d04b637d3f5477ea4a29f47411d385e608b85e57bd930ea3e18f85c31401288a385adc651365043df5bc6bade2870f73179b17067f706f220a8007b2efe3eb
-  data.tar.gz: bcdf191cb6943a854503e5504ee69c41cde23bad18ffa77374d056cb61f616af208e696674a97d72a6008a62bf80ddc513e4bbbe94ee9b631138c52b7e1da57c
+  metadata.gz: 9f5fa1663e8fbf61b7e4f91501ff54dff521d567d0264a23c53d535580f25c423a7552829dcfa51a823bce599b143661f5f9a52ade22a12419c2a628f3e7d8dc
+  data.tar.gz: cfd6a663991702d6cade925af2f0b1d0ee7778bdd9e96511c68493ea44ba143a5e9f8e07fdac1186c748240f5877eb2fda37a60919429885ad25774525570ff0

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 2.5.3
+- Fix Sidekiq action names containing arguments. PR #401
+
 # 2.5.2
 - Support Sidekiq delay extension for ActiveRecord instances. If using this
   feature in your app, an update is strongly recommended! PR #387

data/lib/appsignal/hooks/sidekiq.rb

@@ -22,6 +22,7 @@ module Appsignal
     class SidekiqPlugin # rubocop:disable Metrics/ClassLength
       include Appsignal::Hooks::Helpers
 
+      UNKNOWN_ACTION_NAME = "unknown".freeze
       JOB_KEYS = %w[
         args backtrace class created_at enqueued_at error_backtrace error_class
         error_message failed_at jid retried_at retry wrapped
@@ -60,7 +61,10 @@ module Appsignal
 
       def formatted_action_name(job)
         sidekiq_action_name = parse_action_name(job)
-        return sidekiq_action_name if sidekiq_action_name =~ /\.|#/
+        complete_action = sidekiq_action_name =~ /\.|#/
+        if complete_action || sidekiq_action_name == UNKNOWN_ACTION_NAME
+          return sidekiq_action_name
+        end
         "#{sidekiq_action_name}#perform"
       end
 
@@ -94,11 +98,16 @@ module Appsignal
           end
         when "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper"
           job_class = job["wrapped"] || args[0]
-          if job_class == "ActionMailer::DeliveryJob"
+          case job_class
+          when "ActionMailer::DeliveryJob"
             # MailerClass#mailer_method
             args[0]["arguments"][0..1].join("#")
-          else
+          when String
             job_class
+          else
+            Appsignal.logger.debug \
+              "Unable to determine an action name from Sidekiq payload: #{job}"
+            UNKNOWN_ACTION_NAME
           end
         else
           job["class"]

data/lib/appsignal/version.rb

@@ -1,3 +1,3 @@
 module Appsignal
-  VERSION = "2.5.2".freeze
+  VERSION = "2.5.3.alpha.1".freeze
 end

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

@@ -317,6 +317,62 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
           )
         end
       end
+
+      context "when Sidekiq job payload is missing the 'wrapped' value" do
+        let(:item) do
+          {
+            "class" => "ActiveJob::QueueAdapters::SidekiqAdapter::JobWrapper",
+            "queue" => "default",
+            "args" => [{
+              "job_class" => "ActiveMailerTestJob",
+              "job_id" => "23e79d48-6966-40d0-b2d4-f7938463a263",
+              "queue_name" => "default",
+              "arguments" => [
+                "MailerClass", "mailer_method", "deliver_now",
+                "foo", { "foo" => "Foo", "bar" => "Bar", "baz" => { 1 => :bar } }
+              ]
+            }],
+            "retry" => true,
+            "jid" => "efb140489485999d32b5504c",
+            "created_at" => Time.parse("2001-01-01 10:00:00UTC").to_f,
+            "enqueued_at" => Time.parse("2001-01-01 10:00:00UTC").to_f
+          }
+        end
+
+        it "sets the action name to unknown and without sample data" do
+          perform_job
+
+          transaction_hash = transaction.to_h
+          expect(transaction_hash).to include(
+            "id" => kind_of(String),
+            "action" => "unknown",
+            "error" => nil,
+            "namespace" => namespace,
+            "metadata" => {
+              "queue" => "default"
+            },
+            "sample_data" => {
+              "environment" => {},
+              "params" => [],
+              "tags" => {}
+            }
+          )
+          # TODO: Not available in transaction.to_h yet.
+          # https://github.com/appsignal/appsignal-agent/issues/293
+          expect(transaction.request.env).to eq(
+            :queue_start => Time.parse("2001-01-01 10:00:00UTC").to_f
+          )
+          expect_transaction_to_have_sidekiq_event(transaction_hash)
+        end
+
+        it "logs a debug message" do
+          perform_job
+
+          expect(log_contents(log)).to contains_log(
+            :debug, "Unable to determine an action name from Sidekiq payload: #{item}"
+          )
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.5.3.alpha.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-21 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -357,9 +357,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.14