Add reference to hidden_pii to cutom events #153
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
| @@ -256,7 +256,7 @@ it might be necessary to add a primary key to the table and to update the releva | |||
|
|
|||
| ## Custom events | |||
|
|
|||
| If you wish to send custom analytics event, create a file `config/analytics_custom_events.yml` containing an array of your custom events types under a `shared` key like: | |||
| If you wish to send custom analytics event, for example if you have data about emails sent, server side validation errors, api query data or data relating to searches performed, create a file `config/analytics_custom_events.yml` containing an array of your custom events types under a `shared` key like: | |||
There was a problem hiding this comment.
Perhaps capitalise API?
README.md
Outdated
| @@ -275,6 +275,20 @@ event = DfE::Analytics::Event.new | |||
| .with_data(some: 'custom details about event') | |||
| ``` | |||
|
|
|||
| If you need to include hidden_pii, you can use the `hidden_data` key which will allow all fields lsited to be sent separately to BigQuery where they will be hidden. | |||
There was a problem hiding this comment.
Typo: listed not lsited
README.md
Outdated
| .with_request_details(request) | ||
| .with_namespace('some_namespace') | ||
| .with_data( | ||
| data: { some: 'custom details about event' }, |
There was a problem hiding this comment.
Would it be worth including more than one field in data and hidden_data in the example so it's super clear how to achieve this?
stevenleggdfe
approved these changes
Jun 28, 2024
ericaporter
added a commit
that referenced
this pull request
Jul 8, 2024
* Add DATA_hidden to events table creation SQL script * Add hidden PII required permissions to GCP custom IAM role setup instructions * Add policy tag setup instructions to GCP setup instructions * Update role configuration to match latest BAT configuration * Add hidden_pii.yml (#121) * Allow hidden data to be sent separately (#128) * Mask hidden_pii from logs * Add validation for hidden pii fields appearing on both lists * Change DATA_hidden to hidden_DATA in google_cloud_bigquery_setup.md * Change DATA_hidden to hidden_DATA in create-events-table.sql * Cover edge cases for validations (#146) * Update log masking method (#150) * Add reference to hidden_pii to cutom events (#153)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes an update to the Readme and a event test to cover hidden_data being included in in a custom event