appsignal 3.4.4 → 3.7.0

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

@@ -2,6 +2,10 @@ if DependencyHelper.rails_present?
   require "action_mailer"
 
   describe Appsignal::Integrations::Railtie do
+    include RailsHelper
+
+    after { clear_rails_error_reporter! }
+
     context "after initializing the app" do
       it "should call initialize_appsignal" do
         expect(Appsignal::Integrations::Railtie).to receive(:initialize_appsignal)
@@ -14,9 +18,9 @@ if DependencyHelper.rails_present?
     describe "#initialize_appsignal" do
       let(:app) { MyApp::Application.new }
 
-      describe ".logger" do
+      describe ".internal_logger" do
         before  { Appsignal::Integrations::Railtie.initialize_appsignal(app) }
-        subject { Appsignal.logger }
+        subject { Appsignal.internal_logger }
 
         it { is_expected.to be_a Logger }
       end
@@ -125,17 +129,16 @@ if DependencyHelper.rails_present?
 
       if Rails.respond_to?(:error)
         describe "Rails error reporter" do
-          before do
-            Appsignal::Integrations::Railtie.initialize_appsignal(app)
-            start_agent
-          end
+          before { start_agent }
           around { |example| keep_transactions { example.run } }
 
           context "when error is not handled (reraises the error)" do
             it "does nothing" do
-              expect do
-                Rails.error.record { raise ExampleStandardError }
-              end.to raise_error(ExampleStandardError)
+              with_rails_error_reporter do
+                expect do
+                  Rails.error.record { raise ExampleStandardError }
+                end.to raise_error(ExampleStandardError)
+              end
 
               expect(created_transactions).to be_empty
             end
@@ -151,26 +154,28 @@ if DependencyHelper.rails_present?
                   :duplicated_tag => "duplicated value"
                 )
 
-                with_current_transaction current_transaction do
-                  Rails.error.handle { raise ExampleStandardError }
-
-                  transaction = last_transaction
-                  transaction_hash = transaction.to_h
-                  expect(transaction_hash).to include(
-                    "action" => "CustomAction",
-                    "namespace" => "custom",
-                    "error" => {
-                      "name" => "ExampleStandardError",
-                      "message" => "ExampleStandardError",
-                      "backtrace" => kind_of(String)
-                    },
-                    "sample_data" => hash_including(
-                      "tags" => {
-                        "duplicated_tag" => "duplicated value",
-                        "severity" => "warning"
-                      }
+                with_rails_error_reporter do
+                  with_current_transaction current_transaction do
+                    Rails.error.handle { raise ExampleStandardError }
+
+                    transaction = last_transaction
+                    transaction_hash = transaction.to_h
+                    expect(transaction_hash).to include(
+                      "action" => "CustomAction",
+                      "namespace" => "custom",
+                      "error" => {
+                        "name" => "ExampleStandardError",
+                        "message" => "ExampleStandardError",
+                        "backtrace" => kind_of(String)
+                      },
+                      "sample_data" => hash_including(
+                        "tags" => hash_including(
+                          "duplicated_tag" => "duplicated value",
+                          "severity" => "warning"
+                        )
+                      )
                     )
-                  )
+                  end
                 end
               end
 
@@ -178,21 +183,52 @@ if DependencyHelper.rails_present?
                 current_transaction = http_request_transaction
                 current_transaction.set_tags(:tag1 => "duplicated value")
 
-                with_current_transaction current_transaction do
-                  given_context = { :tag1 => "value1", :tag2 => "value2" }
-                  Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+                with_rails_error_reporter do
+                  with_current_transaction current_transaction do
+                    given_context = { :tag1 => "value1", :tag2 => "value2" }
+                    Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+
+                    transaction = last_transaction
+                    transaction_hash = transaction.to_h
+                    expect(transaction_hash).to include(
+                      "sample_data" => hash_including(
+                        "tags" => hash_including(
+                          "tag1" => "value1",
+                          "tag2" => "value2",
+                          "severity" => "warning"
+                        )
+                      )
+                    )
+                  end
+                end
+              end
+
+              it "sends tags stored in :appsignal -> :custom_data as custom data" do
+                current_transaction = http_request_transaction
 
-                  transaction = last_transaction
-                  transaction_hash = transaction.to_h
-                  expect(transaction_hash).to include(
-                    "sample_data" => hash_including(
-                      "tags" => {
-                        "tag1" => "value1",
-                        "tag2" => "value2",
-                        "severity" => "warning"
+                with_rails_error_reporter do
+                  with_current_transaction current_transaction do
+                    given_context = {
+                      :appsignal => {
+                        :custom_data => {
+                          :array => [1, 2],
+                          :hash => { :one => 1, :two => 2 }
+                        }
                       }
+                    }
+                    Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+
+                    transaction = last_transaction
+                    transaction_hash = transaction.to_h
+                    expect(transaction_hash).to include(
+                      "sample_data" => hash_including(
+                        "custom_data" => {
+                          "array" => [1, 2],
+                          "hash" => { "one" => 1, "two" => 2 }
+                        }
+                      )
                     )
-                  )
+                  end
                 end
               end
 
@@ -201,27 +237,47 @@ if DependencyHelper.rails_present?
                 current_transaction.set_namespace "custom"
                 current_transaction.set_action "CustomAction"
 
-                with_current_transaction current_transaction do
-                  given_context = {
-                    :appsignal => { :namespace => "context", :action => "ContextAction" }
-                  }
-                  Rails.error.handle(:context => given_context) { raise ExampleStandardError }
-
-                  transaction = last_transaction
-                  transaction_hash = transaction.to_h
-                  expect(transaction_hash).to include(
-                    "namespace" => "context",
-                    "action" => "ContextAction"
-                  )
+                with_rails_error_reporter do
+                  with_current_transaction current_transaction do
+                    given_context = {
+                      :appsignal => { :namespace => "context", :action => "ContextAction" }
+                    }
+                    Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+
+                    transaction = last_transaction
+                    transaction_hash = transaction.to_h
+                    expect(transaction_hash).to include(
+                      "namespace" => "context",
+                      "action" => "ContextAction"
+                    )
+                  end
                 end
               end
             end
 
             context "when no transaction is active" do
+              class ExampleRailsRequestMock
+                def path
+                  "path"
+                end
+
+                def method
+                  "GET"
+                end
+
+                def filtered_parameters
+                  { :user_id => 123, :password => "[FILTERED]" }
+                end
+              end
+
               class ExampleRailsControllerMock
                 def action_name
                   "index"
                 end
+
+                def request
+                  @request ||= ExampleRailsRequestMock.new
+                end
               end
 
               class ExampleRailsJobMock
@@ -237,21 +293,32 @@ if DependencyHelper.rails_present?
                 clear_current_transaction!
               end
 
-              it "fetches the action from the controller in the context" do
+              it "fetches the action, path and method from the controller in the context" do
                 # The controller key is set by Rails when raised in a controller
                 given_context = { :controller => ExampleRailsControllerMock.new }
-                Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+                with_rails_error_reporter do
+                  Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+                end
 
                 transaction = last_transaction
                 transaction_hash = transaction.to_h
                 expect(transaction_hash).to include(
-                  "action" => "ExampleRailsControllerMock#index"
+                  "action" => "ExampleRailsControllerMock#index",
+                  "metadata" => hash_including(
+                    "path" => "path",
+                    "method" => "GET"
+                  ),
+                  "sample_data" => hash_including(
+                    "params" => { "user_id" => 123, "password" => "[FILTERED]" }
+                  )
                 )
               end
 
               it "sets no action if no execution context is present" do
                 # The controller key is set by Rails when raised in a controller
-                Rails.error.handle { raise ExampleStandardError }
+                with_rails_error_reporter do
+                  Rails.error.handle { raise ExampleStandardError }
+                end
 
                 transaction = last_transaction
                 transaction_hash = transaction.to_h
@@ -269,17 +336,19 @@ if DependencyHelper.rails_present?
                 :tag1 => "value1",
                 :tag2 => "value2"
               }
-              Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+              with_rails_error_reporter do
+                Rails.error.handle(:context => given_context) { raise ExampleStandardError }
+              end
 
               transaction = last_transaction
               transaction_hash = transaction.to_h
               expect(transaction_hash).to include(
                 "sample_data" => hash_including(
-                  "tags" => {
+                  "tags" => hash_including(
                     "tag1" => "value1",
                     "tag2" => "value2",
                     "severity" => "warning"
-                  }
+                  )
                 )
               )
             end

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

@@ -4,11 +4,11 @@ describe Appsignal::Integrations::SidekiqErrorHandler do
   let(:log) { StringIO.new }
   before do
     start_agent
-    Appsignal.logger = test_logger(log)
+    Appsignal.internal_logger = test_logger(log)
   end
   around { |example| keep_transactions { example.run } }
 
-  context "without a current transction" do
+  context "without a current transaction" do
     let(:exception) do
       raise ExampleStandardError, "uh oh"
     rescue => error
@@ -86,7 +86,7 @@ describe Appsignal::Integrations::SidekiqMiddleware, :with_yaml_parse_error => f
   let(:log) { StringIO.new }
   before do
     start_agent
-    Appsignal.logger = test_logger(log)
+    Appsignal.internal_logger = test_logger(log)
   end
   around { |example| keep_transactions { example.run } }
   after :with_yaml_parse_error => false do
@@ -266,13 +266,16 @@ describe Appsignal::Integrations::SidekiqMiddleware, :with_yaml_parse_error => f
 
   if DependencyHelper.rails7_present?
     context "with Rails error reporter" do
+      include RailsHelper
+
       it "reports the worker name as the action, copies the namespace and tags" do
-        Appsignal::Integrations::Railtie.initialize_appsignal(MyApp::Application.new)
         Appsignal.config = project_fixture_config("production")
-        perform_job do
-          Appsignal.tag_job("test_tag" => "value")
-          Rails.error.handle do
-            raise error, "uh oh"
+        with_rails_error_reporter do
+          perform_job do
+            Appsignal.tag_job("test_tag" => "value")
+            Rails.error.handle do
+              raise ExampleStandardError, "uh oh"
+            end
           end
         end
 
@@ -363,7 +366,9 @@ if DependencyHelper.active_job_present?
   require "sidekiq/testing"
 
   describe "Sidekiq ActiveJob integration" do
+    include RailsHelper
     include ActiveJobHelpers
+
     let(:namespace) { Appsignal::Transaction::BACKGROUND_JOB }
     let(:time) { Time.parse("2001-01-01 10:00:00UTC") }
     let(:log) { StringIO.new }
@@ -416,9 +421,9 @@ if DependencyHelper.active_job_present?
         ["perform_job.sidekiq", "perform_start.active_job", "perform.active_job"]
       end
     end
-    before do
+    around do |example|
       start_agent
-      Appsignal.logger = test_logger(log)
+      Appsignal.internal_logger = test_logger(log)
       ActiveJob::Base.queue_adapter = :sidekiq
 
       class ActiveJobSidekiqTestJob < ActiveJob::Base
@@ -441,11 +446,11 @@ if DependencyHelper.active_job_present?
       Sidekiq::Testing.server_middleware do |chain|
         chain.add Appsignal::Integrations::SidekiqMiddleware
       end
-    end
-    around do |example|
-      keep_transactions do
-        Sidekiq::Testing.fake! do
-          example.run
+      with_rails_error_reporter do
+        keep_transactions do
+          Sidekiq::Testing.fake! do
+            example.run
+          end
         end
       end
     end

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

@@ -16,8 +16,8 @@ if DependencyHelper.sinatra_present?
     before { allow(Appsignal).to receive(:active?).and_return(true) }
     after { uninstall_sinatra_integration }
 
-    context "Appsignal.logger" do
-      subject { Appsignal.logger }
+    context "Appsignal.internal_logger" do
+      subject { Appsignal.internal_logger }
 
       it "sets a logger" do
         install_sinatra_integration

data/spec/lib/appsignal/minutely_spec.rb

@@ -42,7 +42,7 @@ describe Appsignal::Minutely do
     let(:log_stream) { StringIO.new }
     let(:log) { log_contents(log_stream) }
     before do
-      Appsignal.logger = test_logger(log_stream)
+      Appsignal.internal_logger = test_logger(log_stream)
       # Speed up test time
       allow(Appsignal::Minutely).to receive(:initial_wait_time).and_return(0.001)
       allow(Appsignal::Minutely).to receive(:wait_time).and_return(0.001)
@@ -287,7 +287,7 @@ describe Appsignal::Minutely do
     describe "#register" do
       let(:log_stream) { std_stream }
       let(:log) { log_contents(log_stream) }
-      before { Appsignal.logger = test_logger(log_stream) }
+      before { Appsignal.internal_logger = test_logger(log_stream) }
 
       it "adds the by key probe" do
         probe = lambda {}

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

@@ -73,6 +73,20 @@ describe Appsignal::Probes::SidekiqProbe do
       module Sidekiq7Mock
         VERSION = "7.0.0".freeze
 
+        def self.redis_info_data=(info)
+          @redis_info_data = info
+        end
+
+        def self.redis_info_data
+          return @redis_info_data if defined?(@redis_info_data)
+
+          {
+            "connected_clients" => 2,
+            "used_memory" => 1024,
+            "used_memory_rss" => 512
+          }
+        end
+
         def self.redis
           yield Client.new
         end
@@ -83,11 +97,7 @@ describe Appsignal::Probes::SidekiqProbe do
           end
 
           def info
-            {
-              "connected_clients" => 2,
-              "used_memory" => 1024,
-              "used_memory_rss" => 512
-            }
+            Sidekiq7Mock.redis_info_data
           end
         end
 
@@ -227,6 +237,19 @@ describe Appsignal::Probes::SidekiqProbe do
         probe.call
         probe.call
       end
+
+      context "when redis info doesn't contain requested keys" do
+        before { Sidekiq7Mock.redis_info_data = {} }
+
+        it "doesn't create metrics for nil values" do
+          expect_gauge("connection_count").never
+          expect_gauge("memory_usage").never
+          expect_gauge("memory_usage_rss").never
+          # Call probe twice so we can calculate the delta for some gauge values
+          probe.call
+          probe.call
+        end
+      end
     end
 
     context "with Sidekiq 6" do
@@ -301,7 +324,7 @@ describe Appsignal::Probes::SidekiqProbe do
       end
     end
 
-    def expect_gauge(key, value, tags = {})
+    def expect_gauge(key, value = anything, tags = {})
       expect(Appsignal).to receive(:set_gauge)
         .with("sidekiq_#{key}", value, expected_default_tags.merge(tags))
         .and_call_original

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

@@ -6,7 +6,7 @@ if DependencyHelper.rails_present?
     let(:log) { StringIO.new }
     before do
       start_agent
-      Appsignal.logger = test_logger(log)
+      Appsignal.internal_logger = test_logger(log)
     end
 
     let(:params) do