doc/imfile: add File and Tag to parameter samples

This commit is contained in:
Rainer Gerhards 2025-08-18 18:27:14 +02:00
parent 12e4ec6655
commit ca0eaeee3f
29 changed files with 114 additions and 29 deletions

View File

@ -36,7 +36,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" addCeeTag="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
addCeeTag="on")
Notes Notes
----- -----

View File

@ -37,7 +37,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" addMetadata="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
addMetadata="on")
Notes Notes
----- -----

View File

@ -39,7 +39,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" deleteStateOnFileDelete="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
deleteStateOnFileDelete="on")
Notes Notes
----- -----

View File

@ -50,7 +50,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" deleteStateOnFileMove="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
deleteStateOnFileMove="on")
Notes Notes
----- -----

View File

@ -37,7 +37,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" discardTruncatedMsg="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
discardTruncatedMsg="on")
Notes Notes
----- -----

View File

@ -50,7 +50,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" endmsg.regex="pattern") input(type="imfile"
File="/var/log/example.log"
Tag="example"
endmsg.regex="pattern")
See also See also
-------- --------

View File

@ -46,7 +46,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" escapeLF="on" escapeLF.replacement="[LF]") input(type="imfile"
File="/var/log/example.log"
Tag="example"
escapeLF="on" escapeLF.replacement="[LF]")
See also See also
-------- --------

View File

@ -39,7 +39,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" escapeLF="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
escapeLF="on")
Notes Notes
----- -----

View File

@ -37,7 +37,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" Facility="local0") input(type="imfile"
File="/var/log/example.log"
Tag="example"
Facility="local0")
Notes Notes
----- -----

View File

@ -37,7 +37,9 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" File="/path/to/logfile") input(type="imfile"
File="/path/to/logfile"
Tag="example")
Legacy names (for reference) Legacy names (for reference)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -47,7 +47,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" freshStartTail="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
freshStartTail="on")
Notes Notes
----- -----

View File

@ -37,7 +37,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" ignoreOlderThan="0") input(type="imfile"
File="/var/log/example.log"
Tag="example"
ignoreOlderThan="0")
See also See also
-------- --------

View File

@ -38,7 +38,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" MaxBytesPerMinute="0") input(type="imfile"
File="/var/log/example.log"
Tag="example"
MaxBytesPerMinute="0")
See also See also
-------- --------

View File

@ -42,7 +42,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" MaxLinesAtOnce="0") input(type="imfile"
File="/var/log/example.log"
Tag="example"
MaxLinesAtOnce="0")
Legacy names (for reference) Legacy names (for reference)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -37,7 +37,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" MaxLinesPerMinute="0") input(type="imfile"
File="/var/log/example.log"
Tag="example"
MaxLinesPerMinute="0")
See also See also
-------- --------

View File

@ -38,7 +38,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" MaxSubmitAtOnce="1024") input(type="imfile"
File="/var/log/example.log"
Tag="example"
MaxSubmitAtOnce="1024")
See also See also
-------- --------

View File

@ -36,7 +36,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" msgDiscardingError="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
msgDiscardingError="on")
Notes Notes
----- -----

View File

@ -37,7 +37,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" needParse="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
needParse="on")
Notes Notes
----- -----

View File

@ -38,7 +38,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" persistStateAfterSubmission="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
persistStateAfterSubmission="on")
Notes Notes
----- -----

View File

@ -43,7 +43,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" PersistStateInterval="0") input(type="imfile"
File="/var/log/example.log"
Tag="example"
PersistStateInterval="0")
Legacy names (for reference) Legacy names (for reference)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -42,7 +42,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" readMode="0") input(type="imfile"
File="/var/log/example.log"
Tag="example"
readMode="0")
Legacy names (for reference) Legacy names (for reference)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -53,7 +53,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" readTimeout="0") input(type="imfile"
File="/var/log/example.log"
Tag="example"
readTimeout="0")
Notes Notes
----- -----

View File

@ -37,7 +37,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" reopenOnTruncate="on") input(type="imfile"
File="/var/log/example.log"
Tag="example"
reopenOnTruncate="on")
Notes Notes
----- -----

View File

@ -35,7 +35,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" Ruleset="myrules") input(type="imfile"
File="/var/log/example.log"
Tag="example"
Ruleset="myrules")
Legacy names (for reference) Legacy names (for reference)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -37,7 +37,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" Severity="notice") input(type="imfile"
File="/var/log/example.log"
Tag="example"
Severity="notice")
Notes Notes
----- -----

View File

@ -40,7 +40,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" startmsg.regex="^start") input(type="imfile"
File="/var/log/example.log"
Tag="example"
startmsg.regex="^start")
See also See also
-------- --------

View File

@ -41,7 +41,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" stateFile="/path/to/state") input(type="imfile"
File="/var/log/example.log"
Tag="example"
stateFile="/path/to/state")
Notes Notes
----- -----

View File

@ -37,7 +37,9 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" Tag="app:") input(type="imfile"
File="/var/log/example.log"
Tag="app:")
Legacy names (for reference) Legacy names (for reference)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~

View File

@ -38,7 +38,10 @@ Input usage
.. code-block:: rsyslog .. code-block:: rsyslog
input(type="imfile" trimLineOverBytes="0") input(type="imfile"
File="/var/log/example.log"
Tag="example"
trimLineOverBytes="0")
See also See also
-------- --------