appsignal 2.5.3 → 2.6.0.beta.1

data/lib/appsignal/cli/notify_of_deploy.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class CLI
     # Command line tool to send a "Deploy Marker" for an application to
@@ -44,6 +46,12 @@ module Appsignal
     # @example help command
     #   appsignal notify_of_deploy --help
     #
+    # @deprecated This method of sending AppSignal deploy markers is
+    #   deprecated. Use the [`revision` config option]
+    #   (https://docs.appsignal.com/ruby/configuration/options.html#app_revision-revision)
+    #   instead. For more information, please read the [deploy markers]
+    #   (https://docs.appsignal.com/application/markers/deploy-markers.html)
+    #   documentation.
     # @since 0.2.5
     # @see Appsignal::Marker Appsignal::Marker
     # @see http://docs.appsignal.com/ruby/command-line/notify_of_deploy.html

data/lib/appsignal/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "erb"
 require "yaml"
 require "uri"
@@ -13,6 +15,7 @@ module Appsignal
       :ignore_errors                  => [],
       :ignore_namespaces              => [],
       :filter_parameters              => [],
+      :filter_session_data            => [],
       :send_params                    => true,
       :endpoint                       => "https://push.appsignal.com",
       :instrument_net_http            => true,
@@ -25,7 +28,6 @@ module Appsignal
       :enable_gc_instrumentation      => false,
       :enable_host_metrics            => true,
       :enable_minutely_probes         => false,
-      :hostname                       => ::Socket.gethostname,
       :ca_file_path                   => File.expand_path(File.join("../../../resources/cacert.pem"), __FILE__),
       :dns_servers                    => [],
       :files_world_accessible         => true
@@ -49,6 +51,7 @@ module Appsignal
       "APPSIGNAL_IGNORE_ERRORS"                  => :ignore_errors,
       "APPSIGNAL_IGNORE_NAMESPACES"              => :ignore_namespaces,
       "APPSIGNAL_FILTER_PARAMETERS"              => :filter_parameters,
+      "APPSIGNAL_FILTER_SESSION_DATA"            => :filter_session_data,
       "APPSIGNAL_SEND_PARAMS"                    => :send_params,
       "APPSIGNAL_HTTP_PROXY"                     => :http_proxy,
       "APPSIGNAL_ENABLE_ALLOCATION_TRACKING"     => :enable_allocation_tracking,
@@ -60,8 +63,18 @@ module Appsignal
       "APPSIGNAL_HOSTNAME"                       => :hostname,
       "APPSIGNAL_CA_FILE_PATH"                   => :ca_file_path,
       "APPSIGNAL_DNS_SERVERS"                    => :dns_servers,
-      "APPSIGNAL_FILES_WORLD_ACCESSIBLE"         => :files_world_accessible
+      "APPSIGNAL_FILES_WORLD_ACCESSIBLE"         => :files_world_accessible,
+      "APPSIGNAL_REQUEST_HEADERS"                => :request_headers,
+      "APP_REVISION"                             => :revision
     }.freeze
+    # Formatted in two-dimensional array for easy printing
+    SUGGESTED_REQUEST_HEADERS = [
+      %w[HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING],
+      %w[HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_CONNECTION],
+      %w[CONTENT_LENGTH PATH_INFO HTTP_RANGE],
+      %w[REQUEST_METHOD REQUEST_URI SERVER_NAME SERVER_PORT],
+      %w[SERVER_PROTOCOL]
+    ].freeze
 
     # Mapping of old and deprecated AppSignal configuration keys
     DEPRECATED_CONFIG_KEY_MAPPING = {
@@ -153,7 +166,6 @@ module Appsignal
       ENV["_APPSIGNAL_IGNORE_ACTIONS"]               = config_hash[:ignore_actions].join(",")
       ENV["_APPSIGNAL_IGNORE_ERRORS"]                = config_hash[:ignore_errors].join(",")
       ENV["_APPSIGNAL_IGNORE_NAMESPACES"]            = config_hash[:ignore_namespaces].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]
@@ -164,6 +176,7 @@ module Appsignal
       ENV["_APPSIGNAL_CA_FILE_PATH"]                 = config_hash[:ca_file_path].to_s
       ENV["_APPSIGNAL_DNS_SERVERS"]                  = config_hash[:dns_servers].join(",")
       ENV["_APPSIGNAL_FILES_WORLD_ACCESSIBLE"]       = config_hash[:files_world_accessible].to_s
+      ENV["_APP_REVISION"]                           = config_hash[:revision].to_s
     end
 
     def validate
@@ -184,10 +197,35 @@ module Appsignal
         @valid = false
         @logger.error "Push api key not set after loading config"
       end
+
+      check_if_request_headers_option_is_set
     end
 
     private
 
+    def check_if_request_headers_option_is_set
+      return unless valid?
+      return if config_hash.key?(:request_headers) || env == "test"
+
+      multi_line_request_headers = SUGGESTED_REQUEST_HEADERS.map do |row|
+        row.map(&:inspect).join(", ")
+      end.join(",\n    ")
+      single_line_request_headers = SUGGESTED_REQUEST_HEADERS.flatten.join(",")
+
+      puts "Warning: The `request_headers` config option was not set " \
+        " in the AppSignal configuration, falling back to the default list. " \
+        "Please explicitly list response headers to send to AppSignal in " \
+        "config/appsignal.yml:\n\n" \
+        "  request_headers: [\n" \
+        "    #{multi_line_request_headers}\n" \
+        "]\n\n" \
+        "Or set the APPSIGNAL_REQUEST_HEADERS environment variable:\n\n"\
+        "  $ export APPSIGNAL_REQUEST_HEADERS=" \
+        "\"#{single_line_request_headers}\"\n\n" \
+        "Please check https://github.com/appsignal/appsignal-ruby/pull/406 " \
+        "for more information on this change."
+    end
+
     def config_file
       @config_file ||=
         root_path.nil? ? nil : File.join(root_path, "config", "appsignal.yml")
@@ -244,7 +282,7 @@ module Appsignal
       %w[APPSIGNAL_PUSH_API_KEY APPSIGNAL_APP_NAME APPSIGNAL_PUSH_API_ENDPOINT
          APPSIGNAL_FRONTEND_ERROR_CATCHING_PATH APPSIGNAL_HTTP_PROXY
          APPSIGNAL_LOG APPSIGNAL_LOG_PATH APPSIGNAL_WORKING_DIR_PATH
-         APPSIGNAL_HOSTNAME APPSIGNAL_CA_FILE_PATH].each do |var|
+         APPSIGNAL_HOSTNAME APPSIGNAL_CA_FILE_PATH APP_REVISION].each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var
@@ -265,7 +303,8 @@ module Appsignal
 
       # Configuration with array of strings type
       %w[APPSIGNAL_IGNORE_ACTIONS APPSIGNAL_IGNORE_ERRORS
-         APPSIGNAL_IGNORE_NAMESPACES APPSIGNAL_FILTER_PARAMETERS].each do |var|
+         APPSIGNAL_IGNORE_NAMESPACES APPSIGNAL_FILTER_PARAMETERS
+         APPSIGNAL_FILTER_SESSION_DATA APPSIGNAL_REQUEST_HEADERS].each do |var|
         env_var = ENV[var]
         next unless env_var
         config[ENV_TO_KEY_MAPPING[var]] = env_var.split(",")

data/lib/appsignal/demo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rack/mock"
 
 module Appsignal

data/lib/appsignal/event_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   # Keeps track of formatters for types event that we can use to get
   # the title and body of an event. Formatters should inherit from this class

data/lib/appsignal/event_formatter/action_view/render_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class EventFormatter
     # @api private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class EventFormatter
     # @api private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class EventFormatter
     # @api private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class EventFormatter
     # @api private

data/lib/appsignal/event_formatter/faraday/request_formatter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class EventFormatter
     # @api private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class EventFormatter
     # @api private

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class EventFormatter
     # @api private

data/lib/appsignal/extension.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 
 begin

data/lib/appsignal/extension/jruby.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "ffi"
 
 module Appsignal
@@ -61,7 +63,7 @@ module Appsignal
 
         # Metrics methods
         attach_function :appsignal_set_gauge,
-          [:appsignal_string, :double],
+          [:appsignal_string, :double, :pointer],
           :void
         attach_function :appsignal_set_host_gauge,
           [:appsignal_string, :double],
@@ -70,10 +72,10 @@ module Appsignal
           [:appsignal_string, :double],
           :void
         attach_function :appsignal_increment_counter,
-          [:appsignal_string, :int64],
+          [:appsignal_string, :int64, :pointer],
           :void
         attach_function :appsignal_add_distribution_value,
-          [:appsignal_string, :double],
+          [:appsignal_string, :double, :pointer],
           :void
 
         # Transaction methods
@@ -222,8 +224,8 @@ module Appsignal
         appsignal_running_in_container
       end
 
-      def set_gauge(key, value)
-        appsignal_set_gauge(make_appsignal_string(key), value)
+      def set_gauge(key, value, tags)
+        appsignal_set_gauge(make_appsignal_string(key), value, tags.pointer)
       end
 
       def set_host_gauge(key, value)
@@ -234,12 +236,12 @@ module Appsignal
         appsignal_set_process_gauge(make_appsignal_string(key), value)
       end
 
-      def increment_counter(key, value)
-        appsignal_increment_counter(make_appsignal_string(key), value)
+      def increment_counter(key, value, tags)
+        appsignal_increment_counter(make_appsignal_string(key), value, tags.pointer)
       end
 
-      def add_distribution_value(key, value)
-        appsignal_add_distribution_value(make_appsignal_string(key), value)
+      def add_distribution_value(key, value, tags)
+        appsignal_add_distribution_value(make_appsignal_string(key), value, tags.pointer)
       end
 
       class Transaction # rubocop:disable Metrics/ClassLength
@@ -314,14 +316,14 @@ module Appsignal
           )
         end
 
-        def set_action(action_name) # rubocop:disable Style/AccessorMethodName
+        def set_action(action_name) # rubocop:disable Naming/AccessorMethodName
           Extension.appsignal_set_transaction_action(
             pointer,
             make_appsignal_string(action_name)
           )
         end
 
-        def set_namespace(namespace) # rubocop:disable Style/AccessorMethodName
+        def set_namespace(namespace) # rubocop:disable Naming/AccessorMethodName
           Extension.appsignal_set_transaction_namespace(
             pointer,
             make_appsignal_string(namespace)
@@ -336,7 +338,7 @@ module Appsignal
           )
         end
 
-        def set_queue_start(time) # rubocop:disable Style/AccessorMethodName
+        def set_queue_start(time) # rubocop:disable Naming/AccessorMethodName
           Extension.appsignal_set_transaction_queue_start(pointer, time)
         end
 
@@ -405,7 +407,7 @@ module Appsignal
           )
         end
 
-        def set_nil(key) # rubocop:disable Style/AccessorMethodName
+        def set_nil(key) # rubocop:disable Naming/AccessorMethodName
           Extension.appsignal_data_map_set_null(
             pointer,
             make_appsignal_string(key)

data/lib/appsignal/garbage_collection_profiler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   # {Appsignal::GarbageCollectionProfiler} wraps Ruby's `GC::Profiler` to be
   # able to track garbage collection time for multiple transactions, while

data/lib/appsignal/hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   # @api private
   class Hooks

data/lib/appsignal/hooks/action_cable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/active_support_notifications.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/celluloid.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/data_mapper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/delayed_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/mongo_ruby_driver.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/net_http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "net/http"
 
 module Appsignal

data/lib/appsignal/hooks/passenger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/puma.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/que.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/rake.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/redis.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/sequel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/shoryuken.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private
@@ -11,8 +13,10 @@ module Appsignal
         }
 
         args = body.is_a?(Hash) ? body : { :params => body }
-        options[:params] = Appsignal::Utils::ParamsSanitizer.sanitize args,
-          :filter_parameters => Appsignal.config[:filter_parameters]
+        options[:params] = Appsignal::Utils::HashSanitizer.sanitize(
+          args,
+          Appsignal.config[:filter_parameters]
+        )
 
         if sqs_msg.attributes.key?("SentTimestamp")
           options[:queue_start] = Time.at(sqs_msg.attributes["SentTimestamp"].to_i / 1000)

data/lib/appsignal/hooks/sidekiq.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "yaml"
 
 module Appsignal
@@ -69,9 +71,9 @@ module Appsignal
       end
 
       def filtered_arguments(job)
-        Appsignal::Utils::ParamsSanitizer.sanitize(
+        Appsignal::Utils::HashSanitizer.sanitize(
           parse_arguments(job),
-          :filter_parameters => Appsignal.config[:filter_parameters]
+          Appsignal.config[:filter_parameters]
         )
       end
 

data/lib/appsignal/hooks/unicorn.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private

data/lib/appsignal/hooks/webmachine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private