From 8f9f4148661994bdb8fd6f483af23a36e23a6802 Mon Sep 17 00:00:00 2001 From: Juliana Fajardini Date: Fri, 11 Jul 2025 14:57:19 -0300 Subject: [PATCH] schema: document stats.detect counters ... that were missing. Task #7795 --- etc/schema.json | 31 +++++++++++++++++++++---------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/etc/schema.json b/etc/schema.json index 18e445215c..f3a7cd51fa 100644 --- a/etc/schema.json +++ b/etc/schema.json @@ -6524,16 +6524,20 @@ }, "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", @@ -6543,19 +6547,24 @@ "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" } } } @@ -6585,10 +6594,12 @@ } }, "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" } } },