appsignal 0.11.13.beta.2 → 0.11.13.beta.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2d6b6b69b1d8d66673b8322f59914d9b0ee411e
-  data.tar.gz: 1f10620110c8acc23fb9c0bfdd6eba8e027d262e
+  metadata.gz: e82e8a2b0ee5efe8865d8bb8bef7862255e2966c
+  data.tar.gz: 2b19926295a4060b742aecd9a7bfa1bda1ab3431
 SHA512:
-  metadata.gz: 968ef086fccf1833f3f6049dc16b800c8488069252a700424bc98d03cb58164f2ebd0d4b0a11bcba7464b1d9f2af67e1482d78790886c4fa76be117068263ad0
-  data.tar.gz: 96225881c0898a7a0febb304cd0253cdf5237729c1b5e89af777ac15bf08845b9ea1c7943ad834b02e638f3810bfdfd92210f346df8a8795b6410f1b2c582502
+  metadata.gz: b4fdd6810b6997212c6eac458185efb503c505f214547541357bec9c1f5c3138ca9e1535c716594bc2eaba79c29a1c6bb3496a017b3a3066216aba6ae22a5c75
+  data.tar.gz: 014ce4f570b63b9856639378bfe3a1153d4dfcf83358ceef38ede6d5d37d29ed70acda922a73cbeb04f746d869385348665816c8017bf5e706c8fb02a2143033

data/lib/appsignal/integrations/rake.rb

@@ -3,9 +3,13 @@ module Rake
     alias_method :invoke_without_appsignal, :invoke
 
     def invoke(*args)
-      transaction = Appsignal::Transaction.create(SecureRandom.uuid, ENV)
-      transaction.set_kind('background_job')
-      transaction.set_action(name)
+      transaction = Appsignal::Transaction.create(
+        SecureRandom.uuid,
+        ENV,
+        :kind => 'background_job',
+        :action => name,
+        :params => args
+      )
 
       invoke_without_appsignal(*args)
     rescue => exception

data/lib/appsignal/transaction.rb

@@ -11,10 +11,10 @@ module Appsignal
     HTTP_CACHE_CONTROL HTTP_CONNECTION HTTP_USER_AGENT HTTP_FROM HTTP_NEGOTIATE
     HTTP_PRAGMA HTTP_REFERER HTTP_X_FORWARDED_FOR HTTP_CLIENT_IP).freeze
 
-    def self.create(request_id, env)
+    def self.create(request_id, env, defaults={})
       Appsignal.logger.debug("Creating transaction: #{request_id}")
       Thread.current[:appsignal_transaction_id] = request_id
-      Appsignal::Transaction.new(request_id, env)
+      Appsignal::Transaction.new(request_id, env, defaults)
     end
 
     def self.current
@@ -31,17 +31,20 @@ module Appsignal
     end
 
     attr_reader :request_id, :events, :process_action_event, :action, :exception,
-                :env, :fullpath, :time, :tags, :kind, :queue_start, :paused
+                :env, :fullpath, :time, :tags, :kind, :queue_start, :paused, :params
 
-    def initialize(request_id, env)
+    def initialize(request_id, env, defaults={})
       Appsignal.transactions[request_id] = self
-      @request_id = request_id
-      @events = []
+      @request_id           =  request_id
+      @events               = []
       @process_action_event = nil
-      @exception = {}
-      @env = env
-      @tags = {}
-      @paused = false
+      @exception            = {}
+      @env                  = env
+      @params               = defaults[:params] || {}
+      @tags                 = defaults[:tags] || {}
+      @kind                 = defaults[:kind] || 'web'
+      @action               = defaults[:action]
+      @paused               = false
     end
 
     def sanitized_environment
@@ -52,6 +55,10 @@ module Appsignal
       @sanitized_session_data ||= {}
     end
 
+    def sanitized_params
+      @sanitized_params ||= {}
+    end
+
     def request
       ::Rack::Request.new(@env)
     end
@@ -68,14 +75,6 @@ module Appsignal
       @paused = false
     end
 
-    def set_kind(kind)
-      @kind = kind
-    end
-
-    def set_action(action)
-      @action = action
-    end
-
     def set_process_action_event(event)
       return unless event && event.payload
       @process_action_event = event.dup
@@ -144,6 +143,7 @@ module Appsignal
       tags.clear
       sanitized_environment.clear
       sanitized_session_data.clear
+      sanitized_params.clear
       @env = nil
       @truncated = true
     end
@@ -221,6 +221,7 @@ module Appsignal
       sanitize_environment!
       sanitize_session_data! if kind == 'http_request'
       sanitize_tags!
+      sanitize_params!
       @env = nil
     end
 
@@ -236,7 +237,7 @@ module Appsignal
     end
 
     def sanitize_environment!
-      return unless env
+      return unless env && env.keys.any?
       ENV_METHODS.each do |key|
         sanitized_environment[key] = env[key]
       end
@@ -248,5 +249,10 @@ module Appsignal
       ) if Appsignal.config[:skip_session_data] == false
       @fullpath = request.fullpath
     end
+
+    def sanitize_params!
+      return unless Appsignal.config[:send_params]
+      @sanitized_params = Appsignal::ParamsSanitizer.sanitize(@params)
+    end
   end
 end

data/lib/appsignal/transaction/formatter.rb

@@ -23,16 +23,17 @@ module Appsignal
       def default_hash
         {
           :request_id => request_id,
-          :log_entry => {
-            :path => fullpath,
-            :kind => kind,
-            :action => action,
-            :time => time,
-            :environment => sanitized_environment,
+          :log_entry  => {
+            :path         => fullpath,
+            :kind         => kind,
+            :action       => action,
+            :time         => time,
+            :environment  => sanitized_environment,
             :session_data => sanitized_session_data,
-            :revision => Appsignal.agent.revision
+            :params       => sanitized_params,
+            :revision     => Appsignal.agent.revision
           },
-          :failed => exception?
+          :failed     => exception?
         }
       end
 

data/lib/appsignal/version.rb

@@ -1,3 +1,3 @@
 module Appsignal
-  VERSION = '0.11.13.beta.2'
+  VERSION = '0.11.13.beta.3'
 end

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

@@ -24,16 +24,19 @@ describe "Rack integration" do
       let!(:transaction) { Appsignal::Transaction.new('123', {}) }
       let!(:agent)       { double('Agent', :send_queue => true) }
       before do
+        SecureRandom.stub(:uuid => '123')
         Appsignal::Transaction.stub(:create => transaction)
         Appsignal.stub(:agent => agent, :active? => true)
       end
 
-      it "should set the kind" do
-        expect( transaction ).to receive(:set_kind).with('background_job')
-      end
-
-      it "should set the action" do
-        expect( transaction ).to receive(:set_action).with('task:name')
+      it "should create a transaction" do
+        expect( Appsignal::Transaction ).to receive(:create).with(
+          '123',
+          ENV,
+          :kind => 'background_job',
+          :action => 'task:name',
+          :params => ['foo']
+        )
       end
 
       it "should call the original task" do

data/spec/lib/appsignal/transaction/formatter_spec.rb

@@ -28,6 +28,7 @@ describe Appsignal::Transaction::Formatter do
           :path => "/foo",
           :session_data => {},
           :revision => nil,
+          :params => {},
           :time => 1389783600.0,
       } }
       its([:events]) { should be_nil }
@@ -58,12 +59,19 @@ describe Appsignal::Transaction::Formatter do
 
     context "with a background request without payload" do
       let(:transaction) do
-        Appsignal::Transaction.new('123', {}).tap do |transaction|
-          transaction.set_kind('web')
-          transaction.set_action('foo#bar')
-        end
+        Appsignal::Transaction.new(
+          '123',
+          {},
+          {
+            :kind   => 'web',
+            :action => 'foo#bar',
+            :params => {'foo' => 'bar'}
+          }
+        )
       end
 
+      before { transaction.send(:add_sanitized_context!) }
+
       it "should get the kind and action from the transaction" do
         subject.to_hash.should == {
           :request_id => '123',
@@ -74,7 +82,9 @@ describe Appsignal::Transaction::Formatter do
             :time         => nil,
             :environment  => {},
             :session_data => {},
-            :revision     => nil},
+            :revision     => nil,
+            :params       => {'foo' => 'bar'}
+          },
           :failed => false
         }
       end
@@ -199,6 +209,7 @@ describe Appsignal::Transaction::Formatter do
         :kind => "background_job",
         :path => "/foo",
         :session_data => {},
+        :params => {},
         :revision => nil,
         :time => 1389783600.0,
       } }

data/spec/lib/appsignal/transaction_spec.rb

@@ -189,22 +189,6 @@ describe Appsignal::Transaction do
       end
     end
 
-    describe "#set_kind" do
-      it "should set the kind" do
-        expect{
-          transaction.set_kind('web')
-        }.to change(transaction, :kind).from(nil).to('web')
-      end
-    end
-
-    describe "#set_action" do
-      it "should set the action" do
-        expect{
-          transaction.set_action('foo#bar')
-        }.to change(transaction, :action).from(nil).to('foo#bar')
-      end
-    end
-
     context "using exceptions" do
       let(:exception) do
         double(
@@ -341,7 +325,12 @@ describe Appsignal::Transaction do
 
     describe "#truncate!" do
       subject { slow_transaction }
-      before { subject.set_tags('a' => 'b') }
+      before  do
+        subject.set_tags('a' => 'b')
+        subject.sanitized_environment[:foo]  = 'bar'
+        subject.sanitized_session_data[:foo] = 'bar'
+        subject.sanitized_params[:foo]       = 'bar'
+      end
 
       it "should clear the process action payload and events" do
         subject.truncate!
@@ -349,6 +338,11 @@ describe Appsignal::Transaction do
         subject.process_action_event.payload.should be_empty
         subject.events.should be_empty
         subject.tags.should be_empty
+
+        subject.sanitized_environment.should be_empty
+        subject.sanitized_session_data.should be_empty
+        subject.sanitized_params.should be_empty
+
         subject.truncated?.should be_true
       end
 
@@ -619,6 +613,7 @@ describe Appsignal::Transaction do
           transaction.should_receive(:sanitize_environment!)
           transaction.should_receive(:sanitize_session_data!)
           transaction.should_receive(:sanitize_tags!)
+          transaction.should_receive(:sanitize_params!)
           subject
         end
       end
@@ -630,6 +625,7 @@ describe Appsignal::Transaction do
           transaction.should_receive(:sanitize_environment!)
           transaction.should_not_receive(:sanitize_session_data!)
           transaction.should_receive(:sanitize_tags!)
+          transaction.should_receive(:sanitize_params!)
           subject
         end
       end
@@ -743,5 +739,35 @@ describe Appsignal::Transaction do
         end
       end
     end
+
+    describe '#sanitize_params!' do
+      let(:params) { {:foo => 'bar'} }
+      let(:transaction) do
+        Appsignal::Transaction.create('1', {}, :params => params)
+      end
+      before  { Appsignal.config = {:send_params => true} }
+      subject { transaction.sanitized_params }
+
+      it "should call the params sanitizer and set sanitized params" do
+        Appsignal::ParamsSanitizer.should_receive(:sanitize)
+          .with(params)
+          .and_return({'foo' => 'bar'})
+
+        transaction.send(:sanitize_params!)
+
+        should == {'foo' => 'bar'}
+      end
+
+      context "when skipping session data" do
+        before { Appsignal.config = {:send_params => false} }
+
+        it "should not pass data to the params sanitizer" do
+          Appsignal::ParamsSanitizer.should_not_receive(:sanitize)
+          transaction.send(:sanitize_params!)
+
+          should == {}
+        end
+      end
+    end
   end
 end

data/spec/support/helpers/transaction_helpers.rb

@@ -82,13 +82,15 @@ module TransactionHelpers
       notification_event(:name => 'query.mongoid')
     ]
     exception = args.delete(:exception)
+    defaults = args.delete(:defaults) || {}
     Appsignal::Transaction.create(
       '1',
       {
         'HTTP_USER_AGENT' => 'IE6',
         'SERVER_NAME' => 'localhost',
         'action_dispatch.routes' => 'not_available'
-      }.merge(args)
+      }.merge(args),
+      defaults
     ).tap do |o|
       o.set_process_action_event(process_action_event)
       o.add_exception(exception)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 0.11.13.beta.2
+  version: 0.11.13.beta.3
 platform: ruby
 authors:
 - Robert Beekman
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack