appsignal 1.1.0.beta.6 → 1.1.0.beta.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e48c3733ad27f81562f7088da9751efc8ae6ad5a
-  data.tar.gz: 169f88717d3a6f64d89c9edda77f7b8e532ee401
+  metadata.gz: 1fa63ff273674425ef46e0f345a9952679404e3a
+  data.tar.gz: 1a2badc054342ffaa7bf111c839ef8c5b4c0c8d7
 SHA512:
-  metadata.gz: 1fcd60d7288e64b0e4d6d4f6bc5c8208c06a391d5a8204a3a6aa2a2523f80a330add31948e69859fb61005835a12dda414f6547e2316838533f0cf09e32d6d26
-  data.tar.gz: e7d31695310fbe921c385c511ac185a19acd2457f2fa87105e1f1c52a4cbd083687b244f70d7aa96dfc04cb970d32f99f22ef20c8bcdefba263af8450e5dbc77
+  metadata.gz: 061ad6a3873066cca81ab131385357dc2811bac4854a51128a7c63a46023ff1f94075e5257514d7bea42fb734b05f3374a114149de3fdf46d781b7eb1063b6ea
+  data.tar.gz: 66ff54cd46e64294a8ba13d004c9b297a976b638aece34d98fc174eb7f00d9935caf13678b2843c7d930ed059ebf86600659b2b0061fade58d4c0cb446408196

data/CHANGELOG.md

@@ -4,6 +4,16 @@
 * Collect perams for Delayed Job and Sidekiq when using ActiveJob
 * Official Grape support
 
+# 1.0.5
+* Improved sql sanitization
+* Improved mongoid/mongodb sanitization
+* Minor performance improvements
+* Better handling for non-utf8 convertable strings
+* Make gem installable (but not functional) on jRuby
+
+# 1.0.4
+* Make working dir configurable using `APPSIGNAL_WORKING_DIR_PATH` or `:working_dir_path`
+
 # 1.0.3
 * Fix bug in completing JS transactions
 * Make Resque integration robust for bigger payloads

data/ext/agent.yml

@@ -1,15 +1,15 @@
 ---
-version: ee3d28b
+version: d394e75
 triples:
   x86_64-linux:
-    checksum: 709efd9cbf9d8b253d5c55a1a089e99c965d0a5824d11c439db6b539693c3f11
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/ee3d28b/appsignal-agent-x86_64-linux-static.tar.gz
+    checksum: 20b198a1a8ab5dff24b1e205d98eb7aa90d469e2a9bf8d6c659c3fe4015400c3
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d394e75/appsignal-agent-x86_64-linux-static.tar.gz
     lib_filename: libappsignal.a
   i686-linux:
-    checksum: 109ea2cef01c2e71309790f04c409dd2984e257bf7e814b7a37351667fccf2f4
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/ee3d28b/appsignal-agent-i686-linux-static.tar.gz
+    checksum: c39b3806e36d693a75854a865d7e836b84d9ce35d7522841e7d75aa75a7307e6
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d394e75/appsignal-agent-i686-linux-static.tar.gz
     lib_filename: libappsignal.a
   x86_64-darwin:
-    checksum: 2b9a6ae54a5886ec7677da7a99703a3336630e75fe2778782777fa2c45c942b1
-    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/ee3d28b/appsignal-agent-x86_64-darwin-static.tar.gz
+    checksum: 5cf300f552712734b724a6103336353bb809ef246fc62230d6bfcfed7045eed5
+    download_url: https://appsignal-agent-releases.global.ssl.fastly.net/d394e75/appsignal-agent-x86_64-darwin-static.tar.gz
     lib_filename: libappsignal.a

data/ext/appsignal_extension.c

@@ -26,17 +26,19 @@ static VALUE start_event(VALUE self, VALUE transaction_index) {
   return Qnil;
 }
 
-static VALUE finish_event(VALUE self, VALUE transaction_index, VALUE name, VALUE title, VALUE body) {
+static VALUE finish_event(VALUE self, VALUE transaction_index, VALUE name, VALUE title, VALUE body, VALUE body_format) {
   Check_Type(transaction_index, T_FIXNUM);
   Check_Type(name, T_STRING);
   Check_Type(title, T_STRING);
   Check_Type(body, T_STRING);
+  Check_Type(body_format, T_FIXNUM);
 
   appsignal_finish_event(
       FIX2INT(transaction_index),
       StringValueCStr(name),
       StringValueCStr(title),
-      StringValueCStr(body)
+      StringValueCStr(body),
+      FIX2INT(body_format)
   );
   return Qnil;
 }
@@ -187,10 +189,10 @@ static VALUE install_gc_event_hooks() {
       Qnil
   );
   #endif
-  #if defined(RUBY_INTERNAL_EVENT_GC_END_MARK)
+  #if defined(RUBY_INTERNAL_EVENT_GC_END_SWEEP)
   rb_add_event_hook(
       track_gc_end,
-      RUBY_INTERNAL_EVENT_GC_END_MARK,
+      RUBY_INTERNAL_EVENT_GC_END_MARK | RUBY_INTERNAL_EVENT_GC_END_SWEEP,
       Qnil
   );
   #endif
@@ -207,7 +209,7 @@ void Init_appsignal_extension(void) {
   rb_define_singleton_method(Extension, "stop",                        stop,                        0);
   rb_define_singleton_method(Extension, "start_transaction",           start_transaction,           2);
   rb_define_singleton_method(Extension, "start_event",                 start_event,                 1);
-  rb_define_singleton_method(Extension, "finish_event",                finish_event,                4);
+  rb_define_singleton_method(Extension, "finish_event",                finish_event,                5);
   rb_define_singleton_method(Extension, "set_transaction_error",       set_transaction_error,       4);
   rb_define_singleton_method(Extension, "set_transaction_sample_data", set_transaction_sample_data, 3);
   rb_define_singleton_method(Extension, "set_transaction_action",      set_transaction_action,      2);

data/ext/extconf.rb

@@ -1,6 +1,5 @@
 require 'digest'
 require 'logger'
-require 'mkmf'
 require 'fileutils'
 require 'open-uri'
 require 'zlib'
@@ -30,6 +29,13 @@ end
 def install
   logger.info "Installing appsignal agent #{Appsignal::VERSION} for Ruby #{RUBY_VERSION} on #{RUBY_PLATFORM}"
 
+  if RUBY_PLATFORM =~ /java/
+    installation_failed(
+      "We do not support jRuby at the moment, email support@appsignal.com if you want to join the beta"
+    )
+    return
+  end
+
   unless AGENT_CONFIG['triples'].keys.include?(ARCH)
     installation_failed(
       "AppSignal currently does not support your system architecture (#{ARCH})." \
@@ -70,13 +76,14 @@ def install
   end
 
   logger.info "Creating makefile"
+  require 'mkmf'
   if find_library('appsignal', 'appsignal_start', EXT_PATH) &&
        find_executable('appsignal-agent', EXT_PATH) &&
        find_header('appsignal_extension.h', EXT_PATH)
     create_makefile 'appsignal_extension'
     logger.info 'Successfully installed appsignal extension'
   else
-    installation_failed "Aborting installation, extension files were not present"
+    installation_failed "Aborting installation, extension files were not present or could not be loaded"
   end
 rescue => ex
   installation_failed "Exception while installing: #{ex}"

data/lib/appsignal/config.rb

@@ -42,7 +42,8 @@ module Appsignal
       'APPSIGNAL_HTTP_PROXY'                     => :http_proxy,
       'APPSIGNAL_ENABLE_ALLOCATION_TRACKING'     => :enable_allocation_tracking,
       'APPSIGNAL_ENABLE_GC_INSTRUMENTATION'      => :enable_gc_instrumentation,
-      'APPSIGNAL_RUNNING_IN_CONTAINER'           => :running_in_container
+      'APPSIGNAL_RUNNING_IN_CONTAINER'           => :running_in_container,
+      'APPSIGNAL_WORKING_DIR_PATH'               => :working_dir_path
     }.freeze
 
     attr_reader :root_path, :env, :initial_config, :config_hash
@@ -103,6 +104,7 @@ module Appsignal
       ENV['APPSIGNAL_HTTP_PROXY']                   = config_hash[:http_proxy]
       ENV['APPSIGNAL_IGNORE_ACTIONS']               = config_hash[:ignore_actions].join(',')
       ENV['APPSIGNAL_RUNNING_IN_CONTAINER']         = config_hash[:running_in_container].to_s
+      ENV['APPSIGNAL_WORKING_DIR_PATH']             = config_hash[:working_dir_path] if config_hash[:working_dir_path]
     end
 
     protected
@@ -150,7 +152,8 @@ module Appsignal
 
       # Configuration with string type
       %w(APPSIGNAL_PUSH_API_KEY APPSIGNAL_APP_NAME APPSIGNAL_PUSH_API_ENDPOINT
-         APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH APPSIGNAL_HTTP_PROXY APPSIGNAL_LOG_PATH).each do |var|
+         APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH APPSIGNAL_HTTP_PROXY APPSIGNAL_LOG_PATH
+         APPSIGNAL_WORKING_DIR_PATH).each do |var|
         if env_var = ENV[var]
           config[ENV_TO_KEY_MAPPING[var]] = env_var
         end

data/lib/appsignal/event_formatter.rb

@@ -60,6 +60,8 @@ module Appsignal
       end
     end
   end
+
+  SQL_BODY_FORMAT = 1
 end
 
 Dir.glob(File.expand_path('../event_formatter/**/*.rb', __FILE__)).each do |file|

data/lib/appsignal/event_formatter/active_record/sql_formatter.rb

@@ -4,55 +4,9 @@ module Appsignal
       class SqlFormatter < Appsignal::EventFormatter
         register 'sql.active_record'
 
-        SINGLE_QUOTED_STRING = /'(.?|[^']).*'/.freeze
-        DOUBLE_QUOTED_STRING = /"(.?|[^"]).*"/.freeze
-        IN_OPERATOR_CONTENT  = /(IN \()[^SELECT][^\)]+(\))/.freeze
-        NUMERIC              = /\d*\.?\d+/.freeze
-        REPLACEMENT          = '?'.freeze
-        IN_REPLACEMENT       = '\1?\2'.freeze
-        SCHEMA               = 'SCHEMA'.freeze
-
-        attr_reader :adapter_uses_double_quoted_table_names
-
-        def initialize
-          @connection_config = connection_config
-          @adapter_uses_double_quoted_table_names = adapter_uses_double_quoted_table_names?
-        rescue ::ActiveRecord::ConnectionNotEstablished
-          Appsignal::EventFormatter.unregister('sql.active_record', self.class)
-          Appsignal.logger.error('Error while getting ActiveRecord connection info, unregistering sql.active_record event formatter')
-        end
-
         def format(payload)
-          return nil if schema_query?(payload) || !payload[:sql]
-          sql_string = payload[:sql].dup
-          unless adapter_uses_double_quoted_table_names
-            sql_string.gsub!(DOUBLE_QUOTED_STRING, REPLACEMENT)
-          end
-          sql_string.gsub!(SINGLE_QUOTED_STRING, REPLACEMENT)
-          sql_string.gsub!(IN_OPERATOR_CONTENT, IN_REPLACEMENT)
-          sql_string.gsub!(NUMERIC, REPLACEMENT)
-          [payload[:name], sql_string]
+          [payload[:name], payload[:sql], SQL_BODY_FORMAT]
         end
-
-        protected
-
-          def schema_query?(payload)
-            payload[:name] == SCHEMA
-          end
-
-          def connection_config
-            # TODO handle ActiveRecord::ConnectionNotEstablished
-            if ::ActiveRecord::Base.respond_to?(:connection_config)
-              ::ActiveRecord::Base.connection_config
-            else
-              ::ActiveRecord::Base.connection_pool.spec.config
-            end
-          end
-
-          def adapter_uses_double_quoted_table_names?
-            adapter = @connection_config[:adapter]
-            adapter =~ /postgres/ || adapter =~ /sqlite/
-          end
       end
     end
   end

data/lib/appsignal/event_formatter/mongo_ruby_driver/query_formatter.rb

@@ -0,0 +1,88 @@
+module Appsignal
+  class EventFormatter
+    module MongoRubyDriver
+      class QueryFormatter
+        ALLOWED = {
+          "find" => {
+            "find"   => :allow,
+            "filter" => :sanitize_document
+          },
+          "count" => {
+            "count" => :allow,
+            "query" => :sanitize_document
+          },
+          "distinct" => {
+            "distinct" => :allow,
+            "key"      => :allow,
+            "query"    => :sanitize_document
+          },
+          "insert" => {
+            "insert"    => :allow,
+            "documents" => :deny_array,
+            "ordered"   => :allow
+          },
+          "update" => {
+            "update"  => :allow,
+            "updates" => :sanitize_bulk,
+            "ordered" => :allow
+          },
+          "findandmodify" => {
+            "findandmodify" => :allow,
+            "query"         => :sanitize_document,
+            "update"        => :deny_array,
+            "new"           => :allow
+          },
+          "delete" => {
+            "delete" => :allow,
+            "deletes" => :sanitize_bulk,
+            "ordered" => :allow
+          },
+          "bulk" => {
+            "q"      => :sanitize_document,
+            "u"      => :deny_array,
+            "limit"  => :allow,
+            "multi"  => :allow,
+            "upsert" => :allow
+          }
+        }
+
+        # Format command based on given strategy
+        def self.format(strategy, command)
+          # Stop processing if command is not a hash
+          return {} unless command.is_a?(Hash)
+
+          # Get the strategy and stop if it's not present
+          strategies = ALLOWED[strategy.to_s]
+          return {} unless strategies
+
+          {}.tap do |hsh|
+            command.each do |key, val|
+              hsh[key] = self.apply_strategy(strategies[key], val)
+            end
+          end
+        end
+
+        # Applies strategy on hash values based on keys
+        def self.apply_strategy(strategy, val)
+          case strategy
+          when :allow      then val
+          when :deny       then '?'
+          when :deny_array then '[?]'
+          when :sanitize_document
+            Appsignal::Utils.sanitize(val, true, :mongodb)
+          when :sanitize_bulk
+            if val.length > 1
+              [
+                self.format(:bulk, val.first),
+                "[...]"
+              ]
+            else
+              val.map { |v| self.format(:bulk, v) }
+            end
+          else '?'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/event_formatter/moped/query_formatter.rb

@@ -11,12 +11,12 @@ module Appsignal
             when 'Moped::Protocol::Command'
               return ['Command', {
                 :database => op.full_collection_name,
-                :selector => Appsignal::Utils.sanitize(op.selector)
+                :selector => Appsignal::Utils.sanitize(op.selector, true, :mongodb)
               }.inspect]
             when 'Moped::Protocol::Query'
               return ['Query', {
                 :database => op.full_collection_name,
-                :selector => Appsignal::Utils.sanitize(op.selector),
+                :selector => Appsignal::Utils.sanitize(op.selector, false, :mongodb),
                 :flags    => op.flags,
                 :limit    => op.limit,
                 :skip     => op.skip,
@@ -25,21 +25,21 @@ module Appsignal
             when 'Moped::Protocol::Delete'
               return ['Delete', {
                 :database => op.full_collection_name,
-                :selector => Appsignal::Utils.sanitize(op.selector),
+                :selector => Appsignal::Utils.sanitize(op.selector, false, :mongodb),
                 :flags    => op.flags,
               }.inspect]
             when 'Moped::Protocol::Insert'
               return ['Insert', {
                 :database   => op.full_collection_name,
-                :documents  => Appsignal::Utils.sanitize(op.documents, true),
+                :documents  => Appsignal::Utils.sanitize(op.documents, true, :mongodb),
                 :count      => op.documents.count,
                 :flags      => op.flags,
               }.inspect]
             when 'Moped::Protocol::Update'
               return ['Update', {
                 :database => op.full_collection_name,
-                :selector => Appsignal::Utils.sanitize(op.selector),
-                :update   => Appsignal::Utils.sanitize(op.update, true),
+                :selector => Appsignal::Utils.sanitize(op.selector, false, :mongodb),
+                :update   => Appsignal::Utils.sanitize(op.update, true, :mongodb),
                 :flags    => op.flags,
               }.inspect]
             when 'Moped::Protocol::KillCursors'
@@ -53,7 +53,6 @@ module Appsignal
             end
           end
         end
-
       end
     end
   end

data/lib/appsignal/event_formatter/sequel/sql_formatter.rb

@@ -0,0 +1,13 @@
+module Appsignal
+  class EventFormatter
+    module Sequel
+      class SqlFormatter < Appsignal::EventFormatter
+        register 'sql.sequel'
+
+        def format(payload)
+          [nil, payload[:sql], SQL_BODY_FORMAT]
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/hooks/sequel.rb

@@ -3,13 +3,10 @@ module Appsignal
     module SequelExtension
       # Add query instrumentation
       def log_yield(sql, args = nil)
-
-        # We'd like to get full sql queries in the payloads as well. To do
-        # that we need to find out a way to ask Sequel which quoting strategy
-        # is used by the adapter. We can then do something similar to the AR
-        # formatter.
-
-        ActiveSupport::Notifications.instrument('sql.sequel') do
+        ActiveSupport::Notifications.instrument(
+          'sql.sequel',
+          :sql => sql
+        ) do
           yield
         end
       end

data/lib/appsignal/integrations/capistrano/appsignal.cap

@@ -1,6 +1,6 @@
 namespace :appsignal do
   task :deploy do
-    env = fetch(:rails_env, fetch(:rack_env, 'production'))
+    env = fetch(:stage, fetch(:rails_env, fetch(:rack_env, 'production')))
     user = ENV['USER'] || ENV['USERNAME']
     revision = fetch(:appsignal_revision, fetch(:current_revision))
     logger = fetch(:logger, Logger.new($stdout))

data/lib/appsignal/integrations/mongo_ruby_driver.rb

@@ -1,16 +1,19 @@
 module Appsignal
   class Hooks
     class MongoMonitorSubscriber
-
       # Called by Mongo::Monitor when query starts
       def started(event)
         transaction = Appsignal::Transaction.current
         return if transaction.nil_transaction?
         return if transaction.paused?
 
+        # Format the command
+        command = Appsignal::EventFormatter::MongoRubyDriver::QueryFormatter
+          .format(event.command_name, event.command)
+
         # Store the query on the transaction, we need it when the event finishes
         store                   = transaction.store('mongo_driver')
-        store[event.request_id] = Appsignal::Utils.sanitize(event.command)
+        store[event.request_id] = command
 
         # Start this event
         Appsignal::Extension.start_event(transaction.transaction_index)
@@ -36,14 +39,15 @@ module Appsignal
 
         # Get the query from the transaction store
         store   = transaction.store('mongo_driver')
-        command = store[event.request_id].inspect
+        command = store.delete(event.request_id) || {}
 
         # Finish the event in the extension.
         Appsignal::Extension.finish_event(
           transaction.transaction_index,
           'query.mongodb',
-          event.command_name.to_s,
-          %Q(#{event.database_name} | #{result} | #{command})
+          "#{event.command_name.to_s} | #{event.database_name} | #{result}",
+          Appsignal::Utils.json_generate(command),
+          0
         )
       end
     end