scout_apm 5.7.0 → 5.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2182f0bacb1555c0eb3323f8200db7f8d93068f018ce57c82bb4975361d0581
-  data.tar.gz: fd8b5694f8cacf2a648bb7a9e4440d16cb70be93c84b17db439781b01f2d5d48
+  metadata.gz: 2e96ebe1b7d9a1fb4bd1427ba0564e645cb9bed376da56bc92f9d86f0515adf7
+  data.tar.gz: d1c4692af9e37bb6107f14064ce89f94626d987bf55d845dea19b522fa910ce1
 SHA512:
-  metadata.gz: e44b2bcab8ec4d818faec5b87b4068ce3be0dd37afe97e123c4920cb4d5aa3a931c550bfb80cad1e9d9b6aea6102172cedd68afaee4a1497b3948675f61e2bec
-  data.tar.gz: a2e1dd693d0fc1f43e9f68d7a3b019c1d98d879a7671c9bc38944056390d6d8f7e0af6546ec39fc95d568edc3cca12bb73621ffd39e6c6eb80295c6a34cc3c20
+  metadata.gz: 958530e614d6ad7ac0ef8805d40843883fae446d5dbfdee7f982a504eff838e0f6abe9fc70e7ead42f0e3a7075540291954264704da73694f132674ef2edc48b
+  data.tar.gz: d35f05a9f2c6094b87e1df04a95fa54138c901b25b479ce5962c616d54806fea1a25ab5e89feb5d98c0ecf0d5e13163e97f990c3e74229544751f3b6e0d4fe9f

data/CHANGELOG.markdown

@@ -1,5 +1,9 @@
 # Unreleased
 
+# 5.7.1
+- Update error capture API to use context (#560)
+- Filter env in error records (#559)
+
 # 5.7.0
 - Fix native extension compilation with GCC 15 (#552)
 - Handle non Rails/ActiveSupport applications w/ sampling (#557)

data/lib/scout_apm/config.rb

@@ -50,6 +50,14 @@ require 'scout_apm/environment'
 # endpoint_sample_rate     - Rate to sample all endpoints. An integer between 0 and 100. 0 means no traces are sent, 100 means all traces are sent. (supercedes 'sample_rate')
 # job_sample_rate          - Rate to sample all jobs. An integer between 0 and 100. 0 means no traces are sent, 100 means all traces are sent. (supercedes 'sample_rate')
 #
+#
+# Errors Service Configuration
+# errors_enabled - true/false to enable the errors service
+# errors_ignored_exceptions - An array of exception classes to ignore.
+# errors_filtered_params - An array of parameter names to filter/redact out of error reports.
+# errors_env_capture - An array of environment variables to capture in error reports.
+# errors_host - The host to send error reports to.
+#
 # Any of these config settings can be set with an environment variable prefixed
 # by SCOUT_ and uppercasing the key: SCOUT_LOG_LEVEL for instance.
 
@@ -113,6 +121,7 @@ module ScoutApm
         'errors_enabled',
         'errors_ignored_exceptions',
         'errors_filtered_params',
+        'errors_env_capture',
         'errors_host',
     ]
 
@@ -232,6 +241,7 @@ module ScoutApm
       'errors_enabled' => BooleanCoercion.new,
       'errors_ignored_exceptions' => JsonCoercion.new,
       'errors_filtered_params' => JsonCoercion.new,
+      'errors_env_capture' => JsonCoercion.new,
     }
 
 
@@ -365,6 +375,7 @@ module ScoutApm
         'errors_enabled'                       => false,
         'errors_ignored_exceptions'            => %w(ActiveRecord::RecordNotFound ActionController::RoutingError),
         'errors_filtered_params'               => %w(password s3-key),
+        'errors_env_capture'                   => %w(),
         'errors_host'                          => 'https://errors.scoutapm.com',
       }.freeze
 

data/lib/scout_apm/error.rb

@@ -9,11 +9,11 @@ module ScoutApm
     class Custom < ScoutDefined; end
       
     class << self
-      def capture(exception, env={}, name: "ScoutApm::Error::Custom")
-        context = ScoutApm::Agent.instance.context
+      def capture(exception, context={}, env: {}, name: "ScoutApm::Error::Custom")
+        agent_context = ScoutApm::Agent.instance.context
 
         # Skip if error monitoring isn't enabled at all
-        if ! context.config.value("errors_enabled")
+        if ! agent_context.config.value("errors_enabled")
           return false
         end
 
@@ -21,12 +21,23 @@ module ScoutApm
         return false unless exception
 
         # Skip if this one error is ignored
-        if context.ignored_exceptions.ignored?(exception)
+        if agent_context.ignored_exceptions.ignored?(exception)
           return false
         end
 
+        unless env.is_a?(Hash)
+          log_warning("Expected env to be a Hash, got #{env.class}")
+          env = {}
+        end
+
+        unless context.is_a?(Hash)
+          log_warning("Expected context to be a Hash, got #{context.class}")
+          context = {}
+        end
+        ScoutApm::Context.add(context)
+
         # Capture the error for further processing and shipping
-        context.error_buffer.capture(exception, env)
+        agent_context.error_buffer.capture(exception, env)
 
         return true
       end

data/lib/scout_apm/error_service/error_record.rb

@@ -7,7 +7,6 @@ module ScoutApm
       attr_reader :message
       attr_reader :request_uri
       attr_reader :request_params
-      attr_reader :request_session
       attr_reader :environment
       attr_reader :trace
       attr_reader :request_components
@@ -28,8 +27,7 @@ module ScoutApm
         @message = LengthLimit.new(exception.message, 100).to_s
         @request_uri = LengthLimit.new(rack_request_url(env), 200).to_s
         @request_params = clean_params(env["action_dispatch.request.parameters"])
-        @request_session = clean_params(session_data(env))
-        @environment = clean_params(strip_env(env))
+        @environment = clean_params(env_captured(env))
         @trace = clean_backtrace(exception.backtrace)
         @request_components = components(env)
         @agent_time = Time.now.iso8601
@@ -92,46 +90,20 @@ module ScoutApm
         end
       end
 
-      # Deletes params from env
-      #
-      # These are not configurable, and will leak PII info up to Scout if
-      # allowed through. Things like specific parameters can be exposed with
-      # the ScoutApm::Context interface.
-      KEYS_TO_REMOVE = [
-        "rack.request.form_hash",
-        "rack.request.form_vars",
-        "async.callback",
-
-        # Security related items
-        "action_dispatch.secret_key_base",
-        "action_dispatch.http_auth_salt",
-        "action_dispatch.signed_cookie_salt",
-        "action_dispatch.encrypted_cookie_salt",
-        "action_dispatch.encrypted_signed_cookie_salt",
-        "action_dispatch.authenticated_encrypted_cookie_salt",
-
-        # Raw data from the URL & parameters. Would bypass our normal params filtering
-        "QUERY_STRING",
-        "REQUEST_URI",
-        "REQUEST_PATH",
-        "ORIGINAL_FULLPATH",
-        "action_dispatch.request.query_parameters",
-        "action_dispatch.request.parameters",
-        "rack.request.query_string",
-        "rack.request.query_hash",
+      # Capture params from env
+      KEYS_TO_KEEP = [
+        "HTTP_USER_AGENT",
+        "HTTP_REFERER",
+        "HTTP_ACCEPT_ENCODING",
+        "HTTP_ORIGIN",
       ]
-      def strip_env(env)
-        env.reject { |k, v| KEYS_TO_REMOVE.include?(k) }
-      end
-
-      def session_data(env)
-        session = env["action_dispatch.request.session"]
-        return if session.nil?
-
-        if session.respond_to?(:to_hash)
-          session.to_hash
-        else
-          session.data
+      def env_captured(env)
+        env.select { |k, v| KEYS_TO_KEEP.include?(k) }.tap do |filtered_env|
+          filtered_env["HTTP_X_FORWARDED_FOR"] = env["HTTP_X_FORWARDED_FOR"] if @agent_context.config.value('collect_remote_ip') && env["HTTP_X_FORWARDED_FOR"]
+          
+          @agent_context.config.value('errors_env_capture').each do |key|
+            filtered_env[key] = env[key] if env[key]
+          end
         end
       end
 

data/lib/scout_apm/error_service/payload.rb

@@ -35,7 +35,6 @@ module ScoutApm
           :message => error_record.message,
           :request_uri => error_record.request_uri,
           :request_params => error_record.request_params,
-          :request_session => error_record.request_session,
           :environment => error_record.environment,
           :trace => error_record.trace,
           :request_components => error_record.request_components,

data/lib/scout_apm/version.rb

@@ -1,3 +1,3 @@
 module ScoutApm
-  VERSION = "5.7.0"
+  VERSION = "5.7.1"
 end

data/test/unit/error_service/error_buffer_test.rb

@@ -9,6 +9,34 @@ class ErrorBufferTest < Minitest::Test
     eb.capture(ex, env)
   end
 
+  def test_only_captures_relevant_environment
+    config = make_fake_config(
+      'errors_enabled' => true,
+      'errors_env_capture' => %w(ANOTHER_HEADER),
+      'collect_remote_ip' => true
+    )
+
+    test_context = ScoutApm::AgentContext.new().tap { |c| c.config = config }
+    ScoutApm::Agent.instance.stub(:context, test_context) do
+      eb = ScoutApm::ErrorService::ErrorBuffer.new(test_context)
+      eb.capture(ex, env)
+      exceptions = eb.instance_variable_get(:@error_records)
+      assert_equal 1, exceptions.length
+
+      exception = exceptions[0]
+      expected_env_keys = [
+        "ANOTHER_HEADER",
+        "HTTP_X_FORWARDED_FOR",
+        "HTTP_USER_AGENT",
+        "HTTP_REFERER",
+        "HTTP_ACCEPT_ENCODING",
+        "HTTP_ORIGIN",
+      ].to_set
+
+      assert_equal expected_env_keys, exception.environment.keys.to_set
+    end
+  end
+
   #### Helpers
 
   def context
@@ -16,7 +44,24 @@ class ErrorBufferTest < Minitest::Test
   end
 
   def env
-    {}
+    {
+      "REQUEST_METHOD" => "GET",
+      "SERVER_NAME" => "localhost",
+      "SERVER_PORT" => "3000",
+      "PATH_INFO" => "/test",
+      "HTTP_VERSION" => "HTTP/1.1",
+      "HTTP_USER_AGENT" => "TestAgent",
+      "HTTP_ACCEPT" => "text/html",
+      "HTTP_HOST" => "localhost:3000",
+      "HTTP_X_FORWARDED_FOR" => "123.345.67.89",
+      "HTTP_X_FORWARDED_PROTO" => "http",
+      "rack.url_scheme" => "http",
+      "REMOTE_ADDR" => "123.345.67.89",
+      "ANOTHER_HEADER" => "value",
+      "HTTP_REFERER" => "http://example.com",
+      "HTTP_ACCEPT_ENCODING" => "gzip, deflate",
+      "HTTP_ORIGIN" => "http://example.com",
+    }
   end
 
   def ex(msg="Whoops")

data/test/unit/error_test.rb

@@ -7,6 +7,7 @@ class ErrorTest < Minitest::Test
   def test_captures_and_stores_exceptions_and_env
     config = make_fake_config(
       'errors_enabled' => true,
+      'errors_env_capture' => %w(),
     )
     test_context = ScoutApm::AgentContext.new().tap{|c| c.config = config }
     ScoutApm::Agent.instance.stub(:context, test_context) do
@@ -15,12 +16,19 @@ class ErrorTest < Minitest::Test
       end
       assert_equal true, ScoutApm::Error.capture("Oh no an error") # Will be of type ScoutApm::Error::Custom
       assert_equal true, ScoutApm::Error.capture("Oh no another error") # Will be of type ScoutApm::Error::Custom
+
       assert_equal true, ScoutApm::Error.capture("Something went boom", {"boom" => "yes"}, name: "boom_error")
-      assert_equal true, ScoutApm::Error.capture("No env", name: "another error")
-      assert_equal true, ScoutApm::Error.capture(ex, env)
-      assert_equal true, ScoutApm::Error.capture(exwbt, env)
-      assert_equal false, ScoutApm::Error.capture(Class, env)
-      assert_equal true, ScoutApm::Error.capture("Name collision, but", env, name: "ScoutApm")
+      ScoutApm::Context.current.instance_variable_set(:@extra, {}) # Need to reset as the context/request won't change.
+
+      assert_equal true, ScoutApm::Error.capture("No context or env", name: "another error")
+      
+      assert_equal true, ScoutApm::Error.capture(ex, context)
+      ScoutApm::Context.current.instance_variable_set(:@extra, {})
+
+      assert_equal true, ScoutApm::Error.capture(exwbt, env: env)
+
+      assert_equal false, ScoutApm::Error.capture(Class, env: env)
+      assert_equal true, ScoutApm::Error.capture("Name collision", context, env: env, name: "ScoutApm")
       
       begin
         raise StandardError, "Whoops"
@@ -43,24 +51,41 @@ class ErrorTest < Minitest::Test
 
       assert_equal "Something went boom", exceptions[2].message
       assert_equal "BoomError", exceptions[2].exception_class
+      assert_equal "yes", exceptions[2].context["boom"]
 
-      assert_equal "No env", exceptions[3].message
+      assert_equal "No context or env", exceptions[3].message
       assert_equal "AnotherError", exceptions[3].exception_class
+      assert_equal assert_empty_context, exceptions[3].context
 
       assert_equal "Whoops", exceptions[4].message
       assert_equal "ErrorTest::FakeError", exceptions[4].exception_class
+      assert_equal 123, exceptions[4].context["user_id"]
 
       assert_equal "/path/to/file.rb:10:in `method_name'", exceptions[5].trace.first
 
       assert_equal "ScoutApm::Error::Custom", exceptions[6].exception_class
+      assert_equal 123, exceptions[6].context["user_id"]
+      assert_equal "TestAgent", exceptions[6].environment["HTTP_USER_AGENT"]
 
       assert_equal "StandardError", exceptions[7].exception_class
     end
   end
 
   #### Helpers
+  def context
+    {
+      "user_id" => 123,
+    }
+  end
+
   def env
-    {}
+    {
+      "HTTP_USER_AGENT" => "TestAgent",
+    }
+  end
+
+  def assert_empty_context
+    {user: {}}
   end
 
   def ex(msg="Whoops")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scout_apm
 version: !ruby/object:Gem::Version
-  version: 5.7.0
+  version: 5.7.1
 platform: ruby
 authors:
 - Derek Haynes