scout_apm 6.3.1 → 6.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97692f03252aa5c2af4a4f87092742319b9088dace2f3dbcb4c48af766dfb848
-  data.tar.gz: 30bc39d151abec5d26723b2de0626319cf80685548a0f68da48074e283c72515
+  metadata.gz: 647c2a2c8787f10d68fde13900fce45112cf0cc2686559b1a8a9df06eaab9f36
+  data.tar.gz: f5085e257c1cf9988d005d2d87cfce79997f30d2672b9021a7632f4a3870913d
 SHA512:
-  metadata.gz: 0c6a06a5e08a3a753a7110568f44d9c9c6b0163aeeabf3be281a2de9df6a2357f14515de7419c9dedd79e8f7e8266dca67cbf58b3dbac2e6efb54f283ba4d433
-  data.tar.gz: 13bacea25583bf396a3e4d0edee2e957a756296a3c4fcf6083a5a42b5e0bb2e57c90a9751dd6b04f7d86f0315d8c30222ba4d3d0c9c679aa2d73eb1eb38b2eb3
+  metadata.gz: e996594b47f8765c9cad43fa774d1d72d51f5beec9923d2836e9caf0a344280e8270d08bb9812fc535f8ddd6c642eeba4b6e221070e62b3d9781ddfaccec1bc2
+  data.tar.gz: 95f2051eedde3f0b9c24a25a98ec5f28fa1d637ce23c83fac59aee0d73e1083c6469f537bb6ae270faa88477aa331858bb5f54d6c1853894100c8af628f8e74c

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # Pending
 
+# 6.3.2
+
+- Build the per-minute debug dumps of metrics, slow traces and auto-instrument histograms only when debug logging is enabled (#639)
+
 # 6.3.1
 
 - Capture route names for Grape 4 (#635)

data/lib/scout_apm/periodic_work.rb

@@ -21,6 +21,8 @@ module ScoutApm
     private
 
     def log_autoinstrument_significant_counts
+      return unless context.logger.debug?
+
       # Ex key/value -
       # "/Users/dlite/projects/scout/apm/app/controllers/application_controller.rb"=>[[0.0, 689], [1.0, 16]]
       hists = context.auto_instruments_layer_histograms.as_json

data/lib/scout_apm/reporting.rb

@@ -118,7 +118,7 @@ module ScoutApm
       histogram_clause  = "#{histograms.length} Histograms"
 
       logger.info "#{time_clause} Delivering #{metrics_clause} and #{slow_trans_clause} and #{job_clause}, #{process_log_str}."
-      logger.debug("\n\nMetrics: #{metrics.pretty_inspect}\nSlowTrans: #{slow_transactions.pretty_inspect}\nMetadata: #{metadata.inspect.pretty_inspect}\n\n")
+      logger.debug { "\n\nMetrics: #{metrics.pretty_inspect}\nSlowTrans: #{slow_transactions.pretty_inspect}\nMetadata: #{metadata.inspect.pretty_inspect}\n\n" }
     end
 
     # TODO: Move this into PayloadSerializer?

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "6.3.1"
+  VERSION = "6.3.2"
 end

data/test/unit/reporting_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+class ReportingTest < Minitest::Test
+  class InspectCountingHash < Hash
+    attr_reader :pretty_inspect_calls
+
+    def pretty_inspect
+      @pretty_inspect_calls = (@pretty_inspect_calls || 0) + 1
+      super
+    end
+  end
+
+  FakeContext = Struct.new(:logger)
+
+  def test_log_deliver_skips_debug_dump_when_debug_is_disabled
+    metrics = InspectCountingHash.new
+    reporting = ScoutApm::Reporting.new(FakeContext.new(logger_at(::Logger::INFO)))
+
+    reporting.log_deliver(metrics, [], { :agent_time => Time.now.iso8601 }, [], [])
+
+    assert_nil metrics.pretty_inspect_calls
+  end
+
+  def test_log_deliver_writes_debug_dump_when_debug_is_enabled
+    metrics = InspectCountingHash.new
+    output = StringIO.new
+    reporting = ScoutApm::Reporting.new(FakeContext.new(logger_at(::Logger::DEBUG, output)))
+
+    reporting.log_deliver(metrics, [], { :agent_time => Time.now.iso8601 }, [], [])
+
+    assert_equal 1, metrics.pretty_inspect_calls
+    assert_match(/Metrics:/, output.string)
+  end
+
+  private
+
+  def logger_at(level, output = StringIO.new)
+    ::Logger.new(output).tap { |logger| logger.level = level }
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 6.3.1
+  version: 6.3.2
 platform: ruby
 authors:
 - Derek Haynes
@@ -485,6 +485,7 @@ files:
 - test/unit/remote/message_test.rb
 - test/unit/remote/route_test.rb
 - test/unit/remote/server_test.rb
+- test/unit/reporting_test.rb
 - test/unit/request_histograms_test.rb
 - test/unit/request_manager_test.rb
 - test/unit/sampling_test.rb