From 8b0ad2208dcd25e1dfb35d007f28311286d35828 Mon Sep 17 00:00:00 2001 From: Steve Laing Date: Thu, 1 Feb 2024 16:22:49 +0000 Subject: [PATCH] Update README detailing web request event query filtering --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 0ef74e55..20f064b6 100644 --- a/README.md +++ b/README.md @@ -231,6 +231,14 @@ user identifier proc can be defined in `config/initializers/dfe_analytics.rb`: DfE::Analytics.config.user_identifier = proc { |user| user&.uid } ``` +#### Filtering PII from web request query string data + +Query strings may be filtered using the same `Rails.application.config.filter_parameters` +configuration you'd normally use to prevent PII leakage to logs and error handling services. + +To enable this option, ensure the attributes to filter are specified in `Rails.application.config.filter_parameters`. +Then enable filtering with `DfE::Analytics.config.filter_web_request_events = true`. + ### 6. Import existing data To load the current contents of your database into BigQuery, run