appsignal 1.2.5 → 1.3.0.beta.1

data/lib/appsignal/config.rb

@@ -8,6 +8,7 @@ module Appsignal
       :debug                          => false,
       :ignore_errors                  => [],
       :ignore_actions                 => [],
+      :filter_parameters              => [],
       :send_params                    => true,
       :endpoint                       => 'https://push.appsignal.com',
       :instrument_net_http            => true,
@@ -19,7 +20,9 @@ module Appsignal
       :enable_allocation_tracking     => true,
       :enable_gc_instrumentation      => false,
       :running_in_container           => false,
-      :enable_host_metrics            => false
+      :enable_host_metrics            => true,
+      :enable_minutely_probes         => false,
+      :hostname                       => Socket.gethostname
     }.freeze
 
     ENV_TO_KEY_MAPPING = {
@@ -37,12 +40,16 @@ module Appsignal
       'APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING' => :enable_frontend_error_catching,
       'APPSIGNAL_IGNORE_ERRORS'                  => :ignore_errors,
       'APPSIGNAL_IGNORE_ACTIONS'                 => :ignore_actions,
+      'APPSIGNAL_FILTER_PARAMETERS'              => :filter_parameters,
+      'APPSIGNAL_SEND_PARAMS'                    => :send_params,
       '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_WORKING_DIR_PATH'               => :working_dir_path,
-      'APPSIGNAL_ENABLE_HOST_METRICS'            => :enable_host_metrics
+      'APPSIGNAL_ENABLE_HOST_METRICS'            => :enable_host_metrics,
+      'APPSIGNAL_ENABLE_MINUTELY_PROBES'         => :enable_minutely_probes,
+      'APPSIGNAL_HOSTNAME'                       => :hostname
     }.freeze
 
     attr_reader :root_path, :env, :initial_config, :config_hash
@@ -111,9 +118,14 @@ module Appsignal
       ENV['APPSIGNAL_APP_NAME']                     = config_hash[:name]
       ENV['APPSIGNAL_HTTP_PROXY']                   = config_hash[:http_proxy]
       ENV['APPSIGNAL_IGNORE_ACTIONS']               = config_hash[:ignore_actions].join(',')
+      ENV['APPSIGNAL_FILTER_PARAMETERS']            = config_hash[:filter_parameters].join(',')
+      ENV['APPSIGNAL_SEND_PARAMS']                  = config_hash[:send_params].to_s
       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]
       ENV['APPSIGNAL_ENABLE_HOST_METRICS']          = config_hash[:enable_host_metrics].to_s
+      ENV['APPSIGNAL_ENABLE_MINUTELY_PROBES']       = config_hash[:enable_minutely_probes].to_s
+      ENV['APPSIGNAL_HOSTNAME']                     = config_hash[:hostname].to_s
+      ENV['APPSIGNAL_PROCESS_NAME']                 = $0
     end
 
     protected
@@ -162,7 +174,7 @@ 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
-         APPSIGNAL_WORKING_DIR_PATH).each do |var|
+         APPSIGNAL_WORKING_DIR_PATH APPSIGNAL_HOSTNAME).each do |var|
         if env_var = ENV[var]
           config[ENV_TO_KEY_MAPPING[var]] = env_var
         end
@@ -172,14 +184,16 @@ module Appsignal
       %w(APPSIGNAL_ACTIVE APPSIGNAL_DEBUG APPSIGNAL_INSTRUMENT_NET_HTTP
          APPSIGNAL_SKIP_SESSION_DATA APPSIGNAL_ENABLE_FRONTEND_ERROR_CATCHING
          APPSIGNAL_ENABLE_ALLOCATION_TRACKING APPSIGNAL_ENABLE_GC_INSTRUMENTATION
-         APPSIGNAL_RUNNING_IN_CONTAINER APPSIGNAL_ENABLE_HOST_METRICS).each do |var|
+         APPSIGNAL_RUNNING_IN_CONTAINER APPSIGNAL_ENABLE_HOST_METRICS
+         APPSIGNAL_SEND_PARAMS APPSIGNAL_ENABLE_MINUTELY_PROBES).each do |var|
         if env_var = ENV[var]
           config[ENV_TO_KEY_MAPPING[var]] = env_var == 'true'
         end
       end
 
       # Configuration with array of strings type
-      %w(APPSIGNAL_IGNORE_ERRORS APPSIGNAL_IGNORE_ACTIONS).each do |var|
+      %w(APPSIGNAL_IGNORE_ERRORS APPSIGNAL_IGNORE_ACTIONS
+         APPSIGNAL_FILTER_PARAMETERS).each do |var|
         if env_var = ENV[var]
           config[ENV_TO_KEY_MAPPING[var]] = env_var.split(',')
         end

data/lib/appsignal/event_formatter.rb

@@ -59,9 +59,10 @@ module Appsignal
         formatter.format(payload) unless formatter.nil?
       end
     end
-  end
 
-  SQL_BODY_FORMAT = 1
+    DEFAULT = 0
+    SQL_BODY_FORMAT = 1
+  end
 end
 
 Dir.glob(File.expand_path('../event_formatter/**/*.rb', __FILE__)).each do |file|

data/lib/appsignal/event_formatter/elastic_search/search_formatter.rb

@@ -18,7 +18,7 @@ module Appsignal
               if [:index, :type].include?(key)
                 hsh[key] = val
               else
-                hsh[key] = Appsignal::Utils.sanitize(val)
+                hsh[key] = Appsignal::Utils::QueryParamsSanitizer.sanitize(val)
               end
             end
           end

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

@@ -69,7 +69,7 @@ module Appsignal
           when :deny       then '?'
           when :deny_array then '[?]'
           when :sanitize_document
-            Appsignal::Utils.sanitize(val, true, :mongodb)
+            Appsignal::Utils::QueryParamsSanitizer.sanitize(val, true, :mongodb)
           when :sanitize_bulk
             if val.length > 1
               [

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, true, :mongodb)
+                :selector => sanitize(op.selector, true, :mongodb)
               }.inspect]
             when 'Moped::Protocol::Query'
               return ['Query', {
                 :database => op.full_collection_name,
-                :selector => Appsignal::Utils.sanitize(op.selector, false, :mongodb),
+                :selector => 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, false, :mongodb),
+                :selector => 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, :mongodb),
+                :documents  => 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, false, :mongodb),
-                :update   => Appsignal::Utils.sanitize(op.update, true, :mongodb),
+                :selector => sanitize(op.selector, false, :mongodb),
+                :update   => sanitize(op.update, true, :mongodb),
                 :flags    => op.flags,
               }.inspect]
             when 'Moped::Protocol::KillCursors'
@@ -53,6 +53,13 @@ module Appsignal
             end
           end
         end
+
+        private
+
+        def sanitize(params, only_top_level, key_sanitizer)
+          Appsignal::Utils::QueryParamsSanitizer.sanitize \
+            params, only_top_level, key_sanitizer
+        end
       end
     end
   end

data/lib/appsignal/hooks/mongo_ruby_driver.rb

@@ -16,6 +16,5 @@ module Appsignal
         )
       end
     end
-
   end
 end

data/lib/appsignal/hooks/net_http.rb

@@ -14,12 +14,9 @@ module Appsignal
           alias request_without_appsignal request
 
           def request(request, body=nil, &block)
-            ActiveSupport::Notifications.instrument(
+            Appsignal.instrument(
               'request.net_http',
-              :protocol => use_ssl? ? 'https' : 'http',
-              :domain   => request['host'] || self.address,
-              :path     => request.path,
-              :method   => request.method
+              "#{request.method} #{use_ssl? ? 'https' : 'http'}://#{request['host'] || self.address}"
             ) do
               request_without_appsignal(request, body, &block)
             end

data/lib/appsignal/hooks/redis.rb

@@ -14,7 +14,7 @@ module Appsignal
           alias process_without_appsignal process
 
           def process(commands, &block)
-            ActiveSupport::Notifications.instrument('query.redis') do
+            Appsignal.instrument 'query.redis' do
               process_without_appsignal(commands, &block)
             end
           end

data/lib/appsignal/hooks/sequel.rb

@@ -3,9 +3,11 @@ module Appsignal
     module SequelLogExtension
       # Add query instrumentation
       def log_yield(sql, args = nil)
-        ActiveSupport::Notifications.instrument(
+        Appsignal.instrument(
           'sql.sequel',
-          :sql => sql
+          nil,
+          sql,
+          Appsignal::EventFormatter::SQL_BODY_FORMAT
         ) do
           yield
         end
@@ -15,9 +17,11 @@ module Appsignal
     module SequelLogConnectionExtension
       # Add query instrumentation
       def log_connection_yield(sql, conn, args = nil)
-        ActiveSupport::Notifications.instrument(
+        Appsignal.instrument(
           'sql.sequel',
-          :sql => sql
+          nil,
+          sql,
+          Appsignal::EventFormatter::SQL_BODY_FORMAT
         ) do
           yield
         end

data/lib/appsignal/integrations/mongo_ruby_driver.rb

@@ -46,7 +46,7 @@ module Appsignal
           'query.mongodb',
           "#{event.command_name.to_s} | #{event.database_name} | #{result}",
           Appsignal::Utils.json_generate(command),
-          0
+          Appsignal::EventFormatter::DEFAULT
         )
       end
     end

data/lib/appsignal/integrations/object.rb

@@ -0,0 +1,35 @@
+class Object
+  def self.appsignal_instrument_class_method(method_name, options = {})
+    singleton_class.send \
+      :alias_method, "appsignal_uninstrumented_#{method_name}", method_name
+    singleton_class.send(:define_method, method_name) do |*args|
+      name = options.fetch(:name) do
+        "#{method_name}.class_method.#{appsignal_reverse_class_name}.other"
+      end
+      Appsignal.instrument name do
+        send "appsignal_uninstrumented_#{method_name}", *args
+      end
+    end
+  end
+
+  def self.appsignal_instrument_method(method_name, options = {})
+    alias_method "appsignal_uninstrumented_#{method_name}", method_name
+    define_method method_name do |*args|
+      name = options.fetch(:name) do
+        "#{method_name}.#{appsignal_reverse_class_name}.other"
+      end
+      Appsignal.instrument name do
+        send "appsignal_uninstrumented_#{method_name}", *args
+      end
+    end
+  end
+
+  def self.appsignal_reverse_class_name
+    return "AnonymousClass" unless name
+    name.split("::").reverse.join(".")
+  end
+
+  def appsignal_reverse_class_name
+    self.class.appsignal_reverse_class_name
+  end
+end

data/lib/appsignal/integrations/resque.rb

@@ -1,6 +1,11 @@
 module Appsignal
   module Integrations
     module ResquePlugin
+
+      # Do not use this file as a template for your own background processor
+      # Resque is an exception to the rule and the code below causes the
+      # extension to shut itself down after a single job.
+      # see http://docs.appsignal.com/background-monitoring/custom.html
       def around_perform_resque_plugin(*args)
         Appsignal.monitor_single_transaction(
           'perform_job.resque',

data/lib/appsignal/integrations/sinatra.rb

@@ -5,7 +5,7 @@ Appsignal.logger.info("Loading Sinatra (#{Sinatra::VERSION}) integration")
 
 app_settings = ::Sinatra::Application.settings
 Appsignal.config = Appsignal::Config.new(
-  app_settings.root,
+  app_settings.root || Dir.pwd,
   app_settings.environment
 )
 
@@ -13,5 +13,5 @@ Appsignal.start_logger
 Appsignal.start
 
 if Appsignal.active?
-  ::Sinatra::Application.use(Appsignal::Rack::SinatraInstrumentation)
+  ::Sinatra::Base.use(Appsignal::Rack::SinatraBaseInstrumentation)
 end

data/lib/appsignal/minutely.rb

@@ -0,0 +1,41 @@
+module Appsignal
+  class Minutely
+    class << self
+      # List of probes. Probes can be lamdba's or objects that
+      # respond to call.
+      def probes
+        @@probes ||= []
+      end
+
+      def start
+        Thread.new do
+          begin
+            loop do
+              Appsignal.logger.debug("Gathering minutely metrics with #{probes.count} probe(s)")
+              probes.each(&:call)
+              sleep(wait_time)
+            end
+          rescue Exception => ex
+            Appsignal.logger.error("Error in minutely thread: #{ex}")
+          end
+        end
+      end
+
+      def wait_time
+        60 - Time.now.sec
+      end
+
+      def add_gc_probe
+        probes << GCProbe.new
+      end
+    end
+
+    class GCProbe
+      def call
+        GC.stat.each do |key, value|
+          Appsignal.set_process_gauge("gc.#{key}", value)
+        end
+      end
+    end
+  end
+end

data/lib/appsignal/params_sanitizer.rb

@@ -1,114 +1,13 @@
 module Appsignal
   class ParamsSanitizer
     class << self
-      def sanitize(params)
-        ParamsSanitizerCopy.sanitize_value(params)
-      end
-
-      def sanitize!(params)
-        ParamsSanitizerDestructive.sanitize_value(params)
-      end
-
-      def scrub(params)
-        ParamsSanitizerCopyScrub.sanitize_value(params)
-      end
-
-      def scrub!(params)
-        ParamsSanitizerDestructiveScrub.sanitize_value(params)
-      end
-
-      protected
-
-      def sanitize_value(value)
-        case value
-        when Hash
-          sanitize_hash(value)
-        when Array
-          sanitize_array(value)
-        when TrueClass, FalseClass, NilClass, Fixnum, String, Symbol, Float
-          unmodified(value)
-        else
-          inspected(value)
-        end
-      end
-
-      def sanitize_hash_with_target(source_hash, target_hash)
-        source_hash.each_pair do |key, value|
-          target_hash[key] = sanitize_value(value)
-        end
-        target_hash
-      end
-
-      def sanitize_array_with_target(source_array, target_array)
-        source_array.each_with_index do |item, index|
-          target_array[index] = sanitize_value(item)
-        end
-        target_array
-      end
-
-      def unmodified(value)
-        value
-      end
-
-      def inspected(value)
-        "#<#{value.class.to_s}>"
-      end
-    end
-  end
-
-  class ParamsSanitizerCopy < ParamsSanitizer
-    class << self
-      protected
-
-      def sanitize_hash(hash)
-        sanitize_hash_with_target(hash, {})
-      end
+      extend Gem::Deprecate
 
-      def sanitize_array(array)
-        sanitize_array_with_target(array, [])
-      end
-    end
-  end
-
-  class ParamsSanitizerDestructive < ParamsSanitizer
-    class << self
-      protected
-
-      def sanitize_hash(hash)
-        sanitize_hash_with_target(hash, hash)
-      end
-
-      def sanitize_array(array)
-        sanitize_array_with_target(array, array)
-      end
-    end
-  end
-
-  class ParamsSanitizerCopyScrub < ParamsSanitizerCopy
-    class << self
-      protected
-
-      def unmodified(value)
-        '?'
-      end
-
-      def inspected(value)
-        '?'
-      end
-    end
-  end
-
-  class ParamsSanitizerDestructiveScrub < ParamsSanitizerDestructive
-    class << self
-      protected
-
-      def unmodified(value)
-        '?'
+      def sanitize(params)
+        Appsignal::Utils::ParamsSanitizer.sanitize(params)
       end
 
-      def inspected(value)
-        '?'
-      end
+      deprecate :sanitize, "AppSignal::Utils::ParamsSanitizer.sanitize", 2016, 9
     end
   end
 end