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

Support JSON output #54

Open
moshekaplan opened this issue Jun 13, 2023 · 9 comments
Open

Support JSON output #54

moshekaplan opened this issue Jun 13, 2023 · 9 comments
Assignees
Labels
enhancement New feature or request

Comments

@moshekaplan
Copy link
Owner

moshekaplan commented Jun 13, 2023

Support generating JSON output, instead of only text-based.
JSON should (ideally) include:

  • Configuration file version
  • Date of execution
  • Runtime
  • Output from each analyzer
@Nawtest
Copy link
Contributor

Nawtest commented Feb 1, 2024

It would be interesting to add the quantity of analyzed elements to create custom KPIs. Did you have any specific method in mind to accomplish this?

@moshekaplan
Copy link
Owner Author

It would be interesting to add the quantity of analyzed elements to create custom KPIs. Did you have any specific method in mind to accomplish this?

Nope, although if I'm understanding correctly, it would seem that those sorts of aggregate queries would best be moved into a separate 'reporting' module, so that reporting (and each report) would be independent of everything else.

@Nawtest
Copy link
Contributor

Nawtest commented Feb 2, 2024

No, what I want is to extract the totals from the analyzed information so that every person using the tool can utilize them to implement the necessary KPIs. Not calculate the KPIs within the tool itself.

@moshekaplan
Copy link
Owner Author

Could you give any examples of what totals you'd want to extract?

@Nawtest
Copy link
Contributor

Nawtest commented Feb 5, 2024

I was thinking of something like this:

image

@Nawtest
Copy link
Contributor

Nawtest commented Feb 5, 2024

And in txt file:
image

@Nawtest
Copy link
Contributor

Nawtest commented Feb 8, 2024

I have been modifying the JSON output to be able to exploit the data a bit more, I'll show you an image.

image

The idea is to add another parameter "--detail" to break down the text info.

@moshekaplan
Copy link
Owner Author

Apologies for the delayed response.

I like the idea, but my only concern is that it's not immediately clear what the fractions represent. Especially as some policies or objects are complex enough that a single object could have multiple failures. (e.g., a rule with a non-resolving FQDN can have entries in the source, destination, or both)

@Nawtest
Copy link
Contributor

Nawtest commented Feb 9, 2024

Don't worry, yes, I understand your concern. For now, I'm handling the simple ones. When I get to those types of rules, I guess I'll have to restructure the detail output. Let's see how it goes...

@moshekaplan moshekaplan added the enhancement New feature or request label Feb 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants