File: omhttp-template.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 (54 lines) | stat: -rw-r--r-- 1,346 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
49
50
51
52
53
54
.. _param-omhttp-template:
.. _omhttp.parameter.input.template:

template
========

.. index::
   single: omhttp; template
   single: template

.. summary-start

Selects the rsyslog template used to render each message before omhttp submits it.

.. summary-end

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

:Name: template
:Scope: input
:Type: word
:Default: input=StdJSONFmt
:Required?: no
:Introduced: Not specified

Description
-----------
The template to be used for the messages.

Note that in batching mode, this describes the format of *each* individual message, *not* the format of the resulting batch. Some batch modes require that a template produces valid JSON.

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

.. code-block:: rsyslog

   template(name="tpl_omhttp_json" type="list") {
      constant(value="{")   property(name="msg"           outname="message"   format="jsonfr")
      constant(value=",")   property(name="hostname"      outname="host"      format="jsonfr")
      constant(value=",")   property(name="timereported"  outname="timestamp" format="jsonfr" dateFormat="rfc3339")
      constant(value="}")
   }

   module(load="omhttp")

   action(
      type="omhttp"
      template="tpl_omhttp_json"
   )

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