appsignal 1.1.5 → 1.1.6.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e253f71324a9429a7063e3a4e139a1f48a1e03ea
-  data.tar.gz: 9daaa2eeeb87b6a3dd0fea7d1da6f1164c582317
+  metadata.gz: 0ae9ee5ab79b406d2d3334b3f5b36af2b4a983a0
+  data.tar.gz: 3ffba4eac43c6f0f5d7fcdb5aaf9b7b14234041c
 SHA512:
-  metadata.gz: 6ccffc4452a64917b4e4df293f6404683954bffee9834f2ec11d1272f64784b94482cedddfa5dac615e92a0a038ebdd6f6052048ccd38ad3fafcbe3dd2b56a81
-  data.tar.gz: b83e0996d671890864422a923442d942ec281f3de711d3234407614674afe5b6f3cecd9862352b6ad13423ca0c7306c92454403418b481d32d3e26bb8b0150c7
+  metadata.gz: 3f044966b171092d94def63d5a0bfaf12941eac1ee7bece88968267050cdf0dd5c40e2cf57c21be33c2909a945cec2f80f564638619a74fc21ee828d908ef2de
+  data.tar.gz: c497ebe798b27c9dd78b379b4713cabf21891a00bd4dc5a8140b6ec3d7bf47e66b1e59d63b539a674a7cecdd72d15f7e3b31aadc18d06467e1b7e759573804ce

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.1.6
+* Generic Rack instrumentation middleware
+* Event formatter for Faraday
+* Rescue and log errors in transaction complete and fetching params
+
 # 1.1.5
 * Support for null in sql sanitization
 * Add require to deploy.rb if present on installation

data/gemfiles/capistrano3.gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'capistrano', '>= 3.0'
+gem 'capistrano', '3.4.0'
 gem 'net-ssh', '2.9.2'
 
 gemspec :path => '../'

data/lib/appsignal.rb

@@ -266,6 +266,7 @@ require 'appsignal/integrations/resque'
 require 'appsignal/subscriber'
 require 'appsignal/transaction'
 require 'appsignal/version'
+require 'appsignal/rack/generic_instrumentation'
 require 'appsignal/rack/js_exception_catcher'
 require 'appsignal/js_exception_transaction'
 require 'appsignal/transmitter'

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

@@ -0,0 +1,18 @@
+module Appsignal
+  class EventFormatter
+    module Faraday
+      class RequestFormatter < Appsignal::EventFormatter
+        register 'request.faraday'
+
+        def format(payload)
+          http_method = payload[:method].to_s.upcase
+          uri = payload[:url]
+          [
+            "#{http_method} #{uri.scheme}://#{uri.host}",
+            "#{http_method} #{uri.scheme}://#{uri.host}#{uri.path}"
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/rack/generic_instrumentation.rb

@@ -0,0 +1,47 @@
+require 'rack'
+
+module Appsignal
+  module Rack
+    class GenericInstrumentation
+      def initialize(app, options = {})
+        Appsignal.logger.debug 'Initializing Appsignal::Rack::GenericInstrumentation'
+        @app, @options = app, options
+      end
+
+      def call(env)
+        if Appsignal.active?
+          call_with_appsignal_monitoring(env)
+        else
+          @app.call(env)
+        end
+      end
+
+      def call_with_appsignal_monitoring(env)
+        request = ::Rack::Request.new(env)
+        transaction = Appsignal::Transaction.create(
+          SecureRandom.uuid,
+          Appsignal::Transaction::HTTP_REQUEST,
+          request
+        )
+        begin
+          ActiveSupport::Notifications.instrument('process_action.generic') do
+            @app.call(env)
+          end
+        rescue => error
+          transaction.set_error(error)
+          raise error
+        ensure
+          if env['appsignal.route']
+            transaction.set_action(env['appsignal.route'])
+          else
+            transaction.set_action('unknown')
+          end
+          transaction.set_metadata('path', request.path)
+          transaction.set_metadata('method', request.request_method)
+          transaction.set_http_or_background_queue_start
+          Appsignal::Transaction.complete_current!
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/transaction.rb

@@ -19,15 +19,13 @@ module Appsignal
       def create(id, namespace, request, options={})
         # Check if we already have a running transaction
         if Thread.current[:appsignal_transaction] != nil
-
           # Log the issue and return the current transaction
           Appsignal.logger.debug("Trying to start new transaction #{id} but #{current.transaction_id} is already running. Using #{current.transaction_id}")
 
           # Return the current (running) transaction
           current
-
-        # Otherwise, start a new transaction
         else
+          # Otherwise, start a new transaction
           Thread.current[:appsignal_transaction] = Appsignal::Transaction.new(id, namespace, request, options)
         end
       end
@@ -38,6 +36,9 @@ module Appsignal
 
       def complete_current!
         current.complete
+      rescue Exception => e
+        Appsignal.logger.error("Failed to complete transaction ##{current.transaction_id}. #{e.message}")
+      ensure
         Thread.current[:appsignal_transaction] = nil
       end
     end
@@ -201,7 +202,13 @@ module Appsignal
     def sanitized_params
       return unless Appsignal.config[:send_params]
       return unless request.respond_to?(options[:params_method])
-      return unless params = request.send(options[:params_method])
+      begin
+        return unless params = request.send(options[:params_method])
+      rescue Exception => ex
+        # Getting params from the request has been know to fail.
+        Appsignal.logger.debug "Exception while getting params: #{ex}"
+        return
+      end
       if params.is_a?(Hash)
         Appsignal::ParamsSanitizer.sanitize(params)
       elsif params.is_a?(Array)

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 require 'yaml'
 
 module Appsignal
-  VERSION = '1.1.5'
+  VERSION = '1.1.6.beta.1'
 end

data/spec/lib/appsignal/event_formatter/faraday/request_formatter_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Appsignal::EventFormatter::Faraday::RequestFormatter do
+  let(:klass)     { Appsignal::EventFormatter::Faraday::RequestFormatter }
+  let(:formatter) { klass.new }
+
+  it "should register request.faraday" do
+    Appsignal::EventFormatter.registered?('request.faraday', klass).should be_true
+  end
+
+  describe "#format" do
+    let(:payload) do
+      {
+        method: :get,
+        url: URI.parse("http://example.org/hello/world?some=param")
+      }
+    end
+
+    subject { formatter.format(payload) }
+
+    it { should == ['GET http://example.org', 'GET http://example.org/hello/world'] }
+  end
+end

data/spec/lib/appsignal/rack/generic_instrumentation_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Appsignal::Rack::GenericInstrumentation do
+  before :all do
+    start_agent
+  end
+
+  let(:app) { double(:call => true) }
+  let(:env) { {:path => '/', :method => 'GET'} }
+  let(:options) { {} }
+  let(:middleware) { Appsignal::Rack::GenericInstrumentation.new(app, options) }
+
+  describe "#call" do
+    before do
+      middleware.stub(:raw_payload => {})
+    end
+
+    context "when appsignal is active" do
+      before { Appsignal.stub(:active? => true) }
+
+      it "should call with monitoring" do
+        expect( middleware ).to receive(:call_with_appsignal_monitoring).with(env)
+      end
+    end
+
+    context "when appsignal is not active" do
+      before { Appsignal.stub(:active? => false) }
+
+      it "should not call with monitoring" do
+        expect( middleware ).to_not receive(:call_with_appsignal_monitoring)
+      end
+
+      it "should call the stack" do
+        expect( app ).to receive(:call).with(env)
+      end
+    end
+
+    after { middleware.call(env) }
+  end
+
+  describe "#call_with_appsignal_monitoring" do
+    it "should create a transaction" do
+      Appsignal::Transaction.should_receive(:create).with(
+        kind_of(String),
+        Appsignal::Transaction::HTTP_REQUEST,
+        kind_of(Rack::Request)
+      ).and_return(double(:set_action => nil, :set_http_or_background_queue_start => nil, :set_metadata => nil))
+    end
+
+    it "should call the app" do
+      app.should_receive(:call).with(env)
+    end
+
+    context "with an error" do
+      let(:error) { VerySpecificError.new }
+      let(:app) do
+        double.tap do |d|
+          d.stub(:call).and_raise(error)
+        end
+      end
+
+      it "should set the error" do
+        Appsignal::Transaction.any_instance.should_receive(:set_error).with(error)
+      end
+    end
+
+    it "should set the action to unknown" do
+      Appsignal::Transaction.any_instance.should_receive(:set_action).with('unknown')
+    end
+
+    context "with a route specified in the env" do
+      before do
+        env['appsignal.route'] = 'GET /'
+      end
+
+      it "should set the action" do
+        Appsignal::Transaction.any_instance.should_receive(:set_action).with('GET /')
+      end
+    end
+
+    it "should set metadata" do
+      Appsignal::Transaction.any_instance.should_receive(:set_metadata).twice
+    end
+
+    it "should set the queue start" do
+      Appsignal::Transaction.any_instance.should_receive(:set_http_or_background_queue_start)
+    end
+
+    after { middleware.call(env) rescue VerySpecificError }
+  end
+end

data/spec/lib/appsignal/transaction_spec.rb

@@ -102,6 +102,14 @@ describe Appsignal::Transaction do
 
         Thread.current[:appsignal_transaction].should be_nil
       end
+
+      it "should still clear the transaction if there is an error" do
+        Appsignal::Extension.should_receive(:finish_transaction).with(kind_of(Integer)).and_raise 'Error'
+
+        Appsignal::Transaction.complete_current!
+
+        Thread.current[:appsignal_transaction].should be_nil
+      end
     end
   end
 
@@ -532,6 +540,12 @@ describe Appsignal::Transaction do
         it { should be_nil }
       end
 
+      context "when params crashes" do
+        before { transaction.request.stub(:params).and_raise(NoMethodError) }
+
+        it { should be_nil }
+      end
+
       context "when not sending params" do
         before { Appsignal.config.config_hash[:send_params] = false }
         after { Appsignal.config.config_hash[:send_params] = true }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 1.1.5
+  version: 1.1.6.beta.1
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-18 00:00:00.000000000 Z
+date: 2016-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -159,6 +159,7 @@ files:
 - lib/appsignal/event_formatter/active_record/instantiation_formatter.rb
 - lib/appsignal/event_formatter/active_record/sql_formatter.rb
 - lib/appsignal/event_formatter/elastic_search/search_formatter.rb
+- lib/appsignal/event_formatter/faraday/request_formatter.rb
 - lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter.rb
 - lib/appsignal/event_formatter/moped/query_formatter.rb
 - lib/appsignal/event_formatter/net_http/request_formatter.rb
@@ -189,6 +190,7 @@ files:
 - lib/appsignal/js_exception_transaction.rb
 - lib/appsignal/marker.rb
 - lib/appsignal/params_sanitizer.rb
+- lib/appsignal/rack/generic_instrumentation.rb
 - lib/appsignal/rack/js_exception_catcher.rb
 - lib/appsignal/rack/rails_instrumentation.rb
 - lib/appsignal/rack/sinatra_instrumentation.rb
@@ -219,6 +221,7 @@ files:
 - spec/lib/appsignal/event_formatter/active_record/instantiation_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/sql_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/elastic_search/search_formatter_spec.rb
+- spec/lib/appsignal/event_formatter/faraday/request_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/moped/query_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/net_http/request_formatter_spec.rb
@@ -246,6 +249,7 @@ files:
 - spec/lib/appsignal/js_exception_transaction_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/params_sanitizer_spec.rb
+- spec/lib/appsignal/rack/generic_instrumentation_spec.rb
 - spec/lib/appsignal/rack/js_exception_catcher_spec.rb
 - spec/lib/appsignal/rack/rails_instrumentation_spec.rb
 - spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb
@@ -291,9 +295,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -313,6 +317,7 @@ test_files:
 - spec/lib/appsignal/event_formatter/active_record/instantiation_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/active_record/sql_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/elastic_search/search_formatter_spec.rb
+- spec/lib/appsignal/event_formatter/faraday/request_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/moped/query_formatter_spec.rb
 - spec/lib/appsignal/event_formatter/net_http/request_formatter_spec.rb
@@ -340,6 +345,7 @@ test_files:
 - spec/lib/appsignal/js_exception_transaction_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/params_sanitizer_spec.rb
+- spec/lib/appsignal/rack/generic_instrumentation_spec.rb
 - spec/lib/appsignal/rack/js_exception_catcher_spec.rb
 - spec/lib/appsignal/rack/rails_instrumentation_spec.rb
 - spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb