]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
schema: document stats.detect counters
authorJuliana Fajardini <jufajardini@oisf.net>
Fri, 11 Jul 2025 17:57:19 +0000 (14:57 -0300)
committerVictor Julien <victor@inliniac.net>
Wed, 3 Sep 2025 06:32:47 +0000 (08:32 +0200)
... that were missing.

Task #7795

etc/schema.json

index 18e445215c0b4cd8a50e5514fa6c22075b819bed..f3a7cd51fab7308374ac6630c480c18295b9a36d 100644 (file)
                 },
                 "detect": {
                     "type": "object",
+                    "description": "Statistics related to the detection engines",
                     "additionalProperties": false,
                     "properties": {
                         "alert": {
-                            "type": "integer"
+                            "type": "integer",
+                            "description": "Count of alerts triggered"
                         },
                         "alert_queue_overflow": {
-                            "type": "integer"
+                            "type": "integer",
+                            "description": "Count of alerts discarded due to alert queue overflow or a drop in firewall mode"
                         },
                         "alerts_suppressed": {
-                            "type": "integer"
+                            "type": "integer",
+                            "description": "Count of alerts not logged due to noalert keyword usage or thresholding"
                         },
                         "engines": {
                             "type": "array",
                                 "additionalProperties": false,
                                 "properties": {
                                     "id": {
-                                        "type": "integer"
+                                        "type": "integer",
+                                        "description": "If multi-tenancy is enabled, the tenant id"
                                     },
                                     "last_reload": {
-                                        "type": "string"
+                                        "type": "string",
+                                        "description": "Last time the rules were reloaded, in TimeString format"
                                     },
                                     "rules_failed": {
-                                        "type": "integer"
+                                        "type": "integer",
+                                        "description": "Count of rules that failed to load"
                                     },
                                     "rules_loaded": {
-                                        "type": "integer"
+                                        "type": "integer",
+                                        "description": "Count of rules successfully loaded"
                                     },
                                     "rules_skipped": {
-                                        "type": "integer"
+                                        "type": "integer",
+                                        "description": "Count of rules that were skipped due to missing requirements"
                                     }
                                 }
                             }
                             }
                         },
                         "match_list": {
-                            "type": "integer"
+                            "type": "integer",
+                            "description": "If profiling is enabled, average count of signature matched against a packet"
                         },
                         "mpm_list": {
-                            "type": "integer"
+                            "type": "integer",
+                            "description": "If profiling is enabled, average count of signatures in the mpm prefilter list"
                         }
                     }
                 },