scout_apm 1.2.7 → 1.2.8.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9efb3b04bdfcd19df6d60a358e8b30abe48be29b
-  data.tar.gz: b53820b59423029619cef843ba6887bbc0f61118
+  metadata.gz: 648de873df09b8d7419abd803d9180fb67e1595d
+  data.tar.gz: 61cf23bc15c91ba74022f8390348cf4896bfd9d5
 SHA512:
-  metadata.gz: 65a5694303ce81df40aa755877732b98fa5e849f51849ab37e96b3ea22ad3bc38f0ed8a29ed2c1c98e6e8107b252aff6d0319f875da25151470758e1a0445789
-  data.tar.gz: 4222de374831297d9a6bd87b167324b7d5d542086296bb6213f1a53c3c3d2cdfc8521217d98dfca5d546845be97809bd80b37f9b7f93c143100704f2f3864169
+  metadata.gz: 8856fc5d888b1a6243b16e2b04d1d4d60f84167d1dea79032e504d6b21f2fb43292df433cb6c5b99454c39fa529529d5f534880b8867d7a3446834228c164366
+  data.tar.gz: c7142c814ad6c572381688dea1baf5fdcd6f968bd6d79dff59fb7bfe68fb1e6822abf22d3ff8e0ec8d24e9bc6e1cfca748cb91e7091914ea65fe1cf0897678c1

data/CHANGELOG.markdown

@@ -1,3 +1,8 @@
+# 1.2.8
+
+* Enhance shutdown code to be sure we save current-minute metrics and minimize
+  the amount of work necessary.
+
 # 1.2.7
 
 * Clarifying that Rails3 instrumentation also supports Rails4

data/lib/scout_apm/agent.rb

@@ -152,15 +152,21 @@ module ScoutApm
       end
     end
 
-    # Called via an at_exit handler, it (1) stops the background worker and (2) runs it a final time.
-    # The final run ensures metrics are stored locally to the layaway / reported to scoutapp.com. Otherwise,
-    # in-memory metrics would be lost and a gap would appear on restarts.
+    # Called via an at_exit handler, it:
+    # (1) Stops the background worker
+    # (2) Stores metrics locally (forcing current-minute metrics to be written)
+    # It does not attempt to actually report metrics.
     def shutdown
+      logger.info "Shutting down ScoutApm"
       return if !started?
       if @background_worker
         @background_worker.stop
-        @background_worker.run_once
+        store.write_to_layaway(layaway, :force)
       end
+
+      # Make sure we don't exit the process while the background worker is running its task.
+      logger.debug "Joining background worker thread"
+      @background_worker_thread.join if @background_worker_thread
     end
 
     def started?

data/lib/scout_apm/background_worker.rb

@@ -23,20 +23,33 @@ module ScoutApm
     # Starts running the passed block every 60 seconds (starting now).
     def start(&block)
       @task = block
+
       begin
         ScoutApm::Agent.instance.logger.debug "Starting Background Worker, running every #{period} seconds"
-        next_time = Time.now
-        while @keep_running do
+
+        # The first run should be 1 period of time from now
+        next_time = Time.now + period
+
+        loop do
           now = Time.now
+
+          # Sleep the correct amount of time to reach next_time
           while now < next_time
             sleep_time = next_time - now
             sleep(sleep_time) if sleep_time > 0
             now = Time.now
           end
+
+          # Bail out if @keep_running is false
+          break unless @keep_running
+
           @task.call
+
+          # Adjust the next time to run forward by @periods until it is in the future
           while next_time <= now
             next_time += period
           end
+
         end
       rescue
         ScoutApm::Agent.instance.logger.debug "Background Worker Exception!"

data/lib/scout_apm/layaway.rb

@@ -11,9 +11,18 @@ module ScoutApm
     def add_reporting_period(time, reporting_period)
       file.read_and_write do |existing_data|
         existing_data ||= Hash.new
-        existing_data.merge(time => reporting_period) {|key, old_val, new_val|
+        ScoutApm::Agent.instance.logger.debug("AddReportingPeriod: Adding a reporting_period with timestamp: #{reporting_period.timestamp.to_s}, and #{reporting_period.request_count} requests")
+
+        existing_data = existing_data.merge(time => reporting_period) {|key, old_val, new_val|
+          old_req = old_val.request_count
+          new_req = new_val.request_count
+          ScoutApm::Agent.instance.logger.debug("Merging Two reporting periods (#{old_val.timestamp.to_s}, #{new_val.timestamp.to_s}): old req #{old_req}, new req #{new_req}")
+
           old_val.merge_metrics!(new_val.metrics_payload).merge_slow_transactions!(new_val.slow_transactions)
         }
+
+        ScoutApm::Agent.instance.logger.debug("AddReportingPeriod: AfterMerge Timestamps: #{existing_data.keys.map(&:to_s).inspect}")
+        existing_data
       end
     end
 
@@ -24,6 +33,9 @@ module ScoutApm
       ready_for_delivery = []
       file.read_and_write do |existing_data|
         existing_data ||= {}
+
+        ScoutApm::Agent.instance.logger.debug("PeriodsReadyForDeliver: All Timestamps: #{existing_data.keys.map(&:to_s).inspect}")
+
         ready_for_delivery = existing_data.to_a.select {|time, rp| should_send?(rp) } # Select off the values we want. to_a is needed for compatibility with Ruby 1.8.7.
 
         # Rewrite anything not plucked out back to the file

data/lib/scout_apm/store.rb

@@ -38,14 +38,21 @@ module ScoutApm
     end
 
     # Take each completed reporting_period, and write it to the layaway passed
-    def write_to_layaway(layaway)
+    #
+    # force - a boolean argument that forces this function to write
+    # current-minute metrics.  Useful when we are shutting down the agent
+    # during a restart.
+    def write_to_layaway(layaway, force=false)
+      ScoutApm::Agent.instance.logger.debug("Writing to layaway#{" (Forced)" if force}")
+
       @mutex.synchronize {
-        reporting_periods.select { |time, rp| time.timestamp < current_timestamp.timestamp}.
+        reporting_periods.select { |time, rp| force || time.timestamp < current_timestamp.timestamp}.
                           each   { |time, rp|
                                    layaway.add_reporting_period(time, rp)
                                    reporting_periods.delete(time)
                                  }
       }
+      ScoutApm::Agent.instance.logger.debug("Finished writing to layaway")
     end
   end
 
@@ -60,7 +67,7 @@ module ScoutApm
     end
 
     def to_s
-      @raw_time.iso8601
+      Time.at(@timestamp).iso8601
     end
 
     def eql?(o)
@@ -123,6 +130,16 @@ module ScoutApm
       @slow_transactions.to_a
     end
 
+    #################################
+    # Debug Helpers
+    #################################
+
+    def request_count
+      metrics_payload.
+        select { |meta,stats| meta.metric_name =~ /\AController/ }.
+        inject(0) {|sum, (_, stat)| sum + stat.call_count }
+    end
+
     private
 
     # Removes payloads from slow transactions that exceed +SlowRequestPolicy::MAX_DETAIL_PER_MINUTE+ to avoid

data/lib/scout_apm/tracked_request.rb

@@ -139,6 +139,8 @@ module ScoutApm
 
       queue_time_metrics = RequestQueueTime.new(self).call
       ScoutApm::Agent.instance.store.track!(queue_time_metrics)
+
+      # ScoutApm::Agent.instance.logger.debug("Finished recording request") if metrics.any?
     end
 
     # Have we already persisted this request?

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.2.7"
+  VERSION = "1.2.8.pre1"
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8.pre1
 platform: ruby
 authors:
 - Derek Haynes
@@ -170,12 +170,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: scout_apm
-rubygems_version: 2.4.8
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring