File: mmcount-appname.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 (52 lines) | stat: -rw-r--r-- 1,369 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
.. _param-mmcount-appname:
.. _mmcount.parameter.input.appname:

appName
=======

.. index::
   single: mmcount; appName
   single: appName

.. summary-start

Selects the application name whose messages the mmcount action tracks.

.. summary-end

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

:Name: appName
:Scope: input
:Type: word
:Default: none
:Required?: yes
:Introduced: 7.5.0

Description
-----------
Specifies the syslog APP-NAME that must match for mmcount to process a
message. When the application name of the current message does not match
``appName``, the action immediately returns without altering counters. If
no match is found, no ``mmcount`` property is added to the message.

For matching messages, mmcount increments counters based on the
additional parameters. When :ref:`param-mmcount-key` is omitted, the
module counts per-severity totals for the selected application. If
:ref:`param-mmcount-key` is provided, counters are updated according to
that parameter's logic. The updated total is written into the message's
``mmcount`` JSON property so later actions can react to it.

Input usage
-----------
.. _param-mmcount-appname-usage:
.. _mmcount.parameter.input.appname-usage:

.. code-block:: rsyslog

   action(type="mmcount" appName="gluster")

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