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.

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

Add table and models to support system scan history #1396

Closed
allisonking opened this issue Oct 11, 2022 · 2 comments · Fixed by #1554
Closed

Add table and models to support system scan history #1396

allisonking opened this issue Oct 11, 2022 · 2 comments · Fixed by #1554
Assignees

Comments

@allisonking
Copy link
Contributor

allisonking commented Oct 11, 2022

Is your feature request related to a specific problem?

We would like to persist a user's system scan history.

Describe the solution you'd like

We should have a table with each time a user initiates a system scan. We'll also need the associated models.

Describe alternatives you've considered, if any

A description of any alternative solutions or features you've considered.

Additional context

https://github.com/ethyca/fidesctl-plus/issues/188

@PSalant726
Copy link
Contributor

For now I think a single table, plus_system_scans, would suffice. It should support at least the following columns:

  • id - psql default primary key, identifies unique scans
  • created_at - datetime when the scan was initiated
  • updated_at - datetime when the record was last modified
  • status - string representing one of a few possible states of the scan (scanning, classifying, writing results (?), error, complete)
  • error - nullable string, contains an error that prevented the scan from completing successfully, when applicable
    • Sensitive info or system details must be pruned before writing to this column
  • results - JSON blob containing the list of System resources discovered by the scan (with sorted keys, if possible, to support future diff-ing)

Optionally we may find it beneficial to include the following additional columns, although there is no immediate use case:

  • system_count - int representing the number of systems discovered
  • classified - boolean representing whether the classifier was used as part of the scan
    • We should think about a better name for this column, as we don't want to imply that any scan record contains sensitive information
  • stats - JSON blob containing arbitrary statistics that may be fun to display in the UI
    • "most used data_category" (or data_categories, if we want to display a list in descending order)
    • "most ingressed system"
    • "most egressed system"
    • ?

@seanpreston seanpreston added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 25, 2022
@PSalant726
Copy link
Contributor

Completed in #1554.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants