appsignal 0.11.8.beta.0 → 0.11.8.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69c0fe4aba981d664f4b5a320c2cf47816ae4598
-  data.tar.gz: 546e20aa73e171ca1183c4cba04beed672ced563
+  metadata.gz: d352412d00bbd2c1cf81315d80ae4a5c08d8115e
+  data.tar.gz: df2cda49d433880e1c89b5c42c1c12cf1abb65bd
 SHA512:
-  metadata.gz: dba3ef8508c2b43ef0456f926397ae29cd34a0b454de79cf3cf10e853386a2bfb90fb2d1e60ef21f9ffcf8e56c9425f6ede6669436430b35e2fb95936851be8c
-  data.tar.gz: 26d06743732e417cd38ddf55372f25f80be96f38d55ed5719c3740b746a32cc0579e5f399e75b1b9d31a62564a31d643778ca8a0ff8ddc02ba7142c582762cb8
+  metadata.gz: 8347c842bde632030871bbe90392115a744d1676d1afc98c9f796987b587be7ce5d8c56a742019dd004b1f8b580fc05a9250e2b59ed099ef555d6e31052b1deb
+  data.tar.gz: cda5f26ebd0b612f46feca9952f1e420c6370e89e9682e8879e91f1250e9d47edcee7ff61e2cd5b11f6c2e0b08ae1a063451e92e008f1bc4cc10e1d006ec48ca

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 # 0.11.8
 * Add frontend error catcher
+* Add background job metadata (queue, priority etc.) to transaction overview
+* Add APPSIGNAL_APP_ENV variable to Rails config, so you can override the environment
 
 # 0.11.7
 * Add option to override Job name in Delayed Job

data/lib/appsignal/integrations/delayed_job.rb

@@ -22,9 +22,11 @@ if defined?(::Delayed::Plugin)
             'perform_job.delayed_job',
             :class => class_name,
             :method => method_name,
-            :priority => job.priority,
-            :attempts => job.attempts,
-            :queue => job.queue,
+            :metadata => {
+              :priority => job.priority,
+              :attempts => job.attempts,
+              :queue    => job.queue,
+            },
             :queue_start => job.created_at
           ) do
             block.call(job)

data/lib/appsignal/integrations/rails.rb

@@ -22,7 +22,7 @@ if defined?(::Rails)
           # Load config
           Appsignal.config = Appsignal::Config.new(
             Rails.root,
-            Rails.env,
+            ENV.fetch('APPSIGNAL_APP_ENV', Rails.env),
             :name => Rails.application.class.parent_name
           )
 

data/lib/appsignal/integrations/sidekiq.rb

@@ -4,18 +4,52 @@ if defined?(::Sidekiq)
   module Appsignal
     module Integrations
       class SidekiqPlugin
+        def job_keys
+          @job_keys ||= Set.new(%w(
+            class args retried_at failed_at
+            error_message error_class backtrace
+            error_backtrace enqueued_at retry
+          ))
+        end
+
         def call(worker, item, queue)
           Appsignal.monitor_transaction(
             'perform_job.sidekiq',
-            :class => item['class'],
-            :method => 'perform',
-            :attempts => item['retry_count'],
-            :queue => item['queue'],
+            :class       => item['class'],
+            :method      => 'perform',
+            :metadata    => formatted_metadata(item),
+            :params      => format_args(item['args']),
             :queue_start => item['enqueued_at']
           ) do
             yield
           end
         end
+
+        def formatted_metadata(item)
+          {}.tap do |hsh|
+            item.each do |key, val|
+              hsh[key] = truncate(string_or_inspect(val)) unless job_keys.include?(key)
+            end
+          end
+        end
+
+        def string_or_inspect(string_or_other)
+          if string_or_other.is_a?(String)
+            string_or_other
+          else
+            string_or_other.inspect
+          end
+        end
+
+        def format_args(args)
+          args.map do |arg|
+            truncate(string_or_inspect(arg))
+          end
+        end
+
+        def truncate(text)
+          text.size > 100 ? "#{text[0...97]}..." : text
+        end
       end
     end
   end

data/lib/appsignal/version.rb

@@ -1,3 +1,3 @@
 module Appsignal
-  VERSION = '0.11.8.beta.0'
+  VERSION = '0.11.8.beta.1'
 end

data/spec/lib/appsignal/integrations/delayed_job_spec.rb

@@ -30,11 +30,11 @@ describe "Delayed Job integration" do
       let(:time) { Time.parse('01-01-2001 10:01:00UTC') }
       let(:job) do
         double(
-          :name => 'TestClass#perform',
-          :priority => 1,
-          :attempts => 1,
-          :queue => 'default',
-          :created_at => time - 60_000,
+          :name           => 'TestClass#perform',
+          :priority       => 1,
+          :attempts       => 1,
+          :queue          => 'default',
+          :created_at     => time - 60_000,
           :payload_object => double
         )
       end
@@ -45,11 +45,13 @@ describe "Delayed Job integration" do
         it "should wrap in a transaction with the correct params" do
           Appsignal.should_receive(:monitor_transaction).with(
             'perform_job.delayed_job',
-            :class => 'TestClass',
-            :method => 'perform',
-            :priority => 1,
-            :attempts => 1,
-            :queue => 'default',
+            :class    => 'TestClass',
+            :method   => 'perform',
+            :metadata => {
+              :priority => 1,
+              :attempts => 1,
+              :queue    => 'default',
+            },
             :queue_start => time - 60_000,
           )
 
@@ -67,7 +69,7 @@ describe "Delayed Job integration" do
               :name => 'TestClass#perform',
               :priority => 1,
               :attempts => 1,
-              :queue => 'default',
+              :queue    => 'default',
               :created_at => time - 60_000
             )
           end
@@ -76,9 +78,11 @@ describe "Delayed Job integration" do
               'perform_job.delayed_job',
               :class => 'CustomClass',
               :method => 'perform',
-              :priority => 1,
-              :attempts => 1,
-              :queue => 'default',
+              :metadata => {
+                :priority => 1,
+                :attempts => 1,
+                :queue    => 'default',
+              },
               :queue_start => time - 60_000
             )
 

data/spec/lib/appsignal/integrations/rails_spec.rb

@@ -20,8 +20,8 @@ if rails_present?
         it { should be_a(Appsignal::Config) }
 
         its(:root_path) { should == Pathname.new(project_fixture_path) }
-        its(:env) { should == 'test' }
-        its([:name]) { should == 'TestApp' }
+        its(:env)       { should == 'test' }
+        its([:name])    { should == 'TestApp' }
 
         context "initial config" do
           subject { Appsignal.config.initial_config }
@@ -48,5 +48,21 @@ if rails_present?
         MyApp::Application.middleware.to_a.should_not include Appsignal::Rack::Instrumentation
       end
     end
+
+    context "with APPSIGNAL_APP_ENV ENV var set" do
+      around do |sample|
+        ENV['APPSIGNAL_APP_ENV'] = 'env_test'
+
+        MyEnvApp::Application.config.root = project_fixture_path
+        MyEnvApp::Application.initialize!
+
+        sample.run
+
+        ENV.delete('APPSIGNAL_APP_ENV')
+      end
+      subject { Appsignal.config }
+
+      its(:env) { should == 'env_test' }
+    end
   end
 end

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

@@ -17,11 +17,14 @@ describe "Sidekiq integration" do
   let(:queue) { double }
   let(:current_transaction) { Appsignal::Transaction.create(SecureRandom.uuid, {}) }
   let(:item) {{
-    'class' => 'TestClass',
+    'class'       => 'TestClass',
     'retry_count' => 0,
-    'queue' => 'default',
-    'enqueued_at' => Time.parse('01-01-2001 10:00:00UTC')
+    'queue'       => 'default',
+    'enqueued_at' => Time.parse('01-01-2001 10:00:00UTC'),
+    'args'        => ['Model', 1],
+    'extra'       => 'data'
   }}
+  let(:plugin) { Appsignal::Integrations::SidekiqPlugin.new }
 
   before do
     Appsignal.stub(:is_ignored_exception? => false)
@@ -32,10 +35,14 @@ describe "Sidekiq integration" do
     it "should wrap in a transaction with the correct params" do
       Appsignal.should_receive(:monitor_transaction).with(
         'perform_job.sidekiq',
-        :class => 'TestClass',
-        :method => 'perform',
-        :attempts => 0,
-        :queue => 'default',
+        :class    => 'TestClass',
+        :method   => 'perform',
+        :metadata => {
+          'retry_count' => "0",
+          'queue'       => 'default',
+          'extra'       => 'data'
+        },
+        :params      => ['Model', "1"],
         :queue_start => Time.parse('01-01-2001 10:00:00UTC')
       )
     end
@@ -67,6 +74,67 @@ describe "Sidekiq integration" do
     end
   end
 
+  describe "#formatted_data" do
+    let(:item) do
+      {
+        'foo'   => 'bar',
+        'class' => 'TestClass',
+      }
+    end
+
+    it "should only add items to the hash that do not appear in JOB_KEYS" do
+      plugin.formatted_metadata(item).should == {'foo' => 'bar'}
+    end
+  end
+
+  describe "#format_args" do
+    let(:object) { Object.new }
+    let(:args) do
+      [
+        'Model',
+        1,
+        object
+      ]
+    end
+
+    it "should format the arguments" do
+      plugin.format_args(args).should == ['Model', '1', object.inspect]
+    end
+  end
+
+  describe "#truncate" do
+    let(:very_long_text) do
+      "a" * 200
+    end
+
+    it "should truncate the text to 100 chars max" do
+      plugin.truncate(very_long_text).should == "#{'a' * 97}..."
+    end
+  end
+
+  describe "#string_or_inspect" do
+    context "when string" do
+      it "should return the string" do
+        plugin.string_or_inspect('foo').should == 'foo'
+      end
+    end
+
+    context "when integer" do
+      it "should return the string" do
+        plugin.string_or_inspect(1).should == '1'
+      end
+    end
+
+    context "when object" do
+      let(:object) { Object.new }
+
+      it "should return the string" do
+        plugin.string_or_inspect(object).should == object.inspect
+      end
+    end
+
+  end
+
   context "without sidekiq" do
     before(:all) { Object.send(:remove_const, :Sidekiq) }
 

data/spec/support/rails/my_app.rb

@@ -4,3 +4,10 @@ module MyApp
     config.eager_load = false
   end
 end
+
+module MyEnvApp
+  class Application < Rails::Application
+    config.active_support.deprecation = proc { |message, stack| }
+    config.eager_load = false
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 0.11.8.beta.0
+  version: 0.11.8.beta.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-03 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack