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

conntrack: Add conntrack docs to README.md #291

Merged
merged 4 commits into from
Sep 7, 2022

Conversation

ronensc
Copy link
Collaborator

@ronensc ronensc commented Aug 25, 2022

No description provided.

@ronensc ronensc mentioned this pull request Aug 25, 2022
14 tasks
@codecov-commenter
Copy link

Codecov Report

Merging #291 (e7eb18f) into main (009a086) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #291   +/-   ##
=======================================
  Coverage   67.39%   67.39%           
=======================================
  Files          73       73           
  Lines        4278     4278           
=======================================
  Hits         2883     2883           
  Misses       1212     1212           
  Partials      183      183           
Flag Coverage Δ
unittests 67.39% <ø> (ø)

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

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

README.md Outdated
fieldGroups:
- name: src
fields:
- SrcIP
Copy link
Collaborator

@KalmanMeth KalmanMeth Aug 28, 2022

Choose a reason for hiding this comment

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

Above you use SrcAddr and DstAddr rather than SrcIP and DstIP.

- newConnection
- endConnection
- updateConnection
- flowLog
Copy link
Collaborator

Choose a reason for hiding this comment

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

The flowlog parameter is not described above.


Notice that all output records contain `_RecordType` and `_HashId` fields.
Output fields that set `splitAB: true` (like in `Bytes`) are split into 2 fields `Bytes_AB` and `Bytes_BA` which
aggregate values separately based on direction A->B and B->A respectively.
Copy link
Collaborator

Choose a reason for hiding this comment

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

and also adds a XX_total field ?

Is there other fields than Bytes ?

Copy link
Collaborator Author

@ronensc ronensc Aug 30, 2022

Choose a reason for hiding this comment

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

and also adds a XX_total field ?

The Bytes_total field is created because it was specified explicitly in the config snippet.
It's not auto-generated by the conntrack module. I created an issue to discuss this: #280

Is there other fields than Bytes ?

In this config snippet, Bytes is the only field that is set with splitAB: true.
For all the other output fields, the default is set to false.
I'll add a sentence for the default case.

Copy link
Member

@jotak jotak left a comment

Choose a reason for hiding this comment

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

lgtm

@ronensc ronensc merged commit ba6bf34 into netobserv:main Sep 7, 2022
@ronensc ronensc deleted the conntrack-docs branch September 7, 2022 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants