From 9a6fc2d474511ead2fe8c39524d23b156d640ef8 Mon Sep 17 00:00:00 2001 From: Aurelien DARRAGON Date: Wed, 30 Oct 2024 17:22:33 +0100 Subject: [PATCH] DOC: config: add missing glitch_{cnt,rate} data types 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. --- doc/configuration.txt | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/configuration.txt b/doc/configuration.txt index 68777b2b8c..556c067768 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -12953,6 +12953,21 @@ stick-table type {ip | integer | string [len ] | binary [len ]} 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() : frequency counter (takes 12 bytes). It takes an + integer parameter 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