appsignal 2.5.3 → 2.6.0.beta.1

data/lib/appsignal/integrations/capistrano/capistrano_2_tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   # @todo Move to sub-namespace
   # @api private

data/lib/appsignal/integrations/data_mapper.rb

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

data/lib/appsignal/integrations/delayed_job_plugin.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class Hooks
     # @api private
@@ -30,8 +32,10 @@ module Appsignal
           class_name, method_name = class_and_method_name.split("#")
         end
 
-        params = Appsignal::Utils::ParamsSanitizer.sanitize args,
-          :filter_parameters => Appsignal.config[:filter_parameters]
+        params = Appsignal::Utils::HashSanitizer.sanitize(
+          args,
+          Appsignal.config[:filter_parameters]
+        )
 
         Appsignal.monitor_transaction(
           "perform_job.delayed_job",

data/lib/appsignal/integrations/grape.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   # @todo Move to sub-namespace
   # @api private

data/lib/appsignal/integrations/mongo_ruby_driver.rb

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

data/lib/appsignal/integrations/object.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Object
   def self.appsignal_instrument_class_method(method_name, options = {})
     singleton_class.send \

data/lib/appsignal/integrations/padrino.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "appsignal"
 
 module Appsignal
@@ -60,9 +62,6 @@ module Padrino::Routing::InstanceMethods
     controller_name = request.controller if request.respond_to?(:controller)
     action_name = request.action if request.respond_to?(:action)
     action_name ||= ""
-    if action_name.empty? && request.respond_to?(:fullpath)
-      action_name = request.fullpath
-    end
 
     unless action_name.empty?
       return "#{settings.name}:#{controller_name}##{action_name}"
@@ -75,7 +74,7 @@ module Padrino::Routing::InstanceMethods
 
     # Fall back to the application name if we haven't found an action name in
     # any previous methods.
-    settings.name.to_s
+    "#{settings.name}#unknown"
   end
 end
 

data/lib/appsignal/integrations/que.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   module Integrations
     module QuePlugin

data/lib/appsignal/integrations/railtie.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Appsignal.logger.info("Loading Rails (#{Rails.version}) integration")
 
 require "appsignal/rack/rails_instrumentation"

data/lib/appsignal/integrations/rake.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Since version 1.0 requiring this file is not necessary anymore to get
 # Rake integration, it's just here for backward compatibility.

data/lib/appsignal/integrations/resque.rb

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

data/lib/appsignal/integrations/resque_active_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   module Integrations
     # @api private
@@ -7,8 +9,10 @@ module Appsignal
       def self.included(base)
         base.class_eval do
           around_perform do |job, block|
-            params = Appsignal::Utils::ParamsSanitizer.sanitize job.arguments,
-              :filter_parameters => Appsignal.config[:filter_parameters]
+            params = Appsignal::Utils::HashSanitizer.sanitize(
+              job.arguments,
+              Appsignal.config[:filter_parameters]
+            )
 
             Appsignal.monitor_single_transaction(
               "perform_job.resque",

data/lib/appsignal/integrations/sinatra.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "appsignal"
 require "appsignal/rack/sinatra_instrumentation"
 

data/lib/appsignal/integrations/webmachine.rb

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

data/lib/appsignal/js_exception_transaction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   class JSExceptionTransaction
     attr_reader :uuid, :ext

data/lib/appsignal/marker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   # Deploy markers are used on AppSignal.com to indicate changes in an
   # application, "Deploy markers" indicate a deploy of an application.

data/lib/appsignal/minutely.rb

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

data/lib/appsignal/rack/generic_instrumentation.rb

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

data/lib/appsignal/rack/js_exception_catcher.rb

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

data/lib/appsignal/rack/rails_instrumentation.rb

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

data/lib/appsignal/rack/sinatra_instrumentation.rb

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

data/lib/appsignal/rack/streaming_listener.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   module Rack
     # Appsignal module that tracks exceptions in Streaming rack responses.

data/lib/appsignal/system.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
   # System environment detection module.
   #

data/lib/appsignal/transaction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 module Appsignal
@@ -9,7 +11,7 @@ module Appsignal
     BLANK          = "".freeze
 
     # Based on what Rails uses + some variables we'd like to show
-    ENV_METHODS = %w[
+    FALLBACK_REQUEST_HEADERS = %w[
       CONTENT_LENGTH AUTH_TYPE GATEWAY_INTERFACE
       PATH_TRANSLATED REMOTE_HOST REMOTE_IDENT REMOTE_USER REMOTE_ADDR
       REQUEST_METHOD SERVER_NAME SERVER_PORT SERVER_PROTOCOL REQUEST_URI
@@ -382,11 +384,8 @@ module Appsignal
     def sanitized_params
       return unless Appsignal.config[:send_params]
 
-      options = {}
-      if Appsignal.config[:filter_parameters]
-        options[:filter_parameters] = Appsignal.config[:filter_parameters]
-      end
-      Appsignal::Utils::ParamsSanitizer.sanitize params, options
+      filter_keys = Appsignal.config[:filter_parameters] || []
+      Appsignal::Utils::HashSanitizer.sanitize params, filter_keys
     end
 
     def request_params
@@ -406,7 +405,8 @@ module Appsignal
     # The environment of a transaction can contain a lot of information, not
     # all of it useful for debugging.
     #
-    # Only the values from the keys specified in {ENV_METHODS} are returned.
+    # Only the values from the keys specified in {FALLBACK_REQUEST_HEADERS} are
+    # returned.
     #
     # @return [nil] if no environment is present.
     # @return [Hash<String, Object>]
@@ -415,7 +415,8 @@ module Appsignal
       return if env.empty?
 
       {}.tap do |out|
-        ENV_METHODS.each do |key|
+        (Appsignal.config[:request_headers] ||
+          FALLBACK_REQUEST_HEADERS).each do |key|
           out[key] = env[key] if env[key]
         end
       end
@@ -423,7 +424,7 @@ module Appsignal
 
     # Returns sanitized session data.
     #
-    # The session data is sanitized by the {Appsignal::Utils::ParamsSanitizer}.
+    # The session data is sanitized by the {Appsignal::Utils::HashSanitizer}.
     #
     # @return [nil] if `:skip_session_data` config is set to `true`.
     # @return [nil] if the {#request} object doesn't respond to `#session`.
@@ -435,7 +436,9 @@ module Appsignal
       session = request.session
       return unless session
 
-      Appsignal::Utils::ParamsSanitizer.sanitize(session.to_hash)
+      Appsignal::Utils::HashSanitizer.sanitize(
+        session.to_hash, Appsignal.config[:filter_session_data]
+      )
     end
 
     # Returns metadata from the environment.

data/lib/appsignal/transmitter.rb

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

data/lib/appsignal/utils.rb

@@ -1,4 +1,6 @@
-require "appsignal/utils/params_sanitizer"
+# frozen_string_literal: true
+
+require "appsignal/utils/hash_sanitizer"
 require "appsignal/utils/query_params_sanitizer"
 
 module Appsignal

data/lib/appsignal/utils/{params_sanitizer.rb → hash_sanitizer.rb}

@@ -1,22 +1,24 @@
+# frozen_string_literal: true
+
 module Appsignal
   module Utils
     # @api private
-    class ParamsSanitizer
+    class HashSanitizer
       FILTERED = "[FILTERED]".freeze
 
       class << self
-        def sanitize(params, options = {})
-          sanitize_value(params, options)
+        def sanitize(value, filter_keys = [])
+          sanitize_value(value, filter_keys)
         end
 
         private
 
-        def sanitize_value(value, options = {})
+        def sanitize_value(value, filter_keys)
           case value
           when Hash
-            sanitize_hash(value, options)
+            sanitize_hash(value, filter_keys)
           when Array
-            sanitize_array(value, options)
+            sanitize_array(value, filter_keys)
           when TrueClass, FalseClass, NilClass, Integer, String, Symbol, Float
             unmodified(value)
           else
@@ -24,24 +26,23 @@ module Appsignal
           end
         end
 
-        def sanitize_hash(source, options)
-          filter_keys = options.fetch(:filter_parameters, [])
+        def sanitize_hash(source, filter_keys)
           {}.tap do |hash|
             source.each_pair do |key, value|
               hash[key] =
                 if filter_keys.include?(key.to_s)
                   FILTERED
                 else
-                  sanitize_value(value, options)
+                  sanitize_value(value, filter_keys)
                 end
             end
           end
         end
 
-        def sanitize_array(source, options)
+        def sanitize_array(source, filter_keys)
           [].tap do |array|
             source.each_with_index do |item, index|
-              array[index] = sanitize_value(item, options)
+              array[index] = sanitize_value(item, filter_keys)
             end
           end
         end

data/lib/appsignal/utils/query_params_sanitizer.rb

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

data/lib/appsignal/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Appsignal
-  VERSION = "2.5.3".freeze
+  VERSION = "2.6.0.beta.1".freeze
 end

data/lib/sequel/extensions/appsignal_integration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This is just a placeholder file, as +Sequel.extensions+ forcefully loads it
 # instead of assuming we already did. If you're looking for the integration
 # implementation, you can find it in +lib/appsignal/instrumentations/sequel.rb+

data/resources/appsignal.yml.erb

@@ -6,6 +6,11 @@ default: &defaults
   # Your app's name
   name: "<%= app_name %>"
 
+  # Request headers that should be recorded per sample
+  request_headers: [
+    <%= request_headers %>
+  ]
+
   # Actions that should not be monitored by AppSignal
   # ignore_actions:
   #   - ApplicationController#isup

data/spec/lib/appsignal/auth_check_spec.rb

@@ -2,13 +2,13 @@ describe Appsignal::AuthCheck do
   let(:config) { project_fixture_config }
   let(:auth_check) { Appsignal::AuthCheck.new(config) }
   let(:auth_url) do
-    query = {
+    query = build_uri_query_string(
       :api_key => config[:push_api_key],
       :environment => config.env,
       :gem_version => Appsignal::VERSION,
       :hostname => config[:hostname],
       :name => config[:name]
-    }.map { |k, v| "#{k}=#{v}" }.join("&")
+    )
 
     URI(config[:endpoint]).tap do |uri|
       uri.path = "/1/auth"
@@ -19,6 +19,15 @@ describe Appsignal::AuthCheck do
     WebMock.stub_request(:post, auth_url).with(:body => "{}")
   end
 
+  def build_uri_query_string(hash)
+    hash.map do |k, v|
+      k.to_s.tap do |s|
+        next unless v
+        s << "=#{v}"
+      end
+    end.join("&")
+  end
+
   describe "#perform" do
     subject { auth_check.perform }
 

data/spec/lib/appsignal/cli/install_spec.rb

@@ -39,6 +39,16 @@ describe Appsignal::CLI::Install do
       actual.include?("export APPSIGNAL_APP_NAME=#{name}")
     end
   end
+  define :include_env_request_headers do
+    match do |actual|
+      actual.include?(
+        "export APPSIGNAL_REQUEST_HEADERS=HTTP_ACCEPT,HTTP_ACCEPT_CHARSET," \
+        "HTTP_ACCEPT_ENCODING,HTTP_ACCEPT_LANGUAGE,HTTP_CACHE_CONTROL," \
+        "HTTP_CONNECTION,CONTENT_LENGTH,PATH_INFO,HTTP_RANGE," \
+        "REQUEST_METHOD,REQUEST_URI,SERVER_NAME,SERVER_PORT,SERVER_PROTOCOL"
+      )
+    end
+  end
 
   define :configure_app_name do |name|
     match do |file_contents|
@@ -50,6 +60,17 @@ describe Appsignal::CLI::Install do
       file_contents =~ /^  push_api_key: "#{key}"/
     end
   end
+  define :configure_request_headers do
+    match do |file_contents|
+      file_contents =~ /^  request_headers: \[/ &&
+        file_contents =~ /^    "HTTP_ACCEPT", "HTTP_ACCEPT_CHARSET", "HTTP_ACCEPT_ENCODING",/ &&
+        file_contents =~ /^    "HTTP_ACCEPT_LANGUAGE", "HTTP_CACHE_CONTROL", "HTTP_CONNECTION",/ &&
+        file_contents =~ /^    "CONTENT_LENGTH", "PATH_INFO", "HTTP_RANGE",/ &&
+        file_contents =~ /^    "REQUEST_METHOD", "REQUEST_URI", "SERVER_NAME", "SERVER_PORT",/ &&
+        file_contents =~ /^    "SERVER_PROTOCOL"/ &&
+        file_contents =~ /^  \]/
+    end
+  end
   define :configure_environment do |env|
     match do |file_contents|
       file_contents =~ /^#{env}:$/
@@ -272,6 +293,7 @@ describe Appsignal::CLI::Install do
           expect(output).to include_file_config
           expect(config_file).to configure_app_name(app_name)
           expect(config_file).to configure_push_api_key(push_api_key)
+          expect(config_file).to configure_request_headers
           expect(config_file).to_not configure_environment("development")
           expect(config_file).to_not configure_environment("staging")
           expect(config_file).to configure_environment("production")
@@ -299,6 +321,7 @@ describe Appsignal::CLI::Install do
 
             expect(output).to include_env_push_api_key(push_api_key)
             expect(output).to_not include_env_app_name
+            expect(output).to include_env_request_headers
           end
 
           it "completes the installation" do
@@ -322,6 +345,7 @@ describe Appsignal::CLI::Install do
             expect(output).to include_file_config
             expect(config_file).to configure_app_name(app_name)
             expect(config_file).to configure_push_api_key(push_api_key)
+            expect(config_file).to configure_request_headers
             expect(config_file).to configure_environment("development")
             expect(config_file).to configure_environment("staging")
             expect(config_file).to configure_environment("production")
@@ -366,6 +390,7 @@ describe Appsignal::CLI::Install do
 
             expect(output).to include_env_push_api_key(push_api_key)
             expect(output).to include_env_app_name(app_name)
+            expect(output).to include_env_request_headers
           end
 
           it "completes the installation" do
@@ -392,6 +417,7 @@ describe Appsignal::CLI::Install do
             expect(output).to include_file_config
             expect(config_file).to configure_app_name(app_name)
             expect(config_file).to configure_push_api_key(push_api_key)
+            expect(config_file).to configure_request_headers
             expect(config_file).to configure_environment("development")
             expect(config_file).to configure_environment("staging")
             expect(config_file).to configure_environment("production")
@@ -437,6 +463,7 @@ describe Appsignal::CLI::Install do
 
             expect(output).to include_env_push_api_key(push_api_key)
             expect(output).to include_env_app_name(app_name)
+            expect(output).to include_env_request_headers
           end
 
           it "completes the installation" do
@@ -460,6 +487,7 @@ describe Appsignal::CLI::Install do
             expect(output).to include_file_config
             expect(config_file).to configure_app_name(app_name)
             expect(config_file).to configure_push_api_key(push_api_key)
+            expect(config_file).to configure_request_headers
             expect(config_file).to configure_environment("development")
             expect(config_file).to configure_environment("staging")
             expect(config_file).to configure_environment("production")
@@ -504,6 +532,7 @@ describe Appsignal::CLI::Install do
 
             expect(output).to include_env_push_api_key(push_api_key)
             expect(output).to include_env_app_name(app_name)
+            expect(output).to include_env_request_headers
           end
 
           it "completes the installation" do
@@ -527,6 +556,7 @@ describe Appsignal::CLI::Install do
             expect(output).to include_file_config
             expect(config_file).to configure_app_name(app_name)
             expect(config_file).to configure_push_api_key(push_api_key)
+            expect(config_file).to configure_request_headers
             expect(config_file).to configure_environment("development")
             expect(config_file).to configure_environment("staging")
             expect(config_file).to configure_environment("production")
@@ -571,6 +601,7 @@ describe Appsignal::CLI::Install do
 
             expect(output).to include_env_push_api_key(push_api_key)
             expect(output).to include_env_app_name(app_name)
+            expect(output).to include_env_request_headers
           end
 
           it "completes the installation" do
@@ -594,6 +625,7 @@ describe Appsignal::CLI::Install do
             expect(output).to include_file_config
             expect(config_file).to configure_app_name(app_name)
             expect(config_file).to configure_push_api_key(push_api_key)
+            expect(config_file).to configure_request_headers
             expect(config_file).to configure_environment("development")
             expect(config_file).to configure_environment("staging")
             expect(config_file).to configure_environment("production")
@@ -625,6 +657,7 @@ describe Appsignal::CLI::Install do
           "\e[31mWarning:\e[0m We could not detect which framework you are using."
         expect(output).to_not include_env_push_api_key
         expect(output).to_not include_env_app_name
+        expect(output).to_not include_env_request_headers
         expect(File.exist?(config_file_path)).to be_falsy
       end
     end