]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
yaml: unify 0 stats counter config option terms
authorJuliana Fajardini <jufajardini@oisf.net>
Wed, 17 Apr 2024 00:29:51 +0000 (21:29 -0300)
committerVictor Julien <victor@inliniac.net>
Fri, 19 Apr 2024 18:51:21 +0000 (20:51 +0200)
When we added feature #5976 (72146b969), we overlook that we also have
a config stats option for the human-readable stats logs to output
0 counters.
Due to not seeing this before, we now have two different setting names
for basically the same thing, but in different logs:
- zero-valued-counters for EVE
- null-values for stats.log

This ensures we use the same terminology, and change the recently added
one to `null-values`, as this one has been around for longer.

Task #6962

doc/userguide/output/eve/eve-json-output.rst
doc/userguide/partials/eve-log.yaml
src/output-json-stats.c
suricata.yaml.in

index 4756c042e8894003e4e6507ee871173b64e466b5..6e1778ed5ebaae00a3a8043b8538545ec29421b8 100644 (file)
@@ -293,7 +293,7 @@ While the human-friendly `stats.log` output will only log out non-zeroed
 counters, by default EVE Stats logs output all enabled counters, which may lead
 to fairly verbose logs.
 
-To reduce log file size, one may set `zero-valued-counters` to false. Do note
+To reduce log file size, one may set `null-values` to false. Do note
 that this may impact on the visibility of information for which a stats counter
 as zero is relevant.
 
@@ -301,7 +301,7 @@ Config::
 
     - stats:
         # Don't log stats counters that are zero. Default: true
-        #zero-valued-counters: false    # False will NOT log stats counters: 0
+        #null-values: false    # False will NOT log stats counters: 0
 
 Date modifiers in filename
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
index 685bbf8c4892c987cd4b11dc89fec5d69b99c052..d71c80b894602378e918ed9455b72dad8a5bc472 100644 (file)
@@ -170,7 +170,7 @@ outputs:
             threads: no       # per thread stats
             deltas: no        # include delta values
             # Don't log stats counters that are zero. Default: true
-            #zero-valued-counters: false    # False will NOT log stats counters: 0
+            #null-values: false    # False will NOT log stats counters: 0
         - dhcp:
             # DHCP logging.
             enabled: yes
index 5207ae2d30edba37e9f68d40182c53e04f137f86..d7485d01f979f1c4406bd5cc25acdd328f348604 100644 (file)
@@ -450,7 +450,7 @@ static OutputInitResult OutputStatsLogInitSub(ConfNode *conf, OutputCtx *parent_
         const char *totals = ConfNodeLookupChildValue(conf, "totals");
         const char *threads = ConfNodeLookupChildValue(conf, "threads");
         const char *deltas = ConfNodeLookupChildValue(conf, "deltas");
-        const char *zero_counters = ConfNodeLookupChildValue(conf, "zero-valued-counters");
+        const char *zero_counters = ConfNodeLookupChildValue(conf, "null-values");
         SCLogDebug("totals %s threads %s deltas %s", totals, threads, deltas);
 
         if ((totals != NULL && ConfValIsFalse(totals)) &&
index 28fcac442a02d63eb1b985d16403536c667a7a0a..879b389f14515b635376cdcdbce151e1e92cfac7 100644 (file)
@@ -319,7 +319,7 @@ outputs:
             threads: no       # per thread stats
             deltas: no        # include delta values
             # Don't log stats counters that are zero. Default: true
-            #zero-valued-counters: false    # False will NOT log stats counters: 0
+            #null-values: false    # False will NOT log stats counters: 0
         # bi-directional flows
         - flow
         # uni-directional flows