-
Notifications
You must be signed in to change notification settings - Fork 16
[#681] add documentation on fideslog use #751
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just 1 note for future of fideslog in fidesops, not sure if we wanted to update the copy to be more generic or not.
Thanks so much for writing this up @conceptualshark !
More information on use, implementation, and configuration can be found in the [fideslog repository](https://github.com/ethyca/fideslog#readme). | ||
|
||
## Collected Data | ||
Fideslog collects information on instances of fidesops by recording internal events. Starting the server and calling an endpoint will result in sending any or all of the following analytics data to Ethyca: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the future, we'll include not only starting the server and calling endpoints, but also specific interactions from the UI (e.g. toggling show PII, or clicking download report, etc)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right -I updated this line to be generic, while the table below still calls out the individual use at the moment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for that minor update @conceptualshark , looks great to me!
Purpose
Add a new page on how fideslog is used, and how to opt out of analytics, to the fidesops documentation.
Checklist
CHANGELOG.md
fileCHANGELOG.md
file is being appended toUnreleased
section in an appropriate category. Add a new category from the list at the top of the file if the needed one isn't already there.Ticket
Fixes #681