File: omhttp-retry-addmetadata.rst

package info (click to toggle)
rsyslog 8.2512.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,464 kB
  • sloc: ansic: 123,809; sh: 42,109; makefile: 5,962; javascript: 1,842; python: 1,222; lex: 607; yacc: 193; perl: 162; sql: 103; tcl: 9; ruby: 2
file content (47 lines) | stat: -rw-r--r-- 1,038 bytes parent folder | download
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
.. _param-omhttp-retry-addmetadata:
.. _omhttp.parameter.input.retry-addmetadata:

retry.addmetadata
=================

.. index::
   single: omhttp; retry.addmetadata
   single: retry.addmetadata

.. summary-start

Adds HTTP response metadata to ``$!omhttp!response`` for messages handled by the retry logic.

.. summary-end

This parameter applies to :doc:`../../configuration/modules/omhttp`.

:Name: retry.addmetadata
:Scope: input
:Type: boolean
:Default: input=off
:Required?: no
:Introduced: Not specified

Description
-----------
When this option is enabled, omhttp will add the response metadata to ``$!omhttp!response``. There are three response metadata fields added: ``code``, ``body``, ``batch_index``.

Input usage
-----------
.. _omhttp.parameter.input.retry-addmetadata-usage:

.. code-block:: rsyslog

   module(load="omhttp")

   action(
       type="omhttp"
       retry="on"
       retryRuleSet="rs_omhttp_retry"
       retryAddMetadata="on"
   )

See also
--------
See also :doc:`../../configuration/modules/omhttp`.