appsignal 3.1.3 → 3.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16fff6fc92481e9164ad7611fdb1de6d0ebee1d28906ebc95d7fe10100d69cfd
-  data.tar.gz: 790ec312c3349ee2b6889d8fca238e6cea7daa537c71cf81b7438152c2a2a2cb
+  metadata.gz: c21e4e80dd54b8a0f6619a40b7c046e6bc132634ce26666b281fdd4298c72c3f
+  data.tar.gz: 53743646f5cf821ab45559817cf65c2bf9ed483184725fca2413b3606fad6e1e
 SHA512:
-  metadata.gz: c20ef4e52d38822a25880f8be5d88ea1f703b7c165813cdcd3d959383c03ff668f47a9c0bab41fe904eb8bf746911d4eb445f90a1804227847172bdc45e80c38
-  data.tar.gz: c5705bfeca7ec423ee1888572f84ef70fd15abdb5501cd0c9e73c2d5855b498d7e03ac8c50ab1aa88137d3335376cd2d0b767503c0ec17d9b2c7b209cd04e80f
+  metadata.gz: 36a34d74cf16e5f274e3485471833f516e34227546017d14f24d70fc75ca824b68261a7048924391135a3c0d815d7ef605b60ac19396bdeb9b9b46f1d4911daa
+  data.tar.gz: b03a309a6c8649397e6f5d9b62a65324e4b4e39a3a1eee77b6cb60280758838212e2de7ca3eb28c8f10b3b59cb5b02ca7d88347cc9f3995be0308bf5249cae70

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.1.4
+
+### Added
+
+- [ffe49cfe](https://github.com/appsignal/appsignal-ruby/commit/ffe49cfe94f5269e59d6f168a73114f7a3914f79) patch - Support temporarily disabling GC profiling without reporting inaccurate `gc_time` metric durations. The MRI probe's `gc_time` will not report any value when the `GC::Profiler.enabled?` returns `false`.
+
+### Changed
+
+- [af7e666c](https://github.com/appsignal/appsignal-ruby/commit/af7e666cf173ec1f42e9cf3fce2ab6c8e658440c) patch - Listen if the Ruby Garbage Collection profiler is enabled and collect how long the GC is running for the Ruby VM magic dashboard. An app will need to call `GC::Profiler.enable` to enable the GC profiler. Do not enable this in production environments, or at least not for long, because this can negatively impact performance of apps.
+
+### Fixed
+
+- [b3a163be](https://github.com/appsignal/appsignal-ruby/commit/b3a163be154796e1f358c5061eaee99845c960ee) patch - Fix the MRI probe using the Garbage Collection profiler instead of the NilProfiler when garbage collection instrumentation is not enabled for MRI probe. This caused unnecessary overhead.
+
 ## 3.1.3
 
 ### Added

data/lib/appsignal/config.rb

@@ -15,7 +15,6 @@ module Appsignal
       :debug                          => false,
       :dns_servers                    => [],
       :enable_allocation_tracking     => true,
-      :enable_gc_instrumentation      => false,
       :enable_host_metrics            => true,
       :enable_minutely_probes         => true,
       :enable_statsd                  => true,
@@ -63,7 +62,6 @@ module Appsignal
       "APPSIGNAL_DEBUG"                          => :debug,
       "APPSIGNAL_DNS_SERVERS"                    => :dns_servers,
       "APPSIGNAL_ENABLE_ALLOCATION_TRACKING"     => :enable_allocation_tracking,
-      "APPSIGNAL_ENABLE_GC_INSTRUMENTATION"      => :enable_gc_instrumentation,
       "APPSIGNAL_ENABLE_HOST_METRICS"            => :enable_host_metrics,
       "APPSIGNAL_ENABLE_MINUTELY_PROBES"         => :enable_minutely_probes,
       "APPSIGNAL_ENABLE_STATSD"                  => :enable_statsd,
@@ -114,7 +112,6 @@ module Appsignal
       APPSIGNAL_ACTIVE
       APPSIGNAL_DEBUG
       APPSIGNAL_ENABLE_ALLOCATION_TRACKING
-      APPSIGNAL_ENABLE_GC_INSTRUMENTATION
       APPSIGNAL_ENABLE_HOST_METRICS
       APPSIGNAL_ENABLE_MINUTELY_PROBES
       APPSIGNAL_ENABLE_STATSD

data/lib/appsignal/garbage_collection.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Appsignal
+  # @api private
+  module GarbageCollection
+    # Return the GC profiler wrapper.
+    #
+    # Returns {Profiler} if the Ruby Garbage Collection profiler is enabled.
+    # This is checked by calling `GC::Profiler.enabled?`.
+    #
+    # GC profiling is disabled by default due to the overhead it causes. Do not
+    # enable this in production for long periods of time.
+    def self.profiler
+      # Cached instances so it doesn't create a new object every time this
+      # method is called. Especially necessary for the {Profiler} because a new
+      # instance will have a new internal time counter.
+      @real_profiler ||= Profiler.new
+      @nil_profiler ||= NilProfiler.new
+
+      enabled? ? @real_profiler : @nil_profiler
+    end
+
+    # Check if Garbage Collection is enabled at the moment.
+    #
+    # @return [Boolean]
+    def self.enabled?
+      GC::Profiler.enabled?
+    end
+
+    # Unset the currently cached profilers.
+    #
+    # @return [void]
+    def self.clear_profiler!
+      @real_profiler = nil
+      @nil_profiler = nil
+    end
+
+    # A wrapper around Ruby's `GC::Profiler` that tracks garbage collection
+    # time, while clearing `GC::Profiler`'s total_time to make sure it doesn't
+    # leak memory by keeping garbage collection run samples in memory.
+    class Profiler
+      def self.lock
+        @lock ||= Mutex.new
+      end
+
+      def initialize
+        @total_time = 0
+      end
+
+      # Whenever {#total_time} is called, the current `GC::Profiler#total_time`
+      # gets added to `@total_time`, after which `GC::Profiler.clear` is called
+      # to prevent it from leaking memory. A class-level lock is used to make
+      # sure garbage collection time is never counted more than once.
+      #
+      # Whenever `@total_time` gets above two billion milliseconds (about 23
+      # days), it's reset to make sure the result fits in a signed 32-bit
+      # integer.
+      #
+      # @return [Integer]
+      def total_time
+        lock.synchronize do
+          @total_time += (internal_profiler.total_time * 1000).round
+          internal_profiler.clear
+        end
+
+        @total_time = 0 if @total_time > 2_000_000_000
+
+        @total_time
+      end
+
+      private
+
+      def internal_profiler
+        GC::Profiler
+      end
+
+      def lock
+        self.class.lock
+      end
+    end
+
+    # A dummy profiler that always returns 0 as the total time. Used when GC
+    # profiler is disabled.
+    class NilProfiler
+      def total_time
+        0
+      end
+    end
+  end
+end

data/lib/appsignal/probes/mri.rb

@@ -8,7 +8,7 @@ module Appsignal
         defined?(::RubyVM) && ::RubyVM.respond_to?(:stat)
       end
 
-      def initialize(appsignal: Appsignal, gc_profiler: Appsignal::GarbageCollectionProfiler.new)
+      def initialize(appsignal: Appsignal, gc_profiler: Appsignal::GarbageCollection.profiler)
         Appsignal.logger.debug("Initializing VM probe")
         @appsignal = appsignal
         @gc_profiler = gc_profiler
@@ -31,8 +31,10 @@ module Appsignal
         )
 
         set_gauge("thread_count", Thread.list.size)
-        gauge_delta(:gc_time, @gc_profiler.total_time) do |gc_time|
-          set_gauge("gc_time", gc_time) if gc_time > 0
+        if Appsignal::GarbageCollection.enabled?
+          gauge_delta(:gc_time, @gc_profiler.total_time) do |gc_time|
+            set_gauge("gc_time", gc_time) if gc_time > 0
+          end
         end
 
         gc_stats = GC.stat

data/lib/appsignal/transaction.rb

@@ -66,11 +66,6 @@ module Appsignal
       def clear_current_transaction!
         Thread.current[:appsignal_transaction] = nil
       end
-
-      def garbage_collection_profiler
-        @garbage_collection_profiler ||=
-          Appsignal.config[:enable_gc_instrumentation] ? Appsignal::GarbageCollectionProfiler.new : NilGarbageCollectionProfiler.new
-      end
     end
 
     attr_reader :ext, :transaction_id, :action, :namespace, :request, :paused, :tags, :options, :discarded, :breadcrumbs
@@ -103,7 +98,7 @@ module Appsignal
       @ext = Appsignal::Extension.start_transaction(
         @transaction_id,
         @namespace,
-        self.class.garbage_collection_profiler.total_time
+        0
       ) || Appsignal::Extension::MockTransaction.new
     end
 
@@ -117,9 +112,7 @@ module Appsignal
           "because it was manually discarded."
         return
       end
-      if @ext.finish(self.class.garbage_collection_profiler.total_time)
-        sample_data
-      end
+      sample_data if @ext.finish(0)
       @ext.complete
     end
 
@@ -355,7 +348,7 @@ module Appsignal
 
     def start_event
       return if paused?
-      @ext.start_event(self.class.garbage_collection_profiler.total_time)
+      @ext.start_event(0)
     end
 
     def finish_event(name, title, body, body_format = Appsignal::EventFormatter::DEFAULT)
@@ -365,7 +358,7 @@ module Appsignal
         title || BLANK,
         body || BLANK,
         body_format || Appsignal::EventFormatter::DEFAULT,
-        self.class.garbage_collection_profiler.total_time
+        0
       )
     end
 
@@ -377,7 +370,7 @@ module Appsignal
         body || BLANK,
         body_format || Appsignal::EventFormatter::DEFAULT,
         duration,
-        self.class.garbage_collection_profiler.total_time
+        0
       )
     end
 

data/lib/appsignal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Appsignal
-  VERSION = "3.1.3".freeze
+  VERSION = "3.1.4".freeze
 end

data/lib/appsignal.rb

@@ -115,11 +115,6 @@ module Appsignal
             Appsignal::Environment.report_enabled("allocation_tracking")
           end
 
-          if config[:enable_gc_instrumentation]
-            GC::Profiler.enable
-            Appsignal::Environment.report_enabled("gc_instrumentation")
-          end
-
           Appsignal::Minutely.start if config[:enable_minutely_probes]
 
           collect_environment_metadata
@@ -298,7 +293,7 @@ require "appsignal/hooks"
 require "appsignal/probes"
 require "appsignal/marker"
 require "appsignal/minutely"
-require "appsignal/garbage_collection_profiler"
+require "appsignal/garbage_collection"
 require "appsignal/integrations/railtie" if defined?(::Rails)
 require "appsignal/transaction"
 require "appsignal/version"

data/spec/lib/appsignal/config_spec.rb

@@ -156,7 +156,6 @@ describe Appsignal::Config do
         :debug                          => false,
         :dns_servers                    => [],
         :enable_allocation_tracking     => true,
-        :enable_gc_instrumentation      => false,
         :enable_host_metrics            => true,
         :enable_minutely_probes         => true,
         :enable_statsd                  => true,

data/spec/lib/appsignal/{garbage_collection_profiler_spec.rb → garbage_collection_spec.rb}

@@ -1,11 +1,33 @@
-describe Appsignal::GarbageCollectionProfiler do
+describe Appsignal::GarbageCollection do
+  describe ".profiler" do
+    before do
+      # Unset the internal memoized variable to avoid state leaking
+      described_class.clear_profiler!
+    end
+
+    context "when GC instrumentation is disabled" do
+      it "returns the NilProfiler" do
+        expect(described_class.profiler).to be_a(Appsignal::GarbageCollection::NilProfiler)
+      end
+    end
+
+    context "when GC profiling is enabled" do
+      before { GC::Profiler.enable }
+      after { GC::Profiler.disable }
+
+      it "returns the Profiler" do
+        expect(described_class.profiler).to be_a(Appsignal::GarbageCollection::Profiler)
+      end
+    end
+  end
+end
+
+describe Appsignal::GarbageCollection::Profiler do
   let(:internal_profiler) { FakeGCProfiler.new }
   let(:profiler) { described_class.new }
 
   before do
-    allow_any_instance_of(described_class)
-      .to receive(:internal_profiler)
-      .and_return(internal_profiler)
+    stub_const("GC::Profiler", internal_profiler)
   end
 
   context "on initialization" do
@@ -54,7 +76,7 @@ describe Appsignal::GarbageCollectionProfiler do
 
       2.times do
         threads << Thread.new do
-          profiler = Appsignal::GarbageCollectionProfiler.new
+          profiler = Appsignal::GarbageCollection::Profiler.new
           results << profiler.total_time
         end
       end
@@ -65,7 +87,7 @@ describe Appsignal::GarbageCollectionProfiler do
   end
 end
 
-describe Appsignal::NilGarbageCollectionProfiler do
+describe Appsignal::GarbageCollection::NilProfiler do
   let(:profiler) { described_class.new }
 
   describe "#total_time" do

data/spec/lib/appsignal/probes/mri_spec.rb

@@ -39,6 +39,7 @@ describe Appsignal::Probes::MriProbe do
       let(:hostname) { nil }
       before do
         allow(gc_profiler_mock).to receive(:total_time)
+        allow(GC::Profiler).to receive(:enabled?).and_return(true)
       end
 
       it "should track vm metrics" do
@@ -70,6 +71,40 @@ describe Appsignal::Probes::MriProbe do
         end
       end
 
+      context "when GC profiling is disabled" do
+        it "does not report a gc_time metric" do
+          allow(GC::Profiler).to receive(:enabled?).and_return(false)
+          expect(gc_profiler_mock).to_not receive(:total_time)
+          probe.call # Normal call, create a cache
+          probe.call # Report delta value based on cached value
+          metrics = appsignal_mock.gauges.map { |(key)| key }
+          expect(metrics).to_not include("gc_time")
+        end
+
+        it "does not report a gc_time metric while temporarily disabled" do
+          # While enabled
+          allow(GC::Profiler).to receive(:enabled?).and_return(true)
+          expect(gc_profiler_mock).to receive(:total_time).and_return(10, 15)
+          probe.call # Normal call, create a cache
+          probe.call # Report delta value based on cached value
+          expect_gauges([["gc_time", 5]])
+
+          # While disabled
+          allow(GC::Profiler).to receive(:enabled?).and_return(false)
+          probe.call # Call twice to make sure any caches resets wouldn't mess up the assertion
+          probe.call
+          # Does not include any newly reported metrics
+          expect_gauges([["gc_time", 5]])
+
+          # When enabled after being disabled for a while, it only reports the
+          # newly reported time since it was renabled
+          allow(GC::Profiler).to receive(:enabled?).and_return(true)
+          expect(gc_profiler_mock).to receive(:total_time).and_return(25)
+          probe.call
+          expect_gauges([["gc_time", 5], ["gc_time", 10]])
+        end
+      end
+
       it "tracks GC run count" do
         expect(GC).to receive(:count).and_return(10, 15)
         expect(GC).to receive(:stat).and_return(

data/spec/lib/appsignal/transaction_spec.rb

@@ -792,23 +792,6 @@ describe Appsignal::Transaction do
       end
     end
 
-    describe "#garbage_collection_profiler" do
-      before { Appsignal::Transaction.instance_variable_set(:@garbage_collection_profiler, nil) }
-
-      it "returns the NilGarbageCollectionProfiler" do
-        expect(Appsignal::Transaction.garbage_collection_profiler).to be_a(Appsignal::NilGarbageCollectionProfiler)
-      end
-
-      context "when gc profiling is enabled" do
-        before { Appsignal.config.config_hash[:enable_gc_instrumentation] = true }
-        after { Appsignal.config.config_hash[:enable_gc_instrumentation] = false }
-
-        it "returns the GarbageCollectionProfiler" do
-          expect(Appsignal::Transaction.garbage_collection_profiler).to be_a(Appsignal::GarbageCollectionProfiler)
-        end
-      end
-    end
-
     describe "#start_event" do
       it "starts the event in the extension" do
         expect(transaction.ext).to receive(:start_event).with(0).and_call_original
@@ -827,11 +810,7 @@ describe Appsignal::Transaction do
     end
 
     describe "#finish_event" do
-      let(:fake_gc_time) { 123 }
-      before do
-        expect(described_class.garbage_collection_profiler)
-          .to receive(:total_time).at_least(:once).and_return(fake_gc_time)
-      end
+      let(:fake_gc_time) { 0 }
 
       it "should finish the event in the extension" do
         expect(transaction.ext).to receive(:finish_event).with(
@@ -878,11 +857,7 @@ describe Appsignal::Transaction do
     end
 
     describe "#record_event" do
-      let(:fake_gc_time) { 123 }
-      before do
-        expect(described_class.garbage_collection_profiler)
-          .to receive(:total_time).at_least(:once).and_return(fake_gc_time)
-      end
+      let(:fake_gc_time) { 0 }
 
       it "should record the event in the extension" do
         expect(transaction.ext).to receive(:record_event).with(

data/spec/lib/appsignal_spec.rb

@@ -54,20 +54,12 @@ describe Appsignal do
         Appsignal.start
       end
 
-      context "when allocation tracking and gc instrumentation have been enabled" do
+      context "when allocation tracking has been enabled" do
         before do
-          allow(GC::Profiler).to receive(:enable)
           Appsignal.config.config_hash[:enable_allocation_tracking] = true
-          Appsignal.config.config_hash[:enable_gc_instrumentation] = true
           capture_environment_metadata_report_calls
         end
 
-        it "should enable Ruby's GC::Profiler" do
-          expect(GC::Profiler).to receive(:enable)
-          Appsignal.start
-          expect_environment_metadata("ruby_gc_instrumentation_enabled", "true")
-        end
-
         unless DependencyHelper.running_jruby?
           it "installs the allocation event hook" do
             expect(Appsignal::Extension).to receive(:install_allocation_event_hook)
@@ -78,29 +70,17 @@ describe Appsignal do
         end
       end
 
-      context "when allocation tracking and gc instrumentation have been disabled" do
+      context "when allocation tracking has been disabled" do
         before do
           Appsignal.config.config_hash[:enable_allocation_tracking] = false
-          Appsignal.config.config_hash[:enable_gc_instrumentation] = false
           capture_environment_metadata_report_calls
         end
 
-        it "should not enable Ruby's GC::Profiler" do
-          expect(GC::Profiler).not_to receive(:enable)
-          Appsignal.start
-        end
-
         it "should not install the allocation event hook" do
           expect(Appsignal::Minutely).not_to receive(:install_allocation_event_hook)
           Appsignal.start
           expect_not_environment_metadata("ruby_allocation_tracking_enabled")
         end
-
-        it "should not add the gc probe to minutely" do
-          expect(Appsignal::Minutely).not_to receive(:register_garbage_collection_probe)
-          Appsignal.start
-          expect_not_environment_metadata("ruby_gc_instrumentation_enabled")
-        end
       end
 
       context "when minutely metrics has been enabled" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.4
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-04 00:00:00.000000000 Z
+date: 2022-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -204,7 +204,7 @@ files:
 - lib/appsignal/event_formatter/sequel/sql_formatter.rb
 - lib/appsignal/extension.rb
 - lib/appsignal/extension/jruby.rb
-- lib/appsignal/garbage_collection_profiler.rb
+- lib/appsignal/garbage_collection.rb
 - lib/appsignal/helpers/instrumentation.rb
 - lib/appsignal/helpers/metrics.rb
 - lib/appsignal/hooks.rb
@@ -305,7 +305,7 @@ files:
 - spec/lib/appsignal/extension/jruby_spec.rb
 - spec/lib/appsignal/extension_install_failure_spec.rb
 - spec/lib/appsignal/extension_spec.rb
-- spec/lib/appsignal/garbage_collection_profiler_spec.rb
+- spec/lib/appsignal/garbage_collection_spec.rb
 - spec/lib/appsignal/hooks/action_cable_spec.rb
 - spec/lib/appsignal/hooks/action_mailer_spec.rb
 - spec/lib/appsignal/hooks/active_support_notifications/finish_with_state_shared_examples.rb
@@ -457,7 +457,7 @@ test_files:
 - spec/lib/appsignal/extension/jruby_spec.rb
 - spec/lib/appsignal/extension_install_failure_spec.rb
 - spec/lib/appsignal/extension_spec.rb
-- spec/lib/appsignal/garbage_collection_profiler_spec.rb
+- spec/lib/appsignal/garbage_collection_spec.rb
 - spec/lib/appsignal/hooks/action_cable_spec.rb
 - spec/lib/appsignal/hooks/action_mailer_spec.rb
 - spec/lib/appsignal/hooks/active_support_notifications/finish_with_state_shared_examples.rb

data/lib/appsignal/garbage_collection_profiler.rb

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Appsignal
-  # {Appsignal::GarbageCollectionProfiler} wraps Ruby's `GC::Profiler` to be
-  # able to track garbage collection time for multiple transactions, while
-  # constantly clearing `GC::Profiler`'s total_time to make sure it doesn't
-  # leak memory by keeping garbage collection run samples in memory.
-  #
-  # @api private
-  class GarbageCollectionProfiler
-    def self.lock
-      @lock ||= Mutex.new
-    end
-
-    def initialize
-      @total_time = 0
-    end
-
-    # Whenever {#total_time} is called, the current `GC::Profiler#total_time`
-    # gets added to `@total_time`, after which `GC::Profiler.clear` is called
-    # to prevent it from leaking memory. A class-level lock is used to make
-    # sure garbage collection time is never counted more than once.
-    #
-    # Whenever `@total_time` gets above two billion milliseconds (about 23
-    # days), it's reset to make sure the result fits in a signed 32-bit
-    # integer.
-    #
-    # @return [Integer]
-    def total_time
-      lock.synchronize do
-        @total_time += (internal_profiler.total_time * 1000).round
-        internal_profiler.clear
-      end
-
-      @total_time = 0 if @total_time > 2_000_000_000
-
-      @total_time
-    end
-
-    private
-
-    def internal_profiler
-      GC::Profiler
-    end
-
-    def lock
-      self.class.lock
-    end
-  end
-
-  # {Appsignal::NilGarbageCollectionProfiler} is a dummy profiler
-  # that always returns 0 as the total time.
-  # Used when we don't want any profile information
-  #
-  # @api private
-  class NilGarbageCollectionProfiler
-    def total_time
-      0
-    end
-  end
-end