appsignal 0.12.beta.38 → 0.12.beta.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62bbe2d18782692068b5abff78db393694d683c1
-  data.tar.gz: 8974650b3583fd691f682b1f4dee0fd3ce041366
+  metadata.gz: 7a7a0812a006296451ced17e5caf4ed0dcc24b66
+  data.tar.gz: 9cf99ae0382bcb236f48b10c0b3c087ee31951b7
 SHA512:
-  metadata.gz: 4990d91ff2025d7b01e1ce9a15a3a0fb0ad8dcdfe8d4073bfaabb0a71e51add00832fd6d4539f24bcc8dd235eced3b85b211e06c7760bd70301f9d1ffae8f271
-  data.tar.gz: 5aa7b3e31bef025086625fe9302d360173ccd3195567e7287f4b647085b20471ef8db0489032f042b428cdd19212f9f53f6629fad5f18b9896e2b87067d512b5
+  metadata.gz: f1b9f2b1ecfbd223672bac629303d12e3248d26d208e6155e2b9a59e64520c2a7a2f0a7e44ef2e614b305fbb35c3b86eccdc2c7004b7c2e98fdb95b2efc372c9
+  data.tar.gz: bf59b508199dd15fc8eb38d96d4e095e1abca9801bdba559f94c2f9d231a3807820215c8de408360f18e2197c246fe1fb6d0ae561bd63562fc35800e810fecae

data/ext/agent.yml

@@ -1,11 +1,11 @@
 ---
-:version: '2025234'
+:version: d6c8254
 :triples:
   x86_64-linux:
-    :checksum: 2b2c57f682ce64dbcebd40bce4bf85560e2f09e9c14f803f8049813c899299cf
-    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/2025234/appsignal-agent-x86_64-linux-static.tar.gz
+    :checksum: 046c8564ec74e511706623ce90295f7639bd2a4f23818e3b0f245f4348300ecd
+    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d6c8254/appsignal-agent-x86_64-linux-static.tar.gz
     :lib_filename: libappsignal.a
   x86_64-darwin:
-    :checksum: c78c28852c673e2d27498c523d58a8cb6d0d11a2c4dcd420bb8d298c2d5d9739
-    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/2025234/appsignal-agent-x86_64-darwin-static.tar.gz
+    :checksum: 73f4da97749df2b9161020e910fbfaba4c530838698009762ac453026ade67a7
+    :download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d6c8254/appsignal-agent-x86_64-darwin-static.tar.gz
     :lib_filename: libappsignal.a

data/ext/appsignal_extension.c

@@ -176,8 +176,8 @@ static void track_gc_end(rb_event_flag_t flag, VALUE arg1, VALUE arg2, ID arg3,
   appsignal_track_gc_end();
 }
 
-static void install_event_hooks() {
-  // These event hooks are only available on Ruby 2.1 and 2.2
+static VALUE install_allocation_event_hook() {
+  // This event hook is only available on Ruby 2.1 and 2.2
   #if defined(RUBY_INTERNAL_EVENT_NEWOBJ)
   rb_add_event_hook(
       track_allocation,
@@ -185,6 +185,12 @@ static void install_event_hooks() {
       Qnil
   );
   #endif
+
+  return Qnil;
+}
+
+static VALUE install_gc_event_hooks() {
+  // These event hooks are only available on Ruby 2.1 and 2.2
   #if defined(RUBY_INTERNAL_EVENT_GC_START)
   rb_add_event_hook(
       track_gc_start,
@@ -208,6 +214,8 @@ static void install_event_hooks() {
       Qnil
   );
   #endif
+
+  return Qnil;
 }
 
 void Init_appsignal_extension(void) {
@@ -227,13 +235,14 @@ void Init_appsignal_extension(void) {
   rb_define_singleton_method(Extension, "set_transaction_metadata",    set_transaction_metadata,    3);
   rb_define_singleton_method(Extension, "finish_transaction",          finish_transaction,          1);
 
+  // Event hook installation
+  rb_define_singleton_method(Extension, "install_allocation_event_hook", install_allocation_event_hook, 0);
+  rb_define_singleton_method(Extension, "install_gc_event_hooks",        install_gc_event_hooks,        0);
+
   // Metrics
-  rb_define_singleton_method(Extension, "set_gauge",                   set_gauge,                   2);
-  rb_define_singleton_method(Extension, "set_host_gauge",              set_host_gauge,              2);
-  rb_define_singleton_method(Extension, "set_process_gauge",           set_process_gauge,           2);
-  rb_define_singleton_method(Extension, "increment_counter",           increment_counter,           2);
-  rb_define_singleton_method(Extension, "add_distribution_value",      add_distribution_value,      2);
-
-  // Event hooks
-  install_event_hooks();
+  rb_define_singleton_method(Extension, "set_gauge",              set_gauge,              2);
+  rb_define_singleton_method(Extension, "set_host_gauge",         set_host_gauge,         2);
+  rb_define_singleton_method(Extension, "set_process_gauge",      set_process_gauge,      2);
+  rb_define_singleton_method(Extension, "increment_counter",      increment_counter,      2);
+  rb_define_singleton_method(Extension, "add_distribution_value", add_distribution_value, 2);
 }

data/lib/appsignal.rb

@@ -15,9 +15,12 @@ module Appsignal
     def load_integrations
       require 'appsignal/integrations/celluloid'
       require 'appsignal/integrations/delayed_job'
+      require 'appsignal/integrations/passenger'
+      require 'appsignal/integrations/puma'
       require 'appsignal/integrations/sidekiq'
       require 'appsignal/integrations/resque'
       require 'appsignal/integrations/sequel'
+      require 'appsignal/integrations/unicorn'
     end
 
     def load_instrumentations
@@ -60,6 +63,8 @@ module Appsignal
           load_instrumentations
           Appsignal::EventFormatter.initialize_formatters
           initialize_extensions
+          Appsignal::Extension.install_allocation_event_hook if config[:enable_allocation_tracking]
+          Appsignal::Extension.install_gc_event_hooks if config[:enable_gc_instrumentation]
           @subscriber = Appsignal::Subscriber.new
         else
           logger.info("Not starting, not active for #{config.env}")
@@ -73,13 +78,14 @@ module Appsignal
       Appsignal::Extension.stop
     end
 
+    # Wrap a transaction with appsignal monitoring.
     def monitor_transaction(name, env={})
       unless active?
         yield
         return
       end
 
-       if name.start_with?('perform_job'.freeze)
+      if name.start_with?('perform_job'.freeze)
         namespace = Appsignal::Transaction::BACKGROUND_JOB
         request   = Appsignal::Transaction::GenericRequest.new(env)
       elsif name.start_with?('process_action'.freeze)
@@ -107,6 +113,17 @@ module Appsignal
       end
     end
 
+    # Monitor a transaction, stop Appsignal and wait for this single transaction to be
+    # flushed.
+    #
+    # Useful for cases such as Rake tasks and Resque-like systems where a process is
+    # forked and immediately exits after the transaction finishes.
+    def monitor_single_transaction(name, env={}, &block)
+      monitor_transaction(name, env, &block)
+    ensure
+      stop
+    end
+
     def listen_for_error(&block)
       yield
     rescue => error

data/lib/appsignal/config.rb

@@ -15,7 +15,9 @@ module Appsignal
       :instrument_net_http            => true,
       :skip_session_data              => false,
       :enable_frontend_error_catching => false,
-      :frontend_error_catching_path   => '/appsignal_error_catcher'
+      :frontend_error_catching_path   => '/appsignal_error_catcher',
+      :enable_allocation_tracking     => true,
+      :enable_gc_instrumentation      => true
     }.freeze
 
     ENV_TO_KEY_MAPPING = {
@@ -30,7 +32,9 @@ module Appsignal
       'APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING' => :enable_frontend_error_catching,
       'APPSIGNAL_IGNORE_ERRORS'                  => :ignore_errors,
       'APPSIGNAL_IGNORE_ACTIONS'                 => :ignore_actions,
-      'APPSIGNAL_HTTP_PROXY'                     => :http_proxy
+      'APPSIGNAL_HTTP_PROXY'                     => :http_proxy,
+      'APPSIGNAL_ENABLE_ALLOCATION_TRACKING'     => :enable_allocation_tracking,
+      'APPSIGNAL_ENABLE_GC_INSTRUMENTATION'      => :enable_gc_instrumentation
     }.freeze
 
     attr_reader :root_path, :env, :initial_config, :config_hash
@@ -73,7 +77,6 @@ module Appsignal
       ENV['APPSIGNAL_ACTIVE']            = active?.to_s
       ENV['APPSIGNAL_APP_PATH']          = root_path.to_s
       ENV['APPSIGNAL_AGENT_PATH']        = File.expand_path('../../../ext', __FILE__).to_s
-      ENV['APPSIGNAL_LOG_PATH']          = File.join(root_path, 'log')
       ENV['APPSIGNAL_ENVIRONMENT']       = env
       ENV['APPSIGNAL_AGENT_VERSION']     = Appsignal::Extension.agent_version
       ENV['APPSIGNAL_DEBUG_LOGGING']     = config_hash[:debug].to_s
@@ -131,7 +134,8 @@ module Appsignal
 
       # Configuration with boolean type
       %w(APPSIGNAL_ACTIVE APPSIGNAL_DEBUG APPSIGNAL_INSTRUMENT_NET_HTTP
-         APPSIGNAL_SKIP_SESSION_DATA APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING).each do |var|
+         APPSIGNAL_SKIP_SESSION_DATA APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING
+         APPSIGNAL_ENABLE_ALLOCATION_TRACKING APPSIGNAL_ENABLE_GC_INSTRUMENTATION).each do |var|
         if env_var = ENV[var]
           config[ENV_TO_KEY_MAPPING[var]] = env_var == 'true'
         end

data/lib/appsignal/integrations/celluloid.rb

@@ -4,6 +4,7 @@ if defined?(::Celluloid)
   # Some versions of Celluloid have race conditions while exiting
   # that can result in a dead lock. We stop appsignal before shutting
   # down Celluloid so we're sure our thread does not aggravate this situation.
+  # This way we also make sure any outstanding transactions get flushed.
 
   ::Celluloid.class_eval do
     class << self

data/lib/appsignal/integrations/delayed_job.rb

@@ -8,6 +8,10 @@ if defined?(::Delayed::Plugin)
           lifecycle.around(:invoke_job) do |job, &block|
             invoke_with_instrumentation(job, block)
           end
+
+          lifecycle.after(:loop) do |loop|
+            Appsignal.stop
+          end
         end
 
         def self.invoke_with_instrumentation(job, block)

data/lib/appsignal/integrations/passenger.rb

@@ -0,0 +1,7 @@
+if defined?(::PhusionPassenger)
+  Appsignal.logger.info('Loading Passenger integration')
+
+  ::PhusionPassenger.on_event(:stopping_worker_process) do
+    Appsignal.stop
+  end
+end

data/lib/appsignal/integrations/puma.rb

@@ -0,0 +1,9 @@
+if defined?(::Puma) && ::Puma.respond_to?(:cli_config)
+  Appsignal.logger.info('Loading Puma integration')
+
+  if ::Puma.cli_config
+    ::Puma.cli_config.options[:before_worker_shutdown] << Proc.new do |id|
+      Appsignal.stop
+    end
+  end
+end

data/lib/appsignal/integrations/rake.rb

@@ -23,7 +23,7 @@ module Rake
       transaction.set_action(name)
       transaction.set_error(error)
       transaction.complete!
-      sleep 0.5 # Give us some time to flush to the agent
+      Appsignal.stop
       raise error
     end
   end

data/lib/appsignal/integrations/resque.rb

@@ -5,7 +5,7 @@ if defined?(::Resque)
     module Integrations
       module ResquePlugin
         def around_perform_resque_plugin(*args)
-          Appsignal.monitor_transaction(
+          Appsignal.monitor_single_transaction(
             'perform_job.resque',
             :class => self.to_s,
             :method => 'perform'

data/lib/appsignal/integrations/unicorn.rb

@@ -0,0 +1,18 @@
+if defined?(::Unicorn)
+  Appsignal.logger.info('Loading Unicorn integration')
+
+  # Make sure the last transaction in a worker gets flushed.
+  #
+  # We'd love to be able to hook this into Unicorn in a less
+  # intrusive way, but this is the best we can do given the
+  # options we have.
+
+  class Unicorn::Worker
+    alias_method :original_close, :close
+
+    def close
+      Appsignal.stop
+      original_close
+    end
+  end
+end

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 require 'yaml'
 
 module Appsignal
-  VERSION = '0.12.beta.38'
+  VERSION = '0.12.beta.39'
 end

data/spec/lib/appsignal/config_spec.rb

@@ -27,7 +27,9 @@ describe Appsignal::Config do
         :name                           => 'TestApp',
         :active                         => true,
         :enable_frontend_error_catching => false,
-        :frontend_error_catching_path   => '/appsignal_error_catcher'
+        :frontend_error_catching_path   => '/appsignal_error_catcher',
+        :enable_allocation_tracking     => true,
+        :enable_gc_instrumentation      => true
       }
     end
 
@@ -52,7 +54,6 @@ describe Appsignal::Config do
         ENV['APPSIGNAL_ACTIVE'].should            == 'true'
         ENV['APPSIGNAL_APP_PATH'].should          end_with('spec/support/project_fixture')
         ENV['APPSIGNAL_AGENT_PATH'].should        end_with('/ext')
-        ENV['APPSIGNAL_LOG_PATH'].should          end_with('/log')
         ENV['APPSIGNAL_DEBUG_LOGGING'].should     == 'false'
         ENV['APPSIGNAL_PUSH_API_ENDPOINT'].should == 'https://push.appsignal.com'
         ENV['APPSIGNAL_PUSH_API_KEY'].should      == 'abc'

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

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe "Passenger integration" do
+  let(:file) { File.expand_path('lib/appsignal/integrations/passenger.rb') }
+  before(:all) do
+    module PhusionPassenger
+    end
+  end
+
+  it "adds behavior to stopping_worker_process" do
+    PhusionPassenger.should_receive(:on_event).with(:stopping_worker_process)
+    load file
+  end
+
+  context "without passenger" do
+    before(:all) { Object.send(:remove_const, :PhusionPassenger) }
+
+    specify { expect { PhusionPassenger }.to raise_error(NameError) }
+    specify { expect { load file }.to_not raise_error }
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe "Puma integration" do
+  let(:file) { File.expand_path('lib/appsignal/integrations/puma.rb') }
+  before(:all) do
+    class Puma
+      def self.cli_config
+        @cli_config ||= CliConfig.new
+      end
+    end
+
+    class CliConfig
+      attr_accessor :options
+
+      def initialize
+        @options = {}
+        @options[:before_worker_shutdown] = []
+      end
+    end
+  end
+  before do
+    load file
+    start_agent
+  end
+
+  it "should add a before shutdown worker callback" do
+    Puma.cli_config.options[:before_worker_shutdown].first.should be_a(Proc)
+  end
+
+  context "without Puma" do
+    before(:all) { Object.send(:remove_const, :Puma) }
+
+    specify { expect { Puma }.to raise_error(NameError) }
+    specify { expect { load file }.to_not raise_error }
+  end
+end

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

@@ -1,6 +1,7 @@
 require 'spec_helper'
 require 'rake'
-describe "Rack integration" do
+
+describe "Rake integration" do
   let(:file) { File.expand_path('lib/appsignal/integrations/rake.rb') }
   let(:app)  { double(:current_scope => nil) }
   let(:task) { Rake::Task.new('task', app) }
@@ -39,15 +40,22 @@ describe "Rack integration" do
       let!(:transaction) { regular_transaction }
       let!(:agent)       { double('Agent', :send_queue => true) }
       before do
+        transaction.stub(:set_action)
+        transaction.stub(:set_error)
+        transaction.stub(:complete!)
         SecureRandom.stub(:uuid => '123')
         Appsignal::Transaction.stub(:create => transaction)
-        Appsignal.stub(:agent => agent, :active? => true)
+        Appsignal.stub(:active? => true)
       end
 
       it "should call the original task" do
         expect( task ).to receive(:invoke_without_appsignal).with('foo')
       end
 
+      it "should not create a transaction" do
+        expect( Appsignal::Transaction ).not_to receive(:create)
+      end
+
       context "with an exception" do
         let(:exception) { VerySpecificError.new }
 
@@ -70,6 +78,14 @@ describe "Rack integration" do
         it "should add the exception to the transaction" do
           expect( transaction ).to receive(:set_error).with(exception)
         end
+
+        it "should call complete! on the transaction" do
+          expect( transaction ).to receive(:complete!)
+        end
+
+        it "should stop appsignal" do
+          expect( Appsignal ).to receive(:stop)
+        end
       end
     end
 

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

@@ -39,7 +39,7 @@ describe "Resque integration" do
         end
 
         it "should wrap in a transaction with the correct params" do
-          Appsignal.should_receive(:monitor_transaction).with(
+          Appsignal.should_receive(:monitor_single_transaction).with(
             'perform_job.resque',
             :class => 'Resque::Job',
             :method => 'perform'

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

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe "Unicorn integration" do
+  let(:file) { File.expand_path('lib/appsignal/integrations/unicorn.rb') }
+  before(:all) do
+    module Unicorn
+      class Worker
+        def close
+        end
+      end
+    end
+  end
+  before do
+    load file
+    start_agent
+  end
+
+  it "should add behavior to Unicorn::Worker#close" do
+    worker = Unicorn::Worker.new
+
+    Appsignal.should_receive(:stop)
+    worker.should_receive(:original_close)
+
+    worker.close
+  end
+
+  context "without unicorn" do
+    before(:all) { Object.send(:remove_const, :Unicorn) }
+
+    specify { expect { Unicorn }.to raise_error(NameError) }
+    specify { expect { load file }.to_not raise_error }
+  end
+end

data/spec/lib/appsignal_spec.rb

@@ -84,6 +84,12 @@ describe Appsignal do
         Appsignal.subscriber.should be_a(Appsignal::Subscriber)
       end
 
+      it "should install event hooks" do
+        Appsignal::Extension.should_receive(:install_allocation_event_hook)
+        Appsignal::Extension.should_receive(:install_gc_event_hooks)
+        Appsignal.start
+      end
+
       context "when not active for this environment" do
         before { Appsignal.config = project_fixture_config('staging') }
 
@@ -101,6 +107,19 @@ describe Appsignal do
           Appsignal.start
         end
       end
+
+      context "when allocation tracking and gc instrumentation has been disabled" do
+        before do
+          Appsignal.config.config_hash[:enable_allocation_tracking] = false
+          Appsignal.config.config_hash[:enable_gc_instrumentation] = false
+        end
+
+        it "should not install event hooks" do
+          Appsignal::Extension.should_not_receive(:install_allocation_event_hook)
+          Appsignal::Extension.should_not_receive(:install_gc_event_hooks)
+          Appsignal.start
+        end
+      end
     end
 
     describe ".load_integrations" do
@@ -300,6 +319,40 @@ describe Appsignal do
       end
     end
 
+    describe ".monitor_single_transaction" do
+      context "with a successful call" do
+        it "should call monitor_transaction and stop" do
+          Appsignal.should_receive(:monitor_transaction).with(
+            'perform_job.something',
+            :key => :value
+          ).and_yield
+          Appsignal.should_receive(:stop)
+
+          Appsignal.monitor_single_transaction('perform_job.something', :key => :value) do
+            # nothing
+          end
+        end
+      end
+
+      context "with an erroring call" do
+        let(:error) { VerySpecificError.new('the roof') }
+
+        it "should call monitor_transaction and stop and then raise the error" do
+          Appsignal.should_receive(:monitor_transaction).with(
+            'perform_job.something',
+            :key => :value
+          ).and_yield
+          Appsignal.should_receive(:stop)
+
+          lambda {
+            Appsignal.monitor_single_transaction('perform_job.something', :key => :value) do
+              raise error
+            end
+          }.should raise_error(error)
+        end
+      end
+    end
+
     describe ".tag_request" do
       before { Appsignal::Transaction.stub(:current => transaction) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 0.12.beta.38
+  version: 0.12.beta.39
 platform: ruby
 authors:
 - Robert Beekman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -162,12 +162,15 @@ files:
 - lib/appsignal/integrations/celluloid.rb
 - lib/appsignal/integrations/delayed_job.rb
 - lib/appsignal/integrations/padrino.rb
+- lib/appsignal/integrations/passenger.rb
+- lib/appsignal/integrations/puma.rb
 - lib/appsignal/integrations/rails.rb
 - lib/appsignal/integrations/rake.rb
 - lib/appsignal/integrations/resque.rb
 - lib/appsignal/integrations/sequel.rb
 - lib/appsignal/integrations/sidekiq.rb
 - lib/appsignal/integrations/sinatra.rb
+- lib/appsignal/integrations/unicorn.rb
 - lib/appsignal/js_exception_transaction.rb
 - lib/appsignal/marker.rb
 - lib/appsignal/params_sanitizer.rb
@@ -202,12 +205,15 @@ files:
 - spec/lib/appsignal/integrations/celluloid_spec.rb
 - spec/lib/appsignal/integrations/delayed_job_spec.rb
 - spec/lib/appsignal/integrations/padrino_spec.rb
+- spec/lib/appsignal/integrations/passenger_spec.rb
+- spec/lib/appsignal/integrations/puma_spec.rb
 - spec/lib/appsignal/integrations/rails_spec.rb
 - spec/lib/appsignal/integrations/rake_spec.rb
 - spec/lib/appsignal/integrations/resque_spec.rb
 - spec/lib/appsignal/integrations/sequel_spec.rb
 - spec/lib/appsignal/integrations/sidekiq_spec.rb
 - spec/lib/appsignal/integrations/sinatra_spec.rb
+- spec/lib/appsignal/integrations/unicorn_spec.rb
 - spec/lib/appsignal/js_exception_transaction_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/params_sanitizer_spec.rb
@@ -274,12 +280,15 @@ test_files:
 - spec/lib/appsignal/integrations/celluloid_spec.rb
 - spec/lib/appsignal/integrations/delayed_job_spec.rb
 - spec/lib/appsignal/integrations/padrino_spec.rb
+- spec/lib/appsignal/integrations/passenger_spec.rb
+- spec/lib/appsignal/integrations/puma_spec.rb
 - spec/lib/appsignal/integrations/rails_spec.rb
 - spec/lib/appsignal/integrations/rake_spec.rb
 - spec/lib/appsignal/integrations/resque_spec.rb
 - spec/lib/appsignal/integrations/sequel_spec.rb
 - spec/lib/appsignal/integrations/sidekiq_spec.rb
 - spec/lib/appsignal/integrations/sinatra_spec.rb
+- spec/lib/appsignal/integrations/unicorn_spec.rb
 - spec/lib/appsignal/js_exception_transaction_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/params_sanitizer_spec.rb