File: imkafka-parsehostname.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 (46 lines) | stat: -rw-r--r-- 996 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
.. _param-imkafka-parsehostname:
.. _imkafka.parameter.input.parsehostname:

parseHostname
=============

.. index::
   single: imkafka; parseHostname
   single: parseHostname

.. summary-start

Controls whether imkafka parses the hostname from each received message.

.. summary-end

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

:Name: parseHostname
:Scope: input
:Type: boolean
:Default: input=``off``
:Required?: no
:Introduced: 8.38.0

Description
-----------
If this parameter is set to on, imkafka will parse the hostname in log if it
exists. The result can be retrieved from $hostname. If it's off, for
compatibility reasons, the local hostname is used, same as the previous
version.

Input usage
-----------
.. _imkafka.parameter.input.parsehostname-usage:

.. code-block:: rsyslog

   module(load="imkafka")
   input(type="imkafka"
         topic="your-topic"
         parseHostname="on")

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