]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
userguide/exceptions: clarify when stats are logged 12805/head
authorJuliana Fajardini <jufajardini@gmail.com>
Wed, 26 Feb 2025 19:38:36 +0000 (16:38 -0300)
committerVictor Julien <victor@inliniac.net>
Fri, 21 Mar 2025 06:08:59 +0000 (07:08 +0100)
The stats for exception policies are only logged/ present when any of
the exception policies are enabled (which means any value other than
"auto" or "ignore" in IDS mode, or "ignore" in IPS mode).

This wasn't clearly stated in the docs.

doc/userguide/configuration/exception-policies.rst

index d559604445e06e5f53f4346faf08aaa044493e02..25992998e36ffdc8b4f20cc8fd2db7170d9d88e8 100644 (file)
@@ -59,6 +59,10 @@ It is possible to disable this default, by setting the exception policies'
 **In IDS mode**, setting ``auto`` mode actually means disabling the
 ``master-switch``, or ignoring the exception policies.
 
+.. note::
+
+    If no exception policy is enabled, Suricata will not log exception policy stats.
+
 .. _eps_settings:
 
 Specific settings
@@ -264,7 +268,8 @@ exception policy, but that is set up to ``ignore``::
 Available Stats
 ~~~~~~~~~~~~~~~
 
-There are stats counters for each supported exception policy scenario:
+There are stats counters for each supported exception policy scenario that will
+be logged when exception policies are enabled:
 
 .. list-table:: **Exception Policy Stats Counters**
    :widths: 50 50
@@ -293,7 +298,7 @@ Stats for application layer errors are available in summarized form or per
 application layer protocol. As the latter is extremely verbose, by default
 Suricata logs only the summary. If any further investigation is needed, it
 is recommended to enable per-app-proto exception policy error counters
-temporarily (for :ref:`stats configuration<suricata_yaml_outputs>`).
+temporarily (for more, read :ref:`stats configuration<suricata_yaml_outputs>`).
 
 
 Command-line Options for Simulating Exceptions