File: omhttp-dynrestpath.rst

package info (click to toggle)
rsyslog 8.2512.0-3
  • 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 (48 lines) | stat: -rw-r--r-- 1,130 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
48
.. _param-omhttp-dynrestpath:
.. _omhttp.parameter.input.dynrestpath:

dynrestpath
===========

.. index::
   single: omhttp; dynrestpath
   single: dynrestpath

.. summary-start

Enables using a template name in :ref:`param-omhttp-restpath` so each message can select a REST path dynamically.

.. summary-end

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

:Name: dynrestpath
:Scope: input
:Type: boolean
:Default: input=off
:Required?: no
:Introduced: Not specified

Description
-----------
When this parameter is set to ``on`` you can specify a template name in the :ref:`param-omhttp-restpath` parameter instead of the actual path. This way you can use dynamic REST paths for your messages based on the template you are using.

Input usage
-----------
.. _omhttp.parameter.input.dynrestpath-usage:

.. code-block:: rsyslog

   template(name="tpl_dynamic_path" type="string" string="tenant/%hostname%/events")

   module(load="omhttp")

   action(
       type="omhttp"
       dynRestPath="on"
       restPath="tpl_dynamic_path"
   )

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