Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

[#681] add documentation on fideslog use #751

Merged
merged 4 commits into from
Jul 5, 2022
Merged

Conversation

conceptualshark
Copy link
Contributor

@conceptualshark conceptualshark commented Jun 28, 2022

Purpose

Add a new page on how fideslog is used, and how to opt out of analytics, to the fidesops documentation.

Checklist

  • Update CHANGELOG.md file
    • Merge in main so the most recent CHANGELOG.md file is being appended to
    • Add description within the Unreleased 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.
    • Add a link to this PR at the end of the description with the PR number as the text. example: #1
  • Applicable documentation updated (guides, quickstart, postman collections, tutorial, fidesdemo, database diagram.
  • If docs updated (select one):
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
    • documentation issue created (tag docs-team to complete issue separately)

Ticket

Fixes #681

@conceptualshark conceptualshark marked this pull request as ready for review June 28, 2022 20:20
Copy link
Contributor

@eastandwestwind eastandwestwind left a 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:
Copy link
Contributor

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)

Copy link
Contributor Author

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.

Copy link
Contributor

@eastandwestwind eastandwestwind left a 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!

@eastandwestwind eastandwestwind merged commit 59fa144 into main Jul 5, 2022
@eastandwestwind eastandwestwind deleted the cg-fideslog branch July 5, 2022 14:25
sanders41 pushed a commit that referenced this pull request Sep 22, 2022
* [#681] add documentation on fideslog use

* changelog

* update fidesops use wording
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fidesops documentation for API analytics using fideslog
2 participants