userguide: document flow_id, with examples - v2 #9785
Closed
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
Flow_id explanation expanded from version shared by Peter Manev. Task OISF#6445
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #9785 +/- ##
==========================================
- Coverage 82.40% 82.40% -0.01%
==========================================
Files 968 968
Lines 273871 273871
==========================================
- Hits 225695 225690 -5
- Misses 48176 48181 +5
Flags with carried forward coverage won't be shown. Click here to find out more. |
inashivb
reviewed
Nov 14, 2023
| following fileinfo, :ref:`http<eve-format-http>`, :ref:`anomaly<eve-format-anomaly>` | ||
| and :ref:`flow<eve-format-flow>` events, all easily correlated by using the ``flow_id`` EVE field:: | ||
|
|
||
| { |
There was a problem hiding this comment.
Perhaps a jq command here to get this would make sense?
| "dest_port": 80 | ||
| } | ||
| } | ||
| { |
There was a problem hiding this comment.
Should we have all the events in diff boxes? They're a bit difficult to read as a big text
| {"timestamp":"2009-11-24T21:27:09.534255","event_type":"TYPE", ...tuple... ,"TYPE":{ ... type specific content ... }} | ||
| {"timestamp":"2009-11-24T21:27:09.534255","flow_id":ID_NUMBER, "event_type":"TYPE", ...tuple... ,"TYPE":{ ... type specific content ... }} | ||
|
|
||
| Flow id |
There was a problem hiding this comment.
Should this be Flow ID or flow_id?
There was a problem hiding this comment.
Important question. Looking through some other cases, I see that we have ftp_data as FTP_DATA , so I'd say it should be flow_id. Thanks!
|
Feedback incorporated in: #9790 |
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.
Flow_id explanation expanded from version shared by Peter Manev.
Link to redmine ticket:
https://redmine.openinfosecfoundation.org/issues/6445
Previous PR: #9784
Describe changes:
Result can be seen at: https://suri-rtd-test.readthedocs.io/en/doc-flow-id-v2/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.