From 8f86b48c46f73eccc1833e7cc3d35e30b2caa194 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0pa=C4=8Dek?= Date: Mon, 3 Apr 2023 16:18:06 +0200 Subject: [PATCH 1/2] Make rndc dnstap -roll docs easier to read (cherry picked from commit 2897a45644545499f502b071dd32b8e41d50f513) --- bin/rndc/rndc.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/bin/rndc/rndc.rst b/bin/rndc/rndc.rst index 6717e242d1..35a4f31752 100644 --- a/bin/rndc/rndc.rst +++ b/bin/rndc/rndc.rst @@ -189,9 +189,13 @@ Currently supported commands are: .. option:: dnstap (-reopen | -roll [number]) - This command closes and re-opens DNSTAP output files. ``rndc dnstap -reopen`` allows + This command closes and re-opens DNSTAP output files. + + ``rndc dnstap -reopen`` allows the output file to be renamed externally, so that :iscman:`named` can - truncate and re-open it. ``rndc dnstap -roll`` causes the output file + truncate and re-open it. + + ``rndc dnstap -roll`` causes the output file to be rolled automatically, similar to log files. The most recent output file has ".0" appended to its name; the previous most recent output file is moved to ".1", and so on. If ``number`` is specified, then From 9659d40148e62db8628d06e592ce07fb1f68f88e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Petr=20=C5=A0pa=C4=8Dek?= Date: Mon, 3 Apr 2023 16:34:19 +0200 Subject: [PATCH 2/2] Remove erroneous cross-references to suffix statement Logging section referenced to "suffix" statement definition for dns64. (cherry picked from commit 1dada31187f6141d9c3c9b9a837084bfc964390b) --- doc/arm/reference.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/arm/reference.rst b/doc/arm/reference.rst index 3f45dae842..36ea3a5892 100644 --- a/doc/arm/reference.rst +++ b/doc/arm/reference.rst @@ -651,7 +651,7 @@ by the channel (the default is ``info``), and whether to include a allowed to become before it is rolled to a backup file (``size``), how many backup versions of the file are saved each time this happens (``versions``), and the format to use for naming backup versions - (:any:`suffix`). + (``suffix``). The ``size`` option is used to limit log file growth. If the file ever exceeds the specified size, then :iscman:`named` stops writing to the file @@ -667,18 +667,18 @@ by the channel (the default is ``info``), and whether to include a how many backup versions of the file should be kept. If set to ``unlimited``, there is no limit. - The :any:`suffix` option can be set to either ``increment`` or + The ``suffix`` option can be set to either ``increment`` or ``timestamp``. If set to ``timestamp``, then when a log file is rolled, it is saved with the current timestamp as a file suffix. If set to ``increment``, then backup files are saved with incrementing numbers as suffixes; older files are renamed when rolling. For example, if - ``versions`` is set to 3 and :any:`suffix` to ``increment``, then when + ``versions`` is set to 3 and ``suffix`` to ``increment``, then when ``filename.log`` reaches the size specified by ``size``, ``filename.log.1`` is renamed to ``filename.log.2``, ``filename.log.0`` is renamed to ``filename.log.1``, and ``filename.log`` is renamed to ``filename.log.0``, whereupon a new ``filename.log`` is opened. - Here is an example using the ``size``, ``versions``, and :any:`suffix` options: + Here is an example using the ``size``, ``versions``, and ``suffix`` options: :: @@ -1284,10 +1284,10 @@ default is used. options can be added: ``size`` indicates the size to which a :any:`dnstap` log file can grow before being rolled to a new file; ``versions`` specifies the number of rolled log files to retain; and - :any:`suffix` indicates whether to retain rolled log files with an + ``suffix`` indicates whether to retain rolled log files with an incrementing counter as the suffix (``increment``) or with the current timestamp (``timestamp``). These are similar to the ``size``, - ``versions``, and :any:`suffix` options in a :any:`logging` channel. The + ``versions``, and ``suffix`` options in a :any:`logging` channel. The default is to allow :any:`dnstap` log files to grow to any size without rolling.