Added configuration option for errors_filtered_params

scoutapp · Jan 11, 2022 · 7441783 · 7441783
1 parent 3788206
commit 7441783
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 9 deletions.
diff --git a/src/Config.php b/src/Config.php
@@ -58,6 +58,7 @@ public function __construct()
             ConfigKey::URI_FILTERED_PARAMETERS => new CoerceJson(),
             ConfigKey::ERRORS_ENABLED => new CoerceBoolean(),
             ConfigKey::ERRORS_IGNORED_EXCEPTIONS => new CoerceJson(),
+            ConfigKey::ERRORS_FILTERED_PARAMETERS => new CoerceJson(),
         ];
     }
 

diff --git a/src/Config/ConfigKey.php b/src/Config/ConfigKey.php
@@ -43,6 +43,7 @@ abstract class ConfigKey
     public const ERRORS_IGNORED_EXCEPTIONS   = 'errors_ignored_exceptions';
     public const ERRORS_HOST                 = 'errors_host';
     public const ERRORS_BATCH_SIZE           = 'errors_batch_size';
+    public const ERRORS_FILTERED_PARAMETERS  = 'errors_filtered_params';
 
     private const SECRET_CONFIGURATIONS = [self::APPLICATION_KEY];
 
@@ -83,6 +84,11 @@ public static function allConfigurationKeys(): array
             self::CORE_AGENT_PERMISSIONS,
             self::URI_REPORTING,
             self::URI_FILTERED_PARAMETERS,
+            self::ERRORS_ENABLED,
+            self::ERRORS_IGNORED_EXCEPTIONS,
+            self::ERRORS_HOST,
+            self::ERRORS_BATCH_SIZE,
+            self::ERRORS_FILTERED_PARAMETERS,
         ];
     }
 

diff --git a/...per/RequireValidFilteredUriParameters.php → ...Helper/RequireValidFilteredParameters.php b/...per/RequireValidFilteredUriParameters.php → ...Helper/RequireValidFilteredParameters.php
@@ -11,16 +11,19 @@
 use function is_array;
 use function is_string;
 
-final class RequireValidFilteredUriParameters
+final class RequireValidFilteredParameters
 {
-    /** @psalm-return list<string> */
-    public static function fromConfig(Config $config): array
+    /**
+     * @psalm-param ConfigKey::URI_FILTERED_PARAMETERS|ConfigKey::ERRORS_FILTERED_PARAMETERS $filteredParametersConfigKey
+     * @psalm-return list<string>
+     */
+    private static function fromConfigForGivenKey(Config $config, string $filteredParametersConfigKey): array
     {
         /** @var mixed $uriFilteredParameters */
-        $uriFilteredParameters = $config->get(ConfigKey::URI_FILTERED_PARAMETERS);
+        $uriFilteredParameters = $config->get($filteredParametersConfigKey);
 
         /** @var list<string> $defaultFilteredParameters */
-        $defaultFilteredParameters = (new Config\Source\DefaultSource())->get(ConfigKey::URI_FILTERED_PARAMETERS);
+        $defaultFilteredParameters = (new Config\Source\DefaultSource())->get($filteredParametersConfigKey);
 
         if (! is_array($uriFilteredParameters)) {
             return $defaultFilteredParameters;
@@ -35,4 +38,16 @@ public static function fromConfig(Config $config): array
         /** @psalm-var array<array-key, string> $uriFilteredParameters */
         return array_values($uriFilteredParameters);
     }
+
+    /** @psalm-return list<string> */
+    public static function fromConfigForErrors(Config $config): array
+    {
+        return self::fromConfigForGivenKey($config, ConfigKey::ERRORS_FILTERED_PARAMETERS);
+    }
+
+    /** @psalm-return list<string> */
+    public static function fromConfigForUris(Config $config): array
+    {
+        return self::fromConfigForGivenKey($config, ConfigKey::URI_FILTERED_PARAMETERS);
+    }
 }
diff --git a/src/Config/Source/DefaultSource.php b/src/Config/Source/DefaultSource.php
@@ -62,6 +62,12 @@ private function getDefaultConfig(): array
             ConfigKey::ERRORS_HOST => 'https://errors.scoutapm.com',
             ConfigKey::ERRORS_IGNORED_EXCEPTIONS => [],
             ConfigKey::ERRORS_BATCH_SIZE => 5,
+            /** @link https://scoutapm.com/docs/ruby/configuration#errors_filtered_params */
+            ConfigKey::ERRORS_FILTERED_PARAMETERS => [
+                'password',
+                's3-key',
+                'scout_key',
+            ],
             ConfigKey::URI_REPORTING => ConfigKey::URI_REPORTING_PATH_ONLY,
             /** @link https://github.com/scoutapp/scout_apm_python/blob/ee3c4fe47e6d841b243935628bb21191ee59da4b/src/scout_apm/core/web_requests.py#L15-L40 */
             ConfigKey::URI_FILTERED_PARAMETERS => [

diff --git a/src/Errors/ErrorEvent.php b/src/Errors/ErrorEvent.php
@@ -130,7 +130,7 @@ private function buildRequestUri(): string
      */
     public function toJsonableArray(Config $config, array $session, array $env, array $request): array
     {
-        $filteredParameters = Config\Helper\RequireValidFilteredUriParameters::fromConfig($config);
+        $filteredParameters = Config\Helper\RequireValidFilteredParameters::fromConfigForErrors($config);
 
         $controllerName = explode(
             '/',

diff --git a/src/Events/Request/Request.php b/src/Events/Request/Request.php
@@ -108,7 +108,7 @@ public static function fromConfigAndOverrideTime(Config $config, ?float $overrid
     {
         return new self(
             self::requireValidUriReportingValue($config),
-            Config\Helper\RequireValidFilteredUriParameters::fromConfig($config),
+            Config\Helper\RequireValidFilteredParameters::fromConfigForUris($config),
             $override
         );
     }

diff --git a/src/Helper/FilterParameters.php b/src/Helper/FilterParameters.php
@@ -15,6 +15,7 @@
 use function is_object;
 use function is_scalar;
 use function sprintf;
+use function strtolower;
 
 use const ARRAY_FILTER_USE_KEY;
 
@@ -30,10 +31,12 @@ final class FilterParameters
      */
     public static function forUriReportingConfiguration(array $parameterKeysToBeFiltered, array $parameters): array
     {
+        $lowercasedParameterKeysToBeFiltered = array_map('strtolower', $parameterKeysToBeFiltered);
+
         return array_filter(
             $parameters,
-            static function (string $key) use ($parameterKeysToBeFiltered): bool {
-                return ! in_array($key, $parameterKeysToBeFiltered, true);
+            static function (string $key) use ($lowercasedParameterKeysToBeFiltered): bool {
+                return ! in_array(strtolower($key), $lowercasedParameterKeysToBeFiltered, true);
             },
             ARRAY_FILTER_USE_KEY
         );