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

userguide: document flow_id, with examples - v1 #9784

Closed
wants to merge 1 commit into from

Conversation

jufajardini
Copy link
Contributor

Flow_id explanation expanded from version shared by Peter Manev.

Task #6445

Link to redmine ticket:
https://redmine.openinfosecfoundation.org/issues/6445

Describe changes:

  • add section in eve-json-format subchapter, explaining flow id and usefulness
  • add example with a few different eve types
  • add section labels to refer to eve types in the example that already have an explanation

Result can be seen at: https://suri-rtd-test.readthedocs.io/en/doc-flow-id-v1/output/eve/eve-json-format.html#flow-id

The example part is a bit big, but seemed to make sense that we would include at least some different event types, to illustrate the usage.

cc @pevma

Flow_id explanation expanded from version shared by Peter Manev.

Task OISF#6445

The ability to correlate any existing evidence/logs to an alert and/ or the
ability to correlate all logs belonging to a specific session/flow was
introduced in 2014 by Suricata lead developer, Victor Julien (see `commit f1185d051c21
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel it's not necessary to do these kind of explicit attributions unless it's a contribution (git commit link is good though)

Copy link

codecov bot commented Nov 14, 2023

Codecov Report

Merging #9784 (9b9886b) into master (b6cd66f) will decrease coverage by 0.01%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #9784      +/-   ##
==========================================
- Coverage   82.40%   82.40%   -0.01%     
==========================================
  Files         968      968              
  Lines      273871   273871              
==========================================
- Hits       225695   225676      -19     
- Misses      48176    48195      +19     
Flag Coverage Δ
fuzzcorpus 64.37% <ø> (+0.02%) ⬆️
suricata-verify 60.96% <ø> (-0.03%) ⬇️
unittests 62.93% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

@jufajardini
Copy link
Contributor Author

Replaced by: #9785

@jufajardini jufajardini deleted the doc-flow-id/v1 branch November 21, 2023 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants