]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
doc/yaml: Signal-termination option description 6744/head
authorJeff Lucovsky <jeff@lucovsky.org>
Thu, 17 Jun 2021 13:24:46 +0000 (09:24 -0400)
committerVictor Julien <vjulien@oisf.net>
Mon, 3 Jan 2022 11:02:29 +0000 (12:02 +0100)
doc/userguide/configuration/suricata-yaml.rst

index 931d364504bcf90054555103f54338a2bed1ef5b..9513c2ac3045d1ef3e51534ae5b003c4ae8df797 100644 (file)
@@ -2330,6 +2330,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
 ~~~~~~