update(outputs): add configuration option for tags in json outputs #1733
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jason Dellaluce <[email protected]>
Signed-off-by: Jason Dellaluce <[email protected]>
leogr
approved these changes
Sep 28, 2021
Comment on lines
+1114
to
+1132
| json_output_no_tags_property: | ||
| json_output: True | ||
| json_include_tags_property: False | ||
| detect: True | ||
| detect_level: WARNING | ||
| rules_file: | ||
| - rules/rule_append.yaml | ||
| trace_file: trace_files/cat_write.scap | ||
| stdout_contains: "^(?!.*\"tags\":[ ]*\\[.*\\],.*)" | ||
|
|
||
| json_output_empty_tags_property: | ||
| json_output: True | ||
| detect: True | ||
| detect_level: WARNING | ||
| rules_file: | ||
| - rules/rule_append.yaml | ||
| trace_file: trace_files/cat_write.scap | ||
| stdout_contains: "^(.*\"tags\":[ ]*\\[\\],.*)" | ||
|
|
|
LGTM label has been added. Git tree hash: 42163e871e0526a78dcab56258b75f3182c27bbf
|
leodido
approved these changes
Sep 28, 2021
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: jasondellaluce, leodido The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this?
/kind cleanup
/kind feature
Any specific area of the project related to this PR?
/area engine
/area tests
What this PR does / why we need it:
Since the recent merge of #1714,
tagsandsourcefields are now part of both the grpc and json outputs. However, the semantic of the json output is not clear in some corner cases, such as when no tags are defined in a rule. Also, users can't configure whether to includetagsin the json outputs or not, which instead is possible for theoutputfield. Moreover, no test cases are yet present for asserting the expected outcome of these corner cases. These issues were reported in #1714 (comment) by @leodido (thank you!!)As such, this PR contributes with the following:
json_include_tags_propertyconfiguration option, so that users can decide whether to includetagsin the json outputs or not. By default this is set totrueto not introduce breaking changes for clients that currently expect the field to be present.Additional Context:
The table below describes the expected outcomes in the json outputs by using the new configuration option.
json_include_tags_property = truejson_include_tags_property = falsetags=[]tagsfieldtags=[...]tagsfieldThese cases are covered by the following tests:
json_output_empty_tags_property: Case (1)json_output_no_tags_property: Cases (2) and (4)stdout_output_json_strict: Case (3)Does this PR introduce a user-facing change?: