DOC: config: add missing glitch_{cnt,rate} data types
authorAurelien DARRAGON <adarragon@haproxy.com>
Wed, 30 Oct 2024 16:22:33 +0000 (17:22 +0100)
committerChristopher Faulet <cfaulet@haproxy.com>
Wed, 6 Nov 2024 14:47:53 +0000 (15:47 +0100)
When glitch_cnt and glitch_rate data types were implemented in
c9c6b683f ("MEDIUM: stick-tables: add a new stored type for glitch_cnt and
glitch_rate"), the data types list for "stick-table" keyword documentation
was overlooked.

This was reported by Nick Ramirez.

It should be backported in 3.0 with c9c6b683f.

(cherry picked from commit 9a6fc2d474511ead2fe8c39524d23b156d640ef8)
Signed-off-by: Christopher Faulet <cfaulet@haproxy.com>

doc/configuration.txt

index 27ce7d3..a55b62d 100644 (file)
@@ -12600,6 +12600,21 @@ stick-table type {ip | integer | string [len <length>] | binary [len <length>]}
       smoothed with "option contstats" though this is not perfect yet. Use of
       byte_out_cnt is recommended for better fairness.
 
+    - glitch_cnt : front glitches count. It is a positive 32-bit integer which
+      counts the cumulative number of glitches reported on a front connection.
+      Glitches correspond to either unusual or unexpected actions (protocol-
+      wise) from the client that could indicate a badly defective client or
+      possibly an attacker. As such, this counter can help in order to decide
+      how to act with them in such case.
+
+    - glitch_rate(<period>) : frequency counter (takes 12 bytes). It takes an
+      integer parameter <period> which indicates in milliseconds the length of
+      the period over which the average is measured. It reports the average
+      front glitches rate over that period. It may be used to detect defective
+      clients or potential attackers that perform uncommon or unexpected
+      actions from a protocol point of view, provided that HAProxy flagged them
+      them as such.
+
   There is only one stick-table per proxy. At the moment of writing this doc,
   it does not seem useful to have multiple tables per proxy. If this happens
   to be required, simply create a dummy backend with a stick-table in it and