From: Aurelien DARRAGON <adarragon@haproxy.com>
Date: Mon, 28 Apr 2025 10:09:45 +0000 (+0200)
Subject: DOC: config: clarify log-forward "host" option
X-Git-Tag: v3.2-dev13~72
X-Git-Url: http://git.ipfire.org/gitweb/gitweb.cgi?a=commitdiff_plain;h=e9213628109dfa6a2b6cffd9e7d38ffa36fafcc6;p=thirdparty%2Fhaproxy.git

DOC: config: clarify log-forward "host" option

log-forward "host" option may be confusing because we often mention the
host field when talking about syslog RFC3164 or RFC5424 messages, but
neither rfc actually define "host" field. In fact, everywhere we used
"host field" we actually meant "hostname field" as documented in RFC5424.
This was a language abuse on our side.

In this patch we replace "host" with "hostname" where relevant in the
documentation to prevent confusion.

Thanks to Nick Ramirez for having reported the issue.
---

diff --git a/doc/configuration.txt b/doc/configuration.txt
index 7ea7fe2ab..098062509 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -5579,31 +5579,31 @@ option dont-parse-log
 
 option host { replace | fill | keep | append }
   Set the host strategy that should be used on the log-forward section
-  regarding syslog host field for outbound rfc3164 or rfc5424 messages.
+  regarding syslog hostname field for outbound rfc3164 or rfc5424 messages.
 
-      replace If input message already contains a value for the host field,
+      replace If input message already contains a value for the hostname field,
               we replace it by the source IP address from the sender.
-              If input message doesn't contain a value for the host field (ie:
-              '-' as input rfc5424 message or non compliant rfc3164 or rfc5424
-              message), we use the source IP address from the sender as host
-              field.
+              If input message doesn't contain a value for the hostname field
+              (ie: '-' as input rfc5424 message or non compliant rfc3164 or
+              rfc5424 message), we use the source IP address from the sender as
+              hostname field.
 
-      fill    If input message already contains a value for the host field,
+      fill    If input message already contains a value for the hostname field,
               we keep it.
-              If input message doesn't contain a value for the host field
+              If input message doesn't contain a value for the hostname field
               (ie: '-' as input rfc5424 message or non compliant rfc3164 or
               rfc5424 message), we use the source IP address from the sender as
-              host field.
+              hostname field.
               (This is the default)
 
-      keep    If input message already contains a value for the host field,
+      keep    If input message already contains a value for the hostname field,
               we keep it.
-              If input message doesn't contain a value for the host field,
+              If input message doesn't contain a value for the hostname field,
               we set it to 'localhost' (rfc3164) or '-' (rfc5424).
 
-      append  If input message already contains a value for the host field,
+      append  If input message already contains a value for the hostname field,
               we append a comma followed by the IP address from the sender.
-              If input message doesn't contain a value for the host field,
+              If input message doesn't contain a value for the hostname field,
               we use the source IP address from the sender.
 
   For all options above, if the source IP address from the sender is not