1 files changed, 89 insertions, 0 deletions
diff --git a/source/configuration/modules/mmtaghostname.rst b/source/configuration/modules/mmtaghostname.rst
new file mode 100644
index 0000000..114f723
--- /dev/null
+++ b/source/configuration/modules/mmtaghostname.rst
@@ -0,0 +1,89 @@
+******************************************
+mmtaghostname: message modification module
+******************************************
+
+================  ==============================================================
+**Module Name:**  **mmtaghostname**
+**Authors:**      Jean-Philippe Hilaire <jean-philippe.hilaire@pmu.fr> & Philippe Duveau <philippe.duveau@free.fr>
+================  ==============================================================
+
+
+Purpose
+=======
+
+As a message modification, it can be used in a different step of the
+message processing without interfering in the parsers' chain process
+and can be applied before or after parsing process using rulesets.
+
+The purposes are :
+ 
+- to add a tag on message produce by input module which does not provide
+  a tag like imudp or imtcp. Useful when the tag is used for routing the
+  message.
+   
+- to force message hostname to the rsyslog valeur. 
+  AWS Use case : applications in auto-scaling systems provides logs to rsyslog
+  through udp/tcp. As a result of auto-scaling, the name of the host is based
+  on an ephemeral IPs (short term meaning). In this situation rsyslog local
+  hostname is generally closed to business rule. So replacing hostanme received
+  by the rsyslog local Hostname provide values to the logs collected.
+
+Compile
+=======
+
+To successfully compile mmtaghostname module.
+
+.. code-block:: none
+
+ ./configure --enable-mmtaghostname ...
+
+Configuration Parameters
+========================
+
+Tag
+^^^
+
+.. csv-table::
+  :header: "type", "mandatory", "format", "default"
+  :widths: auto
+  :class: parameter-table
+
+  "string", "no", ,"none"
+
+The tag to be assigned to messages modified. If you would like to see the 
+colon after the tag, you need to include it when you assign a tag value, 
+like so: ``tag="myTagValue:"``.
+
+If this attribute is no provided, messages tags are not modified.
+
+ForceLocalHostname
+^^^^^^^^^^^^^^^^^^
+
+.. csv-table::
+  :header: "type", "mandatory", "format", "default"
+  :widths: auto
+  :class: parameter-table
+
+  "Binary", "no", ,"off"
+
+This attribute force to set the HOSTNAME of the message to the rsyslog
+value "localHostName". This allow to set a valid value to message received
+received from local application through imudp or imtcp.
+
+Sample
+======
+
+In this sample, the message received is parsed by RFC5424 parser and then 
+the HOSTNAME is overwritten and a tag is setted. 
+
+.. code-block:: none
+
+    module(load='mmtaghostname')
+    module(load='imudp')
+    global(localhostname="sales-front")
+    
+    ruleset(name="TagUDP" parser=[ "rsyslog.rfc5424" ]) {
+        action(type="mmtaghostname" tag="front" forcelocalhostname="on")
+        call ...
+    }
+    input(type="imudp" port="514" ruleset="TagUDP")