Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README updates covering PII and queues #46

Merged
merged 2 commits into from
Sep 21, 2022
Merged

README updates covering PII and queues #46

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bedb767
README updates covering PII and queues
slorek Sep 13, 2022
a25f1fa
Update README.md
slorek Sep 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,8 @@ The `dfe:analytics:install` generator will also initialize some empty config fil
| `config/analytics_pii.yml` | List all fields we will obfuscate before sending to BigQuery. This should be a subset of fields in `analytics.yml` |
| `config/analytics_blocklist.yml` | Autogenerated file to list all fields we will NOT send to BigQuery, to support the `analytics:check` task |

**It is imperative that you perform a full check of those fields are being sent, and exclude those containing personally-identifiable information (PII) in `config/analytics_pii.yml`, in order to comply with the requirements of the [Data Protection Act 2018](https://www.gov.uk/data-protection), unless an exemption has been obtained.**

### 5. Check your fields

A good place to start is to run
Expand Down Expand Up @@ -161,6 +163,20 @@ models so that they are effective everywhere. A standard Rails application will
have all controllers inheriting from `ApplicationController` and all models
inheriting from `ApplicationRecord`, so these should be a good place to start.

### 7. Configure queues

Events are sent to BigQuery by your application's queueing backed via its ActiveJob adapter.

Events are generated on each web request and database insert/update/delete query. Depending on the architecture of your application, potentially many jobs could be enqueued as users interact with your application.

Consider how this may impact the processing of the other jobs in your application. You may wish to consider setting a custom queue name in `config/initializers/dfe_analytics.rb`:

```ruby
DfE::Analytics.config.queue = :default
```

Alternatively you may consider setting the priority of the jobs according to your chosen ActiveJob adapter's conventions.

#### Controllers

```ruby
Expand Down