From: Bhagya Tholpady (bbantwal) <bbantwal@cisco.com>
Date: Tue, 8 Sep 2020 16:21:48 +0000 (+0000)
Subject: Merge pull request #2440 in SNORT/snort3 from ~OSERHIIE/snort3:doc_trace_all_modules_... 
X-Git-Tag: 3.0.2-6~13
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bfaf33f7eada004f4f75d66ee1cbfe95e34b4ea7;p=thirdparty%2Fsnort3.git

Merge pull request #2440 in SNORT/snort3 from ~OSERHIIE/snort3:doc_trace_all_modules_option to master

Squashed commit of the following:

commit 58f14dbd305d6e7b2cc820e5c1bfbc074ae8f5fe
Author: Oleksandr Serhiienko <oserhiie@cisco.com>
Date:   Fri Aug 28 13:05:31 2020 +0300

    doc: update trace.txt with info about 'trace.modules.all' option
---

diff --git a/doc/user/trace.txt b/doc/user/trace.txt
index 689c5cc92..b2b1de00d 100644
--- a/doc/user/trace.txt
+++ b/doc/user/trace.txt
@@ -79,6 +79,25 @@ modules also and works as a global switcher:
         }
     }
 
+Also, it's possible to enable or disable traces for all modules with a
+top-level *all* option.
+
+The following configuration states that:
+
+* all traces are enabled with verbosity level 5
+* traces for the decode module are enabled with level 3
+* rule_eval traces for the detection module are enabled with level 1
+
+    trace =
+    {
+        modules =
+        {
+            all = 5,
+            decode = { all = 3 },
+            detection = { rule_eval = 1 }
+        }
+    }
+
 The full list of available trace parameters is placed into
 the "Basic Modules.trace" chapter.
 
@@ -198,6 +217,8 @@ the trace module:
 
     trace.set({ modules = {...}, constraints = {...} }) - set modules traces and constraints (should pass a valid Lua-entry)
 
+    trace.set({ modules = { all = N } }) - enable traces for all modules with verbosity level N
+
     trace.set({ log_ntuple = true/false }) - on/off packet n-tuple info logging
 
     trace.clear() - clear modules traces and constraints