schema: add descriptions for flow stats counters - v2#13753
schema: add descriptions for flow stats counters - v2#13753jufajardini wants to merge 2 commits into
Conversation
|
There were more comments that I had not seen. |
jufajardini
force-pushed
the
doc-7794-flow-schema/v2
branch
from
7d02de7 to
14a55df
Compare
Where those weren't like that, yet.
jufajardini
force-pushed
the
doc-7794-flow-schema/v2
branch
from
14a55df to
93aaa26
Compare
Hopefully all where addressed, now. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #13753 +/- ##
===========================================
+ Coverage 77.16% 83.73% +6.56%
===========================================
Files 945 1011 +66
Lines 172228 275066 +102838
===========================================
+ Hits 132906 230319 +97413
- Misses 39322 44747 +5425
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
Information: QA ran without warnings. Pipeline = 27232 |
| "flows_evicted_pkt_inject": { | ||
| "type": "integer" | ||
| "type": "integer", | ||
| "description": "Number of pseudo packets injected into evicted flows to complete flows processing. If for any flow this can be between 0-2, this is the total for all flows" |
There was a problem hiding this comment.
the packets are not injected into flows, but into the worker threads
| "closed": { | ||
| "type": "integer" | ||
| "type": "integer", | ||
| "description": "Number of flows closed at the time of flow end" |
There was a problem hiding this comment.
"flows in a closed state" - it's about the state. Same for established and new
| }, | ||
| "flow_bypassed": { | ||
| "type": "object", | ||
| "description": "", |
There was a problem hiding this comment.
was this empty desc intentional?
There was a problem hiding this comment.
No, I thought I had removed all of these, apologies...
| "spare_sync_avg": { | ||
| "type": "integer" | ||
| "type": "integer", | ||
| "description": "Flows fetched from the global pool is always fetched in blocks of 100. Sometimes, this number is lesser. Counter of the average length of master flow pool/spare queue" |
There was a problem hiding this comment.
I think there are explanations in here that don't belong here?
"Average number of flows a thread could fetch from the master flow pool/spare queue"
The explanation here is more a doc entry?
There was a problem hiding this comment.
It's very tempting to make these more doc like 🤐 I'll reword to be more descriptive and succinct.
There was a problem hiding this comment.
or... easier, just use the suggestion.
| "spare_sync_empty": { | ||
| "type": "integer" | ||
| "type": "integer", | ||
| "description": "Number of spare queues that were empty when trying to fetch a flow" |
There was a problem hiding this comment.
"Number of times the master spare pool was empty when requesting flows from it."
So this is essentially a thread sync failure due to running out of resources.
| "spare_sync_incomplete": { | ||
| "type": "integer" | ||
| "type": "integer", | ||
| "description": "Number of spare flow queues that are incomplete (fetched with less than 100 flows in sync)" |
There was a problem hiding this comment.
its not queues that are incomplete, but syncs. We got fewer flows than expected
| }, | ||
| "mgr": { | ||
| "type": "object", | ||
| "description": "Flow manager thread stats counters", |
There was a problem hiding this comment.
They are tracked per thread, but default output is all threads merged. If per thread logging is enabled, it can be logged per thread. Probably best to drop the thread here.
|
Followed by #13758 |
4 participants
Task #7794
Redmine ticket: https://redmine.openinfosecfoundation.org/issues/7794
Previous PR #13712
Describe changes:
flow_spare_sync_incomplete(and related stats counter)flow.end