Add event details to send event error log message #69
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
| @@ -361,6 +361,12 @@ When defining event filters, note the following: | |||
|
|
|||
| In the above example, all create, delete or update entity events to the `course_options` table and `id` matching value `1234` will be logged, or any import entity events to the `courses` table will also be logged. | |||
|
|
|||
| **IMPORTANT**: | |||
|
|
|||
| Please ensure you are not logging sensitive data to debug. Your project should define blocklist and pii fields, so these should prevent any sensitive data appearing in the events. | |||
There was a problem hiding this comment.
@asatwal is it worth expanding pii to personally identifiable information? Also possibly link to the documentation for the blocklist and analytics_pii.yml here?
asatwal
force-pushed
the
add-event-details-to-send-event-error
branch
from
2d3ae69 to
a537f3a
Compare
duncanjbrown
approved these changes
Jun 29, 2023
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.
Trello-975
When an error occurs in
DfE::Analytics::SendEventscalling the events insert API, the error responses are logged, but the events that caused the error are not included in the log message.Add the events to the error log message to help with error diagnosis.
Also add advice for event debugging regarding sensitive data.