1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
|
.. _param-omprog-reportfailures:
.. _omprog.parameter.action.reportfailures:
reportFailures
==============
.. index::
single: omprog; reportFailures
single: reportFailures
.. summary-start
Logs a warning when the program signals an error while confirming messages.
.. summary-end
This parameter applies to :doc:`../../configuration/modules/omprog`.
:Name: reportFailures
:Scope: action
:Type: boolean
:Default: action=off
:Required?: no
:Introduced: 8.38.0
Description
-----------
Specifies whether rsyslog must internally log a warning message whenever the
program returns an error when confirming a message. The logged message will
include the error line returned by the program. This parameter is ignored when
:ref:`param-omprog-confirmmessages` is set to "off".
Enabling this flag can be useful to log the problems detected by the program.
However, the information that can be logged is limited to a short error line,
and the logs will be tagged as originated by the 'syslog' facility (like the
rest of rsyslog logs). To avoid these shortcomings, consider the use of the
:ref:`param-omprog-output` parameter to capture the stderr of the program.
Action usage
------------
.. _param-omprog-action-reportfailures:
.. _omprog.parameter.action.reportfailures-usage:
.. code-block:: rsyslog
action(type="omprog"
confirmMessages="on"
reportFailures="on")
Notes
-----
- Legacy documentation referred to the type as ``binary``; this maps to ``boolean``.
See also
--------
See also :doc:`../../configuration/modules/omprog`.
|
