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 optional verbose output with the details of the calculation #333

Closed
demeringo opened this issue Sep 8, 2023 · 2 comments
Closed

Add optional verbose output with the details of the calculation #333

demeringo opened this issue Sep 8, 2023 · 2 comments
Assignees
Labels
draft feature draft feature enhancement New feature or request
Milestone

Comments

@demeringo
Copy link
Collaborator

demeringo commented Sep 8, 2023

Problem

Cloud scanner does not return details about the components that leads to a result.
Which prevent us to understand the impact of RAM vs CPU for example.

Solution

Have an optional flag or parameter that add verbosity to the json output.

It should return the equivalent content (list of components and impacts) that are returne by the Boavizta API when used in verbose mode.

⚠ WARNING: It seems that in Boavizta API, The results of Verbose mode do not correspond to the instance, but to the entire server that host an instance. In verbose mode, no ratio is applied to the impacts of components (contrary to non-verbose API output where a ration corresponding to the number of instances per servers is applied before returning results).

See discussion in Boavizta API Q/A: Boavizta/boaviztapi#221

Alternatives

Additional context or elements

@demeringo
Copy link
Collaborator Author

We will do 2 things:

  1. add a raw_data key to the cloud-scanner json output: It will always contain the raw_output of Boavizta API. The rationale is that if API evolves, we benefit from or can parse an additional field that is not managed by cloud-scanner.
  2. Add a verbose flag or parameter (default to false) to the cloud-scannner commands or routes. If active, it will trigger the verbose output of the Boavizta API (which we will retrieve in the new raw_data field.

@damienfernandes
Copy link
Contributor

@demeringo amazing ! Thanks olivier

@demeringo demeringo added this to the 0.4.x milestone Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
draft feature draft feature enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants