scout_apm 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 103d9ad8a0cf748a92bf2283463ced16af225ec6
-  data.tar.gz: d941ca86450397e2499805ae3e7d6a717aa26bbb
+  metadata.gz: 24f14f22f07f52ef204f8547d5f253f32858f390
+  data.tar.gz: 61475d574d1b89429625733f3e5ad1ed21103bc4
 SHA512:
-  metadata.gz: 8402634e74e3153e3031bcb1ccd3854b32f496761b1634e5434afcf5444e7155d1f44e52f549c208ceb32b88aad601bced8b27b9e80d386a424f0397567411bf
-  data.tar.gz: dcee383d2769bbb15d0be63a8c7de47f8f025553fd10ee48375a2e4ef52f4f843bd7107e168cf40b4fedcaece40aed3b0915c7646091b900e0067c0a8592168e
+  metadata.gz: 4fad8d97c3f0421337a36cd6ca6734bfc882bd9ab2a56a9c1ec39359811a3b26d59b50e2e19630b6ae7e21583f1b2273135bf1d9153c902dfa7af4f4daf68817
+  data.tar.gz: 437750875a372707bcc412bcdd42196fd13281b8462dc87d74466b1cb1b938cc98f3afd044cc001f48f77fe63ba288d16c0a7040d9d8299fba4c4bf6eb779ec9

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 1.2.6
+
+* Fix a bug when determining the name of metrics for ActiveRecord queries
+
 # 1.2.5
 
 * Instrument ActionController::Base instead of ::Metal.  This allows us to

data/lib/scout_apm.rb

@@ -74,6 +74,7 @@ require 'scout_apm/instruments/process/process_memory'
 require 'scout_apm/app_server_load'
 
 require 'scout_apm/utils/sql_sanitizer'
+require 'scout_apm/utils/active_record_metric_name'
 require 'scout_apm/utils/null_logger'
 require 'scout_apm/utils/installed_gems'
 require 'scout_apm/utils/time'

data/lib/scout_apm/instruments/active_record.rb

@@ -58,34 +58,12 @@ module ScoutApm
 
       def log_with_scout_instruments(*args, &block)
         sql, name = args
-        self.class.instrument("ActiveRecord", scout_ar_metric_name(sql, name), :desc => Utils::SqlSanitizer.new(sql).to_s ) do
+        self.class.instrument("ActiveRecord",
+                              Utils::ActiveRecordMetricName.new(sql, name).metric_name,
+                              :desc => Utils::SqlSanitizer.new(sql).to_s ) do
           log_without_scout_instruments(sql, name, &block)
         end
       end
-
-      def scout_ar_metric_name(sql, name)
-        # sql: SELECT "places".* FROM "places"  ORDER BY "places"."position" ASC
-        # name: Place Load
-        if name && (parts = name.split(" ")) && parts.size == 2
-          model = parts.first
-          operation = parts.last.downcase
-          metric_name = case operation
-                        when 'load' then 'find'
-                        when 'indexes', 'columns' then nil # not under developer control
-                        when 'destroy', 'find', 'save', 'create', 'exists' then operation
-                        when 'update' then 'save'
-                        else
-                          if model == 'Join'
-                            operation
-                          end
-                        end
-          metric = "#{model}/#{metric_name}" if metric_name
-          metric = "SQL/other" if metric.nil?
-        else
-          metric = "SQL/Unknown"
-        end
-        metric
-      end
     end # module ActiveRecordInstruments
   end
 end

data/lib/scout_apm/utils/active_record_metric_name.rb

@@ -0,0 +1,62 @@
+module ScoutApm
+  module Utils
+    class ActiveRecordMetricName
+      DEFAULT_METRIC = "SQL/Unknown"
+
+      attr_reader :sql, :name
+
+      def initialize(sql, name)
+        @sql = sql
+        @name = name.to_s
+      end
+
+      # Converts an SQL string and the name (typically assigned automatically
+      # by rails) into a Scout metric_name.
+      #
+      # sql: SELECT "places".* FROM "places"  ORDER BY "places"."position" ASC
+      # name: Place Load
+      # metric_name: Place/find
+      def metric_name
+        return DEFAULT_METRIC unless name
+        return DEFAULT_METRIC unless model && operation
+
+        if parsed = parse_operation
+          "#{model}/#{parsed}"
+        else
+          "SQL/other"
+        end
+      end
+
+      private
+
+      def model
+        parts.first
+      end
+
+      def operation
+        if parts.length >= 2
+          parts[1].downcase
+        end
+      end
+
+      def parts
+        name.split(" ")
+      end
+
+      # Returns nil if no match
+      # Returns nil if the operation wasn't under developer control (and hence isn't interesting to report)
+      def parse_operation
+        case operation
+        when 'indexes', 'columns' then nil # not under developer control
+        when 'load' then 'find'
+        when 'destroy', 'find', 'save', 'create', 'exists' then operation
+        when 'update' then 'save'
+        else
+          if model == 'Join'
+            operation
+          end
+        end
+      end
+    end
+  end
+end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "1.2.5"
+  VERSION = "1.2.6"
 end
 

data/test/test_helper.rb

@@ -19,6 +19,7 @@ end
 class Minitest::Test
   def setup
     reopen_logger
+    FileUtils.mkdir_p(DATA_FILE_DIR)
     ENV['SCOUT_DATA_FILE'] = DATA_FILE_PATH
   end
 
@@ -38,5 +39,6 @@ class Minitest::Test
     ScoutApm::Agent.instance.instance_variable_set("@logger", @logger)
   end
 
-  DATA_FILE_PATH = File.dirname(__FILE__) + '/tmp/scout_apm.db' 
+  DATA_FILE_DIR = File.dirname(__FILE__) + '/tmp'
+  DATA_FILE_PATH = "#{DATA_FILE_DIR}/scout_apm.db"
 end

data/test/unit/agent_test.rb

@@ -12,14 +12,14 @@ class AgentTest < Minitest::Test
   def test_start_with_lock_on_layaway_file
     # setup the file, putting a lock on it.
     File.open(DATA_FILE_PATH, "w") {}
-    f=File.open(DATA_FILE_PATH, File::RDWR | File::CREAT)
+    f = File.open(DATA_FILE_PATH, File::RDWR | File::CREAT)
     f.flock(File::LOCK_EX)
 
     agent = ScoutApm::Agent.instance
 
     no_timeout = true
     begin
-      Timeout::timeout(3) { agent.start({:monitor => true,:force => true}) }
+      Timeout::timeout(3) { agent.start({:monitor => true, :force => true}) }
     rescue Timeout::Error
       no_timeout = false
     ensure
@@ -55,4 +55,4 @@ class AgentTest < Minitest::Test
   ## TODO - adds tests to ensure other potentially long-running things don't sneak in, like HTTP calls.
 
   OLD_FORMAT = {1452533280 => {:metrics => {}, :slow_transactions => {}} } # Pre 1.2 agents used a different file format to store data. 
-end
+end

data/test/unit/utils/active_record_metric_name_test.rb

@@ -0,0 +1,58 @@
+require 'test_helper'
+require 'scout_apm/utils/active_record_metric_name'
+
+class ActiveRecordMetricNameTest < Minitest::Test
+  # This is a bug report from Андрей Филиппов <tmn.sun@gmail.com>
+  # The code that triggered the bug was: ActiveRecord::Base.connection.execute("%some sql%", :skip_logging)
+  def test_symbol_name
+    sql = "SELECT * FROM users /*application:Testapp,controller:public,action:index*/"
+    name = :skip_logging
+
+    mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
+    assert_equal "SQL/Unknown", mn.metric_name
+  end
+
+  def test_postgres_column_lookup
+    sql = <<-EOF
+    SELECT t.oid, t.typname, t.typelem, t.typdelim, t.typinput, r.rngsubtype, t.typtype, t.typbasetype
+                  FROM pg_type as t
+                  LEFT JOIN pg_range as r ON oid = rngtypid
+                  WHERE
+                    t.typname IN ('int2', 'int4', 'int8', 'oid', 'float4', 'float8', 'text', 'varchar', 'char', 'name', 'bpchar', 'bool', 'bit', 'varbit', 'timestamptz', 'date', 'time', 'money', 'bytea', 'point', 'hstore', 'json', 'jsonb', 'cidr', 'inet', 'uuid', 'xml', 'tsvector', 'macaddr', 'citext', 'ltree', 'interval', 'path', 'line', 'polygon', 'circle', 'lseg', 'box', 'timestamp', 'numeric')
+                    OR t.typtype IN ('r', 'e', 'd')
+                    OR t.typinput::varchar = 'array_in'
+                    OR t.typelem != 0
+    EOF
+
+    name = "SCHEMA"
+
+    mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
+    assert_equal "SQL/Unknown", mn.metric_name
+  end
+
+
+  def test_user_find
+    sql = %q|SELECT "users".* FROM "users" /*application:Testapp,controller:public,action:index*/|
+    name = "User Load"
+
+    mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
+    assert_equal "User/find", mn.metric_name
+  end
+
+  def test_without_name
+    sql = %q|SELECT "users".* FROM "users" /*application:Testapp,controller:public,action:index*/|
+    name = nil
+
+    mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
+    assert_equal "SQL/Unknown", mn.metric_name
+  end
+
+  # TODO: Determine if there should be a distinction between Unknown and Other.
+  def test_with_custom_name
+    sql = %q|SELECT "users".* FROM "users" /*application:Testapp,controller:public,action:index*/|
+    name = "A whole sentance describing what's what"
+
+    mn = ScoutApm::Utils::ActiveRecordMetricName.new(sql, name)
+    assert_equal "SQL/other", mn.metric_name
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -133,6 +133,7 @@ files:
 - lib/scout_apm/store.rb
 - lib/scout_apm/tracer.rb
 - lib/scout_apm/tracked_request.rb
+- lib/scout_apm/utils/active_record_metric_name.rb
 - lib/scout_apm/utils/fake_stack_prof.rb
 - lib/scout_apm/utils/installed_gems.rb
 - lib/scout_apm/utils/null_logger.rb
@@ -153,6 +154,7 @@ files:
 - test/unit/serializers/payload_serializer_test.rb
 - test/unit/slow_transaction_set_test.rb
 - test/unit/sql_sanitizer_test.rb
+- test/unit/utils/active_record_metric_name_test.rb
 homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses: []
 metadata: {}
@@ -188,3 +190,4 @@ test_files:
 - test/unit/serializers/payload_serializer_test.rb
 - test/unit/slow_transaction_set_test.rb
 - test/unit/sql_sanitizer_test.rb
+- test/unit/utils/active_record_metric_name_test.rb