scout_apm 4.1.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd64c67ede26abdf0cf372b50d0cf025531d5719353b033160e9497fe2abf94f
-  data.tar.gz: c31ae7044cce7eb1d869ef8d1130f269b17b53864c9ad8f2c114d822478a1eda
+  metadata.gz: f9a94a38d6b06a02e34ce7923e8084976739cc8d0fba1adfbc606f88b0bdf4d7
+  data.tar.gz: aebe73f5379911e8691be2771b3a3fc3f5fbdd4779f2038f6a6f6e0ed38e1e20
 SHA512:
-  metadata.gz: 9c12b178b6b6f4ee7ea6add58a5e2b13d362684c7825441e7164dcb878ec75befa4312efd7566dab95f5461401f4591eaa2bc86f477ec4776fed175bdb3f6321
-  data.tar.gz: 3b832fc6ab0c0e676d574e29e37f15f849ddf886ea1d76972bdf81b42431d9daab5caacbc2867b2b22dfb71c3a31ae94d6b64372a297de0f5ec384d7d9ef45bc
+  metadata.gz: d8850b1365747879effcfe383d0b438070069d2b625365dc8ea61db7c72cf6840cdf73675c95aea7a7688750dbcb41efec1b7320232312172bc49be9b207d421
+  data.tar.gz: f3d389aa73f8b4090627843410c610edc1c5fa88740587136dbd8277d3ddfa5360e61d0d256ae23db7cf53f20b482d3f283541c077efcd2d12032e5f3f72f4e2

data/CHANGELOG.markdown

@@ -1,3 +1,12 @@
+# 5.0.0
+
+* Add External Service metrics reporting (#403)
+* Relicense to MIT (#429)
+* Opt out of frozen string literals in select files (#427)
+* Fall back when logger can't write to destination (#423)
+* Avoid exception on race condition (#407)
+* Add Mina deploy tracking support (#327)
+
 # 4.1.2
 
 * Add record_queue_time configuration (PR #422)

data/LICENSE.md

@@ -1,31 +1,24 @@
-# Scout Software Agent License 
-
-Subject to and conditioned upon your continued compliance with the terms and conditions of this license, Zimuth, Inc. grants you a non-exclusive, non-sublicensable and non-transferable, limited license to install, use and run one copy of this software on each of your and your affiliate’s computers.  This license also grants you the limited right to distribute verbatim copies of this software and documentation to third parties provided the software and documentation will (a) remain the exclusive property of Zimuth; (b) be subject to the terms and conditions of this license; and (c) include a complete and unaltered copy of this license and all other copyright or other intellectual property rights notices contained in the original.
-
-The software includes the open-source components listed below. Any use of the open-source components by you shall be governed by, and subject to, the terms and conditions of the applicable open-source licenses.
-
-Except as this license expressly permits, you may not:
-
-* copy the software, in whole or in part; 
-* modify, correct, adapt, translate, enhance or otherwise prepare derivative works or improvements of the software; 
-* sell, sublicense, assign, distribute, publish, transfer or otherwise make available the software to any person or entity; 
-* remove, delete, efface, alter, obscure, translate, combine, supplement or otherwise change any trademarks, terms of the documentation, warranties, disclaimers, or intellectual property rights, or other symbols, notices, marks or serial numbers on or relating to any copy of the software or documentation; or
-use the software in any manner or for any purpose that infringes, misappropriates or otherwise violates any intellectual property right or other right of any person or entity, or that violates any applicable law;
-
-By using the software, you acknowledge and agree that:
-
-* the software and documentation are licensed, not sold, to you by Zimuth and you do not and will not have or acquire under or in connection with this license any ownership interest in the software or documentation, or in any related intellectual property rights; and
-* Zimuth will remain the sole and exclusive owner of all right, title and interest in and to the software and documentation, including all related intellectual property rights, subject only to the rights of third parties in open-source components and the limited license granted to you under this license; and
-
-Except for the limited rights and licenses expressly granted to you under this agreement, nothing in this license grants, by implication, waiver, estoppel or otherwise, to you or any third party any intellectual property rights or other right, title, or interest in or to any of the software or documentation.
- 
-This license shall be automatically terminated and revoked if you exceed the scope or violate any terms and conditions of this license. 
-
-ALL LICENSED SOFTWARE, DOCUMENTATION AND OTHER PRODUCTS, INFORMATION, MATERIALS AND SERVICES PROVIDED BY ZIMUTH ARE PROVIDED HERE “AS IS.” ZIMUTH DISCLAIMS ALL WARRANTIES, WHETHER EXPRESS, IMPLIED, STATUTORY OR OTHER (INCLUDING ALL WARRANTIES ARISING FROM COURSE OF DEALING, USAGE OR TRADE PRACTICE), AND SPECIFICALLY DISCLAIMS ALL IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. WITHOUT LIMITING THE FOREGOING, ZIMUTH MAKES NO WARRANTY OF ANY KIND THAT THE LICENSED SOFTWARE OR DOCUMENTATION, OR ANY OTHER LICENSOR OR THIRD-PARTY GOODS, SERVICES, TECHNOLOGIES OR MATERIALS, WILL MEET YOUR REQUIREMENTS, OPERATE WITHOUT INTERRUPTION, ACHIEVE ANY INTENDED RESULT, BE COMPATIBLE OR WORK WITH ANY OTHER GOODS, SERVICES, TECHNOLOGIES OR MATERIALS (INCLUDING ANY SOFTWARE, HARDWARE, SYSTEM OR NETWORK) EXCEPT IF AND TO THE EXTENT EXPRESSLY SET FORTH IN THE DOCUMENTATION, OR BE SECURE, ACCURATE, COMPLETE, FREE OF HARMFUL CODE OR ERROR FREE. ALL OPEN-SOURCE COMPONENTS AND OTHER THIRD-PARTY MATERIALS ARE PROVIDED “AS IS” AND ANY REPRESENTATION OR WARRANTY OF OR CONCERNING ANY OF THEM IS STRICTLY BETWEEN LICENSEE AND THE THIRD-PARTY OWNER OR DISTRIBUTOR OF SUCH OPEN-SOURCE COMPONENTS AND THIRD-PARTY MATERIALS.
- 
-IN NO EVENT WILL ZIMUTH BE LIABLE UNDER OR IN CONNECTION WITH THIS LICENSE OR ITS SUBJECT MATTER UNDER ANY LEGAL OR EQUITABLE THEORY, INCLUDING BREACH OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY AND OTHERWISE, FOR ANY CONSEQUENTIAL, INCIDENTAL, INDIRECT, EXEMPLARY, SPECIAL, ENHANCED OR PUNITIVE DAMAGES, IN EACH CASE REGARDLESS OF WHETHER SUCH PERSONS WERE ADVISED OF THE POSSIBILITY OF SUCH LOSSES OR DAMAGES OR SUCH LOSSES OR DAMAGES WERE OTHERWISE FORESEEABLE, AND NOTWITHSTANDING THE FAILURE OF ANY AGREED OR OTHER REMEDY OF ITS ESSENTIAL PURPOSE.
-
-## OPEN SOURCE COMPONENTS
+The MIT License (MIT)
+
+Copyright (c) 2015-2021 Zimuth, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
 
 This product includes `rusage`, which inherits the Artistic License 2.0 from proc/wait3.
 See http://www.rubydoc.info/gems/rusage/0.2.0.

data/lib/scout_apm/config.rb

@@ -56,6 +56,8 @@ module ScoutApm
         'direct_host',
         'disabled_instruments',
         'enable_background_jobs',
+        'external_service_metric_limit',
+        'external_service_metric_report_limit',
         'host',
         'hostname',
         'ignore',
@@ -179,6 +181,8 @@ module ScoutApm
       'compress_payload' => BooleanCoercion.new,
       'database_metric_limit'  => IntegerCoercion.new,
       'database_metric_report_limit' => IntegerCoercion.new,
+      'external_service_metric_limit'  => IntegerCoercion.new,
+      'external_service_metric_report_limit' => IntegerCoercion.new,
       'instrument_http_url_length' => IntegerCoercion.new,
       'record_queue_time' => BooleanCoercion.new,
       'start_resque_server_instrument' => BooleanCoercion.new,
@@ -292,6 +296,8 @@ module ScoutApm
         'remote_agent_port'      => 7721, # picked at random
         'database_metric_limit'  => 5000, # The hard limit on db metrics
         'database_metric_report_limit' => 1000,
+        'external_service_metric_limit'  => 5000, # The hard limit on external service metrics
+        'external_service_metric_report_limit' => 1000,
         'instrument_http_url_length' => 300,
         'start_resque_server_instrument' => true, # still only starts if Resque is detected
         'collect_remote_ip' => true,

data/lib/scout_apm/external_service_metric_set.rb

@@ -0,0 +1,97 @@
+# Note, this class must be Marshal Dumpable
+module ScoutApm
+  class ExternalServiceMetricSet
+    include Enumerable
+
+    attr_reader :metrics # the raw metrics. You probably want #metrics_to_report
+
+    def marshal_dump
+      [ @metrics ]
+    end
+
+    def marshal_load(array)
+      @metrics = array.first
+      @context = ScoutApm::Agent.instance.context
+    end
+
+    def initialize(context)
+      @context = context
+
+      # A hash of ExternalServiceMetricStats values, keyed by ExternalServiceMetricStats.key
+      @metrics = Hash.new
+    end
+
+    # Need to look this up again if we end up as nil. Which I guess can happen
+    # after a Marshal load?
+    def context
+      @context ||= ScoutApm::Agent.instance.context
+    end
+
+    def each
+      metrics.each do |_key, external_service_metric_stat|
+        yield external_service_metric_stat
+      end
+    end
+
+    # Looks up a ExternalServiceMetricStats instance in the +@metrics+ hash. Sets the value to +other+ if no key
+    # Returns a ExternalServiceMetricStats instance
+    def lookup(other)
+      metrics[other.key] ||= other
+    end
+
+    # Take another set, and merge it with this one
+    def combine!(other)
+      other.each do |metric|
+        self << metric
+      end
+      self
+    end
+
+    # Add a single ExternalServiceMetricStats object to this set.
+    #
+    # Looks up an existing one under this key and merges, or just saves a new
+    # one under the key
+    def <<(stat)
+      existing_stat = metrics[stat.key]
+      if existing_stat
+        existing_stat.combine!(stat)
+      elsif at_limit?
+        # We're full up, can't add any more.
+        # Should I log this? It may get super noisy?
+      else
+        metrics[stat.key] = stat
+      end
+    end
+
+    def increment_transaction_count!
+      metrics.each do |_key, external_service_metric_stat|
+        external_service_metric_stat.increment_transaction_count!
+      end
+    end
+
+    def metrics_to_report
+      report_limit = context.config.value('external_service_metric_report_limit')
+      if metrics.size > report_limit
+        metrics.
+          values.
+          sort_by {|stat| stat.call_time }.
+          reverse.
+          take(report_limit)
+      else
+        metrics.values
+      end
+    end
+
+    def inspect
+      metrics.map {|key, metric|
+        "#{key.inspect} - Count: #{metric.call_count}, Total Time: #{"%.2f" % metric.call_time}"
+      }.join("\n")
+    end
+
+    def at_limit?
+      @limit ||= context.config.value('external_service_metric_limit')
+      metrics.size >= @limit
+    end
+
+  end
+end

data/lib/scout_apm/external_service_metric_stats.rb

@@ -0,0 +1,85 @@
+module ScoutApm
+  class ExternalServiceMetricStats
+
+    DEFAULT_HISTOGRAM_SIZE = 50
+
+    attr_reader :domain_name
+    attr_reader :operation
+    attr_reader :scope
+
+    attr_reader :transaction_count
+
+    attr_reader :call_count
+    attr_reader :call_time
+
+    attr_reader :min_call_time
+    attr_reader :max_call_time
+
+    attr_reader :histogram
+
+    def initialize(domain_name, operation, scope, call_count, call_time)
+      @domain_name = domain_name
+      @operation = operation
+
+      @call_count = call_count
+
+      @call_time = call_time
+      @min_call_time = call_time
+      @max_call_time = call_time
+
+      # This histogram is for call_time
+      @histogram = NumericHistogram.new(DEFAULT_HISTOGRAM_SIZE)
+      @histogram.add(call_time)
+
+      @transaction_count = 0
+
+      @scope = scope
+    end
+
+    # Merge data in this scope. Used in ExternalServiceMetricSet
+    def key
+      @key ||= [domain_name, operation, scope]
+    end
+
+    # Combine data from another ExternalServiceMetricStats into +self+. Modifies and returns +self+
+    def combine!(other)
+      return self if other == self
+
+      @transaction_count += other.transaction_count
+      @call_count += other.call_count
+      @call_time += other.call_time
+
+      @min_call_time = other.min_call_time if @min_call_time.zero? or other.min_call_time < @min_call_time
+      @max_call_time = other.max_call_time if other.max_call_time > @max_call_time
+
+      @histogram.combine!(other.histogram)
+      self
+    end
+
+    def as_json
+      json_attributes = [
+        :domain_name,
+        :operation,
+        :scope,
+
+        :transaction_count,
+        :call_count,
+
+        :histogram,
+        :call_time,
+        :max_call_time,
+        :min_call_time,
+      ]
+
+      ScoutApm::AttributeArranger.call(self, json_attributes)
+    end
+
+    # Called by the Set on each ExternalServiceMetricStats object that it holds, only
+    # once during the recording of a transaction.
+    #
+    # Don't call elsewhere, and don't set to 1 in the initializer.
+    def increment_transaction_count!
+      @transaction_count += 1
+    end
+  end
+end

data/lib/scout_apm/fake_store.rb

@@ -26,6 +26,9 @@ module ScoutApm
     def track_db_query_metrics!(db_query_metric_set, options={})
     end
 
+    def track_external_service_metrics!(external_service_metric_set, options={})
+    end
+
     def track_slow_transaction!(slow_transaction)
     end
 

data/lib/scout_apm/git_revision.rb

@@ -20,6 +20,7 @@ module ScoutApm
       detect_from_config     ||
       detect_from_heroku     ||
       detect_from_capistrano ||
+      detect_from_mina ||
       detect_from_git
     end
 
@@ -43,6 +44,14 @@ module ScoutApm
       nil
     end
 
+    # https://github.com/mina-deploy/mina
+    def detect_from_mina 
+      File.read(File.join(app_root, '.mina_git_revision')).strip
+    rescue
+      logger.debug "Unable to detect Git Revision from Mina: #{$!.message}"
+      nil
+    end
+
     def detect_from_git
       if File.directory?(".git")
         `git rev-parse --short HEAD`.strip 

data/lib/scout_apm/instant/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 module ScoutApm
   module Instant
 

data/lib/scout_apm/instruments/elasticsearch.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 module ScoutApm
   module Instruments
     class Elasticsearch

data/lib/scout_apm/instruments/sinatra.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 # XXX: Is this file used?
 module ScoutApm
   module Instruments

data/lib/scout_apm/layer_converters/external_service_converter.rb

@@ -0,0 +1,65 @@
+module ScoutApm
+  module LayerConverters
+    class ExternalServiceConverter < ConverterBase
+      def initialize(*)
+        super
+        @external_service_metric_set = ExternalServiceMetricSet.new(context)
+      end
+
+      def register_hooks(walker)
+        super
+
+        return unless scope_layer
+
+        walker.on do |layer|
+          next if skip_layer?(layer)
+          stat = ExternalServiceMetricStats.new(
+            domain_name(layer),
+            operation_name(layer),          # operation name/verb. GET/POST/PUT etc.
+            scope_layer.legacy_metric_name, # controller_scope
+            1,                              # count, this is a single call, so 1
+            layer.total_call_time
+          )
+          @external_service_metric_set << stat
+        end
+      end
+
+      def record!
+        # Everything in the metric set here is from a single transaction, which
+        # we want to keep track of. (One web call did a User#find 10 times, but
+        # only due to 1 http request)
+        @external_service_metric_set.increment_transaction_count!
+        @store.track_external_service_metrics!(@external_service_metric_set)
+
+        nil # not returning anything in the layer results ... not used
+      end
+
+      def skip_layer?(layer)
+        layer.type != 'HTTP' ||
+          layer.limited? ||
+          super
+      end
+
+      private
+
+      # If we can't name the domain name, default to:
+      DEFAULT_DOMAIN = "Unknown"
+
+      def domain_name(layer)
+        domain = ""
+        desc_str = layer.desc.to_s
+        desc_str = 'http://' + desc_str unless desc_str =~ /^http/i
+        domain = URI.parse(desc_str).host
+      rescue
+        # Do nothing
+      ensure
+        domain = DEFAULT_DOMAIN if domain.to_s.blank?
+        domain
+      end
+
+      def operation_name(layer)
+        "all" # Hardcode to "all" until we support breakout by verb
+      end
+    end
+  end
+end

data/lib/scout_apm/logger.rb

@@ -69,7 +69,7 @@ module ScoutApm
     private
 
     def build_logger
-      logger_class.new(@log_destination)
+      logger_class.new(@log_destination) rescue logger_class.new
     end
 
     def logger_class

data/lib/scout_apm/reporting.rb

@@ -83,11 +83,12 @@ module ScoutApm
       slow_jobs = reporting_period.slow_jobs_payload
       histograms = reporting_period.histograms
       db_query_metrics = reporting_period.db_query_metrics_payload
+      external_service_metrics = reporting_period.external_service_metrics_payload
       traces = (slow_transactions.map(&:span_trace) + slow_jobs.map(&:span_trace)).compact
 
       log_deliver(metrics, slow_transactions, metadata, slow_jobs, histograms)
 
-      payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
+      payload = ScoutApm::Serializers::PayloadSerializer.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, external_service_metrics, traces)
       logger.debug("Sending payload w/ Headers: #{headers.inspect}")
 
       reporter.report(payload, headers)

data/lib/scout_apm/serializers/external_service_serializer_to_json.rb

@@ -0,0 +1,15 @@
+module ScoutApm
+  module Serializers
+    class ExternalServiceSerializerToJson
+      attr_reader :external_service_metrics
+
+      def initialize(external_service_metrics)
+        @external_service_metrics = external_service_metrics
+      end
+
+      def as_json
+        external_service_metrics.map{|metric| metric.as_json }
+      end
+    end
+  end
+end

data/lib/scout_apm/serializers/payload_serializer.rb

@@ -2,9 +2,9 @@
 module ScoutApm
   module Serializers
     class PayloadSerializer
-      def self.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
+      def self.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, external_service_metrics, traces)
         if ScoutApm::Agent.instance.context.config.value("report_format") == 'json'
-          ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
+          ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, external_service_metrics, traces)
         else
           metadata = metadata.dup
           metadata.default = nil
@@ -22,7 +22,8 @@ module ScoutApm
                        # payloads. At this point, the marshal code branch is
                        # very rarely used anyway.
                        :histograms        => HistogramsSerializerToJson.new(histograms).as_json,
-                       :db_query_metrics  => db_query_metrics)
+                       :db_query_metrics  => db_query_metrics,
+                       :external_service_metrics  => external_service_metrics)
         end
       end
 

data/lib/scout_apm/serializers/payload_serializer_to_json.rb

@@ -2,7 +2,7 @@ module ScoutApm
   module Serializers
     module PayloadSerializerToJson
       class << self
-        def serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, traces)
+        def serialize(metadata, metrics, slow_transactions, jobs, slow_jobs, histograms, db_query_metrics, external_service_metrics, traces)
           metadata.merge!({:payload_version => 2})
 
           jsonify_hash({:metadata => metadata,
@@ -14,6 +14,9 @@ module ScoutApm
                         :db_metrics => {
                           :query => DbQuerySerializerToJson.new(db_query_metrics).as_json,
                         },
+                        :es_metrics => {
+                          :http => ExternalServiceSerializerToJson.new(external_service_metrics).as_json,
+                        },
                         :span_traces => traces.map{ |t| t.as_json },
           })
         end

data/lib/scout_apm/store.rb

@@ -52,6 +52,13 @@ module ScoutApm
       }
     end
 
+    def track_external_service_metrics!(external_service_metric_set, options={})
+      @mutex.synchronize {
+        period = find_period(options[:timestamp])
+        period.merge_external_service_metrics!(external_service_metric_set)
+      }
+    end
+
     def track_one!(type, name, value, options={})
       meta = MetricMeta.new("#{type}/#{name}")
       stat = MetricStats.new(false)
@@ -206,6 +213,8 @@ module ScoutApm
 
     attr_reader :db_query_metric_set
 
+    attr_reader :external_service_metric_set
+
     def initialize(timestamp, context)
       @timestamp = timestamp
 
@@ -216,6 +225,7 @@ module ScoutApm
 
       @metric_set = MetricSet.new
       @db_query_metric_set = DbQueryMetricSet.new(context)
+      @external_service_metric_set = ExternalServiceMetricSet.new(context)
 
       @jobs = Hash.new
     end
@@ -228,7 +238,8 @@ module ScoutApm
         merge_jobs!(other.jobs).
         merge_slow_jobs!(other.slow_jobs_payload).
         merge_histograms!(other.histograms).
-        merge_db_query_metrics!(other.db_query_metric_set)
+        merge_db_query_metrics!(other.db_query_metric_set).
+        merge_external_service_metrics!(other.external_service_metric_set)
       self
     end
 
@@ -254,6 +265,11 @@ module ScoutApm
       self
     end
 
+    def merge_external_service_metrics!(other_metric_set)
+      external_service_metric_set.combine!(other_metric_set)
+      self
+    end
+
     def merge_slow_transactions!(new_transactions)
       Array(new_transactions).each do |one_transaction|
         request_traces << one_transaction
@@ -316,6 +332,10 @@ module ScoutApm
       db_query_metric_set.metrics_to_report
     end
 
+    def external_service_metrics_payload
+      external_service_metric_set.metrics_to_report
+    end
+
     #################################
     # Debug Helpers
     #################################

data/lib/scout_apm/tracked_request.rb

@@ -117,7 +117,12 @@ module ScoutApm
       # Must follow layer.record_stop_time! as the total_call_time is used to determine if the layer is significant.
       return if layer_insignificant?(layer)
 
-      @layers[-1].add_child(layer) if @layers.any?
+      # Check that the parent exists before calling a method on it, since some threading can get us into a weird state.
+      # this doesn't fix that state, but prevents exceptions from leaking out.
+      parent = @layers[-1]
+      if parent
+        parent.add_child(layer)
+      end
 
       # This must be called before checking if a backtrace should be collected as the call count influences our capture logic.
       # We call `#update_call_counts in stop layer to ensure the layer has a final desc. Layer#desc is updated during the AR instrumentation flow.
@@ -315,6 +320,7 @@ module ScoutApm
         :queue_time => LayerConverters::RequestQueueTimeConverter,
         :job => LayerConverters::JobConverter,
         :db => LayerConverters::DatabaseConverter,
+        :external_service => LayerConverters::ExternalServiceConverter,
 
         :slow_job => LayerConverters::SlowJobConverter,
         :slow_req => LayerConverters::SlowRequestConverter,

data/lib/scout_apm/utils/sql_sanitizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 require 'scout_apm/environment'
 
 # Removes actual values from SQL. Used to both obfuscate the SQL and group

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "4.1.2"
+  VERSION = "5.0.0"
 end

data/lib/scout_apm.rb

@@ -42,6 +42,7 @@ require 'scout_apm/layer_converters/job_converter'
 require 'scout_apm/layer_converters/slow_job_converter'
 require 'scout_apm/layer_converters/metric_converter'
 require 'scout_apm/layer_converters/database_converter'
+require 'scout_apm/layer_converters/external_service_converter'
 require 'scout_apm/layer_converters/slow_request_converter'
 require 'scout_apm/layer_converters/request_queue_time_converter'
 require 'scout_apm/layer_converters/allocation_metric_converter'
@@ -130,6 +131,7 @@ require 'scout_apm/bucket_name_splitter'
 require 'scout_apm/stack_item'
 require 'scout_apm/metric_set'
 require 'scout_apm/db_query_metric_set'
+require 'scout_apm/external_service_metric_set'
 require 'scout_apm/store'
 require 'scout_apm/fake_store'
 require 'scout_apm/tracer'
@@ -142,6 +144,7 @@ require 'scout_apm/synchronous_recorder'
 require 'scout_apm/metric_meta'
 require 'scout_apm/metric_stats'
 require 'scout_apm/db_query_metric_stats'
+require 'scout_apm/external_service_metric_stats'
 require 'scout_apm/slow_transaction'
 require 'scout_apm/slow_job_record'
 require 'scout_apm/detailed_trace'
@@ -167,6 +170,7 @@ require 'scout_apm/serializers/slow_jobs_serializer_to_json'
 require 'scout_apm/serializers/metrics_to_json_serializer'
 require 'scout_apm/serializers/histograms_serializer_to_json'
 require 'scout_apm/serializers/db_query_serializer_to_json'
+require 'scout_apm/serializers/external_service_serializer_to_json'
 require 'scout_apm/serializers/directive_serializer'
 require 'scout_apm/serializers/app_server_load_serializer'
 

data/scout_apm.gemspec

@@ -12,8 +12,6 @@ Gem::Specification.new do |s|
   s.description = "Monitors Ruby apps and reports detailed metrics on performance to Scout."
   s.license     = "Proprietary (See LICENSE.md)"
 
-  s.rubyforge_project = "scout_apm"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }

data/test/unit/external_service_metric_set_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+require 'scout_apm/external_service_metric_set'
+
+module ScoutApm
+class ExternalServiceMetricSetTest < Minitest::Test
+  def test_hard_limit
+    config = make_fake_config(
+      'external_service_metric_limit' => 5, # The hard limit on db metrics
+      'external_service_metric_report_limit' => 2
+    )
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
+    set = ExternalServiceMetricSet.new(context)
+
+    set << fake_stat("a", 10)
+    set << fake_stat("b", 20)
+    set << fake_stat("c", 30)
+    set << fake_stat("d", 40)
+    set << fake_stat("e", 50)
+    set << fake_stat("f", 60)
+
+    assert_equal 5, set.metrics.size
+  end
+
+  def test_report_limit
+    config = make_fake_config(
+      'external_service_metric_limit' => 50, # much larger max, uninterested in hitting it.
+      'external_service_metric_report_limit' => 2
+    )
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
+    set = ExternalServiceMetricSet.new(context)
+    set << fake_stat("a", 10)
+    set << fake_stat("b", 20)
+    set << fake_stat("c", 30)
+    set << fake_stat("d", 40)
+    set << fake_stat("e", 50)
+    set << fake_stat("f", 60)
+
+    assert_equal 2, set.metrics_to_report.size
+    assert_equal ["f","e"], set.metrics_to_report.map{|m| m.key}
+  end
+
+  def test_combine
+    config = make_fake_config(
+      'external_service_metric_limit' => 5, # The hard limit on db metrics
+      'external_service_metric_report_limit' => 2
+    )
+    context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
+    set1 = ExternalServiceMetricSet.new(context)
+    set1 << fake_stat("a", 10)
+    set1 << fake_stat("b", 20)
+    set2 = ExternalServiceMetricSet.new(context)
+    set2 << fake_stat("c", 10)
+    set2 << fake_stat("d", 20)
+
+    combined = set1.combine!(set2)
+    assert_equal ["a", "b", "c", "d"], combined.metrics.map{|_k, m| m.key}.sort
+  end
+
+  def fake_stat(key, call_time)
+    OpenStruct.new(
+      :key => key,
+      :call_time => call_time
+    )
+  end
+end
+end

data/test/unit/external_service_metric_stats_test.rb

@@ -0,0 +1,106 @@
+require 'test_helper'
+
+require 'scout_apm/external_service_metric_stats'
+
+module ScoutApm
+class ExternalServiceMetricStatsTest < Minitest::Test
+  def test_as_json_empty_stats
+    stat = build("example.com", "GET", "Controller/public/index", 1, 10)
+
+    assert_equal({
+      :domain_name => "example.com",
+      :operation => "GET",
+      :call_count => 1,
+      :transaction_count => 0,
+      :scope => "Controller/public/index",
+      :histogram => [[10.0, 1]],
+
+      :max_call_time => 10.0,
+      :min_call_time => 10.0,
+      :call_time => 10.0
+    }, stat.as_json)
+  end
+
+  def test_increment_transaction_count
+    stat = build()
+    assert_equal 0, stat.transaction_count
+
+    stat.increment_transaction_count!
+
+    assert_equal 1, stat.transaction_count
+  end
+
+  def test_key_name
+    stat = build("example.com", "GET", "Controller/public/index")
+    assert_equal ["example.com", "GET", "Controller/public/index"], stat.key
+  end
+
+  def test_combine_min_call_time_picks_smallest
+    stat1, stat2 = build_pair
+    assert_equal 5.1,  stat1.combine!(stat2).min_call_time
+  end
+
+  def test_combine_max_call_time_picks_largest
+    stat1, stat2 = build_pair
+    assert_equal 8.2,  stat1.combine!(stat2).max_call_time
+  end
+
+  def test_combine_call_counts_adds
+    stat1, stat2 = build_pair
+    assert_equal 5, stat1.combine!(stat2).call_count
+  end
+
+  def test_combine_transaction_count_adds
+    stat1, stat2 = build_pair
+    2.times { stat1.increment_transaction_count! }
+    3.times { stat2.increment_transaction_count! }
+
+    assert_equal 5, stat1.combine!(stat2).call_count
+  end
+
+  def test_combine_doesnt_merge_with_self
+    stat = build
+    merged = stat.combine!(stat)
+
+    assert_equal DEFAULTS[:call_count], merged.call_count
+    assert_equal DEFAULTS[:call_time], merged.call_time
+  end
+
+  # A.combine!(B) should be the the same as B.combine!(A)
+  # Have to be a bit careful, since combine! is destructive, so make two pairs
+  # with same data to do both sides, then check that they result in the same
+  # answer
+  [:transaction_count, :call_count, :max_call_time, :min_call_time].each do |attr|
+    define_method :"test_combine_#{attr}_is_symmetric" do
+      stat1_a, stat2_a = build_pair
+      stat1_b, stat2_b = build_pair
+      merged_a = stat1_a.combine!(stat2_a)
+      merged_b = stat2_b.combine!(stat1_b)
+
+      assert_equal merged_a.send(attr), merged_b.send(attr)
+    end
+  end
+
+  #############
+  #  Helpers  #
+  #############
+  DEFAULTS = {
+    :call_count => 1,
+    :call_time => 10.0,
+  }
+
+  def build(domain_name="example.com",
+            operation="GET",
+            scope="Controller/public/index",
+            call_count=DEFAULTS[:call_count],
+            call_time=DEFAULTS[:call_time])
+    ExternalServiceMetricStats.new(domain_name, operation, scope, call_count, call_time)
+  end
+
+  def build_pair
+    stat1 = build("example.com", "GET", "Controller/public/index", 2, 5.1)
+    stat2 = build("example.com", "GET", "Controller/public/index", 3, 8.2)
+    [stat1, stat2]
+  end
+end
+end

data/test/unit/serializers/payload_serializer_test.rb

@@ -8,7 +8,7 @@ class PayloadSerializerTest < Minitest::Test
       :unique_id => "unique_idz",
       :agent_version => 123
     }
-    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {}, [], [], [], {}, [])
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {}, [], [], [], {}, {}, [])
 
     # symbol keys turn to strings
     formatted_metadata = {
@@ -49,7 +49,7 @@ class PayloadSerializerTest < Minitest::Test
         stats.total_exclusive_time = 0.078132088
       }
     }
-    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize({}, metrics, {}, [], [], [], {}, [])
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize({}, metrics, {}, [], [], [], {}, {}, [])
     formatted_metrics = [
       {
         "key" => {
@@ -94,7 +94,7 @@ class PayloadSerializerTest < Minitest::Test
       :quotie => "here are some \"quotes\"",
       :payload_version => 2,
     }
-    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {}, [], [], [], {}, [])
+    payload = ScoutApm::Serializers::PayloadSerializerToJson.serialize(metadata, {}, {}, [], [], [], {}, {}, [])
 
     # symbol keys turn to strings
     formatted_metadata = {

data/test/unit/sql_sanitizer_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: false
+
 require 'test_helper'
 
 module ScoutApm

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 5.0.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-23 00:00:00.000000000 Z
+date: 2021-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -219,7 +219,6 @@ files:
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.markdown
 - Gemfile
 - Guardfile
@@ -283,6 +282,8 @@ files:
 - lib/scout_apm/error_service/sidekiq.rb
 - lib/scout_apm/extensions/config.rb
 - lib/scout_apm/extensions/transaction_callback_payload.rb
+- lib/scout_apm/external_service_metric_set.rb
+- lib/scout_apm/external_service_metric_stats.rb
 - lib/scout_apm/fake_store.rb
 - lib/scout_apm/framework_integrations/rails_2.rb
 - lib/scout_apm/framework_integrations/rails_3_or_4.rb
@@ -329,6 +330,7 @@ files:
 - lib/scout_apm/layer_converters/database_converter.rb
 - lib/scout_apm/layer_converters/depth_first_walker.rb
 - lib/scout_apm/layer_converters/error_converter.rb
+- lib/scout_apm/layer_converters/external_service_converter.rb
 - lib/scout_apm/layer_converters/find_layer_by_type.rb
 - lib/scout_apm/layer_converters/histograms.rb
 - lib/scout_apm/layer_converters/job_converter.rb
@@ -360,6 +362,7 @@ files:
 - lib/scout_apm/serializers/app_server_load_serializer.rb
 - lib/scout_apm/serializers/db_query_serializer_to_json.rb
 - lib/scout_apm/serializers/directive_serializer.rb
+- lib/scout_apm/serializers/external_service_serializer_to_json.rb
 - lib/scout_apm/serializers/histograms_serializer_to_json.rb
 - lib/scout_apm/serializers/jobs_serializer_to_json.rb
 - lib/scout_apm/serializers/metrics_to_json_serializer.rb
@@ -429,6 +432,8 @@ files:
 - test/unit/error_service/ignored_exceptions_test.rb
 - test/unit/extensions/periodic_callbacks_test.rb
 - test/unit/extensions/transaction_callbacks_test.rb
+- test/unit/external_service_metric_set_test.rb
+- test/unit/external_service_metric_stats_test.rb
 - test/unit/fake_store_test.rb
 - test/unit/git_revision_test.rb
 - test/unit/histogram_test.rb

data/.travis.yml

@@ -1,25 +0,0 @@
-language: ruby
-dist: xenial
-cache: bundler
-
-matrix:
-  include:
-    - rvm: 2.1
-      gemfile: gems/rails3.gemfile
-    - rvm: 2.2
-    - rvm: 2.3
-    - rvm: 2.4
-    - rvm: 2.5
-    - rvm: 2.6
-    - rvm: 2.7
-    - rvm: 3.0
-    - rvm: 2.6
-      gemfile: gems/typhoeus.gemfile
-      env: "SCOUT_TEST_FEATURES=typhoeus"
-    - rvm: 2.6
-      gemfile: gems/octoshark.gemfile
-    - rvm: 2.6
-      name: rubocop yo
-      script: bundle exec rubocop
-    - rvm: 2.6
-      gemfile: gems/rails3.gemfile