scout_apm 2.1.28 → 2.1.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22f54f5575e5fa0642c1cf7ff44765a6e0c98d1a
-  data.tar.gz: eeb667d66ae69e342b2de1edc62ec475bcfa253c
+  metadata.gz: 6a05b91b0cb840bd278bee2f470494b5e5a85a32
+  data.tar.gz: a6d75703bd477570ceb40c31dd230f0ca57657ba
 SHA512:
-  metadata.gz: fb7d3f65c107e6b9f1a09e4def243b10827f061160f9a38426ee1d66b8e19f22d971f337bcdf22acf844492c3838c261ce87874f95a636ccc17e4c03aeb66093
-  data.tar.gz: 62e63d73def12c4eca6f27f724cf6d06b3945aa8ebb467c76015032b6942279beade0c262969b147142018a10351cef5a9539ee6ea2f465ae1fcafc8d46a4adb
+  metadata.gz: 7677505dc87d23ce4cbe362bcf6ceced27cd484af214e8563e7b37f215885c8fdb314e70c56252e4968cbf11892aec9e9003e04e37947ba9512d3a6ce8e2daa2
+  data.tar.gz: 0cb53c39bd75b62a931b8c55125554cd364982231b94c89657eb6d4f89baa8ff46fc8dbe91aa7c24aed6027128c68cd4568ac4b26eaf1c7b9c2f8c190d2f218f

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 2.1.29
+
+* Add `scm_subdirectory` option. Useful for when your app code does not live in your SCM root directory.
+
 # 2.1.28
 
 * Changes to app server load data

data/lib/scout_apm/config.rb

@@ -25,6 +25,7 @@ require 'scout_apm/environment'
 # profile          - turn on/off scoutprof (only applicable in Gem versions including scoutprof)
 # proxy            - an http proxy
 # report_format    - 'json' or 'marshal'. Marshal is legacy and will be removed.
+# scm_subdirectory - if the app root lives in source management in a subdirectory. E.g. #{SCM_ROOT}/src
 # uri_reporting    - 'path' or 'full_path' default is 'full_path', which reports URL params as well as the path.
 #
 # Any of these config settings can be set with an environment variable prefixed
@@ -53,6 +54,7 @@ module ScoutApm
         'profile',
         'proxy',
         'report_format',
+        'scm_subdirectory',
         'uri_reporting',
     ]
 
@@ -215,6 +217,7 @@ module ScoutApm
         'log_level'              => 'info',
         'profile'                => true, # for scoutprof
         'report_format'          => 'json',
+        'scm_subdirectory'       => '',
         'uri_reporting'          => 'full_path',
       }.freeze
 

data/lib/scout_apm/environment.rb

@@ -84,6 +84,14 @@ module ScoutApm
                       end
     end
 
+    def scm_subdirectory
+      @scm_subdirectory ||= if Agent.instance.config.value('scm_subdirectory').empty?
+        ''
+      else
+        Agent.instance.config.value('scm_subdirectory').sub(/^\//, '') # Trim any leading slash
+      end
+    end
+
     def root
       @root ||= framework_root
     end

data/lib/scout_apm/utils/backtrace_parser.rb

@@ -24,7 +24,7 @@ module ScoutApm
         stack = []
         call_stack.each do |c|
           if m = c.match(@@app_dir_regex)
-            stack << m[1]
+            stack << ScoutApm::Utils::Scm.relative_scm_path(m[1])
             break if stack.size == APP_FRAMES
           end
         end

data/lib/scout_apm/utils/scm.rb

@@ -0,0 +1,14 @@
+# Module for helping to deal with Source Code Management settings
+module ScoutApm
+  module Utils
+    class Scm
+      # Takes an *already relative* path +path+
+      # Returns a relative path, prepending the configured +scm_subdirectory+ environment string
+      def self.relative_scm_path(path, scm_subdirectory = ScoutApm::Environment.instance.scm_subdirectory)
+        @@scm_subdirectory ||= scm_subdirectory.sub(/^\//, '')
+        @@scm_subdirectoy_blank ||= @@scm_subdirectory.empty?
+        @@scm_subdirectoy_blank ? path : File.join(@@scm_subdirectory, path)
+      end
+    end
+  end
+end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "2.1.28"
+  VERSION = "2.1.29"
 end
 

data/lib/scout_apm.rb

@@ -94,6 +94,7 @@ require 'scout_apm/utils/backtrace_parser'
 require 'scout_apm/utils/installed_gems'
 require 'scout_apm/utils/klass_helper'
 require 'scout_apm/utils/null_logger'
+require 'scout_apm/utils/scm'
 require 'scout_apm/utils/sql_sanitizer'
 require 'scout_apm/utils/time'
 require 'scout_apm/utils/unique_id'

data/test/unit/utils/backtrace_parser_test.rb

@@ -39,6 +39,11 @@ class BacktraceParserTest < Minitest::Test
     end
   end
 
+  def test_calls_scm_relative_path
+    ScoutApm::Utils::Scm.expects(:relative_scm_path).at_least_once
+    assert ScoutApm::Utils::BacktraceParser.new(raw_backtrace, root).call
+  end
+
   def test_works_on_shorter_backtraces
     result = ScoutApm::Utils::BacktraceParser.new(raw_backtrace(1), root).call
 

data/test/unit/utils/scm.rb

@@ -0,0 +1,17 @@
+require_relative '../../test_helper'
+require 'scout_apm/utils/scm'
+
+class ScmTest < Minitest::Test
+
+  def test_relative_scm_path_blank
+    assert_equal 'app/models/person.rb', ScoutApm::Utils::Scm.relative_scm_path('app/models/person.rb', '')
+  end
+
+  def test_relative_scm_path_not_blank
+    assert_equal 'src/app/models/person.rb', ScoutApm::Utils::Scm.relative_scm_path('app/models/person.rb', 'src')
+  end
+
+  def test_relative_scm_path_not_blank_with_slashes
+    assert_equal 'src/app/models/person.rb', ScoutApm::Utils::Scm.relative_scm_path('app/models/person.rb', '/src/')
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 2.1.28
+  version: 2.1.29
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -234,6 +234,7 @@ files:
 - lib/scout_apm/utils/klass_helper.rb
 - lib/scout_apm/utils/null_logger.rb
 - lib/scout_apm/utils/numbers.rb
+- lib/scout_apm/utils/scm.rb
 - lib/scout_apm/utils/sql_sanitizer.rb
 - lib/scout_apm/utils/sql_sanitizer_regex.rb
 - lib/scout_apm/utils/sql_sanitizer_regex_1_8_7.rb
@@ -267,6 +268,7 @@ files:
 - test/unit/utils/active_record_metric_name_test.rb
 - test/unit/utils/backtrace_parser_test.rb
 - test/unit/utils/numbers_test.rb
+- test/unit/utils/scm.rb
 homepage: https://github.com/scoutapp/scout_apm_ruby
 licenses:
 - Proprietary (See LICENSE.md)