Add anonymisation of user_id in the web request event data #64
Conversation
- Make this configurable through dfe analytics config - Update README to explain anonymisation and custom user identifier
README.md
Outdated
| If a field other than `id` is required for the user identifier, then a custom user identifier proc can be defined in `config/initializers/dfe_analytics.rb`: | ||
|
|
||
| ```ruby | ||
| DfE::Analytics.config.user_idenitifier = proc { |user| user&.id } |
There was a problem hiding this comment.
@asatwal I think there's a typo here? idenitifier should be identifier?
There was a problem hiding this comment.
Well spotted @stevenleggdfe
README.md
Outdated
|
|
||
| #### User ID anonymisation | ||
|
|
||
| The `user_id` in the web request event will not be anonymised by default. This can be changed by updating the configuration option in `config/initializers/dfe_analytics.rb`: |
There was a problem hiding this comment.
@asatwal would it be worth adding a line here like 'You probably want to anonymise user_id if the field it comes from in your schema is in analytics_pii.yml so that analysts can join the IDs together. If your user_id is not in analytics_pii.yml but is in analytics.yml then you probably want to ensure user_id is not anonymised so you can join the IDs together.'
README.md
Outdated
| If a field other than `id` is required for the user identifier, then a custom user identifier proc can be defined in `config/initializers/dfe_analytics.rb`: | ||
|
|
||
| ```ruby | ||
| DfE::Analytics.config.user_idenitifier = proc { |user| user&.id } |
There was a problem hiding this comment.
| DfE::Analytics.config.user_idenitifier = proc { |user| user&.id } | |
| DfE::Analytics.config.user_identifier = proc { |user| user&.id } |
|
|
||
| def user_identifier_for(user) | ||
| user_id = DfE::Analytics.user_identifier(user) | ||
| user_id = DfE::Analytics.anonymise(user_id) if user_id.present? && DfE::Analytics.config.anonymise_web_request_user_id |
There was a problem hiding this comment.
I'd turn this into a multiline if, but if Rubocop's fussy 🤷
There was a problem hiding this comment.
Rubocop not happy with multiline if, so left as is :-)
Trello-975
Add anonymisation of user_id in the web request event data