Skip to content

Commit

Permalink
userguide/exceptions: clarify when stats are logged
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jufajardini committed Mar 4, 2025
1 parent 2182909 commit 3f31f45
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions doc/userguide/configuration/exception-policies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 3f31f45

Please sign in to comment.