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 timing information to ScubaGear results #1313

Open
3 tasks
schrolla opened this issue Sep 12, 2024 · 0 comments
Open
3 tasks

Add timing information to ScubaGear results #1313

schrolla opened this issue Sep 12, 2024 · 0 comments
Labels
enhancement This issue or pull request will add new or improve existing functionality
Milestone

Comments

@schrolla
Copy link
Collaborator

💡 Summary

ScubaGear generates a set of results in several formats. The idea is to add timing information for the assessment run associated with the results to include timing information about the wall-clock execution time of the run, and possibly for each major product and component.

Motivation and context

Doing so can better inform users of where ScubaGear may be spending most of its time assessing, and provide feedback to developers to help optimize performance.

Implementation notes

Implementing timing information for the run could be implemented by:

  • Defining JSON fields for timing information to include in the ScubaResults output
  • Adding timing/profiling commands to ScubaGear execution at the orchestrator and provider levels

Acceptance criteria

How do we know when this work is done?

  • The ScubaResults.json includes a section for timing information that successfully tracks either start/stop times or execution duration for the overall program
  • ScubaResults.json includes timing information for each provider included in the assessment run
  • ScubaResults.json includes timing information for major phases of ScubaGear execution, including providers (aggregate), Rego test execution, and report/output creation
@schrolla schrolla added the enhancement This issue or pull request will add new or improve existing functionality label Sep 12, 2024
@schrolla schrolla added this to the Backlog milestone Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

No branches or pull requests

1 participant