appsignal 2.10.2 → 2.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42efa30283b2ef38c0913d3314137b6d94b5aabd2c9268e1a624231dbc346990
-  data.tar.gz: b274b63c33323611103a14cb64d861190406ae84fa5790741f14185ba8607af8
+  metadata.gz: 79d4435bb752fd9bf7c142cbfd998e39f3ed5e076e3cbab2b495d3a67ad43ada
+  data.tar.gz: ecaa124c56de18417510e0f9798c02888a68ccabc8187e6412739f4669a664e2
 SHA512:
-  metadata.gz: e8a41276531fa0c5e94d629a0d6dd6cb8cd3d9cba14dbda18fe865677f75a960e4e9ae741a5782074526de8ebcd55a39d8c029569caa078df07245791f0fdacf
-  data.tar.gz: '099aa78863b122a0733b1c733cd27c8d80e95ce6092658e4e14b64924644dd4ad6f235f550f20f6006f33e6b4d6ebcfd370f5d5e20ad42916739d92202b21459'
+  metadata.gz: 44d8db3ff5eeee9e20062db3a706b4826a34cf5af03c0faf74d5b2a060176a2e4b6a9c187297cf5f071e43a45e0141d253f316f04ca65a6a44d56ce8e4a4d87d
+  data.tar.gz: 0f723ad1d12acef218607e83e7f06639c85969e3dda91c700f285d540a875f89d098e0cdac7a7ea2860d1d736815b106a86977967b497eec56dc361d31b6173a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.10.3
+- Only warn about reused transactions once. Repeated occurrences are logged as
+  debug messages. PR #585
+
 ## 2.10.2
 - Fix wait_for test suite helper. PR #581
 - Fix exception handling of config file issues. PR #582

data/lib/appsignal.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "json"
-require "logger"
 require "securerandom"
 
+require "appsignal/logger"
 require "appsignal/helpers/instrumentation"
 require "appsignal/helpers/metrics"
 
@@ -195,7 +195,7 @@ module Appsignal
     end
 
     def logger
-      @logger ||= Logger.new(in_memory_log).tap do |l|
+      @logger ||= Appsignal::Logger.new(in_memory_log).tap do |l|
         l.level = Logger::INFO
         l.formatter = log_formatter("appsignal")
       end
@@ -294,12 +294,12 @@ module Appsignal
     private
 
     def start_stdout_logger
-      @logger = Logger.new($stdout)
+      @logger = Appsignal::Logger.new($stdout)
       logger.formatter = log_formatter("appsignal")
     end
 
     def start_file_logger(path)
-      @logger = Logger.new(path)
+      @logger = Appsignal::Logger.new(path)
       logger.formatter = log_formatter
     rescue SystemCallError => error
       start_stdout_logger

data/lib/appsignal/logger.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "logger"
+require "set"
+
+# Subclass of logger with method to only log a warning once
+# prevents the log from filling up with repeated messages.
+module Appsignal
+  class Logger < ::Logger
+    def seen_keys
+      @seen_keys ||= Set.new
+    end
+
+    def warn_once_then_debug(key, message)
+      if !seen_keys.add?(key).nil?
+        warn message
+      else
+        debug message
+      end
+    end
+  end
+end

data/lib/appsignal/transaction.rb

@@ -25,7 +25,7 @@ module Appsignal
           Thread.current[:appsignal_transaction] = Appsignal::Transaction.new(id, namespace, request, options)
         else
           # Otherwise, log the issue about trying to start another transaction
-          Appsignal.logger.warn "Trying to start new transaction with id " \
+          Appsignal.logger.warn_once_then_debug :transaction_id, "Trying to start new transaction with id " \
             "'#{id}', but a transaction with id '#{current.transaction_id}' " \
             "is already running. Using transaction '#{current.transaction_id}'."
 

data/lib/appsignal/version.rb

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

data/spec/lib/appsignal/logger_spec.rb

@@ -0,0 +1,25 @@
+describe Appsignal::Logger do
+  let(:log) { std_stream }
+  let(:logger) do
+    Appsignal::Logger.new(log).tap do |l|
+      l.formatter = logger_formatter
+    end
+  end
+
+  describe "#seen_keys" do
+    it "returns a Set" do
+      expect(logger.seen_keys).to be_a(Set)
+    end
+  end
+
+  describe "#warn_once_then_debug" do
+    it "only warns once, then uses debug" do
+      message = "This is a log line"
+      3.times { logger.warn_once_then_debug(:key, message) }
+
+      logs = log_contents(log)
+      expect(logs.scan(/#{Regexp.escape(log_line(:WARN, message))}/).count).to eql(1)
+      expect(logs.scan(/#{Regexp.escape(log_line(:DEBUG, message))}/).count).to eql(2)
+    end
+  end
+end

data/spec/lib/appsignal_spec.rb

@@ -1021,6 +1021,7 @@ describe Appsignal do
             Appsignal.start_logger
             Appsignal.logger.error("Log to file")
           end
+          expect(Appsignal.logger).to be_a(Appsignal::Logger)
         end
 
         it "logs to file" do
@@ -1043,6 +1044,7 @@ describe Appsignal do
             initialize_config
             Appsignal.start_logger
             Appsignal.logger.error("Log to not writable log file")
+            expect(Appsignal.logger).to be_a(Appsignal::Logger)
           end
         end
 
@@ -1073,6 +1075,7 @@ describe Appsignal do
           Appsignal.start_logger
           Appsignal.logger.error("Log to not writable log path")
         end
+        expect(Appsignal.logger).to be_a(Appsignal::Logger)
       end
       after do
         FileUtils.chmod 0o755, Appsignal::Config.system_tmp_dir
@@ -1101,6 +1104,7 @@ describe Appsignal do
           Appsignal.start_logger
           Appsignal.logger.error("Log to stdout")
         end
+        expect(Appsignal.logger).to be_a(Appsignal::Logger)
       end
       around { |example| recognize_as_heroku { example.run } }
 

data/spec/support/helpers/log_helpers.rb

@@ -12,15 +12,22 @@ module LogHelpers
   end
 
   def test_logger(log)
-    Logger.new(log).tap do |logger|
-      logger.formatter =
-        proc do |severity, _datetime, _progname, msg|
-          # This format is used in the `contains_log` matcher.
-          "[#{severity}] #{msg}\n"
-        end
+    Appsignal::Logger.new(log).tap do |logger|
+      logger.formatter = logger_formatter
     end
   end
 
+  def logger_formatter
+    proc do |severity, _datetime, _progname, msg|
+      log_line(severity, msg)
+    end
+  end
+
+  def log_line(severity, message)
+    # This format is used in the `contains_log` matcher.
+    "[#{severity}] #{message}\n"
+  end
+
   def log_contents(log)
     log.rewind
     log.read

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appsignal
 version: !ruby/object:Gem::Version
-  version: 2.10.2
+  version: 2.10.3
 platform: ruby
 authors:
 - Robert Beekman
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2020-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -237,6 +237,7 @@ files:
 - lib/appsignal/integrations/sinatra.rb
 - lib/appsignal/integrations/webmachine.rb
 - lib/appsignal/js_exception_transaction.rb
+- lib/appsignal/logger.rb
 - lib/appsignal/marker.rb
 - lib/appsignal/minutely.rb
 - lib/appsignal/rack/generic_instrumentation.rb
@@ -314,6 +315,7 @@ files:
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/webmachine_spec.rb
 - spec/lib/appsignal/js_exception_transaction_spec.rb
+- spec/lib/appsignal/logger_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/minutely_spec.rb
 - spec/lib/appsignal/rack/generic_instrumentation_spec.rb
@@ -392,7 +394,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Logs performance and exception data from your app to appsignal.com
@@ -452,6 +454,7 @@ test_files:
 - spec/lib/appsignal/integrations/sinatra_spec.rb
 - spec/lib/appsignal/integrations/webmachine_spec.rb
 - spec/lib/appsignal/js_exception_transaction_spec.rb
+- spec/lib/appsignal/logger_spec.rb
 - spec/lib/appsignal/marker_spec.rb
 - spec/lib/appsignal/minutely_spec.rb
 - spec/lib/appsignal/rack/generic_instrumentation_spec.rb