From: Frédéric Lécaille <flecaille@haproxy.com>
Date: Thu, 25 Apr 2019 08:52:17 +0000 (+0200)
Subject: DOC: log: Document the sampling and load-balancing logging feature.
X-Git-Tag: v2.0-dev3~151
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d690dfac1d257e520a9f84818a8cfe67fa80f0cb;p=thirdparty%2Fhaproxy.git

DOC: log: Document the sampling and load-balancing logging feature.

This document should come with these commits:
  'MINOR: log: Enable the log sampling and load-balancing feature'
  'MINOR: log: Add "sample" new keyword to "log" lines.'
---

diff --git a/doc/configuration.txt b/doc/configuration.txt
index 205f5de902..408829143f 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -823,7 +823,8 @@ group <group name>
   Similar to "gid" but uses the GID of group name <group name> from /etc/group.
   See also "gid" and "user".
 
-log <address> [len <length>] [format <format>] <facility> [max level [min level]]
+log <address> [len <length>] [format <format>] [sample <ranges>:<smp_size>]
+    <facility> [max level [min level]]
   Adds a global syslog server. Several global servers can be defined. They
   will receive logs for starts and exits, as well as all logs from proxies
   configured with "log global".
@@ -899,6 +900,19 @@ log <address> [len <length>] [format <format>] <facility> [max level [min level]
               used in containers or during development, where the severity only
               depends on the file descriptor used (stdout/stderr).
 
+  <ranges>   A list of comma-separated ranges to identify the logs to sample.
+             This is used to balance the load of the logs to send to the log
+             server. The limits of the ranges cannot be null. They are numbered
+             from 1. The size or period (in number of logs) of the sample must be
+             set with <sample_size> parameter.
+
+  <sample_size>
+             The size of the sample in number of logs to consider when balancing
+             their logging loads. It is used to balance the load of the logs to
+             send to the syslog server. This size must be greater or equal to the
+             maximum of the high limits of the ranges.
+             (see also <ranges> parameter).
+
   <facility> must be one of the 24 standard syslog facilities :
 
                  kern   user   mail   daemon auth   syslog lpr    news
@@ -5314,7 +5328,8 @@ load-server-state-from-file { global | local | none }
 
 
 log global
-log <address> [len <length>] [format <format>] <facility> [<level> [<minlevel>]]
+log <address> [len <length>] [format <format>] [sample <ranges>:<smp_size>]
+    <facility> [<level> [<minlevel>]]
 no log
   Enable per-instance logging of events and traffic.
   May be used in sections :   defaults | frontend | listen | backend
@@ -5386,6 +5401,19 @@ no log
                generally fine for all standard usages. Some specific cases of
                long captures or JSON-formatted logs may require larger values.
 
+    <ranges>   A list of comma-separated ranges to identify the logs to sample.
+               This is used to balance the load of the logs to send to the log
+               server. The limits of the ranges cannot be null. They are numbered
+               from 1. The size or period (in number of logs) of the sample must
+               be set with <sample_size> parameter.
+
+    <sample_size>
+               The size of the sample in number of logs to consider when balancing
+               their logging loads. It is used to balance the load of the logs to
+               send to the syslog server. This size must be greater or equal to the
+               maximum of the high limits of the ranges.
+               (see also <ranges> parameter).
+
     <format> is the log format used when generating syslog messages. It may be
              one of the following :