appsignal 0.6.3.beta.2 → 0.6.3.beta.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTIwYTY1MmE4MzdlYTk3ZDA1NzBhOWQzNGNiNWZjYjBlZWYwNmY3MQ==
+    MjhhMGUxYTk4NTgyYmUyZTlhNmU5OTQ5YTA5YjI1MjI1NmRiZjFkZA==
   data.tar.gz: !binary |-
-    ZmMzNzg2YTA1MTg4Mjc5ZDcwMGU5MGJiN2JkYjI1MmFlMjNjNDhhNA==
+    MzdkMmI2NDJhNTU4NDliZWJjYmQwNTQ3NGZkYWRkZTFhZmIzYjdiMQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MjZmMjcwNWQ0MGY1MGRhMjU3ZTllYzk3YzFmMTc4OWMzMDMxNjE1ZDAyYTky
-    MDhhYmNhNTgyMmFkMWY3YTYwMzU0M2QwYTU4OTlkOTQ1MjA4MTc5MDYyMGE4
-    NjIxNzNkMWM5ZGNmMDgwNzNlYzBiZTY2NWIxODE3NzU1MTJmYmY=
+    YzRkMWNhMjFlNzEzNjZlZTFjYTU5YWI0NmZhM2ViMDllZjg2Y2NkOWMwZmFm
+    M2VlYTExYjJjY2E3ZTFkYjJjMjg5ZjMyMGQ4NGIwZWYwNjliNTE0MTNjZGI2
+    NDE2OTRmMDE2ZTBlOGQ4MWIyNjgyMWM0MzVlMjgzNzI5MGI4ZDg=
   data.tar.gz: !binary |-
-    M2VhMjFkNzQyNDBhODlmYjk3ZDRiYWVlMTMwNTU5OGViNjk2MGE3OTU0MzA3
-    MTA4YzU2OWFlMjc2YWZjNDc5Y2Q3OTE2ZDViYWE5NWU0NTJkNmQ4Y2RkNDc5
-    Mzc3MDU4MjFmOGYxNzgxZmJlMzY5ODcxMGYxMjQ5MGEzY2Y1ZTA=
+    ZDJkZWM1MTc5OTA3MjZhZjFjZjMzOTMxZWM2NTIyYWI1NDAyYzZlODZiMzJh
+    ZjY0ODg1MDEwZTllYzA2MzFjZTg1NGUwMTUyOGQxNTNiNDEyMmE5MTNkNzQw
+    MDk3MWEwN2Y1ZjNlMjZjMGM3MjQ1ZTg1YWMwNGNlOGE5MTEwNWE=

data/CHANGELOG.md

@@ -1,6 +1,7 @@
 # 0.6.3
 * Use a mutex around access to the aggregator
 * Bugfix for accessing connection config in Rails 3.0
+* Add Appsignal.tag_request
 
 # 0.6.2
 * Bugfix in backtrace cleaner usage for Rails 4

data/lib/appsignal.rb

@@ -32,14 +32,18 @@ module Appsignal
         env = ENV.to_hash
 
         transaction = Appsignal::Transaction.create(SecureRandom.uuid, env)
-        transaction.add_exception(
-          Appsignal::ExceptionNotification.new(env, exception, false)
-        )
+        transaction.add_exception(exception)
         transaction.complete!
         Appsignal.agent.send_queue
       end
     end
 
+    def tag_request(params={})
+      transaction = Appsignal::Transaction.current
+      return false unless transaction
+      transaction.set_tags(params)
+    end
+
     def transactions
       @transactions ||= {}
     end
@@ -93,7 +97,6 @@ require 'appsignal/agent'
 require 'appsignal/aggregator'
 require 'appsignal/auth_check'
 require 'appsignal/config'
-require 'appsignal/exception_notification'
 require 'appsignal/integrations/passenger'
 require 'appsignal/listener'
 require 'appsignal/marker'

data/lib/appsignal/listener.rb

@@ -11,9 +11,7 @@ module Appsignal
       @app.call(env)
     rescue Exception => exception
       unless Appsignal.is_ignored_exception?(exception)
-        Appsignal::Transaction.current.add_exception(
-          Appsignal::ExceptionNotification.new(env, exception)
-        )
+        Appsignal::Transaction.current.add_exception(exception)
       end
       raise exception
     ensure

data/lib/appsignal/railtie.rb

@@ -1,6 +1,5 @@
 module Appsignal
   class Railtie < Rails::Railtie
-
     initializer "appsignal.configure_rails_initialization" do |app|
       # Some apps when run from the console do not have Rails.root set, there's
       # currently no way to spec this.

data/lib/appsignal/transaction.rb

@@ -25,7 +25,7 @@ module Appsignal
     end
 
     attr_reader :request_id, :events, :process_action_event, :action, :exception,
-      :env, :fullpath, :time
+      :env, :fullpath, :time, :tags
 
     def initialize(request_id, env)
       @request_id = request_id
@@ -33,6 +33,7 @@ module Appsignal
       @process_action_event = nil
       @exception = nil
       @env = env
+      @tags = {}
     end
 
     def sanitized_environment
@@ -47,6 +48,10 @@ module Appsignal
       ActionDispatch::Request.new(@env)
     end
 
+    def set_tags(given_tags={})
+      @tags.merge!(given_tags)
+    end
+
     def set_process_action_event(event)
       @process_action_event = event
       if event && event.payload
@@ -80,6 +85,7 @@ module Appsignal
     def truncate!
       process_action_event.payload.clear
       events.clear
+      tags.clear
       sanitized_environment.clear
       sanitized_session_data.clear
       @env = nil
@@ -114,9 +120,21 @@ module Appsignal
     def add_sanitized_context!
       sanitize_environment!
       sanitize_session_data!
+      sanitize_tags!
       @env = nil
     end
 
+    # Only keep tags if they meet the following criteria:
+    # * Key is a symbol or string with less then 100 chars
+    # * Value is a symbol or string with less then 100 chars
+    # * Value is an integer
+    def sanitize_tags!
+      @tags.keep_if do |k,v|
+        (k.is_a?(Symbol) || k.is_a?(String) && k.length <= 100) &&
+        (((v.is_a?(Symbol) || v.is_a?(String)) && v.length <= 100) || (v.is_a?(Integer)))
+      end
+    end
+
     def sanitize_environment!
       env.each do |key, value|
         sanitized_environment[key] = value if ENV_METHODS.include?(key)

data/lib/appsignal/transaction/transaction_formatter.rb

@@ -13,7 +13,10 @@ module Appsignal
 
     def to_hash
       merge_process_action_event_with_log_entry! if process_action_event
-      add_exception_to_hash! if exception?
+      if exception?
+        add_exception_to_hash!
+        add_tags_to_hash!
+      end
       add_events_to_hash! if slow_request?
       hash
     end
@@ -43,11 +46,15 @@ module Appsignal
       end
     end
 
+    def add_tags_to_hash!
+      hash[:log_entry][:tags] = tags
+    end
+
     def add_exception_to_hash!
       hash[:exception] = {
-        :backtrace => exception.backtrace,
-        :exception => exception.name,
-        :message => exception.message
+        :exception => exception.class.name,
+        :message => exception.message,
+        :backtrace => Rails.backtrace_cleaner.clean(exception.backtrace, nil)
       }
     end
 

data/lib/appsignal/version.rb

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

data/spec/appsignal/listener_spec.rb

@@ -40,7 +40,6 @@ describe Appsignal::Listener do
       end
 
       it 'should catch the exception and notify the transaction of it' do
-        Appsignal::ExceptionNotification.should_receive(:new)
         current.should_receive(:add_exception)
         middleware.call(env) rescue nil
       end
@@ -55,7 +54,6 @@ describe Appsignal::Listener do
         end
 
         it 'should ignore the error' do
-          Appsignal::ExceptionNotification.should_not_receive(:new)
           current.should_not_receive(:add_exception)
           middleware.call(env) rescue nil
         end

data/spec/appsignal/transaction/transaction_formatter_spec.rb

@@ -40,13 +40,22 @@ describe Appsignal::TransactionFormatter do
       its([:request_id]) { should == '1' }
       its([:failed]) { should be_true }
 
+      context "log_entry content" do
+        subject { formatter.hash[:log_entry] }
+
+        its([:tags]) { should == {'user_id' => 123} }
+      end
+
       context "exception content" do
         subject { formatter.hash[:exception] }
 
-        its(:keys) { should =~ [:backtrace, :exception, :message] }
-        its([:backtrace]) { should be_instance_of Array }
+        its(:keys) { should =~ [:exception, :message, :backtrace] }
         its([:exception]) { should == 'ArgumentError' }
         its([:message]) { should == 'oh no' }
+        its([:backtrace]) { should == [
+          'app/controllers/somethings_controller.rb:10',
+          '/user/local/ruby/path.rb:8'
+        ] }
       end
     end
 

data/spec/appsignal/transaction_spec.rb

@@ -48,6 +48,14 @@ describe Appsignal::Transaction do
       end
     end
 
+    describe "#set_tags" do
+      it "should add tags to transaction" do
+        expect {
+          transaction.set_tags({'a' => 'b'})
+        }.to change(transaction, :tags).to({'a' => 'b'})
+      end
+    end
+
     describe '#add_event' do
       let(:event) { double(:event, :name => 'test') }
 
@@ -141,12 +149,14 @@ describe Appsignal::Transaction do
 
     describe "#truncate!" do
       subject { slow_transaction }
+      before { subject.set_tags('a' => 'b') }
 
       it "should clear the process action payload and events" do
         subject.truncate!
 
         subject.process_action_event.payload.should be_empty
         subject.events.should be_empty
+        subject.tags.should be_empty
       end
     end
 
@@ -280,6 +290,7 @@ describe Appsignal::Transaction do
       it "delegates to sanitize_environment! and sanitize_session_data!" do
         transaction.should_receive(:sanitize_environment!)
         transaction.should_receive(:sanitize_session_data!)
+        transaction.should_receive(:sanitize_tags!)
         subject
       end
 
@@ -301,6 +312,36 @@ describe Appsignal::Transaction do
       its(:keys) { should =~ whitelisted_keys }
     end
 
+    describe '#sanitize_tags!' do
+      let(:transaction) { Appsignal::Transaction.create('1', {}) }
+      before do
+        transaction.set_tags(
+          {
+            :valid_key => 'valid_value',
+            'valid_string_key' => 'valid_value',
+            :both_symbols => :valid_value,
+            :integer_value => 1,
+            :hash_value => {'invalid' => 'hash'},
+            :array_value => ['invalid', 'array'],
+            :to_long_value => SecureRandom.urlsafe_base64(101),
+            :object => Object.new,
+            SecureRandom.urlsafe_base64(101) => 'to_long_key'
+          }
+        )
+        transaction.send(:sanitize_tags!)
+      end
+      subject { transaction.tags.keys }
+
+      it "should only return whitelisted data" do
+        should =~ [
+          :valid_key,
+          'valid_string_key',
+          :both_symbols,
+          :integer_value
+        ]
+      end
+    end
+
     describe '#sanitize_session_data!' do
       subject { transaction.send(:sanitize_session_data!) }
       before do
@@ -334,7 +375,6 @@ describe Appsignal::Transaction do
             subject
           end
 
-
           def action_dispatch_session
             store = Class.new {
               def load_session(env); [1, {:foo => :bar}]; end

data/spec/appsignal_spec.rb

@@ -14,6 +14,28 @@ describe Appsignal do
     end
   end
 
+  describe ".tag_request" do
+    before { Appsignal::Transaction.stub(:current => transaction) }
+
+    context "with transaction" do
+      let(:transaction) { double }
+
+      it "should call set_tags on transaction" do
+        transaction.should_receive(:set_tags).with({'a' => 'b'})
+      end
+
+      after { Appsignal.tag_request({'a' => 'b'}) }
+    end
+
+    context "without transaction" do
+      let(:transaction) { nil }
+
+      it "should call set_tags on transaction" do
+        Appsignal.tag_request.should be_false
+      end
+    end
+  end
+
   describe ".transactions" do
     subject { Appsignal.transactions }
 

data/spec/support/helpers/transaction_helpers.rb

@@ -6,13 +6,15 @@ module TransactionHelpers
 
   def transaction_with_exception
     appsignal_transaction.tap do |o|
+      o.set_tags('user_id' => 123)
       begin
         raise ArgumentError, 'oh no'
       rescue ArgumentError => exception
-        env = {}
-        o.add_exception(
-          Appsignal::ExceptionNotification.new(env, exception)
-        )
+        exception.stub(:backtrace => [
+          Rails.root.join('app/controllers/somethings_controller.rb:10').to_s,
+          '/user/local/ruby/path.rb:8'
+        ])
+        o.add_exception(exception)
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 0.6.3.beta.2
+  version: 0.6.3.beta.3
 platform: ruby
 authors:
 - Robert Beekman
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -144,7 +144,6 @@ files:
 - lib/appsignal/careful_logger.rb
 - lib/appsignal/cli.rb
 - lib/appsignal/config.rb
-- lib/appsignal/exception_notification.rb
 - lib/appsignal/integrations/passenger.rb
 - lib/appsignal/listener.rb
 - lib/appsignal/marker.rb
@@ -172,7 +171,6 @@ files:
 - spec/appsignal/capistrano_spec.rb
 - spec/appsignal/cli_spec.rb
 - spec/appsignal/config_spec.rb
-- spec/appsignal/exception_notification_spec.rb
 - spec/appsignal/inactive_railtie_spec.rb
 - spec/appsignal/integrations/passenger_spec.rb
 - spec/appsignal/listener_spec.rb
@@ -224,7 +222,6 @@ test_files:
 - spec/appsignal/capistrano_spec.rb
 - spec/appsignal/cli_spec.rb
 - spec/appsignal/config_spec.rb
-- spec/appsignal/exception_notification_spec.rb
 - spec/appsignal/inactive_railtie_spec.rb
 - spec/appsignal/integrations/passenger_spec.rb
 - spec/appsignal/listener_spec.rb

data/lib/appsignal/exception_notification.rb

@@ -1,28 +0,0 @@
-module Appsignal
-  class MissingController
-    def method_missing(*args, &block)
-    end
-  end
-
-  class ExceptionNotification
-    attr_reader :env, :exception, :backtrace
-
-    def initialize(env, exception, run_rails_cleaner=true)
-      @env = env
-      @exception = exception
-      if run_rails_cleaner && Rails.respond_to?(:backtrace_cleaner)
-        @backtrace = Rails.backtrace_cleaner.clean(@exception.backtrace, nil)
-      else
-        @backtrace = @exception.backtrace
-      end
-    end
-
-    def name
-      @exception.class.name
-    end
-
-    def message
-      @exception.message
-    end
-  end
-end

data/spec/appsignal/exception_notification_spec.rb

@@ -1,38 +0,0 @@
-require 'spec_helper'
-
-describe Appsignal::ExceptionNotification do
-  let(:error) { StandardError.new('moo') }
-  let(:notification) { Appsignal::ExceptionNotification.new({}, error, false) }
-  subject { notification }
-  before do
-    Rails.stub(:root => '/home/app/current')
-  end
-
-  its(:env) { should == {} }
-  its(:exception) { should == error }
-  its(:name) { should == 'StandardError' }
-  its(:message) { should == 'moo' }
-
-  context "backtrace" do
-    let(:backtrace) do
-      [
-        '/home/app/current/app/controllers/somethings_controller.rb:10',
-        '/user/local/ruby/path.rb:8'
-      ]
-    end
-    before { error.stub(:backtrace => backtrace) }
-
-    subject { notification.backtrace }
-
-    it { should == backtrace }
-
-    context "when running the backtrace cleaner" do
-      let(:notification) { Appsignal::ExceptionNotification.new({}, error) }
-
-      it { should == [
-        'app/controllers/somethings_controller.rb:10',
-        '/user/local/ruby/path.rb:8'
-      ] }
-    end
-  end
-end