From: Shivani Bhardwaj <shivani@oisf.net>
Date: Wed, 5 Jun 2024 03:25:17 +0000 (+0530)
Subject: eve/stats: add description for flow mgr & recycler
X-Git-Tag: suricata-8.0.0-beta1~1193
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=de1de53e2f9cf6b29a4ec0b1f779e5393d107bfe;p=thirdparty%2Fsuricata.git

eve/stats: add description for flow mgr & recycler

Ticket 6434
---

diff --git a/etc/schema.json b/etc/schema.json
index 3aaab48eff..168a7b65df 100644
--- a/etc/schema.json
+++ b/etc/schema.json
@@ -5514,27 +5514,39 @@
                             "type": "object",
                             "properties": {
                                 "flows_checked": {
+                                    "description":
+                                            "number of flows checked for timeout in the last pass",
                                     "type": "integer"
                                 },
                                 "flows_evicted": {
+                                    "description": "number of flows that were evicted",
                                     "type": "integer"
                                 },
                                 "flows_evicted_needs_work": {
+                                    "description":
+                                            "number of TCP flows that were returned to the workers in case reassembly, detection, logging still needs work",
                                     "type": "integer"
                                 },
                                 "flows_notimeout": {
+                                    "description": "number of flows that did not time out",
                                     "type": "integer"
                                 },
                                 "flows_timeout": {
+                                    "description": "number of flows that reached the time out",
                                     "type": "integer"
                                 },
                                 "full_hash_pass": {
+                                    "description":
+                                            "number of times a full pass of the hash table was done",
                                     "type": "integer"
                                 },
                                 "rows_maxlen": {
+                                    "description": "size of the biggest row in the hash table",
                                     "type": "integer"
                                 },
                                 "rows_per_sec": {
+                                    "description":
+                                            "number of rows to be scanned every second by a worker",
                                     "type": "integer"
                                 }
                             },
@@ -5544,12 +5556,15 @@
                             "type": "object",
                             "properties": {
                                 "recycled": {
+                                    "description": "number of recycled flows",
                                     "type": "integer"
                                 },
                                 "queue_avg": {
+                                    "description": "average number of recycled flows per queue",
                                     "type": "integer"
                                 },
                                 "queue_max": {
+                                    "description": "maximum number of recycled flows per queue",
                                     "type": "integer"
                                 }
                             },