]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc/yaml: Signal-termination option description
authorJeff Lucovsky <jeff@lucovsky.org>
Thu, 17 Jun 2021 13:24:46 +0000 (09:24 -0400)
committerVictor Julien <vjulien@oisf.net>
Thu, 7 Apr 2022 17:30:44 +0000 (19:30 +0200)
(cherry picked from commit 93842aa14a67ed1e7acfc6bbdacbffef8bd6bae0)

doc/userguide/configuration/suricata-yaml.rst

index 6a4db36f0144116cfd984afa281be035c769c0a3..cb62523169ed50c8c23c7b7b62a0919bf0aed71f 100644 (file)
@@ -2246,6 +2246,21 @@ inspected for possible presence of Teredo.
 Advanced Options
 ----------------
 
+stacktrace
+~~~~~~~~~~
+Display diagnostic stacktraces when a signal unexpectedly terminates Suricata, e.g., such as
+SIGSEGV or SIGABRT. Requires the ``libunwind`` library to be available. The default value is
+to display the diagnostic message if a signal unexpectedly terminates Suricata -- e.g.,
+``SIGABRT`` or ``SIGSEGV`` occurs while Suricata is running.
+
+::
+
+    logging:
+        # Requires libunwind to be available when Suricata is configured and built.
+        # If a signal unexpectedly terminates Suricata, displays a brief diagnostic
+        # message with the offending stacktrace if enabled.
+        #stacktrace-on-signal: on
+
 luajit
 ~~~~~~