scout_apm 0.1.16 → 0.1.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5728ecccdb01d128fdc5e222cf7db8f28078c7d1
-  data.tar.gz: 40a2a8ffe2e6a22b859a377916a6ade0777867f3
+  metadata.gz: d868630dc6de8b7e4387d2fc6e0e40860df1500d
+  data.tar.gz: 585b6bbb87aeaeec7408cc24750fa3089165e4b8
 SHA512:
-  metadata.gz: f3652b37e73e8ea2c2e38297e4ca4967db8e7d4a8c485b17bb74b5b4ad68a700299aea8289ba97b504447a557203a3c28d8afc2524b6c8710884a9f378ad8742
-  data.tar.gz: 5b776864017a983996c0ef1d3c27be70bd3f6986b82d3e62a8225128af4b4f36383ad26251b4e3e65f294aee7c1b7afba0eb7c6e537c1d637755a2afc7472ac2
+  metadata.gz: 0be21301d0033dbb09c11bfa79a6723c4ac24b900e99afab977152331a46dc7db8739813ae8d27f80b0fd65f04f02c5cd10f53fe4a0de89e8b3bfc7c1a6420e8
+  data.tar.gz: 2e604678abf6cafcfd6a13ce39955212eae6486a69b92290427ad5f703ab4fa8556643388723dbe5f761409a039b49d8507bc730f1effc2af391216d85fb9a76

data/CHANGELOG.markdown

@@ -1,3 +1,7 @@
+# 0.1.17
+
+* Scrub sql strings for invalid encoding characters.
+
 # 0.1.16
 
 * Beta support for Sinatra monitoring.

data/lib/scout_apm/framework_integrations/sinatra.rb

@@ -19,6 +19,14 @@ module ScoutApm
 
       # TODO: Fetch the name
       def application_name
+        possible = ObjectSpace.each_object(Class).select { |klass| klass < Sinatra::Base } - [Sinatra::Application]
+        if possible.length == 1
+          possible.first.name
+        else
+          "Sinatra"
+        end
+      rescue => e
+        logger.debug "Failed getting Sinatra Application Name: #{e.message}\n#{e.backtrace.join("\n\t")}"
         "Sinatra"
       end
 

data/lib/scout_apm/slow_transaction.rb

@@ -2,7 +2,7 @@ class ScoutApm::SlowTransaction
   BACKTRACE_THRESHOLD = 0.5 # the minimum threshold to record the backtrace for a metric.
   BACKTRACE_LIMIT = 5 # Max length of callers to display
   MAX_SIZE = 100 # Limits the size of the metric hash to prevent a metric explosion.
-  attr_reader :metric_name, :total_call_time, :metrics, :meta, :uri, :context, :time
+  attr_reader :metric_name, :total_call_time, :metrics, :meta, :uri, :context, :time, :prof, :raw_prof
 
   # Given a call stack, generates a filtered backtrace that:
   # * Limits to the app/models, app/controllers, or app/views directories

data/lib/scout_apm/utils/sql_sanitizer.rb

@@ -16,12 +16,11 @@ module ScoutApm
       attr_accessor :database_engine
 
       def initialize(sql)
-        @sql = sql.dup
+        @sql = scrubbed(sql.dup)
         @database_engine = ScoutApm::Environment.instance.database_engine
       end
 
       def to_s
-        return nil if sql.length > 1000 # safeguard - don't sanitize large SQL statements
         case database_engine
         when :postgres then to_s_postgres
         when :mysql    then to_s_mysql
@@ -60,6 +59,25 @@ module ScoutApm
         sql.gsub!(MULTIPLE_SPACES, ' ')
         sql.gsub!(TRAILING_SPACES, '')
       end
+
+      def has_encodings?(encodings=['UTF-8', 'binary'])
+        encodings.all?{|enc| Encoding.find(enc) rescue false}
+      end
+
+      def scrubbed(str)
+        return '' if !str.is_a?(String) || str.length > 1000 # safeguard - don't sanitize or scrub large SQL statements
+        return str if !str.respond_to?(:encode) # Ruby <= 1.8 doesn't have string encoding
+        return str if str.valid_encoding? # Whatever encoding it is, it is valid and we can operate on it
+        ScoutApm::Agent.instance.logger.debug "Scrubbing invalid sql encoding."
+        if str.respond_to?(:scrub) # Prefer to scrub before we have to convert
+          return str.scrub('_')
+        elsif has_encodings?(['UTF-8', 'binary'])
+          return str.encode('UTF-8', 'binary', :invalid => :replace, :undef => :replace, :replace => '_')
+        end
+        ScoutApm::Agent.instance.logger.debug "Unable to scrub invalid sql encoding."
+        ''
+      end
+
     end
   end
 end

data/lib/scout_apm/version.rb

@@ -1,4 +1,4 @@
 module ScoutApm
-  VERSION = "0.1.16"
+  VERSION = "0.1.17"
 end
 

data/test/unit/sql_sanitizer_test.rb

@@ -8,7 +8,7 @@ module ScoutApm
       # Too long, and we just bail out to prevent long running instrumentation
       def test_long_sql
         sql = " " * 1001
-        assert_nil SqlSanitizer.new(sql).to_s
+        assert_equal '', SqlSanitizer.new(sql).to_s
       end
 
       def test_postgres_simple_select_of_first
@@ -62,6 +62,16 @@ module ScoutApm
         ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }
         assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = ?)|, ss.to_s
       end
+
+      def test_scrubs_invalid_encoding
+        sql = "SELECT `blogs`.* FROM `blogs` WHERE (title = 'a\255c')".force_encoding('UTF-8')
+        assert_equal false, sql.valid_encoding?
+        ss = SqlSanitizer.new(sql).tap{ |it| it.database_engine = :mysql }
+        assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = 'a_c')|, ss.sql
+        assert_nothing_raised do
+          assert_equal %q|SELECT `blogs`.* FROM `blogs` WHERE (title = ?)|, ss.to_s
+        end
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - Derek Haynes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -146,10 +146,4 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby application performance monitoring
-test_files:
-- test/data/config_test_1.yml
-- test/test_helper.rb
-- test/unit/config_test.rb
-- test/unit/environment_test.rb
-- test/unit/instruments/active_record_instruments_test.rb
-- test/unit/sql_sanitizer_test.rb
+test_files: []