delayed-plugins-raven 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 510d9ad154ecf812d69636bf14411ed9371fdd8a
-  data.tar.gz: 32a8f245505374f8973dd7743df615bf295b8fb7
+  metadata.gz: 901fd0dbeed8792f6e15e350f7a662c56bc77129
+  data.tar.gz: 67f17fb30f7ab2b19b7ceb03cfefb5b2284eeff2
 SHA512:
-  metadata.gz: 568b2b73d59a534bd000ef4a35ddeb29cba537969aa359cae7186e6a841c0f6f514de1f156c47c7d78706426918be88279dec6db1322ed2e824ff7733f7d7ddf
-  data.tar.gz: 6686dc7b2dcaf92235994cc24a69e912ecb2fd8400a61c9bb863aa4e1f40e45cfb22cec75b6e9f11cd8fd6450d5c788df89c627ea297739178afe053aa74b7f2
+  metadata.gz: 3b26fa53e09b79990b83f08fbbbabbcd36b3d144adfcd1b6ca57cfb129674aa2318cfa861aa4fa9eca176ba606e2c6f40e852a1803f50505f6e31b9ecbe46f54
+  data.tar.gz: a2ae99f7f86b61d0415622dd9415cd8a4c10169bfa09616bb6df3f4a58e6607d5b9c08cd3e3964b690e69a398c641f9901528a575ba9ea5f88816e1858771732

data/README.md

@@ -26,10 +26,19 @@ In a Rails project, this can be done in `config/initializers`.
 To configure `Delayed::Plugins::Raven` independently from the default Raven configuration, add an initializer to `config/initializers`:
 
     require 'delayed-plugins-raven'
-    Delayed::Plugins::Raven.configure do |config|
+    Delayed::Plugins::Raven.configure_raven do |config|
       config.dsn = ENV["SENTRY_DSN"]
       config.excluded_exceptions = []
       ...
     end
 
 If this configuration is omitted, `Raven.capture_exception` will be invoked with the default Raven configuration.
+
+Some other aspects of this plugin can be configured with `Delayed::Plugins::Raven.configure_plugin`:
+
+    Delayed::Plugins::Raven.configure_plugin do |config|
+      config.excluded_attributes = ["created_at", "updated_at", "last_error"]
+      config.trimmed_attributes = { "last_error" => 20, "handler" => 10 }
+    end
+
+See `Delayed::Plugins::Raven::Configuration` for default value of the above configurations.

data/lib/delayed-plugins-raven.rb

@@ -3,6 +3,7 @@ require 'delayed/performable_method'
 require 'delayed/plugin'
 
 require 'delayed-plugins-raven/version'
+require 'delayed-plugins-raven/configuration'
 
 module Delayed::Plugins::Raven
   class Plugin < ::Delayed::Plugin
@@ -10,8 +11,8 @@ module Delayed::Plugins::Raven
       def error(job, error)
         begin
           ::Raven.capture_exception(error, {
-            configuration: ::Delayed::Plugins::Raven.configuration,
-            extra: { delayed_job: job.as_json }
+            configuration: ::Delayed::Plugins::Raven.raven_configuration,
+            extra: { delayed_job: get_job_json(job) }
           })
         rescue Exception => e
           Rails.logger.error "Raven logging failed: #{e.class.name}: #{e.message}"
@@ -19,6 +20,33 @@ module Delayed::Plugins::Raven
         end
         super if defined?(super)
       end
+
+      private
+
+      def get_job_json(job)
+        json = job.as_json["job"]
+
+        if (excluded_attributes = plugin_config.excluded_attributes).present?
+          excluded_attributes.each { |attribute| json.delete(attribute) }
+        end
+
+        if (limits = plugin_config.trimmed_attributes).present?
+          limits.each do |attribute, limit|
+            json[attribute] = trim_lines(json[attribute], limit) if limit > 0
+          end
+        end
+
+        json
+      end
+
+      def trim_lines(string, limit)
+        return string unless limit
+        string.lines.to_a.map(&:strip).slice(0, limit).join("\n") if string.present?
+      end
+
+      def plugin_config
+        ::Delayed::Plugins::Raven.plugin_configuration ||= ::Delayed::Plugins::Raven::Configuration.new
+      end
     end
 
     callbacks do |lifecycle|
@@ -31,11 +59,23 @@ module Delayed::Plugins::Raven
   end
 
   class << self
-    attr_accessor :configuration
+    attr_accessor :raven_configuration
+    attr_accessor :plugin_configuration
+
+    # Note: Deprecated; Use Delayed::Plugins::Raven.configure_raven instead.
+    def configure(&block)
+      configure_raven(&block)
+    end
+
+    def configure_raven(&block)
+      @raven_configuration = ::Raven::Configuration.new
+      block.call(@raven_configuration) if block
+      self
+    end
 
-    def configure
-      @configuration = ::Raven::Configuration.new
-      yield(@configuration) if block_given?
+    def configure_plugin(&block)
+      @plugin_configuration = Delayed::Plugins::Raven::Configuration.new
+      block.call(@plugin_configuration) if block
       self
     end
   end

data/lib/delayed-plugins-raven/configuration.rb

@@ -0,0 +1,16 @@
+module Delayed::Plugins::Raven
+  class Configuration
+
+    # Exclude certain attributes from being serialized into Raven's `extra` field
+    attr_accessor :excluded_attributes
+
+    # Trim specificed attributes to a certain number of lines. Values <= 0 means unlimited.
+    attr_accessor :trimmed_attributes
+
+    def initialize
+      self.excluded_attributes = ["last_error"]
+      self.trimmed_attributes = { "handler" => -1, "last_error" => 10 }
+    end
+
+  end
+end

data/lib/delayed-plugins-raven/version.rb

@@ -1,7 +1,7 @@
 module Delayed
   module Plugins
     module Raven
-      VERSION = '1.0.4'
+      VERSION = '1.0.5'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: delayed-plugins-raven
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Qiushi He
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sentry-raven
@@ -83,6 +83,7 @@ files:
 - Rakefile
 - delayed-plugins-raven.gemspec
 - lib/delayed-plugins-raven.rb
+- lib/delayed-plugins-raven/configuration.rb
 - lib/delayed-plugins-raven/version.rb
 - resources/looking-for-maintainer.png
 - spec/lib/delayed-plugins-raven/plugin_spec.rb