appsignal 0.11.5 → 0.11.6.beta.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.11.6
+* Use `APPSIGNAL_APP_NAME` and `APPSIGNAL_ACTIVE` env vars in config
+* Better Sinatra support: Use route as action and set session data for Sinatra
+
 # 0.11.5
 * Add Sequel gem support (https://github.com/jeremyevans/sequel)
 

data/lib/appsignal.rb

@@ -194,6 +194,7 @@ require 'appsignal/config'
 require 'appsignal/marker'
 require 'appsignal/rack/listener'
 require 'appsignal/rack/instrumentation'
+require 'appsignal/rack/sinatra_instrumentation'
 require 'appsignal/params_sanitizer'
 require 'appsignal/transaction'
 require 'appsignal/transaction/formatter'

data/lib/appsignal/config.rb

@@ -27,11 +27,11 @@ module Appsignal
       if File.exists?(config_file)
         load_config_from_disk
       elsif ENV['APPSIGNAL_PUSH_API_KEY']
-        load_default_config_with_push_api_key(
+        load_default_config_with_push_api_key_and_name_from_env(
           ENV['APPSIGNAL_PUSH_API_KEY']
         )
       elsif ENV['APPSIGNAL_API_KEY']
-        load_default_config_with_push_api_key(
+        load_default_config_with_push_api_key_and_name_from_env(
           ENV['APPSIGNAL_API_KEY']
         )
         @logger.info(
@@ -46,7 +46,7 @@ module Appsignal
       end
       if config_hash && !config_hash[:name]
         @logger.debug(
-          "There's no application name set in your config file. " \
+          "There's no application name set in your config file or in the APPSIGNAL_APP_NAME env var. " \
           "You should set one unless your app runs on Heroku."
         )
       end
@@ -91,11 +91,14 @@ module Appsignal
       end
     end
 
-    def load_default_config_with_push_api_key(key)
+    def load_default_config_with_push_api_key_and_name_from_env(key)
+      # Get base config by doing the default merge and adding the push api key.
       @config_hash = merge_config(
         :push_api_key => key,
         :active => true
       )
+      @config_hash[:name]   = ENV['APPSIGNAL_APP_NAME'] if ENV['APPSIGNAL_APP_NAME']
+      @config_hash[:active] = ENV['APPSIGNAL_ACTIVE'] == 'true' if ENV['APPSIGNAL_ACTIVE']
     end
 
     def merge_config(config)

data/lib/appsignal/integrations/sinatra.rb

@@ -14,5 +14,5 @@ Appsignal.start
 
 if Appsignal.active?
   ::Sinatra::Application.use(Appsignal::Rack::Listener)
-  ::Sinatra::Application.use(Appsignal::Rack::Instrumentation)
+  ::Sinatra::Application.use(Appsignal::Rack::SinatraInstrumentation)
 end

data/lib/appsignal/rack/sinatra_instrumentation.rb

@@ -0,0 +1,36 @@
+module Appsignal
+  module Rack
+    class SinatraInstrumentation
+      def initialize(app, options = {})
+        Appsignal.logger.debug 'Initializing Appsignal::Rack::SinatraInstrumentation'
+        @app, @options = app, options
+      end
+
+      def call(env)
+        ActiveSupport::Notifications.instrument(
+          'process_action.sinatra',
+          raw_payload(env)
+        ) do |payload|
+          begin
+            @app.call(env)
+          ensure
+            # This information is available only after the
+            # request has been processed by Sinatra.
+            payload[:action] = env['sinatra.route']
+          end
+        end
+      end
+
+      def raw_payload(env)
+        request = @options.fetch(:request_class, ::Sinatra::Request).new(env)
+        params = request.public_send(@options.fetch(:params_method, :params))
+        {
+          :params  => params,
+          :session => request.session,
+          :method  => request.request_method,
+          :path    => request.path
+        }
+      end
+    end
+  end
+end

data/lib/appsignal/transaction.rb

@@ -71,7 +71,11 @@ module Appsignal
     def set_process_action_event(event)
       return unless event && event.payload
       @process_action_event = event.dup
-      @action = "#{@process_action_event.payload[:controller]}##{@process_action_event.payload[:action]}"
+      if @process_action_event.payload[:controller]
+        @action = "#{@process_action_event.payload[:controller]}##{@process_action_event.payload[:action]}"
+      else
+        @action = @process_action_event.payload[:action]
+      end
       @kind = 'http_request'
       set_http_queue_start
     end

data/lib/appsignal/version.rb

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

data/spec/lib/appsignal/config_spec.rb

@@ -123,7 +123,7 @@ describe Appsignal::Config do
 
       it "should merge with the default config, fill the config hash and log about the missing name" do
         Appsignal.logger.should_receive(:debug).with(
-          "There's no application name set in your config file. You should set one unless your app runs on Heroku."
+          "There's no application name set in your config file or in the APPSIGNAL_APP_NAME env var. You should set one unless your app runs on Heroku."
         )
 
         subject.config_hash.should == {
@@ -148,6 +148,51 @@ describe Appsignal::Config do
         end
       end
 
+      context "more config in environment" do
+        context "APPSIGNAL_APP_NAME is set" do
+          before do
+            ENV['APPSIGNAL_APP_NAME'] = 'Name from env'
+          end
+
+          it "should set the name" do
+            Appsignal.logger.should_not_receive(:debug)
+            subject[:name].should == 'Name from env'
+          end
+        end
+
+        context "APPSIGNAL_ACTIVE" do
+          context "not present" do
+            before do
+              ENV.delete('APPSIGNAL_ACTIVE')
+            end
+
+            it "should still set active to true" do
+              subject[:active].should be_true
+            end
+          end
+
+          context "true" do
+            before do
+              ENV['APPSIGNAL_ACTIVE'] = 'true'
+            end
+
+            it "should set active to true" do
+              subject[:active].should be_true
+            end
+          end
+
+          context "false" do
+            before do
+              ENV['APPSIGNAL_ACTIVE'] = 'false'
+            end
+
+            it "should set active to false" do
+              subject[:active].should be_false
+            end
+          end
+        end
+      end
+
       context "with only APPSIGNAL_API_KEY" do
         before do
           ENV.delete('APPSIGNAL_PUSH_API_KEY')

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

@@ -36,7 +36,7 @@ if defined?(::Sinatra)
 
     it "should have added the instrumentation middleware" do
       Sinatra::Application.middleware.to_a.should include(
-        [Appsignal::Rack::Instrumentation, [], nil]
+        [Appsignal::Rack::SinatraInstrumentation, [], nil]
       )
     end
   end

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

@@ -0,0 +1,97 @@
+require 'spec_helper'
+
+begin
+  require 'sinatra'
+rescue LoadError
+end
+
+if defined?(::Sinatra)
+  describe Appsignal::Rack::SinatraInstrumentation do
+    before :all do
+      start_agent
+      @events = []
+      @subscriber = ActiveSupport::Notifications.subscribe do |*args|
+        @events << ActiveSupport::Notifications::Event.new(*args)
+      end
+    end
+    after :all do
+      ActiveSupport::Notifications.unsubscribe(@subscriber)
+    end
+
+    let(:app) { double(:call => true) }
+    let(:env) { {} }
+    let(:middleware) { Appsignal::Rack::SinatraInstrumentation.new(app, {}) }
+
+    describe "#call" do
+      before do
+        middleware.stub(:raw_payload => {})
+        env['sinatra.route'] = 'GET /'
+      end
+
+      it "should instrument the call" do
+        app.should_receive(:call).with(env)
+
+        middleware.call(env)
+
+        process_action_event = @events.last
+        process_action_event.name.should == 'process_action.sinatra'
+        process_action_event.payload[:action].should == 'GET /'
+      end
+
+      it "should still set the action if there was an exception" do
+        app.should_receive(:call).with(env).and_raise('the roof')
+
+        lambda {
+          middleware.call(env)
+        }.should raise_error
+
+        process_action_event = @events.last
+        process_action_event.name.should == 'process_action.sinatra'
+        process_action_event.payload[:action].should == 'GET /'
+      end
+    end
+
+    describe "raw_payload" do
+      let(:env) do
+        {
+          'rack.input' => StringIO.new,
+          'REQUEST_METHOD' => 'GET',
+          'PATH_INFO' => '/homepage',
+          'QUERY_STRING' => 'param=something'
+        }
+      end
+      subject { middleware.raw_payload(env) }
+
+      it { should == {
+        :params => {'param' => 'something'},
+        :session => {},
+        :method => 'GET',
+        :path => '/homepage'
+      } }
+    end
+
+    describe "use a custom request class and parameters method" do
+      let(:request_class) do
+        double(
+          new: double(
+            request_method: 'POST',
+            path: '/somewhere',
+            filtered_params: {'param' => 'changed_something'}
+          )
+        )
+      end
+      let(:options) do
+        { request_class: request_class, params_method: :filtered_params }
+      end
+      let(:middleware) { Appsignal::Rack::Instrumentation.new(app, options) }
+      subject { middleware.raw_payload(env) }
+
+      it { should == {
+        :action => 'POST:/somewhere',
+        :params => {'param' => 'changed_something'},
+        :method => 'POST',
+        :path => '/somewhere'
+      } }
+    end
+  end
+end

data/spec/lib/appsignal/transaction_spec.rb

@@ -100,6 +100,18 @@ describe Appsignal::Transaction do
       it "should call set_http_queue_start" do
         transaction.queue_start.should_not be_nil
       end
+
+      context "if there is no controller" do
+        before do
+          process_action_event.payload[:action] = 'GET /items/:id'
+          process_action_event.payload.delete(:controller)
+          transaction.set_process_action_event(process_action_event)
+        end
+
+        it "should set the action without a #" do
+          transaction.action.should == 'GET /items/:id'
+        end
+      end
     end
 
     describe "set_perform_job_event" do

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 0.11.5
+  version: 0.11.6.beta.0
+  prerelease: 7
 platform: ruby
 authors:
 - Robert Beekman
@@ -12,104 +13,118 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-13 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thread_safe
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: The official appsignal.com gem
@@ -120,9 +135,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -174,6 +189,7 @@ files:
 - lib/appsignal/params_sanitizer.rb
 - lib/appsignal/rack/instrumentation.rb
 - lib/appsignal/rack/listener.rb
+- lib/appsignal/rack/sinatra_instrumentation.rb
 - lib/appsignal/transaction.rb
 - lib/appsignal/transaction/formatter.rb
 - lib/appsignal/transaction/params_sanitizer.rb
@@ -216,6 +232,7 @@ files:
 - spec/lib/appsignal/params_sanitizer_spec.rb
 - spec/lib/appsignal/rack/instrumentation_spec.rb
 - spec/lib/appsignal/rack/listener_spec.rb
+- spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb
 - spec/lib/appsignal/transaction/formatter_spec.rb
 - spec/lib/appsignal/transaction_spec.rb
 - spec/lib/appsignal/transmitter_spec.rb
@@ -236,26 +253,27 @@ files:
 homepage: https://github.com/appsignal/appsignal
 licenses:
 - MIT
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
-  - - ">="
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Logs performance and exception data from your app to appsignal.com
 test_files:
 - spec/lib/appsignal/agent_spec.rb
@@ -286,6 +304,7 @@ test_files:
 - spec/lib/appsignal/params_sanitizer_spec.rb
 - spec/lib/appsignal/rack/instrumentation_spec.rb
 - spec/lib/appsignal/rack/listener_spec.rb
+- spec/lib/appsignal/rack/sinatra_instrumentation_spec.rb
 - spec/lib/appsignal/transaction/formatter_spec.rb
 - spec/lib/appsignal/transaction_spec.rb
 - spec/lib/appsignal/transmitter_spec.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 28b9ade66f02b2901ab65933aa6eb993e32000ad
-  data.tar.gz: 1eb565d3a57c0a62c2e261728dcec8a38f55f141
-SHA512:
-  metadata.gz: 8fe9c09d3c7cb5f2fef232220a1acdd45e09a1b1691a939eba00c00de6299b3cb58c78c6be531ae3bc99d2023bab35ffbc1445cc0d1d9c91acbd79290682fe0e
-  data.tar.gz: 2b166f952ea4f0428ff5e54a4aecb7f2835aa70c19dcfc2c9c315a78a6b694e52a3f1dc9f43e09ef50658c929fd0c063fc61e60f64379c6d5c53ff3616c80db7