appsignal 3.1.2 → 3.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 938b418fbe79e961c55384db366497c427d979ad2d7762f71ca59751483158dc
-  data.tar.gz: 2e39e33bc84d311184d446d24adf10629e3c62adde66e832cc64870504b1c6d0
+  metadata.gz: 16fff6fc92481e9164ad7611fdb1de6d0ebee1d28906ebc95d7fe10100d69cfd
+  data.tar.gz: 790ec312c3349ee2b6889d8fca238e6cea7daa537c71cf81b7438152c2a2a2cb
 SHA512:
-  metadata.gz: 1dc42a9dc66d1f8feedc65a82225577c5ca5147599fcc32e73657d67ac89a8feebe4a4dce585549d4f2339a652ceec8362d5e01371de0910ad5f7c5b9247640f
-  data.tar.gz: 2a8b44f0c4c1a7828a6679000ed90a1f143a957757ee842fb59d078134502d88bb7dbc453a5dcf80e55ccaf7e265c191f6a2425853d570a6a48820c9972554f7
+  metadata.gz: c20ef4e52d38822a25880f8be5d88ea1f703b7c165813cdcd3d959383c03ff668f47a9c0bab41fe904eb8bf746911d4eb445f90a1804227847172bdc45e80c38
+  data.tar.gz: c5705bfeca7ec423ee1888572f84ef70fd15abdb5501cd0c9e73c2d5855b498d7e03ac8c50ab1aa88137d3335376cd2d0b767503c0ec17d9b2c7b209cd04e80f

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # AppSignal for Ruby gem Changelog
 
+## 3.1.3
+
+### Added
+
+- [811a1082](https://github.com/appsignal/appsignal-ruby/commit/811a10825043ed584f23d870e3a420ee409eb151) patch - Add the `Transaction.current?` helper to determine if any Transaction is currently active or not. AppSignal `NilTransaction`s are not considered active transactions.
+
+### Changed
+
+- [dc50d889](https://github.com/appsignal/appsignal-ruby/commit/dc50d8892699bf17b2399865ead8b27ce45b60ed) patch - Rename the (so far privately reported) `gc_total_time` metric to `gc_time`. It no longer reports the total time of Garbage Collection measured, but only the time between two (minutely) measurements.
+
+### Fixed
+
+- [7cfed987](https://github.com/appsignal/appsignal-ruby/commit/7cfed98761cf81d475261c553486b24843460cf3) patch - Fix error on unknown HTTP request method. When a request is made with an unknown request method, triggering and `ActionController::UnknownHttpMethod`, it will no longer break the AppSignal instrumentation but omit the request method in the sample data.
+
 ## 3.1.2
 
 ### Changed

data/lib/appsignal/helpers/instrumentation.rb

@@ -325,7 +325,8 @@ module Appsignal
             "value is not an exception: #{exception.inspect}"
           return
         end
-        return if !active? || Appsignal::Transaction.current.nil?
+        return if !active? || !Appsignal::Transaction.current?
+
         transaction = Appsignal::Transaction.current
         transaction.set_error(exception)
         transaction.set_tags(tags) if tags
@@ -359,7 +360,7 @@ module Appsignal
       # @since 2.2.0
       def set_action(action)
         return if !active? ||
-            Appsignal::Transaction.current.nil? ||
+            !Appsignal::Transaction.current? ||
             action.nil?
         Appsignal::Transaction.current.set_action(action)
       end
@@ -398,7 +399,7 @@ module Appsignal
       # @since 2.2.0
       def set_namespace(namespace)
         return if !active? ||
-            Appsignal::Transaction.current.nil? ||
+            !Appsignal::Transaction.current? ||
             namespace.nil?
         Appsignal::Transaction.current.set_namespace(namespace)
       end
@@ -438,8 +439,9 @@ module Appsignal
       #   Tagging guide
       def tag_request(tags = {})
         return unless active?
+        return unless Appsignal::Transaction.current?
+
         transaction = Appsignal::Transaction.current
-        return false unless transaction
         transaction.set_tags(tags)
       end
       alias :tag_job :tag_request
@@ -471,8 +473,9 @@ module Appsignal
       # @since 2.12.0
       def add_breadcrumb(category, action, message = "", metadata = {}, time = Time.now.utc)
         return unless active?
+        return unless Appsignal::Transaction.current?
+
         transaction = Appsignal::Transaction.current
-        return false unless transaction
         transaction.add_breadcrumb(category, action, message, metadata, time)
       end
 

data/lib/appsignal/hooks/active_job.rb

@@ -20,9 +20,11 @@ module Appsignal
       module ActiveJobClassInstrumentation
         def execute(job)
           job_status = nil
-          current_transaction = Appsignal::Transaction.current
+          has_wrapper_transaction = Appsignal::Transaction.current?
           transaction =
-            if current_transaction.nil_transaction?
+            if has_wrapper_transaction
+              Appsignal::Transaction.current
+            else
               # No standalone integration started before ActiveJob integration.
               # We don't have a separate integration for this QueueAdapter like
               # we do for Sidekiq.
@@ -33,8 +35,6 @@ module Appsignal
                 Appsignal::Transaction::BACKGROUND_JOB,
                 Appsignal::Transaction::GenericRequest.new({})
               )
-            else
-              current_transaction
             end
 
           super
@@ -64,7 +64,7 @@ module Appsignal
               transaction.set_queue_start((Time.parse(enqueued_at).to_f * 1_000).to_i)
             end
 
-            if current_transaction.nil_transaction?
+            unless has_wrapper_transaction
               # Only complete transaction if ActiveJob is not wrapped in
               # another supported integration, such as Sidekiq.
               Appsignal::Transaction.complete_current!

data/lib/appsignal/integrations/mongo_ruby_driver.rb

@@ -6,8 +6,9 @@ module Appsignal
     class MongoMonitorSubscriber
       # Called by Mongo::Monitor when query starts
       def started(event)
+        return unless Appsignal::Transaction.current?
+
         transaction = Appsignal::Transaction.current
-        return if transaction.nil_transaction?
         return if transaction.paused?
 
         # Format the command
@@ -36,8 +37,9 @@ module Appsignal
 
       # Finishes the event in the AppSignal extension
       def finish(result, event)
+        return unless Appsignal::Transaction.current?
+
         transaction = Appsignal::Transaction.current
-        return if transaction.nil_transaction?
         return if transaction.paused?
 
         # Get the query from the transaction store

data/lib/appsignal/integrations/sidekiq.rb

@@ -10,21 +10,24 @@ module Appsignal
     # @api private
     class SidekiqErrorHandler
       def call(exception, sidekiq_context)
-        transaction = Appsignal::Transaction.current
-
-        if transaction.nil_transaction?
-          # Sidekiq error outside of the middleware scope.
-          # Can be a job JSON parse error or some other error happening in
-          # Sidekiq.
-          transaction = Appsignal::Transaction.create(
-            SecureRandom.uuid, # Newly generated job id
-            Appsignal::Transaction::BACKGROUND_JOB,
-            Appsignal::Transaction::GenericRequest.new({})
-          )
-          transaction.set_action_if_nil("SidekiqInternal")
-          transaction.set_metadata("sidekiq_error", sidekiq_context[:context])
-          transaction.params = { :jobstr => sidekiq_context[:jobstr] }
-        end
+        transaction =
+          if Appsignal::Transaction.current?
+            Appsignal::Transaction.current
+          else
+            # Sidekiq error outside of the middleware scope.
+            # Can be a job JSON parse error or some other error happening in
+            # Sidekiq.
+            transaction =
+              Appsignal::Transaction.create(
+                SecureRandom.uuid, # Newly generated job id
+                Appsignal::Transaction::BACKGROUND_JOB,
+                Appsignal::Transaction::GenericRequest.new({})
+              )
+            transaction.set_action_if_nil("SidekiqInternal")
+            transaction.set_metadata("sidekiq_error", sidekiq_context[:context])
+            transaction.params = { :jobstr => sidekiq_context[:jobstr] }
+            transaction
+          end
 
         transaction.set_error(exception)
         Appsignal::Transaction.complete_current!

data/lib/appsignal/probes/mri.rb

@@ -31,8 +31,8 @@ module Appsignal
         )
 
         set_gauge("thread_count", Thread.list.size)
-        gauge_delta(:gc_total_time, @gc_profiler.total_time) do |total_time|
-          set_gauge("gc_total_time", total_time) if total_time > 0
+        gauge_delta(:gc_time, @gc_profiler.total_time) do |gc_time|
+          set_gauge("gc_time", gc_time) if gc_time > 0
         end
 
         gc_stats = GC.stat

data/lib/appsignal/rack/rails_instrumentation.rb

@@ -40,7 +40,11 @@ module Appsignal
           end
           transaction.set_http_or_background_queue_start
           transaction.set_metadata("path", request.path)
-          transaction.set_metadata("method", request.request_method)
+          begin
+            transaction.set_metadata("method", request.request_method)
+          rescue => error
+            Appsignal.logger.error("Unable to report HTTP request method: '#{error}'")
+          end
           Appsignal::Transaction.complete_current!
         end
       end

data/lib/appsignal/transaction.rb

@@ -35,10 +35,24 @@ module Appsignal
         end
       end
 
+      # Returns currently active transaction or a {NilTransaction} if none is
+      # active.
+      #
+      # @see .current?
+      # @return [Boolean]
       def current
         Thread.current[:appsignal_transaction] || NilTransaction.new
       end
 
+      # Returns if any transaction is currently active or not. A
+      # {NilTransaction} is not considered an active transaction.
+      #
+      # @see .current
+      # @return [Boolean]
+      def current?
+        current && !current.nil_transaction?
+      end
+
       def complete_current!
         current.complete
       rescue => e

data/lib/appsignal/version.rb

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

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

@@ -52,11 +52,11 @@ describe Appsignal::Probes::MriProbe do
         expect_gauge_value("thread_count")
       end
 
-      it "tracks GC total time" do
+      it "tracks GC time between measurements" do
         expect(gc_profiler_mock).to receive(:total_time).and_return(10, 15)
         probe.call
         probe.call
-        expect_gauge_value("gc_total_time", 5)
+        expect_gauge_value("gc_time", 5)
       end
 
       context "when GC total time overflows" do
@@ -66,7 +66,7 @@ describe Appsignal::Probes::MriProbe do
           probe.call # Report delta value based on cached value
           probe.call # The value overflows and reports no value. Then stores 0 in the cache
           probe.call # Report new value based on cache of 0
-          expect_gauges([["gc_total_time", 5], ["gc_total_time", 10]])
+          expect_gauges([["gc_time", 5], ["gc_time", 10]])
         end
       end
 

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

@@ -3,20 +3,37 @@ if DependencyHelper.rails_present?
   end
 
   describe Appsignal::Rack::RailsInstrumentation do
-    before :context do
+    let(:log) { StringIO.new }
+    before do
       start_agent
+      Appsignal.logger = test_logger(log)
     end
 
+    let(:params) do
+      {
+        "controller" => "blog_posts",
+        "action" => "show",
+        "id" => "1",
+        "my_custom_param" => "my custom secret",
+        "password" => "super secret"
+      }
+    end
+    let(:env_extra) { {} }
     let(:app) { double(:call => true) }
     let(:env) do
-      http_request_env_with_data("action_dispatch.request_id" => "1").tap do |request|
-        request["action_controller.instance"] = double(
+      http_request_env_with_data({
+        :params => params,
+        :with_queue_start => true,
+        "action_dispatch.request_id" => "1",
+        "action_dispatch.parameter_filter" => [:my_custom_param, :password],
+        "action_controller.instance" => double(
           :class => MockController,
           :action_name => "index"
         )
-      end
+      }.merge(env_extra))
     end
     let(:middleware) { Appsignal::Rack::RailsInstrumentation.new(app, {}) }
+    around { |example| keep_transactions { example.run } }
 
     describe "#call" do
       before do
@@ -46,30 +63,62 @@ if DependencyHelper.rails_present?
       after { middleware.call(env) }
     end
 
-    describe "#call_with_appsignal_monitoring", :error => false do
-      it "should create a transaction" do
-        expect(Appsignal::Transaction).to receive(:create).with(
-          "1",
-          Appsignal::Transaction::HTTP_REQUEST,
-          kind_of(ActionDispatch::Request),
-          :params_method => :filtered_parameters
-        ).and_return(
-          instance_double(
-            "Appsignal::Transaction",
-            :set_action => nil,
-            :set_action_if_nil => nil,
-            :set_http_or_background_queue_start => nil,
-            :set_metadata => nil
+    describe "#call_with_appsignal_monitoring" do
+      def run
+        middleware.call(env)
+      end
+
+      it "calls the wrapped app" do
+        run
+        expect(app).to have_received(:call).with(env)
+      end
+
+      it "creates one transaction with metadata" do
+        run
+
+        expect(created_transactions.length).to eq(1)
+        transaction_hash = last_transaction.to_h
+        expect(transaction_hash).to include(
+          "namespace" => Appsignal::Transaction::HTTP_REQUEST,
+          "action" => "MockController#index",
+          "metadata" => hash_including(
+            "method" => "GET",
+            "path" => "/blog"
+          )
+        )
+        expect(last_transaction.ext.queue_start).to eq(
+          fixed_time * 1_000.0
+        )
+      end
+
+      it "filter parameters in Rails" do
+        run
+
+        transaction_hash = last_transaction.to_h
+        expect(transaction_hash).to include(
+          "sample_data" => hash_including(
+            "params" => params.merge(
+              "my_custom_param" => "[FILTERED]",
+              "password" => "[FILTERED]"
+            )
           )
         )
       end
 
-      it "should call the app" do
-        expect(app).to receive(:call).with(env)
+      context "with an invalid HTTP request method" do
+        let(:env_extra) { { :request_method => "FOO", "REQUEST_METHOD" => "FOO" } }
+
+        it "does not store the HTTP request method" do
+          run
+
+          transaction_hash = last_transaction.to_h
+          expect(transaction_hash["metadata"]).to_not have_key("method")
+          expect(log_contents(log)).to contains_log(:error, "Unable to report HTTP request method: '")
+        end
       end
 
-      context "with an exception", :error => true do
-        let(:error) { ExampleException }
+      context "with an exception" do
+        let(:error) { ExampleException.new("ExampleException message") }
         let(:app) do
           double.tap do |d|
             allow(d).to receive(:call).and_raise(error)
@@ -77,21 +126,16 @@ if DependencyHelper.rails_present?
         end
 
         it "records the exception" do
-          expect_any_instance_of(Appsignal::Transaction).to receive(:set_error).with(error)
-        end
-      end
+          expect { run }.to raise_error(error)
 
-      it "should set metadata" do
-        expect_any_instance_of(Appsignal::Transaction).to receive(:set_metadata).twice
-      end
-
-      it "should set the action and queue start" do
-        expect_any_instance_of(Appsignal::Transaction).to receive(:set_action_if_nil).with("MockController#index")
-        expect_any_instance_of(Appsignal::Transaction).to receive(:set_http_or_background_queue_start)
+          transaction_hash = last_transaction.to_h
+          expect(transaction_hash["error"]).to include(
+            "name" => "ExampleException",
+            "message" => "ExampleException message",
+            "backtrace" => kind_of(String)
+          )
+        end
       end
-
-      after(:error => false) { middleware.call(env) }
-      after(:error => true) { expect { middleware.call(env) }.to raise_error(error) }
     end
 
     describe "#request_id" do

data/spec/lib/appsignal/transaction_spec.rb

@@ -85,7 +85,9 @@ describe Appsignal::Transaction do
     end
 
     describe ".current" do
-      subject { Appsignal::Transaction.current }
+      def current_transaction
+        Appsignal::Transaction.current
+      end
 
       context "when there is a current transaction" do
         let!(:transaction) do
@@ -93,13 +95,17 @@ describe Appsignal::Transaction do
         end
 
         it "reads :appsignal_transaction from the current Thread" do
-          expect(subject).to eq Thread.current[:appsignal_transaction]
-          expect(subject).to eq transaction
+          expect(current_transaction).to eq Thread.current[:appsignal_transaction]
+          expect(current_transaction).to eq transaction
         end
 
         it "is not a NilTransaction" do
-          expect(subject.nil_transaction?).to eq false
-          expect(subject).to be_a Appsignal::Transaction
+          expect(current_transaction.nil_transaction?).to eq false
+          expect(current_transaction).to be_a Appsignal::Transaction
+        end
+
+        it "returns true for current?" do
+          expect(Appsignal::Transaction.current?).to be(true)
         end
       end
 
@@ -109,8 +115,12 @@ describe Appsignal::Transaction do
         end
 
         it "returns a NilTransaction stub" do
-          expect(subject.nil_transaction?).to eq true
-          expect(subject).to be_a Appsignal::Transaction::NilTransaction
+          expect(current_transaction.nil_transaction?).to eq true
+          expect(current_transaction).to be_a Appsignal::Transaction::NilTransaction
+        end
+
+        it "returns false for current?" do
+          expect(Appsignal::Transaction.current?).to be(false)
         end
       end
     end

data/spec/lib/appsignal_spec.rb

@@ -511,7 +511,14 @@ describe Appsignal do
       before { allow(Appsignal::Transaction).to receive(:current).and_return(transaction) }
 
       context "with transaction" do
-        let(:transaction) { double }
+        let(:transaction) { http_request_transaction }
+        around do |example|
+          Appsignal.config = project_fixture_config
+          set_current_transaction transaction do
+            example.run
+          end
+        end
+
         it "should call add_breadcrumb on transaction" do
           expect(transaction).to receive(:add_breadcrumb)
             .with("Network", "http", "User made network request", { :response => 200 }, fixed_time)

data/spec/support/helpers/env_helpers.rb

@@ -1,7 +1,8 @@
 module EnvHelpers
   def http_request_env_with_data(args = {})
+    with_queue_start = args.delete(:with_queue_start)
     path = args.delete(:path) || "/blog"
-    Rack::MockRequest.env_for(
+    request = Rack::MockRequest.env_for(
       path,
       :params => args[:params] || {
         "controller" => "blog_posts",
@@ -18,6 +19,13 @@ module EnvHelpers
       :db_runtime => 500,
       :metadata => { :key => "value" }
     ).merge(args)
+
+    # Set default queue value
+    if with_queue_start
+      request["HTTP_X_QUEUE_START"] = "t=#{(fixed_time * 1_000).to_i}" # in milliseconds
+    end
+
+    request
   end
 
   def background_env_with_data(args = {})

data/spec/support/helpers/transaction_helpers.rb

@@ -46,8 +46,14 @@ module TransactionHelpers
 
   # Set current transaction manually.
   # Cleared by {clear_current_transaction!}
+  #
+  # When a block is given, the current transaction is automatically unset after
+  # the block.
   def set_current_transaction(transaction) # rubocop:disable Naming/AccessorMethodName
     Thread.current[:appsignal_transaction] = transaction
+    yield if block_given?
+  ensure
+    clear_current_transaction! if block_given?
   end
 
   # Use when {Appsignal::Transaction.clear_current_transaction!} is stubbed to

data/spec/support/testing.rb

@@ -50,6 +50,17 @@ module Appsignal
 
   class Extension
     class Transaction
+      if Appsignal.extension_loaded?
+        attr_reader :queue_start
+        alias original_set_queue_start set_queue_start
+        # Temporary helper until the extension returns this information
+        # https://github.com/appsignal/appsignal-agent/issues/293
+        def set_queue_start(start) # rubocop:disable Naming/AccessorMethodName
+          @queue_start = start
+          original_set_queue_start(start)
+        end
+      end
+
       alias original_finish finish if method_defined? :finish
 
       # Override default {Extension::Transaction#finish} behavior to always

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.1.3
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-02 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack