From: Shivani Bhardwaj <shivani@oisf.net>
Date: Fri, 19 Jul 2024 11:59:16 +0000 (+0530)
Subject: eve/stats: add description for flow stats
X-Git-Tag: suricata-8.0.0-beta1~981
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=638b5c4da7aef74b8dfbabfa109c0caa9f87ae58;p=thirdparty%2Fsuricata.git

eve/stats: add description for flow stats

Ticket 6434
---

diff --git a/etc/schema.json b/etc/schema.json
index 89329b0944..a780590d9f 100644
--- a/etc/schema.json
+++ b/etc/schema.json
@@ -6026,36 +6026,51 @@
                     "type": "object",
                     "properties": {
                         "active": {
+                            "description": "Number of currently active flows",
                             "type": "integer"
                         },
                         "emerg_mode_entered": {
+                            "description": "Number of times emergency mode was entered",
                             "type": "integer"
                         },
                         "emerg_mode_over": {
+                            "description": "Number of times recovery was made from emergency mode",
                             "type": "integer"
                         },
                         "get_used": {
+                            "description": "Number of reused flows from the hash table in case memcap was reached and spare pool was empty",
                             "type": "integer"
                         },
                         "get_used_eval": {
+                            "description":
+                                    "Number of attempts at getting a flow directly from the hash",
                             "type": "integer"
                         },
                         "get_used_eval_busy": {
+                            "description":
+                                    "Number of times a flow was found in the hash but the lock for hash bucket could not be obtained",
                             "type": "integer"
                         },
                         "get_used_eval_reject": {
+                            "description":
+                                    "Number of flows that were evaluated but rejected from reuse as they were still alive/active",
                             "type": "integer"
                         },
                         "get_used_failed": {
+                            "description":
+                                    "Number of times retrieval of flow from hash was attempted but was unsuccessful",
                             "type": "integer"
                         },
                         "icmpv4": {
+                            "description": "Number of ICMPv4 flows",
                             "type": "integer"
                         },
                         "icmpv6": {
+                            "description": "Number of ICMPv6 flows",
                             "type": "integer"
                         },
                         "memcap": {
+                            "description": "Number of times memcap was reached for flows",
                             "type": "integer"
                         },
                         "memcap_exception_policy": {
@@ -6064,21 +6079,27 @@
                             "$ref": "#/$defs/exceptionPolicy"
                         },
                         "memuse": {
+                            "description": "Memory currently in use by the flows",
                             "type": "integer"
                         },
                         "spare": {
+                            "description": "Number of flows in the spare pool",
                             "type": "integer"
                         },
                         "tcp": {
+                            "description": "Number of TCP flows",
                             "type": "integer"
                         },
                         "tcp_reuse": {
+                            "description": "Number of TCP flows that were reused as they seemed to share the same flow tuple",
                             "type": "integer"
                         },
                         "total": {
+                            "description": "Total number of flows",
                             "type": "integer"
                         },
                         "udp": {
+                            "description": "Number of UDP flows",
                             "type": "integer"
                         },
                         "end": {