scout_apm 1.2.13 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f13ea6034c312de70bf591cd4098cd925439d0a
-  data.tar.gz: 46cfdd7065339dd4089eec27cdb9faa855e09224
+  metadata.gz: 775fbb31b292af0249e53823fd743b051f12a612
+  data.tar.gz: c38270792896a7d986a4ef87171b7d532ca8d39d
 SHA512:
-  metadata.gz: 89411a5bd8b03ef4d7db33297827c03df6f9acc965dbd0b512993c7bf9b5d4eef9f4b2d0e51ca657ff2decfd2f2fd096a3b0dc412c98ce9cdefbe018381afbbc
-  data.tar.gz: c0d3c36fd63ca7332826a5ad69eabc2e803b7ebdfcf63bb879372213abb32f5d7c8c6aea75c5a0d48f895f8ba3c36d249bcbff504b5eef31f28336ebf693fe25
+  metadata.gz: f86a5da6ce114547d61fedb7b955233e43b65246064edf74ca4630affdf872a709946f8dff9aef5c2cf3e695a91e22c1d118ceb79e718899d0075618a16bcd3c
+  data.tar.gz: bc6adffb1608d105d4aface08d72a4afb00ae29feed3f07cbd1e0f11cfd8eed0c1197aa2e879848749432f6c2921ef2145df8bc9f2aa9a8fddc53849396db80f

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 1.3.0
+
+* Lazy metric naming for ActiveRecord calls
+
 # 1.2.13
 
 * SQL Sanitation-Related performance improvements:

data/README.markdown

@@ -26,7 +26,7 @@ Your config file should look like:
 
 ## Supported Rubies
 
-* Ruby 1.8.7 through Ruby 2.1.2
+* Ruby 1.8.7 through Ruby 2.3
 
 ## Supported Application Servers
 
@@ -39,4 +39,4 @@ Your config file should look like:
 
 ## Help
 
-Email support@scoutapp.com if you need a hand.
+See our [help site](http://help.apm.scoutapp.com/) or email support@scoutapp.com if you need a hand.

data/lib/scout_apm/agent/logging.rb

@@ -8,7 +8,7 @@ module ScoutApm
 
       def init_logger
         begin
-          @log_file ||= wants_stdout? ? STDOUT : "#{log_file_path}/scout_apm.log"
+          @log_file ||= determine_log_destination
         rescue => e
         end
 
@@ -43,13 +43,25 @@ module ScoutApm
         end
       end
 
-      def log_file_path
-        config.value('log_file_path') || default_log_path
+      def determine_log_destination
+        case true
+        when wants_stdout? then STDOUT
+        when wants_stderr? then STDERR
+        else "#{log_file_path}/scout_apm.log"
+        end
       end
 
       def wants_stdout?
         config.value('log_file_path').to_s.upcase == 'STDOUT' || environment.platform_integration.log_to_stdout?
       end
+
+      def wants_stderr?
+        config.value('log_file_path').to_s.upcase == 'STDERR'
+      end
+
+      def log_file_path
+        config.value('log_file_path') || default_log_path
+      end
     end
     include Logging
   end

data/lib/scout_apm/instruments/active_record.rb

@@ -59,7 +59,7 @@ module ScoutApm
       def log_with_scout_instruments(*args, &block)
         sql, name = args
         self.class.instrument("ActiveRecord",
-                              Utils::ActiveRecordMetricName.new(sql, name).metric_name,
+                              Utils::ActiveRecordMetricName.new(sql, name),
                               :desc => Utils::SqlSanitizer.new(sql) ) do
           log_without_scout_instruments(sql, name, &block)
         end

data/lib/scout_apm/layer_converter.rb

@@ -54,13 +54,16 @@ module ScoutApm
                          {:scope => scope_layer.legacy_metric_name}
                        end
 
-        meta = MetricMeta.new(layer.legacy_metric_name, meta_options)
+        # we don't need to use the full metric name for scoped metrics as we only display metrics aggregrated
+        # by type.
+        metric_name = meta_options.has_key?(:scope) ? layer.type : layer.legacy_metric_name
+
+        meta = MetricMeta.new(metric_name, meta_options)
         metric_hash[meta] ||= MetricStats.new( meta_options.has_key?(:scope) )
 
         stat = metric_hash[meta]
         stat.update!(layer.total_call_time, layer.total_exclusive_time)
       end
-
       metric_hash
     end
   end
@@ -87,14 +90,15 @@ module ScoutApm
   class LayerSlowTransactionConverter < LayerConverterBase
     def call
       policy = ScoutApm::Agent.instance.slow_request_policy.capture_type(root_layer.total_call_time)
-
-      case policy
-      when ScoutApm::SlowRequestPolicy::CAPTURE_SUMMARY
-        return [nil, {}]
-      when ScoutApm::SlowRequestPolicy::CAPTURE_NONE
-        return [nil, {}]
+      if policy == ScoutApm::SlowRequestPolicy::CAPTURE_NONE
+        return [nil, {}] 
       end
 
+      # increment the slow transaction count if this is a slow transaction.
+      meta = MetricMeta.new("SlowTransaction/#{scope_layer.legacy_metric_name}")
+      stat = MetricStats.new
+      stat.update!(1)
+
       scope = scope_layer
       return [nil, {}] unless scope
 
@@ -104,10 +108,6 @@ module ScoutApm
       # Disable stackprof output for now
       stackprof = [] # request.stackprof
 
-      meta = MetricMeta.new("SlowTransaction/#{scope_layer.legacy_metric_name}")
-      stat = MetricStats.new
-      stat.update!(1)
-
       [
         SlowTransaction.new(uri,
                             scope.legacy_metric_name,

data/lib/scout_apm/slow_request_policy.rb

@@ -8,7 +8,6 @@ module ScoutApm
   class SlowRequestPolicy
     CAPTURE_TYPES = [
       CAPTURE_DETAIL  = "capture_detail",
-      CAPTURE_SUMMARY = "capture_summary",
       CAPTURE_NONE    = "capture_none",
     ]
 
@@ -16,8 +15,11 @@ module ScoutApm
     SLOW_REQUEST_TIME_THRESHOLD = 2.0 # seconds
 
     def capture_type(time)
-      return CAPTURE_NONE unless slow_enough?(time)
-      return CAPTURE_DETAIL
+      if !slow_enough?(time)
+        CAPTURE_NONE
+      else
+        CAPTURE_DETAIL
+      end
     end
 
     private

data/lib/scout_apm/store.rb

@@ -15,10 +15,14 @@ module ScoutApm
       StoreReportingPeriodTimestamp.new
     end
 
+    def current_period
+      reporting_periods[current_timestamp]
+    end
+
     # Save newly collected metrics
     def track!(metrics, options={})
       @mutex.synchronize {
-        reporting_periods[current_timestamp].merge_metrics!(metrics)
+        current_period.merge_metrics!(metrics)
       }
     end
 
@@ -33,7 +37,7 @@ module ScoutApm
     def track_slow_transaction!(slow_transaction)
       return unless slow_transaction
       @mutex.synchronize {
-        reporting_periods[current_timestamp].merge_slow_transactions!(slow_transaction)
+        current_period.merge_slow_transactions!(slow_transaction)
       }
     end
 
@@ -89,7 +93,7 @@ module ScoutApm
 
   # One period of Storage. Typically 1 minute
   class StoreReportingPeriod
-    # An array of SlowTransaction objects
+    # A SlowTransactionSet object. 
     attr_reader :slow_transactions
 
     # A StoreReportingPeriodTimestamp representing the time that this
@@ -142,21 +146,6 @@ module ScoutApm
 
     private
 
-    # Removes payloads from slow transactions that exceed +SlowRequestPolicy::MAX_DETAIL_PER_MINUTE+ to avoid
-    # bloating the layaway file.
-    def trim_slow_transaction_metrics
-      count_with_metrics = 0
-      @slow_transactions.each do |s|
-
-        if s.has_metrics?
-          count_with_metrics += 1
-          if count_with_metrics > SlowRequestPolicy::MAX_DETAIL_PER_MINUTE
-            s.clear_metrics!
-          end
-        end
-      end
-    end
-
     # We can't aggregate CPU, Memory, Capacity, or Controller, so pass through these metrics directly
     # TODO: Figure out a way to not have this duplicate what's in Samplers, and also on server's ingest
     PASSTHROUGH_METRICS = ["CPU", "Memory", "Instance", "Controller", "SlowTransaction"]

data/lib/scout_apm/tracer.rb

@@ -14,7 +14,7 @@ module ScoutApm
 
     module ClassMethods
       # Type: the Layer type - "View" or similar
-      # Name: specific name - "users/_gravatar"
+      # Name: specific name - "users/_gravatar". The object must respond to "#to_s". This allows us to be more efficient - in most cases, the metric name isn't needed unless we are processing a slow transaction.
       # A Block: The code to be instrumented
       #
       # Options:

data/lib/scout_apm/utils/active_record_metric_name.rb

@@ -16,7 +16,7 @@ module ScoutApm
       # sql: SELECT "places".* FROM "places"  ORDER BY "places"."position" ASC
       # name: Place Load
       # metric_name: Place/find
-      def metric_name
+      def to_s
         return DEFAULT_METRIC unless name
         return DEFAULT_METRIC unless model && operation
 

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.2.13"
+  VERSION = "1.3.0"
 end
 

data/test/unit/utils/active_record_metric_name_test.rb

@@ -9,7 +9,7 @@ class ActiveRecordMetricNameTest < Minitest::Test
     name = :skip_logging
 
     mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
-    assert_equal "SQL/Unknown", mn.metric_name
+    assert_equal "SQL/Unknown", mn.to_s
   end
 
   def test_postgres_column_lookup
@@ -27,7 +27,7 @@ class ActiveRecordMetricNameTest < Minitest::Test
     name = "SCHEMA"
 
     mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
-    assert_equal "SQL/Unknown", mn.metric_name
+    assert_equal "SQL/Unknown", mn.to_s
   end
 
 
@@ -36,7 +36,7 @@ class ActiveRecordMetricNameTest < Minitest::Test
     name = "User Load"
 
     mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
-    assert_equal "User/find", mn.metric_name
+    assert_equal "User/find", mn.to_s
   end
 
   def test_without_name
@@ -44,7 +44,7 @@ class ActiveRecordMetricNameTest < Minitest::Test
     name = nil
 
     mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
-    assert_equal "SQL/Unknown", mn.metric_name
+    assert_equal "SQL/Unknown", mn.to_s
   end
 
   # TODO: Determine if there should be a distinction between Unknown and Other.
@@ -53,6 +53,6 @@ class ActiveRecordMetricNameTest < Minitest::Test
     name = "A whole sentance describing what's what"
 
     mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
-    assert_equal "SQL/other", mn.metric_name
+    assert_equal "SQL/other", mn.to_s
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.2.13
+  version: 1.3.0
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-02 00:00:00.000000000 Z
+date: 2016-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest