From 531276cfe03edd76af9680c7aaef368cea262b2c Mon Sep 17 00:00:00 2001 From: Tim Wojtulewicz Date: Fri, 2 Jun 2023 11:05:35 +0200 Subject: [PATCH] Remove LogAscii::logdir (6.1 deprecation) --- .../frameworks/logging/writers/ascii.zeek | 8 ---- src/logging/writers/ascii/Ascii.cc | 25 ++--------- src/logging/writers/ascii/ascii.bif | 1 - .../out | 1 - .../out | 41 +++++++++---------- .../base/frameworks/logging/ascii-logdir.zeek | 2 +- ...ir-leftover-log-rotation-shadow-files.zeek | 34 --------------- ...tover-log-rotation-stale-shadow-files.zeek | 23 ----------- ...te-ascii-logdir-leftover-log-rotation.zeek | 4 +- 9 files changed, 26 insertions(+), 113 deletions(-) delete mode 100644 testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation-shadow-files.zeek delete mode 100644 testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation-stale-shadow-files.zeek diff --git a/scripts/base/frameworks/logging/writers/ascii.zeek b/scripts/base/frameworks/logging/writers/ascii.zeek index 3b7e87a125..a65ae290cb 100644 --- a/scripts/base/frameworks/logging/writers/ascii.zeek +++ b/scripts/base/frameworks/logging/writers/ascii.zeek @@ -54,14 +54,6 @@ export { ## This option is also available as a per-filter ``$config`` option. const gzip_file_extension = "gz" &redef; - ## Define the default logging directory. If empty, logs are written - ## to the current working directory. - ## - ## This setting is superseded by :zeek:see:`Log::default_logdir`. The - ## latter applies to all file writers and also interacts better with - ## log rotation. - const logdir = "" &redef &deprecated="Remove in v6.1. Use 'Log::default_logdir'."; - ## Format of timestamps when writing out JSON. By default, the JSON ## formatter will use double values for timestamps which represent the ## number of seconds from the UNIX epoch. diff --git a/src/logging/writers/ascii/Ascii.cc b/src/logging/writers/ascii/Ascii.cc index fd73b4a9c2..6f6b3435f7 100644 --- a/src/logging/writers/ascii/Ascii.cc +++ b/src/logging/writers/ascii/Ascii.cc @@ -264,13 +264,7 @@ void Ascii::InitConfigOptions() gzip_file_extension.assign((const char*)BifConst::LogAscii::gzip_file_extension->Bytes(), BifConst::LogAscii::gzip_file_extension->Len()); - // Remove in v6.1: LogAscii::logdir should be gone in favor - // of using Log::default_logdir. - logdir.assign((const char*)BifConst::LogAscii::logdir->Bytes(), - BifConst::LogAscii::logdir->Len()); - - if ( logdir.empty() ) - logdir = zeek::id::find_const("Log::default_logdir")->ToStdString(); + logdir = zeek::id::find_const("Log::default_logdir")->ToStdString(); } bool Ascii::InitFilterOptions() @@ -379,15 +373,6 @@ bool Ascii::InitFilterOptions() else if ( strcmp(i->first, "gzip_file_extension") == 0 ) gzip_file_extension.assign(i->second); - - else if ( strcmp(i->first, "logdir") == 0 ) - { - // This doesn't play nice with leftover log rotation - // and log rotation in general. There's no documentation - // or a test for this specifically, so deprecate it. - reporter->Deprecation("Remove in v6.1. Per writer logdir is deprecated."); - logdir.assign(i->second); - } } if ( ! InitFormatter() ) @@ -763,17 +748,13 @@ static std::vector find_leftover_logs() auto prefix_len = strlen(shadow_file_prefix); auto default_logdir = zeek::id::find_const("Log::default_logdir")->ToStdString(); - // Find any .shadow files within LogAscii::logdir, Log::default_logdir - // or otherwise search in the current working directory. + // Find any .shadow files within Log::default_logdir or otherwise search in + // the current working directory. auto logdir = zeek::filesystem::current_path(); if ( ! default_logdir.empty() ) logdir = zeek::filesystem::absolute(default_logdir); - // Remove LogAscii::logdir fallback in v6.1. - if ( BifConst::LogAscii::logdir->Len() > 0 ) - logdir = zeek::filesystem::absolute(BifConst::LogAscii::logdir->ToStdString()); - auto d = opendir(logdir.string().c_str()); struct dirent* dp; diff --git a/src/logging/writers/ascii/ascii.bif b/src/logging/writers/ascii/ascii.bif index 38932ded36..632c89f055 100644 --- a/src/logging/writers/ascii/ascii.bif +++ b/src/logging/writers/ascii/ascii.bif @@ -17,4 +17,3 @@ const json_timestamps: JSON::TimestampFormat; const json_include_unset_fields: bool; const gzip_level: count; const gzip_file_extension: string; -const logdir: string; diff --git a/testing/btest/Baseline/scripts.base.frameworks.logging.rotate-ascii-logdir-leftover-log-rotation-stale-shadow-files/out b/testing/btest/Baseline/scripts.base.frameworks.logging.rotate-ascii-logdir-leftover-log-rotation-stale-shadow-files/out index 0f3aae8c56..49d861c74c 100644 --- a/testing/btest/Baseline/scripts.base.frameworks.logging.rotate-ascii-logdir-leftover-log-rotation-stale-shadow-files/out +++ b/testing/btest/Baseline/scripts.base.frameworks.logging.rotate-ascii-logdir-leftover-log-rotation-stale-shadow-files/out @@ -1,2 +1 @@ ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63. -warning in <...>/rotate-ascii-logdir-leftover-log-rotation-stale-shadow-files.zeek, line 20: deprecated (LogAscii::logdir): Remove in v6.1. Use 'Log::default_logdir'. diff --git a/testing/btest/Baseline/scripts.base.frameworks.logging.rotate-ascii-logdir-leftover-log-rotation/out b/testing/btest/Baseline/scripts.base.frameworks.logging.rotate-ascii-logdir-leftover-log-rotation/out index 21ba63d2f4..94e748a4e2 100644 --- a/testing/btest/Baseline/scripts.base.frameworks.logging.rotate-ascii-logdir-leftover-log-rotation/out +++ b/testing/btest/Baseline/scripts.base.frameworks.logging.rotate-ascii-logdir-leftover-log-rotation/out @@ -1,16 +1,15 @@ ### BTest baseline data generated by btest-diff. Do not edit. Use "btest -U/-u" to update. Requires BTest >= 0.63. -test.2011-03-07-03-00-05.log test 11-03-07_03.00.05 11-03-07_04.00.05 0 ascii -test.2011-03-07-04-00-05.log test 11-03-07_04.00.05 11-03-07_05.00.05 0 ascii -test.2011-03-07-05-00-05.log test 11-03-07_05.00.05 11-03-07_06.00.05 0 ascii -test.2011-03-07-06-00-05.log test 11-03-07_06.00.05 11-03-07_07.00.05 0 ascii -test.2011-03-07-07-00-05.log test 11-03-07_07.00.05 11-03-07_08.00.05 0 ascii -test.2011-03-07-08-00-05.log test 11-03-07_08.00.05 11-03-07_09.00.05 0 ascii -test.2011-03-07-09-00-05.log test 11-03-07_09.00.05 11-03-07_10.00.05 0 ascii -test.2011-03-07-10-00-05.log test 11-03-07_10.00.05 11-03-07_11.00.05 0 ascii -test.2011-03-07-11-00-05.log test 11-03-07_11.00.05 11-03-07_12.00.05 0 ascii -test.2011-03-07-12-00-05.log test 11-03-07_12.00.05 11-03-07_12.59.55 1 ascii -warning in <...>/rotate-ascii-logdir-leftover-log-rotation.zeek, line 22: deprecated (LogAscii::logdir): Remove in v6.1. Use 'Log::default_logdir'. -> test.2011-03-07-03-00-05.log +.<...>/test.2011-03-07-03-00-05.log test 11-03-07_03.00.05 11-03-07_04.00.05 0 ascii +.<...>/test.2011-03-07-04-00-05.log test 11-03-07_04.00.05 11-03-07_05.00.05 0 ascii +.<...>/test.2011-03-07-05-00-05.log test 11-03-07_05.00.05 11-03-07_06.00.05 0 ascii +.<...>/test.2011-03-07-06-00-05.log test 11-03-07_06.00.05 11-03-07_07.00.05 0 ascii +.<...>/test.2011-03-07-07-00-05.log test 11-03-07_07.00.05 11-03-07_08.00.05 0 ascii +.<...>/test.2011-03-07-08-00-05.log test 11-03-07_08.00.05 11-03-07_09.00.05 0 ascii +.<...>/test.2011-03-07-09-00-05.log test 11-03-07_09.00.05 11-03-07_10.00.05 0 ascii +.<...>/test.2011-03-07-10-00-05.log test 11-03-07_10.00.05 11-03-07_11.00.05 0 ascii +.<...>/test.2011-03-07-11-00-05.log test 11-03-07_11.00.05 11-03-07_12.00.05 0 ascii +.<...>/test.2011-03-07-12-00-05.log test 11-03-07_12.00.05 11-03-07_12.59.55 1 ascii +> logs/test.2011-03-07-03-00-05.log #separator \x09 #set_separator , #empty_field (empty) @@ -22,7 +21,7 @@ warning in <...>/rotate-ascii-logdir-leftover-log-rotation.zeek, line 22: deprec XXXXXXXXXX.XXXXXX 10.0.0.1 20 10.0.0.2 1024 XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 0 #close XXXX-XX-XX-XX-XX-XX -> test.2011-03-07-04-00-05.log +> logs/test.2011-03-07-04-00-05.log #separator \x09 #set_separator , #empty_field (empty) @@ -34,7 +33,7 @@ XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 0 XXXXXXXXXX.XXXXXX 10.0.0.1 20 10.0.0.2 1025 XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 1 #close XXXX-XX-XX-XX-XX-XX -> test.2011-03-07-05-00-05.log +> logs/test.2011-03-07-05-00-05.log #separator \x09 #set_separator , #empty_field (empty) @@ -46,7 +45,7 @@ XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 1 XXXXXXXXXX.XXXXXX 10.0.0.1 20 10.0.0.2 1026 XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 2 #close XXXX-XX-XX-XX-XX-XX -> test.2011-03-07-06-00-05.log +> logs/test.2011-03-07-06-00-05.log #separator \x09 #set_separator , #empty_field (empty) @@ -58,7 +57,7 @@ XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 2 XXXXXXXXXX.XXXXXX 10.0.0.1 20 10.0.0.2 1027 XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 3 #close XXXX-XX-XX-XX-XX-XX -> test.2011-03-07-07-00-05.log +> logs/test.2011-03-07-07-00-05.log #separator \x09 #set_separator , #empty_field (empty) @@ -70,7 +69,7 @@ XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 3 XXXXXXXXXX.XXXXXX 10.0.0.1 20 10.0.0.2 1028 XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 4 #close XXXX-XX-XX-XX-XX-XX -> test.2011-03-07-08-00-05.log +> logs/test.2011-03-07-08-00-05.log #separator \x09 #set_separator , #empty_field (empty) @@ -82,7 +81,7 @@ XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 4 XXXXXXXXXX.XXXXXX 10.0.0.1 20 10.0.0.2 1029 XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 5 #close XXXX-XX-XX-XX-XX-XX -> test.2011-03-07-09-00-05.log +> logs/test.2011-03-07-09-00-05.log #separator \x09 #set_separator , #empty_field (empty) @@ -94,7 +93,7 @@ XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 5 XXXXXXXXXX.XXXXXX 10.0.0.1 20 10.0.0.2 1030 XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 6 #close XXXX-XX-XX-XX-XX-XX -> test.2011-03-07-10-00-05.log +> logs/test.2011-03-07-10-00-05.log #separator \x09 #set_separator , #empty_field (empty) @@ -106,7 +105,7 @@ XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 6 XXXXXXXXXX.XXXXXX 10.0.0.1 20 10.0.0.2 1031 XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 7 #close XXXX-XX-XX-XX-XX-XX -> test.2011-03-07-11-00-05.log +> logs/test.2011-03-07-11-00-05.log #separator \x09 #set_separator , #empty_field (empty) @@ -118,7 +117,7 @@ XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 7 XXXXXXXXXX.XXXXXX 10.0.0.1 20 10.0.0.2 1032 XXXXXXXXXX.XXXXXX 10.0.0.2 20 10.0.0.3 8 #close XXXX-XX-XX-XX-XX-XX -> test.2011-03-07-12-00-05.log +> logs/test.2011-03-07-12-00-05.log #separator \x09 #set_separator , #empty_field (empty) diff --git a/testing/btest/scripts/base/frameworks/logging/ascii-logdir.zeek b/testing/btest/scripts/base/frameworks/logging/ascii-logdir.zeek index 104c073971..51b2a9606c 100644 --- a/testing/btest/scripts/base/frameworks/logging/ascii-logdir.zeek +++ b/testing/btest/scripts/base/frameworks/logging/ascii-logdir.zeek @@ -1,6 +1,6 @@ # # @TEST-EXEC: mkdir logdir -# @TEST-EXEC: zeek -b %INPUT LogAscii::logdir=logdir +# @TEST-EXEC: zeek -b %INPUT Log::default_logdir=logdir # @TEST-EXEC: cat logdir/ssh.log | grep -v PREFIX.*20..- >ssh-filtered.log # @TEST-EXEC: btest-diff ssh-filtered.log diff --git a/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation-shadow-files.zeek b/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation-shadow-files.zeek deleted file mode 100644 index 9c15dba571..0000000000 --- a/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation-shadow-files.zeek +++ /dev/null @@ -1,34 +0,0 @@ -# @TEST-DOC: Test that .shadow files are picked up from LogAscii::logdir. -# @TEST-EXEC: mkdir logs -# @TEST-EXEC: echo ".log" >> logs/.shadow.conn.log -# @TEST-EXEC: echo "my_rotation_postprocessor" >> logs/.shadow.conn.log -# @TEST-EXEC: echo "leftover conn log" > logs/conn.log -# @TEST-EXEC: echo ".log" >> logs/.shadow.dns.log -# @TEST-EXEC: echo "my_rotation_postprocessor" >> logs/.shadow.dns.log -# @TEST-EXEC: echo "leftover dns log" > logs/dns.log - -# @TEST-EXEC: zeek -b %INPUT > out - -# @TEST-EXEC: ! test -f logs/.shadow.conn.log -# @TEST-EXEC: ! test -f logs/conn.log -# @TEST-EXEC: ! test -f logs/.shadow.dns.log -# @TEST-EXEC: ! test -f logs/dns.log - -# Ensure rotated logs ends-up in the current working directory: This may change in the future. -# @TEST-EXEC: cat ./conn-*.log ./dns-*.log > logs.cat - -# @TEST-EXEC: TEST_DIFF_CANONIFIER=$SCRIPTS/diff-sort btest-diff out -# @TEST-EXEC: btest-diff logs.cat - -module GLOBAL; - -function my_rotation_postprocessor(info: Log::RotationInfo) : bool - { - print fmt("running my rotation postprocessor for path '%s'", info$path); - return T; - } - -redef LogAscii::logdir = "./logs"; -redef LogAscii::enable_leftover_log_rotation = T; -redef Log::default_rotation_interval = 1hr; -redef Log::default_rotation_postprocessor_cmd = "echo"; diff --git a/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation-stale-shadow-files.zeek b/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation-stale-shadow-files.zeek deleted file mode 100644 index af1f5a6d37..0000000000 --- a/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation-stale-shadow-files.zeek +++ /dev/null @@ -1,23 +0,0 @@ -# @TEST-DOC: Test that stale .shadow files are removed from LogAscii::logdir. -# @TEST-EXEC: mkdir logs -# @TEST-EXEC: echo ".log" >> logs/.shadow.conn.log -# @TEST-EXEC: echo "my_rotation_postprocessor" >> logs/.shadow.conn.log - -# @TEST-EXEC: zeek -b %INPUT > out 2>&1 - -# @TEST-EXEC: ! test -f logs/.shadow.conn.log - -# @TEST-EXEC: TEST_DIFF_CANONIFIER='$SCRIPTS/diff-remove-abspath | $SCRIPTS/diff-remove-timestamps' btest-diff out - -module GLOBAL; - -function my_rotation_postprocessor(info: Log::RotationInfo) : bool - { - print fmt("running my rotation postprocessor for path '%s'", info$path); - return T; - } - -redef LogAscii::logdir = "./logs"; -redef LogAscii::enable_leftover_log_rotation = T; -redef Log::default_rotation_interval = 1hr; -redef Log::default_rotation_postprocessor_cmd = "echo"; diff --git a/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation.zeek b/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation.zeek index 7fdba2c9fa..c6349448e0 100644 --- a/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation.zeek +++ b/testing/btest/scripts/base/frameworks/logging/rotate-ascii-logdir-leftover-log-rotation.zeek @@ -2,7 +2,7 @@ # @TEST-EXEC: mkdir logs # @TEST-EXEC: zeek -b -r ${TRACES}/rotation.trace %INPUT >zeek.out 2>&1 # @TEST-EXEC: grep "test" zeek.out | sort >out -# @TEST-EXEC: for i in `ls test.*.log | sort`; do printf '> %s\n' $i; cat $i; done >>out +# @TEST-EXEC: for i in `ls logs/test.*.log | sort`; do printf '> %s\n' $i; cat $i; done >>out # @TEST-EXEC: TEST_DIFF_CANONIFIER='$SCRIPTS/diff-remove-abspath | $SCRIPTS/diff-remove-timestamps' btest-diff out module Test; @@ -19,8 +19,8 @@ export { } &log; } -redef LogAscii::logdir = "./logs"; redef LogAscii::enable_leftover_log_rotation = T; +redef Log::default_logdir = "./logs"; redef Log::default_rotation_interval = 1hr; redef Log::default_rotation_postprocessor_cmd = "echo";