appsignal 2.5.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2e375f2f3703066e529a51dc84a0db6fc9d1b29
-  data.tar.gz: f44d521a76c7e897d07d47c2bfe244ebbb5b66f8
+  metadata.gz: 638c33adaf9394488da292c98738966981fad1d1
+  data.tar.gz: e0450850d9a358e78d3391050a1c43bfbb1b5705
 SHA512:
-  metadata.gz: 742d3ddd1b0ac482a4211aa1752a87f1b017bb3958062364c8a63f39efc881bf40783db7960b790c130c70ac5c5b1b8c6abd5f424062322e8919c3663dd875ac
-  data.tar.gz: fbda5dce446bf4e06146169e704eb0e372f5afae9c6129247e4be79b9912e2c941c3324ec2ace3a3e740f18627905dc9e6773f226faa23a3d92e73ad4b6af700
+  metadata.gz: 94d04b637d3f5477ea4a29f47411d385e608b85e57bd930ea3e18f85c31401288a385adc651365043df5bc6bade2870f73179b17067f706f220a8007b2efe3eb
+  data.tar.gz: bcdf191cb6943a854503e5504ee69c41cde23bad18ffa77374d056cb61f616af208e696674a97d72a6008a62bf80ddc513e4bbbe94ee9b631138c52b7e1da57c

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 2.5.2
+- Support Sidekiq delay extension for ActiveRecord instances. If using this
+  feature in your app, an update is strongly recommended! PR #387
+- Improve custom event formatter registration. An event formatter can now be
+  registered in a Rails initializer after AppSignal has been loaded/started.
+  PR #397
+
 # 2.5.1
 - Improve internal sample storage in agent.
   Commit 2c8eae26685c7a1517cf2e57b44edd1557a502f2

data/lib/appsignal.rb

@@ -121,7 +121,7 @@ module Appsignal
           config.write_to_environment
           Appsignal::Extension.start
           Appsignal::Hooks.load_hooks
-          Appsignal::EventFormatter.initialize_formatters
+          Appsignal::EventFormatter.initialize_deprecated_formatters
           initialize_extensions
 
           if config[:enable_allocation_tracking] && !Appsignal::System.jruby?

data/lib/appsignal/event_formatter.rb

@@ -16,12 +16,35 @@ module Appsignal
         @@formatters ||= {}
       end
 
+      def deprecated_formatter_classes
+        @@deprecated_formatter_classes ||= {}
+      end
+
       def formatter_classes
         @@formatter_classes ||= {}
       end
 
-      def register(name, formatter = self)
-        formatter_classes[name] = formatter
+      def register(name, formatter = nil)
+        unless formatter
+          register_deprecated_formatter(name)
+          return
+        end
+
+        if registered?(name, formatter)
+          Appsignal.logger.warn(
+            "Formatter for '#{name}' already registered, not registering "\
+            "'#{formatter.name}'"
+          )
+          return
+        end
+
+        initialize_formatter name, formatter
+      end
+
+      def initialize_deprecated_formatters
+        deprecated_formatter_classes.each do |name, formatter|
+          register(name, formatter)
+        end
       end
 
       def unregister(name, formatter = self)
@@ -39,27 +62,37 @@ module Appsignal
         end
       end
 
-      def initialize_formatters
-        formatter_classes.each do |name, formatter|
-          begin
-            format_method = formatter.instance_method(:format)
-            if format_method && format_method.arity == 1
-              formatters[name] = formatter.new
-            else
-              raise "#{f} does not have a format(payload) method"
-            end
-          rescue => ex
-            formatter_classes.delete(name)
-            formatters.delete(name)
-            Appsignal.logger.debug("'#{ex.message}' when initializing #{name} event formatter")
-          end
-        end
-      end
-
       def format(name, payload)
         formatter = formatters[name]
         formatter.format(payload) unless formatter.nil?
       end
+
+      private
+
+      def initialize_formatter(name, formatter)
+        format_method = formatter.instance_method(:format)
+        if format_method && format_method.arity == 1
+          formatter_classes[name] = formatter
+          formatters[name] = formatter.new
+        else
+          raise "#{formatter} does not have a format(payload) method"
+        end
+      rescue => ex
+        formatter_classes.delete(name)
+        formatters.delete(name)
+        Appsignal.logger.warn("'#{ex.message}' when initializing #{name} event formatter")
+      end
+
+      def register_deprecated_formatter(name)
+        Appsignal.logger.warn(
+          "Formatter for '#{name}' is using a deprecated registration " \
+          "method. This event formatter will not be loaded. " \
+          "Please update the formatter according to the documentation at: " \
+          "https://docs.appsignal.com/ruby/instrumentation/event-formatters.html"
+        )
+
+        deprecated_formatter_classes[name] = self
+      end
     end
 
     # @api public

data/lib/appsignal/event_formatter/action_view/render_formatter.rb

@@ -2,10 +2,7 @@ module Appsignal
   class EventFormatter
     # @api private
     module ActionView
-      class RenderFormatter < Appsignal::EventFormatter
-        register "render_partial.action_view"
-        register "render_template.action_view"
-
+      class RenderFormatter
         BLANK = "".freeze
 
         attr_reader :root_path
@@ -22,3 +19,12 @@ module Appsignal
     end
   end
 end
+
+Appsignal::EventFormatter.register(
+  "render_partial.action_view",
+  Appsignal::EventFormatter::ActionView::RenderFormatter
+)
+Appsignal::EventFormatter.register(
+  "render_template.action_view",
+  Appsignal::EventFormatter::ActionView::RenderFormatter
+)

data/lib/appsignal/event_formatter/active_record/instantiation_formatter.rb

@@ -2,9 +2,7 @@ module Appsignal
   class EventFormatter
     # @api private
     module ActiveRecord
-      class InstantiationFormatter < Appsignal::EventFormatter
-        register "instantiation.active_record"
-
+      class InstantiationFormatter
         def format(payload)
           [payload[:class_name], nil]
         end
@@ -12,3 +10,8 @@ module Appsignal
     end
   end
 end
+
+Appsignal::EventFormatter.register(
+  "instantiation.active_record",
+  Appsignal::EventFormatter::ActiveRecord::InstantiationFormatter
+)

data/lib/appsignal/event_formatter/active_record/sql_formatter.rb

@@ -2,9 +2,7 @@ module Appsignal
   class EventFormatter
     # @api private
     module ActiveRecord
-      class SqlFormatter < Appsignal::EventFormatter
-        register "sql.active_record"
-
+      class SqlFormatter
         def format(payload)
           [payload[:name], payload[:sql], SQL_BODY_FORMAT]
         end
@@ -12,3 +10,8 @@ module Appsignal
     end
   end
 end
+
+Appsignal::EventFormatter.register(
+  "sql.active_record",
+  Appsignal::EventFormatter::ActiveRecord::SqlFormatter
+)

data/lib/appsignal/event_formatter/elastic_search/search_formatter.rb

@@ -2,9 +2,7 @@ module Appsignal
   class EventFormatter
     # @api private
     module ElasticSearch
-      class SearchFormatter < Appsignal::EventFormatter
-        register "search.elasticsearch"
-
+      class SearchFormatter
         def format(payload)
           [
             "#{payload[:name]}: #{payload[:klass]}",
@@ -30,3 +28,8 @@ module Appsignal
     end
   end
 end
+
+Appsignal::EventFormatter.register(
+  "search.elasticsearch",
+  Appsignal::EventFormatter::ElasticSearch::SearchFormatter
+)

data/lib/appsignal/event_formatter/faraday/request_formatter.rb

@@ -2,9 +2,7 @@ module Appsignal
   class EventFormatter
     # @api private
     module Faraday
-      class RequestFormatter < Appsignal::EventFormatter
-        register "request.faraday"
-
+      class RequestFormatter
         def format(payload)
           http_method = payload[:method].to_s.upcase
           uri = payload[:url]
@@ -17,3 +15,8 @@ module Appsignal
     end
   end
 end
+
+Appsignal::EventFormatter.register(
+  "request.faraday",
+  Appsignal::EventFormatter::Faraday::RequestFormatter
+)

data/lib/appsignal/event_formatter/moped/query_formatter.rb

@@ -2,9 +2,7 @@ module Appsignal
   class EventFormatter
     # @api private
     module Moped
-      class QueryFormatter < Appsignal::EventFormatter
-        register "query.moped"
-
+      class QueryFormatter
         def format(payload)
           if payload[:ops] && !payload[:ops].empty?
             op = payload[:ops].first
@@ -78,3 +76,8 @@ module Appsignal
     end
   end
 end
+
+Appsignal::EventFormatter.register(
+  "query.moped",
+  Appsignal::EventFormatter::Moped::QueryFormatter
+)

data/lib/appsignal/hooks/sidekiq.rb

@@ -19,7 +19,7 @@ module Appsignal
     end
 
     # @api private
-    class SidekiqPlugin
+    class SidekiqPlugin # rubocop:disable Metrics/ClassLength
       include Appsignal::Hooks::Helpers
 
       JOB_KEYS = %w[
@@ -84,6 +84,10 @@ module Appsignal
       def parse_action_name(job)
         args = job["args"]
         case job["class"]
+        when "Sidekiq::Extensions::DelayedModel"
+          safe_load(job["args"][0], job["class"]) do |target, method, _|
+            "#{target.class}##{method}"
+          end
         when /\ASidekiq::Extensions::Delayed/
           safe_load(job["args"][0], job["class"]) do |target, method, _|
             "#{target}.#{method}"

data/lib/appsignal/version.rb

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

data/spec/lib/appsignal/event_formatter_spec.rb

@@ -1,6 +1,4 @@
 class MockFormatter < Appsignal::EventFormatter
-  register "mock"
-
   attr_reader :body
 
   def initialize
@@ -23,20 +21,30 @@ class IncorrectFormatMockFormatter < Appsignal::EventFormatter
 end
 
 class MockDependentFormatter < Appsignal::EventFormatter
-  register "mock.dependent"
-
   def initialize
     NonsenseDependency.something
   end
 end
 
+Appsignal::EventFormatter.register "mock", MockFormatter
+Appsignal::EventFormatter.register "mock.dependent", MockDependentFormatter
+
 describe Appsignal::EventFormatter do
   before do
-    Appsignal::EventFormatter.initialize_formatters
+    klass.register("mock", MockFormatter)
   end
 
   let(:klass) { Appsignal::EventFormatter }
 
+  let(:deprecated_formatter) do
+    Class.new(Appsignal::EventFormatter) do
+      register "mock.deprecated"
+
+      def format(_payload)
+      end
+    end
+  end
+
   context "registering and unregistering formatters" do
     it "should register a formatter" do
       expect(klass.formatters["mock"]).to be_instance_of(MockFormatter)
@@ -53,19 +61,8 @@ describe Appsignal::EventFormatter do
       expect(klass.registered?("mock.dependent")).to be_falsy
     end
 
-    it "doesn't register formatters that don't have a format(payload) method" do
-      klass.register("mock.missing_format", MissingFormatMockFormatter)
-      klass.register("mock.incorrect_format", IncorrectFormatMockFormatter)
-
-      Appsignal::EventFormatter.initialize_formatters
-
-      expect(klass.registered?("mock.missing_format")).to be_falsy
-      expect(klass.registered?("mock.incorrect_format")).to be_falsy
-    end
-
     it "should register a custom formatter" do
       klass.register("mock.specific", MockFormatter)
-      Appsignal::EventFormatter.initialize_formatters
 
       expect(klass.formatter_classes["mock.specific"]).to eq MockFormatter
       expect(klass.registered?("mock.specific")).to be_truthy
@@ -86,6 +83,32 @@ describe Appsignal::EventFormatter do
       klass.unregister("mock.unregister", MockFormatter)
       expect(klass.registered?("mock.unregister")).to be_falsy
     end
+
+    it "should not register two formatters for the same name" do
+      expect(Appsignal.logger).to receive(:warn)
+        .with("Formatter for 'mock.twice' already registered, not registering 'MockFormatter'")
+      klass.register("mock.twice", MockFormatter)
+      klass.register("mock.twice", MockFormatter)
+    end
+
+    it "should not register deprecated formatter" do
+      expect(Appsignal.logger).to receive(:warn)
+        .with("Formatter for 'mock.deprecated' is using a deprecated registration method. " \
+              "This event formatter will not be loaded. " \
+              "Please update the formatter according to the documentation at: " \
+              "https://docs.appsignal.com/ruby/instrumentation/event-formatters.html")
+
+      deprecated_formatter
+
+      expect(Appsignal::EventFormatter.deprecated_formatter_classes.keys).to include("mock.deprecated")
+    end
+
+    it "should initialize deprecated formatters" do
+      deprecated_formatter
+      Appsignal::EventFormatter.initialize_deprecated_formatters
+
+      expect(klass.registered?("mock.deprecated")).to be_truthy
+    end
   end
 
   context "calling formatters" do

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

@@ -151,6 +151,46 @@ describe Appsignal::Hooks::SidekiqPlugin, :with_yaml_parse_error => false do
       end
     end
 
+    context "when using the Sidekiq ActiveRecord instance delayed extension" do
+      let(:item) do
+        {
+          "jid" => "efb140489485999d32b5504c",
+          "class" => "Sidekiq::Extensions::DelayedModel",
+          "queue" => "default",
+          "args" => [
+            "---\n- !ruby/object:DelayedTestClass {}\n- :foo_method\n- - :bar: :baz\n"
+          ],
+          "retry" => true,
+          "created_at" => Time.parse("2001-01-01 10:00:00UTC").to_f,
+          "enqueued_at" => Time.parse("2001-01-01 10:00:00UTC").to_f,
+          "extra" => "data"
+        }
+      end
+
+      it "uses the delayed class and method name for the action" do
+        perform_job
+
+        transaction_hash = transaction.to_h
+        expect(transaction_hash["action"]).to eq("DelayedTestClass#foo_method")
+        expect(transaction_hash["sample_data"]).to include(
+          "params" => ["bar" => "baz"]
+        )
+      end
+
+      context "when job arguments is a malformed YAML object", :with_yaml_parse_error => true do
+        before { item["args"] = [] }
+
+        it "logs a warning and uses the default argument" do
+          perform_job
+
+          transaction_hash = transaction.to_h
+          expect(transaction_hash["action"]).to eq("Sidekiq::Extensions::DelayedModel#perform")
+          expect(transaction_hash["sample_data"]).to include("params" => [])
+          expect(log_contents(log)).to contains_log(:warn, "Unable to load YAML")
+        end
+      end
+    end
+
     context "when using ActiveJob" do
       let(:item) do
         {

data/spec/lib/appsignal_spec.rb

@@ -61,8 +61,8 @@ describe Appsignal do
         Appsignal.start
       end
 
-      it "should initialize formatters" do
-        expect(Appsignal::EventFormatter).to receive(:initialize_formatters)
+      it "should load deprecated event formatters" do
+        expect(Appsignal::EventFormatter).to receive(:initialize_deprecated_formatters)
         Appsignal.start
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 2.5.2
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-13 00:00:00.000000000 Z
+date: 2018-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack