Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1 | ---------------------- |
Willy Tarreau | 8317b28 | 2014-04-23 01:49:41 +0200 | [diff] [blame] | 2 | HAProxy |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 3 | Configuration Manual |
| 4 | ---------------------- |
Willy Tarreau | 1db5579 | 2020-11-05 17:20:35 +0100 | [diff] [blame] | 5 | version 2.4 |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 6 | willy tarreau |
Willy Tarreau | 4d71176 | 2020-12-21 11:54:56 +0100 | [diff] [blame] | 7 | 2020/12/21 |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 8 | |
| 9 | |
| 10 | This document covers the configuration language as implemented in the version |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11 | specified above. It does not provide any hints, examples, or advice. For such |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12 | documentation, please refer to the Reference Manual or the Architecture Manual. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13 | The summary below is meant to help you find sections by name and navigate |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14 | through the document. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 16 | Note to documentation contributors : |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 17 | This document is formatted with 80 columns per line, with even number of |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 18 | spaces for indentation and without tabs. Please follow these rules strictly |
| 19 | so that it remains easily printable everywhere. If a line needs to be |
| 20 | printed verbatim and does not fit, please end each line with a backslash |
Willy Tarreau | 62a36c4 | 2010-08-17 15:53:10 +0200 | [diff] [blame] | 21 | ('\') and continue on next line, indented by two characters. It is also |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 22 | sometimes useful to prefix all output lines (logs, console outputs) with 3 |
| 23 | closing angle brackets ('>>>') in order to emphasize the difference between |
| 24 | inputs and outputs when they may be ambiguous. If you add sections, |
Willy Tarreau | 62a36c4 | 2010-08-17 15:53:10 +0200 | [diff] [blame] | 25 | please update the summary below for easier searching. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 26 | |
| 27 | |
| 28 | Summary |
| 29 | ------- |
| 30 | |
| 31 | 1. Quick reminder about HTTP |
| 32 | 1.1. The HTTP transaction model |
| 33 | 1.2. HTTP request |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 34 | 1.2.1. The request line |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 35 | 1.2.2. The request headers |
| 36 | 1.3. HTTP response |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 37 | 1.3.1. The response line |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 38 | 1.3.2. The response headers |
| 39 | |
| 40 | 2. Configuring HAProxy |
| 41 | 2.1. Configuration file format |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 42 | 2.2. Quoting and escaping |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 43 | 2.3. Environment variables |
| 44 | 2.4. Time format |
| 45 | 2.5. Examples |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 46 | |
| 47 | 3. Global parameters |
| 48 | 3.1. Process management and security |
| 49 | 3.2. Performance tuning |
| 50 | 3.3. Debugging |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 51 | 3.4. Userlists |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 52 | 3.5. Peers |
Cyril Bonté | 307ee1e | 2015-09-28 23:16:06 +0200 | [diff] [blame] | 53 | 3.6. Mailers |
William Lallemand | c951552 | 2019-06-12 16:32:11 +0200 | [diff] [blame] | 54 | 3.7. Programs |
Christopher Faulet | 76edc0f | 2020-01-13 15:52:01 +0100 | [diff] [blame] | 55 | 3.8. HTTP-errors |
Emeric Brun | 99c453d | 2020-05-25 15:01:04 +0200 | [diff] [blame] | 56 | 3.9. Rings |
William Lallemand | 0217b7b | 2020-11-18 10:41:24 +0100 | [diff] [blame] | 57 | 3.10. Log forwarding |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 58 | |
| 59 | 4. Proxies |
| 60 | 4.1. Proxy keywords matrix |
| 61 | 4.2. Alphabetically sorted keywords reference |
| 62 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 63 | 5. Bind and server options |
Willy Tarreau | 086fbf5 | 2012-09-24 20:34:51 +0200 | [diff] [blame] | 64 | 5.1. Bind options |
| 65 | 5.2. Server and default-server options |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 66 | 5.3. Server DNS resolution |
| 67 | 5.3.1. Global overview |
| 68 | 5.3.2. The resolvers section |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 69 | |
Julien Pivotto | 6ccee41 | 2019-11-27 15:49:54 +0100 | [diff] [blame] | 70 | 6. Cache |
| 71 | 6.1. Limitation |
| 72 | 6.2. Setup |
| 73 | 6.2.1. Cache section |
| 74 | 6.2.2. Proxy section |
| 75 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 76 | 7. Using ACLs and fetching samples |
| 77 | 7.1. ACL basics |
| 78 | 7.1.1. Matching booleans |
| 79 | 7.1.2. Matching integers |
| 80 | 7.1.3. Matching strings |
| 81 | 7.1.4. Matching regular expressions (regexes) |
| 82 | 7.1.5. Matching arbitrary data blocks |
| 83 | 7.1.6. Matching IPv4 and IPv6 addresses |
| 84 | 7.2. Using ACLs to form conditions |
| 85 | 7.3. Fetching samples |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 86 | 7.3.1. Converters |
| 87 | 7.3.2. Fetching samples from internal states |
| 88 | 7.3.3. Fetching samples at Layer 4 |
| 89 | 7.3.4. Fetching samples at Layer 5 |
| 90 | 7.3.5. Fetching samples from buffer contents (Layer 6) |
| 91 | 7.3.6. Fetching HTTP samples (Layer 7) |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 92 | 7.3.7. Fetching samples for developers |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 93 | 7.4. Pre-defined ACLs |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 94 | |
| 95 | 8. Logging |
| 96 | 8.1. Log levels |
| 97 | 8.2. Log formats |
| 98 | 8.2.1. Default log format |
| 99 | 8.2.2. TCP log format |
| 100 | 8.2.3. HTTP log format |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 101 | 8.2.4. Custom log format |
Willy Tarreau | 5f51e1a | 2012-12-03 18:40:10 +0100 | [diff] [blame] | 102 | 8.2.5. Error log format |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 103 | 8.3. Advanced logging options |
| 104 | 8.3.1. Disabling logging of external tests |
| 105 | 8.3.2. Logging before waiting for the session to terminate |
| 106 | 8.3.3. Raising log level upon errors |
| 107 | 8.3.4. Disabling logging of successful connections |
| 108 | 8.4. Timing events |
| 109 | 8.5. Session state at disconnection |
| 110 | 8.6. Non-printable characters |
| 111 | 8.7. Capturing HTTP cookies |
| 112 | 8.8. Capturing HTTP headers |
| 113 | 8.9. Examples of logs |
| 114 | |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 115 | 9. Supported filters |
| 116 | 9.1. Trace |
| 117 | 9.2. HTTP compression |
Christopher Faulet | f7e4e7e | 2016-10-27 22:29:49 +0200 | [diff] [blame] | 118 | 9.3. Stream Processing Offload Engine (SPOE) |
Christopher Faulet | 99a17a2 | 2018-12-11 09:18:27 +0100 | [diff] [blame] | 119 | 9.4. Cache |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 120 | 9.5. fcgi-app |
Miroslav Zagorac | dc32cd9 | 2020-12-13 18:32:57 +0100 | [diff] [blame] | 121 | 9.6. OpenTracing |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 122 | |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 123 | 10. FastCGI applications |
| 124 | 10.1. Setup |
| 125 | 10.1.1. Fcgi-app section |
| 126 | 10.1.2. Proxy section |
| 127 | 10.1.3. Example |
| 128 | 10.2. Default parameters |
| 129 | 10.3. Limitations |
| 130 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 131 | |
| 132 | 1. Quick reminder about HTTP |
| 133 | ---------------------------- |
| 134 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 135 | When HAProxy is running in HTTP mode, both the request and the response are |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 136 | fully analyzed and indexed, thus it becomes possible to build matching criteria |
| 137 | on almost anything found in the contents. |
| 138 | |
| 139 | However, it is important to understand how HTTP requests and responses are |
| 140 | formed, and how HAProxy decomposes them. It will then become easier to write |
| 141 | correct rules and to debug existing configurations. |
| 142 | |
| 143 | |
| 144 | 1.1. The HTTP transaction model |
| 145 | ------------------------------- |
| 146 | |
| 147 | The HTTP protocol is transaction-driven. This means that each request will lead |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 148 | to one and only one response. Traditionally, a TCP connection is established |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 149 | from the client to the server, a request is sent by the client through the |
| 150 | connection, the server responds, and the connection is closed. A new request |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 151 | will involve a new connection : |
| 152 | |
| 153 | [CON1] [REQ1] ... [RESP1] [CLO1] [CON2] [REQ2] ... [RESP2] [CLO2] ... |
| 154 | |
| 155 | In this mode, called the "HTTP close" mode, there are as many connection |
| 156 | establishments as there are HTTP transactions. Since the connection is closed |
| 157 | by the server after the response, the client does not need to know the content |
| 158 | length. |
| 159 | |
| 160 | Due to the transactional nature of the protocol, it was possible to improve it |
| 161 | to avoid closing a connection between two subsequent transactions. In this mode |
| 162 | however, it is mandatory that the server indicates the content length for each |
| 163 | response so that the client does not wait indefinitely. For this, a special |
| 164 | header is used: "Content-length". This mode is called the "keep-alive" mode : |
| 165 | |
| 166 | [CON] [REQ1] ... [RESP1] [REQ2] ... [RESP2] [CLO] ... |
| 167 | |
| 168 | Its advantages are a reduced latency between transactions, and less processing |
| 169 | power required on the server side. It is generally better than the close mode, |
| 170 | but not always because the clients often limit their concurrent connections to |
Patrick Mezard | 9ec2ec4 | 2010-06-12 17:02:45 +0200 | [diff] [blame] | 171 | a smaller value. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 172 | |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 173 | Another improvement in the communications is the pipelining mode. It still uses |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 174 | keep-alive, but the client does not wait for the first response to send the |
| 175 | second request. This is useful for fetching large number of images composing a |
| 176 | page : |
| 177 | |
| 178 | [CON] [REQ1] [REQ2] ... [RESP1] [RESP2] [CLO] ... |
| 179 | |
| 180 | This can obviously have a tremendous benefit on performance because the network |
| 181 | latency is eliminated between subsequent requests. Many HTTP agents do not |
| 182 | correctly support pipelining since there is no way to associate a response with |
| 183 | the corresponding request in HTTP. For this reason, it is mandatory for the |
Cyril Bonté | 78caf84 | 2010-03-10 22:41:43 +0100 | [diff] [blame] | 184 | server to reply in the exact same order as the requests were received. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 185 | |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 186 | The next improvement is the multiplexed mode, as implemented in HTTP/2. This |
| 187 | time, each transaction is assigned a single stream identifier, and all streams |
| 188 | are multiplexed over an existing connection. Many requests can be sent in |
| 189 | parallel by the client, and responses can arrive in any order since they also |
| 190 | carry the stream identifier. |
| 191 | |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 192 | By default HAProxy operates in keep-alive mode with regards to persistent |
| 193 | connections: for each connection it processes each request and response, and |
| 194 | leaves the connection idle on both sides between the end of a response and the |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 195 | start of a new request. When it receives HTTP/2 connections from a client, it |
| 196 | processes all the requests in parallel and leaves the connection idling, |
| 197 | waiting for new requests, just as if it was a keep-alive HTTP connection. |
Patrick Mezard | 9ec2ec4 | 2010-06-12 17:02:45 +0200 | [diff] [blame] | 198 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 199 | HAProxy supports 4 connection modes : |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 200 | - keep alive : all requests and responses are processed (default) |
| 201 | - tunnel : only the first request and response are processed, |
Christopher Faulet | 6c9bbb2 | 2019-03-26 21:37:23 +0100 | [diff] [blame] | 202 | everything else is forwarded with no analysis (deprecated). |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 203 | - server close : the server-facing connection is closed after the response. |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 204 | - close : the connection is actively closed after end of response. |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 205 | |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 206 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 207 | |
| 208 | 1.2. HTTP request |
| 209 | ----------------- |
| 210 | |
| 211 | First, let's consider this HTTP request : |
| 212 | |
| 213 | Line Contents |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 214 | number |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 215 | 1 GET /serv/login.php?lang=en&profile=2 HTTP/1.1 |
| 216 | 2 Host: www.mydomain.com |
| 217 | 3 User-agent: my small browser |
| 218 | 4 Accept: image/jpeg, image/gif |
| 219 | 5 Accept: image/png |
| 220 | |
| 221 | |
| 222 | 1.2.1. The Request line |
| 223 | ----------------------- |
| 224 | |
| 225 | Line 1 is the "request line". It is always composed of 3 fields : |
| 226 | |
| 227 | - a METHOD : GET |
| 228 | - a URI : /serv/login.php?lang=en&profile=2 |
| 229 | - a version tag : HTTP/1.1 |
| 230 | |
| 231 | All of them are delimited by what the standard calls LWS (linear white spaces), |
| 232 | which are commonly spaces, but can also be tabs or line feeds/carriage returns |
| 233 | followed by spaces/tabs. The method itself cannot contain any colon (':') and |
| 234 | is limited to alphabetic letters. All those various combinations make it |
| 235 | desirable that HAProxy performs the splitting itself rather than leaving it to |
| 236 | the user to write a complex or inaccurate regular expression. |
| 237 | |
| 238 | The URI itself can have several forms : |
| 239 | |
| 240 | - A "relative URI" : |
| 241 | |
| 242 | /serv/login.php?lang=en&profile=2 |
| 243 | |
| 244 | It is a complete URL without the host part. This is generally what is |
| 245 | received by servers, reverse proxies and transparent proxies. |
| 246 | |
| 247 | - An "absolute URI", also called a "URL" : |
| 248 | |
| 249 | http://192.168.0.12:8080/serv/login.php?lang=en&profile=2 |
| 250 | |
| 251 | It is composed of a "scheme" (the protocol name followed by '://'), a host |
| 252 | name or address, optionally a colon (':') followed by a port number, then |
| 253 | a relative URI beginning at the first slash ('/') after the address part. |
| 254 | This is generally what proxies receive, but a server supporting HTTP/1.1 |
| 255 | must accept this form too. |
| 256 | |
| 257 | - a star ('*') : this form is only accepted in association with the OPTIONS |
| 258 | method and is not relayable. It is used to inquiry a next hop's |
| 259 | capabilities. |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 260 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 261 | - an address:port combination : 192.168.0.12:80 |
| 262 | This is used with the CONNECT method, which is used to establish TCP |
| 263 | tunnels through HTTP proxies, generally for HTTPS, but sometimes for |
| 264 | other protocols too. |
| 265 | |
| 266 | In a relative URI, two sub-parts are identified. The part before the question |
| 267 | mark is called the "path". It is typically the relative path to static objects |
| 268 | on the server. The part after the question mark is called the "query string". |
| 269 | It is mostly used with GET requests sent to dynamic scripts and is very |
| 270 | specific to the language, framework or application in use. |
| 271 | |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 272 | HTTP/2 doesn't convey a version information with the request, so the version is |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 273 | assumed to be the same as the one of the underlying protocol (i.e. "HTTP/2"). |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 274 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 275 | |
| 276 | 1.2.2. The request headers |
| 277 | -------------------------- |
| 278 | |
| 279 | The headers start at the second line. They are composed of a name at the |
| 280 | beginning of the line, immediately followed by a colon (':'). Traditionally, |
| 281 | an LWS is added after the colon but that's not required. Then come the values. |
| 282 | Multiple identical headers may be folded into one single line, delimiting the |
| 283 | values with commas, provided that their order is respected. This is commonly |
| 284 | encountered in the "Cookie:" field. A header may span over multiple lines if |
| 285 | the subsequent lines begin with an LWS. In the example in 1.2, lines 4 and 5 |
| 286 | define a total of 3 values for the "Accept:" header. |
| 287 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 288 | Contrary to a common misconception, header names are not case-sensitive, and |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 289 | their values are not either if they refer to other header names (such as the |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 290 | "Connection:" header). In HTTP/2, header names are always sent in lower case, |
Willy Tarreau | 253c251 | 2020-07-07 15:55:23 +0200 | [diff] [blame] | 291 | as can be seen when running in debug mode. Internally, all header names are |
| 292 | normalized to lower case so that HTTP/1.x and HTTP/2 use the exact same |
| 293 | representation, and they are sent as-is on the other side. This explains why an |
| 294 | HTTP/1.x request typed with camel case is delivered in lower case. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 295 | |
| 296 | The end of the headers is indicated by the first empty line. People often say |
| 297 | that it's a double line feed, which is not exact, even if a double line feed |
| 298 | is one valid form of empty line. |
| 299 | |
| 300 | Fortunately, HAProxy takes care of all these complex combinations when indexing |
| 301 | headers, checking values and counting them, so there is no reason to worry |
| 302 | about the way they could be written, but it is important not to accuse an |
| 303 | application of being buggy if it does unusual, valid things. |
| 304 | |
| 305 | Important note: |
Lukas Tribus | 2395368 | 2017-04-28 13:24:30 +0000 | [diff] [blame] | 306 | As suggested by RFC7231, HAProxy normalizes headers by replacing line breaks |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 307 | in the middle of headers by LWS in order to join multi-line headers. This |
| 308 | is necessary for proper analysis and helps less capable HTTP parsers to work |
| 309 | correctly and not to be fooled by such complex constructs. |
| 310 | |
| 311 | |
| 312 | 1.3. HTTP response |
| 313 | ------------------ |
| 314 | |
| 315 | An HTTP response looks very much like an HTTP request. Both are called HTTP |
| 316 | messages. Let's consider this HTTP response : |
| 317 | |
| 318 | Line Contents |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 319 | number |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 320 | 1 HTTP/1.1 200 OK |
| 321 | 2 Content-length: 350 |
| 322 | 3 Content-Type: text/html |
| 323 | |
Willy Tarreau | 816b979 | 2009-09-15 21:25:21 +0200 | [diff] [blame] | 324 | As a special case, HTTP supports so called "Informational responses" as status |
| 325 | codes 1xx. These messages are special in that they don't convey any part of the |
| 326 | response, they're just used as sort of a signaling message to ask a client to |
Willy Tarreau | 5843d1a | 2010-02-01 15:13:32 +0100 | [diff] [blame] | 327 | continue to post its request for instance. In the case of a status 100 response |
| 328 | the requested information will be carried by the next non-100 response message |
| 329 | following the informational one. This implies that multiple responses may be |
| 330 | sent to a single request, and that this only works when keep-alive is enabled |
| 331 | (1xx messages are HTTP/1.1 only). HAProxy handles these messages and is able to |
| 332 | correctly forward and skip them, and only process the next non-100 response. As |
| 333 | such, these messages are neither logged nor transformed, unless explicitly |
| 334 | state otherwise. Status 101 messages indicate that the protocol is changing |
| 335 | over the same connection and that haproxy must switch to tunnel mode, just as |
| 336 | if a CONNECT had occurred. Then the Upgrade header would contain additional |
| 337 | information about the type of protocol the connection is switching to. |
Willy Tarreau | 816b979 | 2009-09-15 21:25:21 +0200 | [diff] [blame] | 338 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 339 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 340 | 1.3.1. The response line |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 341 | ------------------------ |
| 342 | |
| 343 | Line 1 is the "response line". It is always composed of 3 fields : |
| 344 | |
| 345 | - a version tag : HTTP/1.1 |
| 346 | - a status code : 200 |
| 347 | - a reason : OK |
| 348 | |
| 349 | The status code is always 3-digit. The first digit indicates a general status : |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 350 | - 1xx = informational message to be skipped (e.g. 100, 101) |
| 351 | - 2xx = OK, content is following (e.g. 200, 206) |
| 352 | - 3xx = OK, no content following (e.g. 302, 304) |
| 353 | - 4xx = error caused by the client (e.g. 401, 403, 404) |
| 354 | - 5xx = error caused by the server (e.g. 500, 502, 503) |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 355 | |
Lukas Tribus | 2395368 | 2017-04-28 13:24:30 +0000 | [diff] [blame] | 356 | Please refer to RFC7231 for the detailed meaning of all such codes. The |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 357 | "reason" field is just a hint, but is not parsed by clients. Anything can be |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 358 | found there, but it's a common practice to respect the well-established |
| 359 | messages. It can be composed of one or multiple words, such as "OK", "Found", |
| 360 | or "Authentication Required". |
| 361 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 362 | HAProxy may emit the following status codes by itself : |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 363 | |
| 364 | Code When / reason |
| 365 | 200 access to stats page, and when replying to monitoring requests |
| 366 | 301 when performing a redirection, depending on the configured code |
| 367 | 302 when performing a redirection, depending on the configured code |
| 368 | 303 when performing a redirection, depending on the configured code |
Willy Tarreau | b67fdc4 | 2013-03-29 19:28:11 +0100 | [diff] [blame] | 369 | 307 when performing a redirection, depending on the configured code |
| 370 | 308 when performing a redirection, depending on the configured code |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 371 | 400 for an invalid or too large request |
| 372 | 401 when an authentication is required to perform the action (when |
| 373 | accessing the stats page) |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 374 | 403 when a request is forbidden by a "http-request deny" rule |
Florian Tham | 9205fea | 2020-01-08 13:35:30 +0100 | [diff] [blame] | 375 | 404 when the requested resource could not be found |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 376 | 408 when the request timeout strikes before the request is complete |
Florian Tham | 272e29b | 2020-01-08 10:19:05 +0100 | [diff] [blame] | 377 | 410 when the requested resource is no longer available and will not |
| 378 | be available again |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 379 | 500 when haproxy encounters an unrecoverable internal error, such as a |
| 380 | memory allocation failure, which should never happen |
| 381 | 502 when the server returns an empty, invalid or incomplete response, or |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 382 | when an "http-response deny" rule blocks the response. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 383 | 503 when no server was available to handle the request, or in response to |
| 384 | monitoring requests which match the "monitor fail" condition |
| 385 | 504 when the response timeout strikes before the server responds |
| 386 | |
| 387 | The error 4xx and 5xx codes above may be customized (see "errorloc" in section |
| 388 | 4.2). |
| 389 | |
| 390 | |
| 391 | 1.3.2. The response headers |
| 392 | --------------------------- |
| 393 | |
| 394 | Response headers work exactly like request headers, and as such, HAProxy uses |
| 395 | the same parsing function for both. Please refer to paragraph 1.2.2 for more |
| 396 | details. |
| 397 | |
| 398 | |
| 399 | 2. Configuring HAProxy |
| 400 | ---------------------- |
| 401 | |
| 402 | 2.1. Configuration file format |
| 403 | ------------------------------ |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 404 | |
| 405 | HAProxy's configuration process involves 3 major sources of parameters : |
| 406 | |
| 407 | - the arguments from the command-line, which always take precedence |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 408 | - the configuration file(s), whose format is described here |
| 409 | - the running process' environment, in case some environment variables are |
| 410 | explicitly referenced |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 411 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 412 | The configuration file follows a fairly simple hierarchical format which obey |
| 413 | a few basic rules: |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 414 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 415 | 1. a configuration file is an ordered sequence of statements |
| 416 | |
| 417 | 2. a statement is a single non-empty line before any unprotected "#" (hash) |
| 418 | |
| 419 | 3. a line is a series of tokens or "words" delimited by unprotected spaces or |
| 420 | tab characters |
| 421 | |
| 422 | 4. the first word or sequence of words of a line is one of the keywords or |
| 423 | keyword sequences listed in this document |
| 424 | |
| 425 | 5. all other words are all arguments of the first one, some being well-known |
| 426 | keywords listed in this document, others being values, references to other |
| 427 | parts of the configuration, or expressions |
| 428 | |
| 429 | 6. certain keywords delimit a section inside which only a subset of keywords |
| 430 | are supported |
| 431 | |
| 432 | 7. a section ends at the end of a file or on a special keyword starting a new |
| 433 | section |
| 434 | |
| 435 | This is all that is needed to know to write a simple but reliable configuration |
| 436 | generator, but this is not enough to reliably parse any configuration nor to |
| 437 | figure how to deal with certain corner cases. |
| 438 | |
| 439 | First, there are a few consequences of the rules above. Rule 6 and 7 imply that |
| 440 | the keywords used to define a new section are valid everywhere and cannot have |
| 441 | a different meaning in a specific section. These keywords are always a single |
| 442 | word (as opposed to a sequence of words), and traditionally the section that |
| 443 | follows them is designated using the same name. For example when speaking about |
| 444 | the "global section", it designates the section of configuration that follows |
| 445 | the "global" keyword. This usage is used a lot in error messages to help locate |
| 446 | the parts that need to be addressed. |
| 447 | |
| 448 | A number of sections create an internal object or configuration space, which |
| 449 | requires to be distinguished from other ones. In this case they will take an |
| 450 | extra word which will set the name of this particular section. For some of them |
| 451 | the section name is mandatory. For example "frontend foo" will create a new |
| 452 | section of type "frontend" named "foo". Usually a name is specific to its |
| 453 | section and two sections of different types may use the same name, but this is |
| 454 | not recommended as it tends to complexify configuration management. |
| 455 | |
| 456 | A direct consequence of rule 7 is that when multiple files are read at once, |
| 457 | each of them must start with a new section, and the end of each file will end |
| 458 | a section. A file cannot contain sub-sections nor end an existing section and |
| 459 | start a new one. |
| 460 | |
| 461 | Rule 1 mentioned that ordering matters. Indeed, some keywords create directives |
| 462 | that can be repeated multiple times to create ordered sequences of rules to be |
| 463 | applied in a certain order. For example "tcp-request" can be used to alternate |
| 464 | "accept" and "reject" rules on varying criteria. As such, a configuration file |
| 465 | processor must always preserve a section's ordering when editing a file. The |
| 466 | ordering of sections usually does not matter except for the global section |
| 467 | which must be placed before other sections, but it may be repeated if needed. |
| 468 | In addition, some automatic identifiers may automatically be assigned to some |
| 469 | of the created objects (e.g. proxies), and by reordering sections, their |
| 470 | identifiers will change. These ones appear in the statistics for example. As |
| 471 | such, the configuration below will assign "foo" ID number 1 and "bar" ID number |
| 472 | 2, which will be swapped if the two sections are reversed: |
| 473 | |
| 474 | listen foo |
| 475 | bind :80 |
| 476 | |
| 477 | listen bar |
| 478 | bind :81 |
| 479 | |
| 480 | Another important point is that according to rules 2 and 3 above, empty lines, |
| 481 | spaces, tabs, and comments following and unprotected "#" character are not part |
| 482 | of the configuration as they are just used as delimiters. This implies that the |
| 483 | following configurations are strictly equivalent: |
| 484 | |
| 485 | global#this is the global section |
| 486 | daemon#daemonize |
| 487 | frontend foo |
| 488 | mode http # or tcp |
| 489 | |
| 490 | and: |
| 491 | |
| 492 | global |
| 493 | daemon |
| 494 | |
| 495 | # this is the public web frontend |
| 496 | frontend foo |
| 497 | mode http |
| 498 | |
| 499 | The common practice is to align to the left only the keyword that initiates a |
| 500 | new section, and indent (i.e. prepend a tab character or a few spaces) all |
| 501 | other keywords so that it's instantly visible that they belong to the same |
| 502 | section (as done in the second example above). Placing comments before a new |
| 503 | section helps the reader decide if it's the desired one. Leaving a blank line |
| 504 | at the end of a section also visually helps spotting the end when editing it. |
| 505 | |
| 506 | Tabs are very convenient for indent but they do not copy-paste well. If spaces |
| 507 | are used instead, it is recommended to avoid placing too many (2 to 4) so that |
| 508 | editing in field doesn't become a burden with limited editors that do not |
| 509 | support automatic indent. |
| 510 | |
| 511 | In the early days it used to be common to see arguments split at fixed tab |
| 512 | positions because most keywords would not take more than two arguments. With |
| 513 | modern versions featuring complex expressions this practice does not stand |
| 514 | anymore, and is not recommended. |
| 515 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 516 | |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 517 | 2.2. Quoting and escaping |
| 518 | ------------------------- |
| 519 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 520 | In modern configurations, some arguments require the use of some characters |
| 521 | that were previously considered as pure delimiters. In order to make this |
| 522 | possible, HAProxy supports character escaping by prepending a backslash ('\') |
| 523 | in front of the character to be escaped, weak quoting within double quotes |
| 524 | ('"') and strong quoting within single quotes ("'"). |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 525 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 526 | This is pretty similar to what is done in a number of programming languages and |
| 527 | very close to what is commonly encountered in Bourne shell. The principle is |
| 528 | the following: while the configuration parser cuts the lines into words, it |
| 529 | also takes care of quotes and backslashes to decide whether a character is a |
| 530 | delimiter or is the raw representation of this character within the current |
| 531 | word. The escape character is then removed, the quotes are removed, and the |
| 532 | remaining word is used as-is as a keyword or argument for example. |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 533 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 534 | If a backslash is needed in a word, it must either be escaped using itself |
| 535 | (i.e. double backslash) or be strongly quoted. |
| 536 | |
| 537 | Escaping outside quotes is achieved by preceding a special character by a |
| 538 | backslash ('\'): |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 539 | |
| 540 | \ to mark a space and differentiate it from a delimiter |
| 541 | \# to mark a hash and differentiate it from a comment |
| 542 | \\ to use a backslash |
| 543 | \' to use a single quote and differentiate it from strong quoting |
| 544 | \" to use a double quote and differentiate it from weak quoting |
| 545 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 546 | In addition, a few non-printable characters may be emitted using their usual |
| 547 | C-language representation: |
| 548 | |
| 549 | \n to insert a line feed (LF, character \x0a or ASCII 10 decimal) |
| 550 | \r to insert a carriage return (CR, character \x0d or ASCII 13 decimal) |
| 551 | \t to insert a tab (character \x09 or ASCII 9 decimal) |
| 552 | \xNN to insert character having ASCII code hex NN (e.g \x0a for LF). |
| 553 | |
| 554 | Weak quoting is achieved by surrounding double quotes ("") around the character |
| 555 | or sequence of characters to protect. Weak quoting prevents the interpretation |
| 556 | of: |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 557 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 558 | space or tab as a word separator |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 559 | ' single quote as a strong quoting delimiter |
| 560 | # hash as a comment start |
| 561 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 562 | Weak quoting permits the interpretation of environment variables (which are not |
| 563 | evaluated outside of quotes) by preceding them with a dollar sign ('$'). If a |
| 564 | dollar character is needed inside double quotes, it must be escaped using a |
| 565 | backslash. |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 566 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 567 | Strong quoting is achieved by surrounding single quotes ('') around the |
| 568 | character or sequence of characters to protect. Inside single quotes, nothing |
| 569 | is interpreted, it's the efficient way to quote regular expressions. |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 570 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 571 | As a result, here is the matrix indicating how special characters can be |
| 572 | entered in different contexts (unprintable characters are replaced with their |
| 573 | name within angle brackets). Note that some characters that may only be |
| 574 | represented escaped have no possible representation inside single quotes, |
| 575 | hence the '-' there: |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 576 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 577 | Character | Unquoted | Weakly quoted | Strongly quoted |
| 578 | -----------+---------------+-----------------------------+----------------- |
| 579 | <TAB> | \<TAB>, \x09 | "<TAB>", "\<TAB>", "\x09" | '<TAB>' |
| 580 | <LF> | \n, \x0a | "\n", "\x0a" | - |
| 581 | <CR> | \r, \x0d | "\r", "\x0d" | - |
| 582 | <SPC> | \<SPC>, \x20 | "<SPC>", "\<SPC>", "\x20" | '<SPC>' |
| 583 | " | \", \x22 | "\"", "\x22" | '"' |
| 584 | # | \#, \x23 | "#", "\#", "\x23" | '#' |
| 585 | $ | $, \$, \x24 | "\$", "\x24" | '$' |
| 586 | ' | \', \x27 | "'", "\'", "\x27" | - |
| 587 | \ | \\, \x5c | "\\", "\x5c" | '\' |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 588 | |
| 589 | Example: |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 590 | # those are all strictly equivalent: |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 591 | log-format %{+Q}o\ %t\ %s\ %{-Q}r |
| 592 | log-format "%{+Q}o %t %s %{-Q}r" |
| 593 | log-format '%{+Q}o %t %s %{-Q}r' |
| 594 | log-format "%{+Q}o %t"' %s %{-Q}r' |
| 595 | log-format "%{+Q}o %t"' %s'\ %{-Q}r |
| 596 | |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 597 | There is one particular case where a second level of quoting or escaping may be |
| 598 | necessary. Some keywords take arguments within parenthesis, sometimes delimited |
| 599 | by commas. These arguments are commonly integers or predefined words, but when |
| 600 | they are arbitrary strings, it may be required to perform a separate level of |
| 601 | escaping to disambiguate the characters that belong to the argument from the |
| 602 | characters that are used to delimit the arguments themselves. A pretty common |
| 603 | case is the "regsub" converter. It takes a regular expression in argument, and |
| 604 | if a closing parenthesis is needed inside, this one will require to have its |
| 605 | own quotes. |
| 606 | |
| 607 | The keyword argument parser is exactly the same as the top-level one regarding |
| 608 | quotes, except that is will not make special cases of backslashes. But what is |
Ilya Shipitsin | 2272d8a | 2020-12-21 01:22:40 +0500 | [diff] [blame] | 609 | not always obvious is that the delimiters used inside must first be escaped or |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 610 | quoted so that they are not resolved at the top level. |
| 611 | |
| 612 | Let's take this example making use of the "regsub" converter which takes 3 |
| 613 | arguments, one regular expression, one replacement string and one set of flags: |
| 614 | |
| 615 | # replace all occurrences of "foo" with "blah" in the path: |
| 616 | http-request set-path %[path,regsub(foo,blah,g)] |
| 617 | |
| 618 | Here no special quoting was necessary. But if now we want to replace either |
| 619 | "foo" or "bar" with "blah", we'll need the regular expression "(foo|bar)". We |
| 620 | cannot write: |
| 621 | |
| 622 | http-request set-path %[path,regsub((foo|bar),blah,g)] |
| 623 | |
| 624 | because we would like the string to cut like this: |
| 625 | |
| 626 | http-request set-path %[path,regsub((foo|bar),blah,g)] |
| 627 | |---------|----|-| |
| 628 | arg1 _/ / / |
| 629 | arg2 __________/ / |
| 630 | arg3 ______________/ |
| 631 | |
| 632 | but actually what is passed is a string between the opening and closing |
| 633 | parenthesis then garbage: |
| 634 | |
| 635 | http-request set-path %[path,regsub((foo|bar),blah,g)] |
| 636 | |--------|--------| |
| 637 | arg1=(foo|bar _/ / |
| 638 | trailing garbage _________/ |
| 639 | |
| 640 | The obvious solution here seems to be that the closing parenthesis needs to be |
| 641 | quoted, but alone this will not work, because as mentioned above, quotes are |
| 642 | processed by the top-level parser which will resolve them before processing |
| 643 | this word: |
| 644 | |
| 645 | http-request set-path %[path,regsub("(foo|bar)",blah,g)] |
| 646 | ------------ -------- ---------------------------------- |
| 647 | word1 word2 word3=%[path,regsub((foo|bar),blah,g)] |
| 648 | |
| 649 | So we didn't change anything for the argument parser at the second level which |
| 650 | still sees a truncated regular expression as the only argument, and garbage at |
| 651 | the end of the string. By escaping the quotes they will be passed unmodified to |
| 652 | the second level: |
| 653 | |
| 654 | http-request set-path %[path,regsub(\"(foo|bar)\",blah,g)] |
| 655 | ------------ -------- ------------------------------------ |
| 656 | word1 word2 word3=%[path,regsub("(foo|bar)",blah,g)] |
| 657 | |---------||----|-| |
| 658 | arg1=(foo|bar) _/ / / |
| 659 | arg2=blah ___________/ / |
| 660 | arg3=g _______________/ |
| 661 | |
Ilya Shipitsin | 2272d8a | 2020-12-21 01:22:40 +0500 | [diff] [blame] | 662 | Another approach consists in using single quotes outside the whole string and |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 663 | double quotes inside (so that the double quotes are not stripped again): |
| 664 | |
| 665 | http-request set-path '%[path,regsub("(foo|bar)",blah,g)]' |
| 666 | ------------ -------- ---------------------------------- |
| 667 | word1 word2 word3=%[path,regsub("(foo|bar)",blah,g)] |
| 668 | |---------||----|-| |
| 669 | arg1=(foo|bar) _/ / / |
| 670 | arg2 ___________/ / |
| 671 | arg3 _______________/ |
| 672 | |
| 673 | When using regular expressions, it can happen that the dollar ('$') character |
| 674 | appears in the expression or that a backslash ('\') is used in the replacement |
| 675 | string. In this case these ones will also be processed inside the double quotes |
| 676 | thus single quotes are preferred (or double escaping). Example: |
| 677 | |
| 678 | http-request set-path '%[path,regsub("^/(here)(/|$)","my/\1",g)]' |
| 679 | ------------ -------- ----------------------------------------- |
| 680 | word1 word2 word3=%[path,regsub("^/(here)(/|$)","my/\1",g)] |
| 681 | |-------------| |-----||-| |
| 682 | arg1=(here)(/|$) _/ / / |
| 683 | arg2=my/\1 ________________/ / |
| 684 | arg3 ______________________/ |
| 685 | |
Ilya Shipitsin | 2272d8a | 2020-12-21 01:22:40 +0500 | [diff] [blame] | 686 | Remember that backslahes are not escape characters within single quotes and |
Willy Tarreau | 6f1129d | 2020-11-25 19:58:20 +0100 | [diff] [blame] | 687 | that the whole word3 above is already protected against them using the single |
| 688 | quotes. Conversely, if double quotes had been used around the whole expression, |
| 689 | single the dollar character and the backslashes would have been resolved at top |
| 690 | level, breaking the argument contents at the second level. |
| 691 | |
| 692 | When in doubt, simply do not use quotes anywhere, and start to place single or |
| 693 | double quotes around arguments that require a comma or a closing parenthesis, |
| 694 | and think about escaping these quotes using a backslash of the string contains |
| 695 | a dollar or a backslash. Again, this is pretty similar to what is used under |
| 696 | a Bourne shell when double-escaping a command passed to "eval". For API writers |
| 697 | the best is probably to place escaped quotes around each and every argument, |
| 698 | regardless of their contents. Users will probably find that using single quotes |
| 699 | around the whole expression and double quotes around each argument provides |
| 700 | more readable configurations. |
William Lallemand | f9873ba | 2015-05-05 17:37:14 +0200 | [diff] [blame] | 701 | |
| 702 | |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 703 | 2.3. Environment variables |
| 704 | -------------------------- |
| 705 | |
| 706 | HAProxy's configuration supports environment variables. Those variables are |
| 707 | interpreted only within double quotes. Variables are expanded during the |
| 708 | configuration parsing. Variable names must be preceded by a dollar ("$") and |
| 709 | optionally enclosed with braces ("{}") similarly to what is done in Bourne |
| 710 | shell. Variable names can contain alphanumerical characters or the character |
Amaury Denoyelle | fa41cb6 | 2020-10-01 14:32:35 +0200 | [diff] [blame] | 711 | underscore ("_") but should not start with a digit. If the variable contains a |
| 712 | list of several values separated by spaces, it can be expanded as individual |
| 713 | arguments by enclosing the variable with braces and appending the suffix '[*]' |
| 714 | before the closing brace. |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 715 | |
| 716 | Example: |
| 717 | |
| 718 | bind "fd@${FD_APP1}" |
| 719 | |
| 720 | log "${LOCAL_SYSLOG}:514" local0 notice # send to local server |
| 721 | |
| 722 | user "$HAPROXY_USER" |
| 723 | |
William Lallemand | 4d03e43 | 2019-06-14 15:35:37 +0200 | [diff] [blame] | 724 | Some variables are defined by HAProxy, they can be used in the configuration |
| 725 | file, or could be inherited by a program (See 3.7. Programs): |
William Lallemand | daf4cd2 | 2018-04-17 16:46:13 +0200 | [diff] [blame] | 726 | |
William Lallemand | 4d03e43 | 2019-06-14 15:35:37 +0200 | [diff] [blame] | 727 | * HAPROXY_LOCALPEER: defined at the startup of the process which contains the |
| 728 | name of the local peer. (See "-L" in the management guide.) |
| 729 | |
| 730 | * HAPROXY_CFGFILES: list of the configuration files loaded by HAProxy, |
| 731 | separated by semicolons. Can be useful in the case you specified a |
| 732 | directory. |
| 733 | |
| 734 | * HAPROXY_MWORKER: In master-worker mode, this variable is set to 1. |
| 735 | |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 736 | * HAPROXY_CLI: configured listeners addresses of the stats socket for every |
William Lallemand | 4d03e43 | 2019-06-14 15:35:37 +0200 | [diff] [blame] | 737 | processes, separated by semicolons. |
| 738 | |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 739 | * HAPROXY_MASTER_CLI: In master-worker mode, listeners addresses of the master |
William Lallemand | 4d03e43 | 2019-06-14 15:35:37 +0200 | [diff] [blame] | 740 | CLI, separated by semicolons. |
| 741 | |
| 742 | See also "external-check command" for other variables. |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 743 | |
| 744 | 2.4. Time format |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 745 | ---------------- |
| 746 | |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 747 | Some parameters involve values representing time, such as timeouts. These |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 748 | values are generally expressed in milliseconds (unless explicitly stated |
| 749 | otherwise) but may be expressed in any other unit by suffixing the unit to the |
| 750 | numeric value. It is important to consider this because it will not be repeated |
| 751 | for every keyword. Supported units are : |
| 752 | |
| 753 | - us : microseconds. 1 microsecond = 1/1000000 second |
| 754 | - ms : milliseconds. 1 millisecond = 1/1000 second. This is the default. |
| 755 | - s : seconds. 1s = 1000ms |
| 756 | - m : minutes. 1m = 60s = 60000ms |
| 757 | - h : hours. 1h = 60m = 3600s = 3600000ms |
| 758 | - d : days. 1d = 24h = 1440m = 86400s = 86400000ms |
| 759 | |
| 760 | |
Lukas Tribus | aa83a31 | 2017-03-21 09:25:09 +0000 | [diff] [blame] | 761 | 2.5. Examples |
Patrick Mezard | 35da19c | 2010-06-12 17:02:47 +0200 | [diff] [blame] | 762 | ------------- |
| 763 | |
| 764 | # Simple configuration for an HTTP proxy listening on port 80 on all |
| 765 | # interfaces and forwarding requests to a single backend "servers" with a |
| 766 | # single server "server1" listening on 127.0.0.1:8000 |
| 767 | global |
| 768 | daemon |
| 769 | maxconn 256 |
| 770 | |
| 771 | defaults |
| 772 | mode http |
| 773 | timeout connect 5000ms |
| 774 | timeout client 50000ms |
| 775 | timeout server 50000ms |
| 776 | |
| 777 | frontend http-in |
| 778 | bind *:80 |
| 779 | default_backend servers |
| 780 | |
| 781 | backend servers |
| 782 | server server1 127.0.0.1:8000 maxconn 32 |
| 783 | |
| 784 | |
| 785 | # The same configuration defined with a single listen block. Shorter but |
| 786 | # less expressive, especially in HTTP mode. |
| 787 | global |
| 788 | daemon |
| 789 | maxconn 256 |
| 790 | |
| 791 | defaults |
| 792 | mode http |
| 793 | timeout connect 5000ms |
| 794 | timeout client 50000ms |
| 795 | timeout server 50000ms |
| 796 | |
| 797 | listen http-in |
| 798 | bind *:80 |
| 799 | server server1 127.0.0.1:8000 maxconn 32 |
| 800 | |
| 801 | |
| 802 | Assuming haproxy is in $PATH, test these configurations in a shell with: |
| 803 | |
Willy Tarreau | ccb289d | 2010-12-11 20:19:38 +0100 | [diff] [blame] | 804 | $ sudo haproxy -f configuration.conf -c |
Patrick Mezard | 35da19c | 2010-06-12 17:02:47 +0200 | [diff] [blame] | 805 | |
| 806 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 807 | 3. Global parameters |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 808 | -------------------- |
| 809 | |
| 810 | Parameters in the "global" section are process-wide and often OS-specific. They |
| 811 | are generally set once for all and do not need being changed once correct. Some |
| 812 | of them have command-line equivalents. |
| 813 | |
| 814 | The following keywords are supported in the "global" section : |
| 815 | |
| 816 | * Process management and security |
Emeric Brun | c8e8d12 | 2012-10-02 18:42:10 +0200 | [diff] [blame] | 817 | - ca-base |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 818 | - chroot |
Emeric Brun | c8e8d12 | 2012-10-02 18:42:10 +0200 | [diff] [blame] | 819 | - crt-base |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 820 | - cpu-map |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 821 | - daemon |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 822 | - description |
| 823 | - deviceatlas-json-file |
| 824 | - deviceatlas-log-level |
| 825 | - deviceatlas-separator |
| 826 | - deviceatlas-properties-cookie |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 827 | - external-check |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 828 | - gid |
| 829 | - group |
Cyril Bonté | 203ec5a | 2017-03-23 22:44:13 +0100 | [diff] [blame] | 830 | - hard-stop-after |
Christopher Faulet | 98fbe95 | 2019-07-22 16:18:24 +0200 | [diff] [blame] | 831 | - h1-case-adjust |
| 832 | - h1-case-adjust-file |
Willy Tarreau | d96f112 | 2019-12-03 07:07:36 +0100 | [diff] [blame] | 833 | - insecure-fork-wanted |
Willy Tarreau | a45a8b5 | 2019-12-06 16:31:45 +0100 | [diff] [blame] | 834 | - insecure-setuid-wanted |
Emmanuel Hocdet | 70df7bf | 2019-01-04 11:08:20 +0100 | [diff] [blame] | 835 | - issuers-chain-path |
Dragan Dosen | 13cd54c | 2020-06-18 18:24:05 +0200 | [diff] [blame] | 836 | - localpeer |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 837 | - log |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 838 | - log-tag |
Joe Williams | df5b38f | 2010-12-29 17:05:48 +0100 | [diff] [blame] | 839 | - log-send-hostname |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 840 | - lua-load |
Thierry Fournier | 59f11be | 2020-11-29 00:37:41 +0100 | [diff] [blame] | 841 | - lua-load-per-thread |
Tim Duesterhus | dd74b5f | 2020-01-12 13:55:40 +0100 | [diff] [blame] | 842 | - lua-prepend-path |
William Lallemand | 27edc4b | 2019-05-07 17:49:33 +0200 | [diff] [blame] | 843 | - mworker-max-reloads |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 844 | - nbproc |
Christopher Faulet | be0faa2 | 2017-08-29 15:37:10 +0200 | [diff] [blame] | 845 | - nbthread |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 846 | - node |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 847 | - pidfile |
Willy Tarreau | 119e50e | 2020-05-22 13:53:29 +0200 | [diff] [blame] | 848 | - pp2-never-send-local |
Willy Tarreau | 1d54972 | 2016-02-16 12:41:57 +0100 | [diff] [blame] | 849 | - presetenv |
| 850 | - resetenv |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 851 | - uid |
| 852 | - ulimit-n |
| 853 | - user |
Willy Tarreau | 636848a | 2019-04-15 19:38:50 +0200 | [diff] [blame] | 854 | - set-dumpable |
Willy Tarreau | 1d54972 | 2016-02-16 12:41:57 +0100 | [diff] [blame] | 855 | - setenv |
Willy Tarreau | fbee713 | 2007-10-18 13:53:22 +0200 | [diff] [blame] | 856 | - stats |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 857 | - ssl-default-bind-ciphers |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 858 | - ssl-default-bind-ciphersuites |
Jerome Magnin | b203ff6 | 2020-04-03 15:28:22 +0200 | [diff] [blame] | 859 | - ssl-default-bind-curves |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 860 | - ssl-default-bind-options |
| 861 | - ssl-default-server-ciphers |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 862 | - ssl-default-server-ciphersuites |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 863 | - ssl-default-server-options |
| 864 | - ssl-dh-param-file |
Emeric Brun | 850efd5 | 2014-01-29 12:24:34 +0100 | [diff] [blame] | 865 | - ssl-server-verify |
Emmanuel Hocdet | c3b7e74 | 2020-04-22 11:06:19 +0200 | [diff] [blame] | 866 | - ssl-skip-self-issued-ca |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 867 | - unix-bind |
Willy Tarreau | 1d54972 | 2016-02-16 12:41:57 +0100 | [diff] [blame] | 868 | - unsetenv |
Thomas Holmes | db04f19 | 2015-05-18 13:21:39 +0100 | [diff] [blame] | 869 | - 51degrees-data-file |
| 870 | - 51degrees-property-name-list |
Dragan Dosen | 93b38d9 | 2015-06-29 16:43:25 +0200 | [diff] [blame] | 871 | - 51degrees-property-separator |
Dragan Dosen | ae6d39a | 2015-06-29 16:43:27 +0200 | [diff] [blame] | 872 | - 51degrees-cache-size |
Willy Tarreau | b3cc9f2 | 2019-04-19 16:03:32 +0200 | [diff] [blame] | 873 | - wurfl-data-file |
| 874 | - wurfl-information-list |
| 875 | - wurfl-information-list-separator |
Willy Tarreau | b3cc9f2 | 2019-04-19 16:03:32 +0200 | [diff] [blame] | 876 | - wurfl-cache-size |
William Dauchy | 0fec3ab | 2019-10-27 20:08:11 +0100 | [diff] [blame] | 877 | - strict-limits |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 878 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 879 | * Performance tuning |
William Dauchy | 0a8824f | 2019-10-27 20:08:09 +0100 | [diff] [blame] | 880 | - busy-polling |
Willy Tarreau | 1746eec | 2014-04-25 10:46:47 +0200 | [diff] [blame] | 881 | - max-spread-checks |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 882 | - maxconn |
Willy Tarreau | 81c25d0 | 2011-09-07 15:17:21 +0200 | [diff] [blame] | 883 | - maxconnrate |
William Lallemand | d85f917 | 2012-11-09 17:05:39 +0100 | [diff] [blame] | 884 | - maxcomprate |
William Lallemand | 072a2bf | 2012-11-20 17:01:01 +0100 | [diff] [blame] | 885 | - maxcompcpuusage |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 886 | - maxpipes |
Willy Tarreau | 93e7c00 | 2013-10-07 18:51:07 +0200 | [diff] [blame] | 887 | - maxsessrate |
Willy Tarreau | 403edff | 2012-09-06 11:58:37 +0200 | [diff] [blame] | 888 | - maxsslconn |
Willy Tarreau | e43d532 | 2013-10-07 20:01:52 +0200 | [diff] [blame] | 889 | - maxsslrate |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 890 | - maxzlibmem |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 891 | - noepoll |
| 892 | - nokqueue |
Emmanuel Hocdet | 0ba4f48 | 2019-04-08 16:53:32 +0000 | [diff] [blame] | 893 | - noevports |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 894 | - nopoll |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 895 | - nosplice |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 896 | - nogetaddrinfo |
Lukas Tribus | a0bcbdc | 2016-09-12 21:42:20 +0000 | [diff] [blame] | 897 | - noreuseport |
Willy Tarreau | 75c62c2 | 2018-11-22 11:02:09 +0100 | [diff] [blame] | 898 | - profiling.tasks |
Willy Tarreau | fe255b7 | 2007-10-14 23:09:26 +0200 | [diff] [blame] | 899 | - spread-checks |
Baptiste Assmann | 5626f48 | 2015-08-23 10:00:10 +0200 | [diff] [blame] | 900 | - server-state-base |
Baptiste Assmann | ef1f0fc | 2015-08-23 10:06:39 +0200 | [diff] [blame] | 901 | - server-state-file |
Grant Zhang | 872f9c2 | 2017-01-21 01:10:18 +0000 | [diff] [blame] | 902 | - ssl-engine |
Grant Zhang | fa6c7ee | 2017-01-14 01:42:15 +0000 | [diff] [blame] | 903 | - ssl-mode-async |
Baptiste Assmann | 3493d0f | 2015-10-12 20:21:23 +0200 | [diff] [blame] | 904 | - tune.buffers.limit |
| 905 | - tune.buffers.reserve |
Willy Tarreau | 27a674e | 2009-08-17 07:23:33 +0200 | [diff] [blame] | 906 | - tune.bufsize |
Willy Tarreau | 43961d5 | 2010-10-04 20:39:20 +0200 | [diff] [blame] | 907 | - tune.chksize |
William Lallemand | f374783 | 2012-11-09 12:33:10 +0100 | [diff] [blame] | 908 | - tune.comp.maxlevel |
Willy Tarreau | bc52bec | 2020-06-18 08:58:47 +0200 | [diff] [blame] | 909 | - tune.fd.edge-triggered |
Willy Tarreau | fe20e5b | 2017-07-27 11:42:14 +0200 | [diff] [blame] | 910 | - tune.h2.header-table-size |
Willy Tarreau | e6baec0 | 2017-07-27 11:45:11 +0200 | [diff] [blame] | 911 | - tune.h2.initial-window-size |
Willy Tarreau | 5242ef8 | 2017-07-27 11:47:28 +0200 | [diff] [blame] | 912 | - tune.h2.max-concurrent-streams |
Willy Tarreau | 193b8c6 | 2012-11-22 00:17:38 +0100 | [diff] [blame] | 913 | - tune.http.cookielen |
Stéphane Cottin | 23e9e93 | 2017-05-18 08:58:41 +0200 | [diff] [blame] | 914 | - tune.http.logurilen |
Willy Tarreau | ac1932d | 2011-10-24 19:14:41 +0200 | [diff] [blame] | 915 | - tune.http.maxhdr |
Willy Tarreau | 76cc699 | 2020-07-01 18:49:24 +0200 | [diff] [blame] | 916 | - tune.idle-pool.shared |
Willy Tarreau | 7e31273 | 2014-02-12 16:35:14 +0100 | [diff] [blame] | 917 | - tune.idletimer |
Thierry FOURNIER | 90da191 | 2015-03-05 11:17:06 +0100 | [diff] [blame] | 918 | - tune.lua.forced-yield |
Willy Tarreau | 32f61e2 | 2015-03-18 17:54:59 +0100 | [diff] [blame] | 919 | - tune.lua.maxmem |
Thierry FOURNIER | 90da191 | 2015-03-05 11:17:06 +0100 | [diff] [blame] | 920 | - tune.lua.session-timeout |
| 921 | - tune.lua.task-timeout |
Thierry FOURNIER | 7dd784b | 2015-10-01 14:49:33 +0200 | [diff] [blame] | 922 | - tune.lua.service-timeout |
Willy Tarreau | a0250ba | 2008-01-06 11:22:57 +0100 | [diff] [blame] | 923 | - tune.maxaccept |
| 924 | - tune.maxpollevents |
Willy Tarreau | 27a674e | 2009-08-17 07:23:33 +0200 | [diff] [blame] | 925 | - tune.maxrewrite |
Willy Tarreau | f3045d2 | 2015-04-29 16:24:50 +0200 | [diff] [blame] | 926 | - tune.pattern.cache-size |
Willy Tarreau | bd9a0a7 | 2011-10-23 21:14:29 +0200 | [diff] [blame] | 927 | - tune.pipesize |
Willy Tarreau | a8e2d97 | 2020-07-01 18:27:16 +0200 | [diff] [blame] | 928 | - tune.pool-high-fd-ratio |
| 929 | - tune.pool-low-fd-ratio |
Willy Tarreau | e803de2 | 2010-01-21 17:43:04 +0100 | [diff] [blame] | 930 | - tune.rcvbuf.client |
| 931 | - tune.rcvbuf.server |
Willy Tarreau | b22fc30 | 2015-12-14 12:04:35 +0100 | [diff] [blame] | 932 | - tune.recv_enough |
Olivier Houchard | 1599b80 | 2018-05-24 18:59:04 +0200 | [diff] [blame] | 933 | - tune.runqueue-depth |
Willy Tarreau | e7723bd | 2020-06-24 11:11:02 +0200 | [diff] [blame] | 934 | - tune.sched.low-latency |
Willy Tarreau | e803de2 | 2010-01-21 17:43:04 +0100 | [diff] [blame] | 935 | - tune.sndbuf.client |
| 936 | - tune.sndbuf.server |
Willy Tarreau | 6ec58db | 2012-11-16 16:32:15 +0100 | [diff] [blame] | 937 | - tune.ssl.cachesize |
William Lallemand | 7d42ef5 | 2020-07-06 11:41:30 +0200 | [diff] [blame] | 938 | - tune.ssl.keylog |
Willy Tarreau | bfd5946 | 2013-02-21 07:46:09 +0100 | [diff] [blame] | 939 | - tune.ssl.lifetime |
Emeric Brun | 8dc6039 | 2014-05-09 13:52:00 +0200 | [diff] [blame] | 940 | - tune.ssl.force-private-cache |
Willy Tarreau | bfd5946 | 2013-02-21 07:46:09 +0100 | [diff] [blame] | 941 | - tune.ssl.maxrecord |
Remi Gacogne | f46cd6e | 2014-06-12 14:58:40 +0200 | [diff] [blame] | 942 | - tune.ssl.default-dh-param |
Christopher Faulet | 31af49d | 2015-06-09 17:29:50 +0200 | [diff] [blame] | 943 | - tune.ssl.ssl-ctx-cache-size |
Thierry FOURNIER | 5bf7732 | 2017-02-25 12:45:22 +0100 | [diff] [blame] | 944 | - tune.ssl.capture-cipherlist-size |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 945 | - tune.vars.global-max-size |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 946 | - tune.vars.proc-max-size |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 947 | - tune.vars.reqres-max-size |
| 948 | - tune.vars.sess-max-size |
| 949 | - tune.vars.txn-max-size |
William Lallemand | a509e4c | 2012-11-07 16:54:34 +0100 | [diff] [blame] | 950 | - tune.zlib.memlevel |
| 951 | - tune.zlib.windowsize |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 952 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 953 | * Debugging |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 954 | - quiet |
Willy Tarreau | 3eb10b8 | 2020-04-15 16:42:39 +0200 | [diff] [blame] | 955 | - zero-warning |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 956 | |
| 957 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 958 | 3.1. Process management and security |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 959 | ------------------------------------ |
| 960 | |
Emeric Brun | c8e8d12 | 2012-10-02 18:42:10 +0200 | [diff] [blame] | 961 | ca-base <dir> |
| 962 | Assigns a default directory to fetch SSL CA certificates and CRLs from when a |
Emmanuel Hocdet | 842e94e | 2019-12-16 16:39:17 +0100 | [diff] [blame] | 963 | relative path is used with "ca-file", "ca-verify-file" or "crl-file" |
| 964 | directives. Absolute locations specified in "ca-file", "ca-verify-file" and |
| 965 | "crl-file" prevail and ignore "ca-base". |
Emeric Brun | c8e8d12 | 2012-10-02 18:42:10 +0200 | [diff] [blame] | 966 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 967 | chroot <jail dir> |
| 968 | Changes current directory to <jail dir> and performs a chroot() there before |
| 969 | dropping privileges. This increases the security level in case an unknown |
| 970 | vulnerability would be exploited, since it would make it very hard for the |
| 971 | attacker to exploit the system. This only works when the process is started |
| 972 | with superuser privileges. It is important to ensure that <jail_dir> is both |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 973 | empty and non-writable to anyone. |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 974 | |
Christopher Faulet | cb6a945 | 2017-11-22 16:50:41 +0100 | [diff] [blame] | 975 | cpu-map [auto:]<process-set>[/<thread-set>] <cpu-set>... |
| 976 | On Linux 2.6 and above, it is possible to bind a process or a thread to a |
| 977 | specific CPU set. This means that the process or the thread will never run on |
| 978 | other CPUs. The "cpu-map" directive specifies CPU sets for process or thread |
| 979 | sets. The first argument is a process set, eventually followed by a thread |
| 980 | set. These sets have the format |
| 981 | |
| 982 | all | odd | even | number[-[number]] |
| 983 | |
| 984 | <number>> must be a number between 1 and 32 or 64, depending on the machine's |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 985 | word size. Any process IDs above nbproc and any thread IDs above nbthread are |
Christopher Faulet | cb6a945 | 2017-11-22 16:50:41 +0100 | [diff] [blame] | 986 | ignored. It is possible to specify a range with two such number delimited by |
| 987 | a dash ('-'). It also is possible to specify all processes at once using |
Christopher Faulet | 1dcb9cb | 2017-11-22 10:24:40 +0100 | [diff] [blame] | 988 | "all", only odd numbers using "odd" or even numbers using "even", just like |
| 989 | with the "bind-process" directive. The second and forthcoming arguments are |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 990 | CPU sets. Each CPU set is either a unique number between 0 and 31 or 63 or a |
Christopher Faulet | 1dcb9cb | 2017-11-22 10:24:40 +0100 | [diff] [blame] | 991 | range with two such numbers delimited by a dash ('-'). Multiple CPU numbers |
Christopher Faulet | cb6a945 | 2017-11-22 16:50:41 +0100 | [diff] [blame] | 992 | or ranges may be specified, and the processes or threads will be allowed to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 993 | bind to all of them. Obviously, multiple "cpu-map" directives may be |
Christopher Faulet | cb6a945 | 2017-11-22 16:50:41 +0100 | [diff] [blame] | 994 | specified. Each "cpu-map" directive will replace the previous ones when they |
| 995 | overlap. A thread will be bound on the intersection of its mapping and the |
| 996 | one of the process on which it is attached. If the intersection is null, no |
| 997 | specific binding will be set for the thread. |
Willy Tarreau | fc6c032 | 2012-11-16 16:12:27 +0100 | [diff] [blame] | 998 | |
Christopher Faulet | ff4121f | 2017-11-22 16:38:49 +0100 | [diff] [blame] | 999 | Ranges can be partially defined. The higher bound can be omitted. In such |
| 1000 | case, it is replaced by the corresponding maximum value, 32 or 64 depending |
| 1001 | on the machine's word size. |
| 1002 | |
Christopher Faulet | 26028f6 | 2017-11-22 15:01:51 +0100 | [diff] [blame] | 1003 | The prefix "auto:" can be added before the process set to let HAProxy |
Christopher Faulet | cb6a945 | 2017-11-22 16:50:41 +0100 | [diff] [blame] | 1004 | automatically bind a process or a thread to a CPU by incrementing |
| 1005 | process/thread and CPU sets. To be valid, both sets must have the same |
| 1006 | size. No matter the declaration order of the CPU sets, it will be bound from |
| 1007 | the lowest to the highest bound. Having a process and a thread range with the |
| 1008 | "auto:" prefix is not supported. Only one range is supported, the other one |
| 1009 | must be a fixed number. |
Christopher Faulet | 26028f6 | 2017-11-22 15:01:51 +0100 | [diff] [blame] | 1010 | |
| 1011 | Examples: |
Christopher Faulet | cb6a945 | 2017-11-22 16:50:41 +0100 | [diff] [blame] | 1012 | cpu-map 1-4 0-3 # bind processes 1 to 4 on the first 4 CPUs |
| 1013 | |
| 1014 | cpu-map 1/all 0-3 # bind all threads of the first process on the |
| 1015 | # first 4 CPUs |
| 1016 | |
| 1017 | cpu-map 1- 0- # will be replaced by "cpu-map 1-64 0-63" |
| 1018 | # or "cpu-map 1-32 0-31" depending on the machine's |
| 1019 | # word size. |
| 1020 | |
Christopher Faulet | 26028f6 | 2017-11-22 15:01:51 +0100 | [diff] [blame] | 1021 | # all these lines bind the process 1 to the cpu 0, the process 2 to cpu 1 |
Christopher Faulet | cb6a945 | 2017-11-22 16:50:41 +0100 | [diff] [blame] | 1022 | # and so on. |
Christopher Faulet | 26028f6 | 2017-11-22 15:01:51 +0100 | [diff] [blame] | 1023 | cpu-map auto:1-4 0-3 |
| 1024 | cpu-map auto:1-4 0-1 2-3 |
| 1025 | cpu-map auto:1-4 3 2 1 0 |
| 1026 | |
Christopher Faulet | cb6a945 | 2017-11-22 16:50:41 +0100 | [diff] [blame] | 1027 | # all these lines bind the thread 1 to the cpu 0, the thread 2 to cpu 1 |
| 1028 | # and so on. |
| 1029 | cpu-map auto:1/1-4 0-3 |
| 1030 | cpu-map auto:1/1-4 0-1 2-3 |
| 1031 | cpu-map auto:1/1-4 3 2 1 0 |
| 1032 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1033 | # bind each process to exactly one CPU using all/odd/even keyword |
Christopher Faulet | 26028f6 | 2017-11-22 15:01:51 +0100 | [diff] [blame] | 1034 | cpu-map auto:all 0-63 |
| 1035 | cpu-map auto:even 0-31 |
| 1036 | cpu-map auto:odd 32-63 |
| 1037 | |
| 1038 | # invalid cpu-map because process and CPU sets have different sizes. |
| 1039 | cpu-map auto:1-4 0 # invalid |
| 1040 | cpu-map auto:1 0-3 # invalid |
| 1041 | |
Christopher Faulet | cb6a945 | 2017-11-22 16:50:41 +0100 | [diff] [blame] | 1042 | # invalid cpu-map because automatic binding is used with a process range |
| 1043 | # and a thread range. |
| 1044 | cpu-map auto:all/all 0 # invalid |
| 1045 | cpu-map auto:all/1-4 0 # invalid |
| 1046 | cpu-map auto:1-4/all 0 # invalid |
| 1047 | |
Emeric Brun | c8e8d12 | 2012-10-02 18:42:10 +0200 | [diff] [blame] | 1048 | crt-base <dir> |
| 1049 | Assigns a default directory to fetch SSL certificates from when a relative |
William Dauchy | 238ea3b | 2020-01-11 13:09:12 +0100 | [diff] [blame] | 1050 | path is used with "crtfile" or "crt" directives. Absolute locations specified |
| 1051 | prevail and ignore "crt-base". |
Emeric Brun | c8e8d12 | 2012-10-02 18:42:10 +0200 | [diff] [blame] | 1052 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1053 | daemon |
| 1054 | Makes the process fork into background. This is the recommended mode of |
| 1055 | operation. It is equivalent to the command line "-D" argument. It can be |
Lukas Tribus | f46bf95 | 2017-11-21 12:39:34 +0100 | [diff] [blame] | 1056 | disabled by the command line "-db" argument. This option is ignored in |
| 1057 | systemd mode. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1058 | |
David Carlier | 8167f30 | 2015-06-01 13:50:06 +0200 | [diff] [blame] | 1059 | deviceatlas-json-file <path> |
| 1060 | Sets the path of the DeviceAtlas JSON data file to be loaded by the API. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1061 | The path must be a valid JSON data file and accessible by HAProxy process. |
David Carlier | 8167f30 | 2015-06-01 13:50:06 +0200 | [diff] [blame] | 1062 | |
| 1063 | deviceatlas-log-level <value> |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1064 | Sets the level of information returned by the API. This directive is |
David Carlier | 8167f30 | 2015-06-01 13:50:06 +0200 | [diff] [blame] | 1065 | optional and set to 0 by default if not set. |
| 1066 | |
| 1067 | deviceatlas-separator <char> |
| 1068 | Sets the character separator for the API properties results. This directive |
| 1069 | is optional and set to | by default if not set. |
| 1070 | |
Cyril Bonté | 0306c4a | 2015-10-26 22:37:38 +0100 | [diff] [blame] | 1071 | deviceatlas-properties-cookie <name> |
Cyril Bonté | 307ee1e | 2015-09-28 23:16:06 +0200 | [diff] [blame] | 1072 | Sets the client cookie's name used for the detection if the DeviceAtlas |
| 1073 | Client-side component was used during the request. This directive is optional |
| 1074 | and set to DAPROPS by default if not set. |
David Carlier | 29b3ca3 | 2015-09-25 14:09:21 +0100 | [diff] [blame] | 1075 | |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 1076 | external-check |
Willy Tarreau | d96f112 | 2019-12-03 07:07:36 +0100 | [diff] [blame] | 1077 | Allows the use of an external agent to perform health checks. This is |
| 1078 | disabled by default as a security precaution, and even when enabled, checks |
Willy Tarreau | a45a8b5 | 2019-12-06 16:31:45 +0100 | [diff] [blame] | 1079 | may still fail unless "insecure-fork-wanted" is enabled as well. If the |
| 1080 | program launched makes use of a setuid executable (it should really not), |
| 1081 | you may also need to set "insecure-setuid-wanted" in the global section. |
| 1082 | See "option external-check", and "insecure-fork-wanted", and |
| 1083 | "insecure-setuid-wanted". |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 1084 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1085 | gid <number> |
| 1086 | Changes the process' group ID to <number>. It is recommended that the group |
| 1087 | ID is dedicated to HAProxy or to a small set of similar daemons. HAProxy must |
| 1088 | be started with a user belonging to this group, or with superuser privileges. |
Michael Scherer | ab012dd | 2013-01-12 18:35:19 +0100 | [diff] [blame] | 1089 | Note that if haproxy is started from a user having supplementary groups, it |
| 1090 | will only be able to drop these groups if started with superuser privileges. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1091 | See also "group" and "uid". |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 1092 | |
Willy Tarreau | 11770ce | 2019-12-03 08:29:22 +0100 | [diff] [blame] | 1093 | group <group name> |
| 1094 | Similar to "gid" but uses the GID of group name <group name> from /etc/group. |
| 1095 | See also "gid" and "user". |
| 1096 | |
Cyril Bonté | 203ec5a | 2017-03-23 22:44:13 +0100 | [diff] [blame] | 1097 | hard-stop-after <time> |
| 1098 | Defines the maximum time allowed to perform a clean soft-stop. |
| 1099 | |
| 1100 | Arguments : |
| 1101 | <time> is the maximum time (by default in milliseconds) for which the |
| 1102 | instance will remain alive when a soft-stop is received via the |
| 1103 | SIGUSR1 signal. |
| 1104 | |
| 1105 | This may be used to ensure that the instance will quit even if connections |
| 1106 | remain opened during a soft-stop (for example with long timeouts for a proxy |
| 1107 | in tcp mode). It applies both in TCP and HTTP mode. |
| 1108 | |
| 1109 | Example: |
| 1110 | global |
| 1111 | hard-stop-after 30s |
| 1112 | |
Christopher Faulet | 98fbe95 | 2019-07-22 16:18:24 +0200 | [diff] [blame] | 1113 | h1-case-adjust <from> <to> |
| 1114 | Defines the case adjustment to apply, when enabled, to the header name |
| 1115 | <from>, to change it to <to> before sending it to HTTP/1 clients or |
| 1116 | servers. <from> must be in lower case, and <from> and <to> must not differ |
| 1117 | except for their case. It may be repeated if several header names need to be |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 1118 | adjusted. Duplicate entries are not allowed. If a lot of header names have to |
Christopher Faulet | 98fbe95 | 2019-07-22 16:18:24 +0200 | [diff] [blame] | 1119 | be adjusted, it might be more convenient to use "h1-case-adjust-file". |
| 1120 | Please note that no transformation will be applied unless "option |
| 1121 | h1-case-adjust-bogus-client" or "option h1-case-adjust-bogus-server" is |
| 1122 | specified in a proxy. |
| 1123 | |
| 1124 | There is no standard case for header names because, as stated in RFC7230, |
| 1125 | they are case-insensitive. So applications must handle them in a case- |
| 1126 | insensitive manner. But some bogus applications violate the standards and |
| 1127 | erroneously rely on the cases most commonly used by browsers. This problem |
| 1128 | becomes critical with HTTP/2 because all header names must be exchanged in |
| 1129 | lower case, and HAProxy follows the same convention. All header names are |
| 1130 | sent in lower case to clients and servers, regardless of the HTTP version. |
| 1131 | |
| 1132 | Applications which fail to properly process requests or responses may require |
| 1133 | to temporarily use such workarounds to adjust header names sent to them for |
| 1134 | the time it takes the application to be fixed. Please note that an |
| 1135 | application which requires such workarounds might be vulnerable to content |
| 1136 | smuggling attacks and must absolutely be fixed. |
| 1137 | |
| 1138 | Example: |
| 1139 | global |
| 1140 | h1-case-adjust content-length Content-Length |
| 1141 | |
| 1142 | See "h1-case-adjust-file", "option h1-case-adjust-bogus-client" and |
| 1143 | "option h1-case-adjust-bogus-server". |
| 1144 | |
| 1145 | h1-case-adjust-file <hdrs-file> |
| 1146 | Defines a file containing a list of key/value pairs used to adjust the case |
| 1147 | of some header names before sending them to HTTP/1 clients or servers. The |
| 1148 | file <hdrs-file> must contain 2 header names per line. The first one must be |
| 1149 | in lower case and both must not differ except for their case. Lines which |
| 1150 | start with '#' are ignored, just like empty lines. Leading and trailing tabs |
| 1151 | and spaces are stripped. Duplicate entries are not allowed. Please note that |
| 1152 | no transformation will be applied unless "option h1-case-adjust-bogus-client" |
| 1153 | or "option h1-case-adjust-bogus-server" is specified in a proxy. |
| 1154 | |
| 1155 | If this directive is repeated, only the last one will be processed. It is an |
| 1156 | alternative to the directive "h1-case-adjust" if a lot of header names need |
| 1157 | to be adjusted. Please read the risks associated with using this. |
| 1158 | |
| 1159 | See "h1-case-adjust", "option h1-case-adjust-bogus-client" and |
| 1160 | "option h1-case-adjust-bogus-server". |
| 1161 | |
Willy Tarreau | d96f112 | 2019-12-03 07:07:36 +0100 | [diff] [blame] | 1162 | insecure-fork-wanted |
| 1163 | By default haproxy tries hard to prevent any thread and process creation |
| 1164 | after it starts. Doing so is particularly important when using Lua files of |
| 1165 | uncertain origin, and when experimenting with development versions which may |
| 1166 | still contain bugs whose exploitability is uncertain. And generally speaking |
| 1167 | it's good hygiene to make sure that no unexpected background activity can be |
| 1168 | triggered by traffic. But this prevents external checks from working, and may |
| 1169 | break some very specific Lua scripts which actively rely on the ability to |
| 1170 | fork. This option is there to disable this protection. Note that it is a bad |
| 1171 | idea to disable it, as a vulnerability in a library or within haproxy itself |
| 1172 | will be easier to exploit once disabled. In addition, forking from Lua or |
| 1173 | anywhere else is not reliable as the forked process may randomly embed a lock |
| 1174 | set by another thread and never manage to finish an operation. As such it is |
| 1175 | highly recommended that this option is never used and that any workload |
| 1176 | requiring such a fork be reconsidered and moved to a safer solution (such as |
| 1177 | agents instead of external checks). This option supports the "no" prefix to |
| 1178 | disable it. |
| 1179 | |
Willy Tarreau | a45a8b5 | 2019-12-06 16:31:45 +0100 | [diff] [blame] | 1180 | insecure-setuid-wanted |
| 1181 | HAProxy doesn't need to call executables at run time (except when using |
| 1182 | external checks which are strongly recommended against), and is even expected |
| 1183 | to isolate itself into an empty chroot. As such, there basically is no valid |
| 1184 | reason to allow a setuid executable to be called without the user being fully |
| 1185 | aware of the risks. In a situation where haproxy would need to call external |
| 1186 | checks and/or disable chroot, exploiting a vulnerability in a library or in |
| 1187 | haproxy itself could lead to the execution of an external program. On Linux |
| 1188 | it is possible to lock the process so that any setuid bit present on such an |
| 1189 | executable is ignored. This significantly reduces the risk of privilege |
| 1190 | escalation in such a situation. This is what haproxy does by default. In case |
| 1191 | this causes a problem to an external check (for example one which would need |
| 1192 | the "ping" command), then it is possible to disable this protection by |
| 1193 | explicitly adding this directive in the global section. If enabled, it is |
| 1194 | possible to turn it back off by prefixing it with the "no" keyword. |
| 1195 | |
Emmanuel Hocdet | 70df7bf | 2019-01-04 11:08:20 +0100 | [diff] [blame] | 1196 | issuers-chain-path <dir> |
| 1197 | Assigns a directory to load certificate chain for issuer completion. All |
| 1198 | files must be in PEM format. For certificates loaded with "crt" or "crt-list", |
| 1199 | if certificate chain is not included in PEM (also commonly known as |
| 1200 | intermediate certificate), haproxy will complete chain if the issuer of the |
| 1201 | certificate corresponds to the first certificate of the chain loaded with |
| 1202 | "issuers-chain-path". |
| 1203 | A "crt" file with PrivateKey+Certificate+IntermediateCA2+IntermediateCA1 |
| 1204 | could be replaced with PrivateKey+Certificate. HAProxy will complete the |
| 1205 | chain if a file with IntermediateCA2+IntermediateCA1 is present in |
| 1206 | "issuers-chain-path" directory. All other certificates with the same issuer |
| 1207 | will share the chain in memory. |
| 1208 | |
Dragan Dosen | 13cd54c | 2020-06-18 18:24:05 +0200 | [diff] [blame] | 1209 | localpeer <name> |
| 1210 | Sets the local instance's peer name. It will be ignored if the "-L" |
| 1211 | command line argument is specified or if used after "peers" section |
| 1212 | definitions. In such cases, a warning message will be emitted during |
| 1213 | the configuration parsing. |
| 1214 | |
| 1215 | This option will also set the HAPROXY_LOCALPEER environment variable. |
| 1216 | See also "-L" in the management guide and "peers" section below. |
| 1217 | |
Jan Wagner | 3e67860 | 2020-12-17 22:22:32 +0100 | [diff] [blame] | 1218 | log <address> [len <length>] [format <format>] [sample <ranges>:<sample_size>] |
Frédéric Lécaille | d690dfa | 2019-04-25 10:52:17 +0200 | [diff] [blame] | 1219 | <facility> [max level [min level]] |
Cyril Bonté | 3e95487 | 2018-03-20 23:30:27 +0100 | [diff] [blame] | 1220 | Adds a global syslog server. Several global servers can be defined. They |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1221 | will receive logs for starts and exits, as well as all logs from proxies |
Robert Tsai | 81ae195 | 2007-12-05 10:47:29 +0100 | [diff] [blame] | 1222 | configured with "log global". |
| 1223 | |
| 1224 | <address> can be one of: |
| 1225 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 1226 | - An IPv4 address optionally followed by a colon and a UDP port. If |
Robert Tsai | 81ae195 | 2007-12-05 10:47:29 +0100 | [diff] [blame] | 1227 | no port is specified, 514 is used by default (the standard syslog |
| 1228 | port). |
| 1229 | |
David du Colombier | 24bb5f5 | 2011-03-17 10:40:23 +0100 | [diff] [blame] | 1230 | - An IPv6 address followed by a colon and optionally a UDP port. If |
| 1231 | no port is specified, 514 is used by default (the standard syslog |
| 1232 | port). |
| 1233 | |
Willy Tarreau | 5a32ecc | 2018-11-12 07:34:59 +0100 | [diff] [blame] | 1234 | - A filesystem path to a datagram UNIX domain socket, keeping in mind |
Robert Tsai | 81ae195 | 2007-12-05 10:47:29 +0100 | [diff] [blame] | 1235 | considerations for chroot (be sure the path is accessible inside |
| 1236 | the chroot) and uid/gid (be sure the path is appropriately |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1237 | writable). |
Robert Tsai | 81ae195 | 2007-12-05 10:47:29 +0100 | [diff] [blame] | 1238 | |
Willy Tarreau | 5a32ecc | 2018-11-12 07:34:59 +0100 | [diff] [blame] | 1239 | - A file descriptor number in the form "fd@<number>", which may point |
| 1240 | to a pipe, terminal, or socket. In this case unbuffered logs are used |
| 1241 | and one writev() call per log is performed. This is a bit expensive |
| 1242 | but acceptable for most workloads. Messages sent this way will not be |
| 1243 | truncated but may be dropped, in which case the DroppedLogs counter |
| 1244 | will be incremented. The writev() call is atomic even on pipes for |
| 1245 | messages up to PIPE_BUF size, which POSIX recommends to be at least |
| 1246 | 512 and which is 4096 bytes on most modern operating systems. Any |
| 1247 | larger message may be interleaved with messages from other processes. |
| 1248 | Exceptionally for debugging purposes the file descriptor may also be |
| 1249 | directed to a file, but doing so will significantly slow haproxy down |
| 1250 | as non-blocking calls will be ignored. Also there will be no way to |
| 1251 | purge nor rotate this file without restarting the process. Note that |
| 1252 | the configured syslog format is preserved, so the output is suitable |
Willy Tarreau | c1b0645 | 2018-11-12 11:57:56 +0100 | [diff] [blame] | 1253 | for use with a TCP syslog server. See also the "short" and "raw" |
| 1254 | format below. |
Willy Tarreau | 5a32ecc | 2018-11-12 07:34:59 +0100 | [diff] [blame] | 1255 | |
| 1256 | - "stdout" / "stderr", which are respectively aliases for "fd@1" and |
| 1257 | "fd@2", see above. |
| 1258 | |
Willy Tarreau | c046d16 | 2019-08-30 15:24:59 +0200 | [diff] [blame] | 1259 | - A ring buffer in the form "ring@<name>", which will correspond to an |
| 1260 | in-memory ring buffer accessible over the CLI using the "show events" |
| 1261 | command, which will also list existing rings and their sizes. Such |
| 1262 | buffers are lost on reload or restart but when used as a complement |
| 1263 | this can help troubleshooting by having the logs instantly available. |
| 1264 | |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 1265 | You may want to reference some environment variables in the address |
| 1266 | parameter, see section 2.3 about environment variables. |
Willy Tarreau | dad36a3 | 2013-03-11 01:20:04 +0100 | [diff] [blame] | 1267 | |
Willy Tarreau | 18324f5 | 2014-06-27 18:10:07 +0200 | [diff] [blame] | 1268 | <length> is an optional maximum line length. Log lines larger than this value |
| 1269 | will be truncated before being sent. The reason is that syslog |
| 1270 | servers act differently on log line length. All servers support the |
| 1271 | default value of 1024, but some servers simply drop larger lines |
| 1272 | while others do log them. If a server supports long lines, it may |
| 1273 | make sense to set this value here in order to avoid truncating long |
| 1274 | lines. Similarly, if a server drops long lines, it is preferable to |
| 1275 | truncate them before sending them. Accepted values are 80 to 65535 |
| 1276 | inclusive. The default value of 1024 is generally fine for all |
| 1277 | standard usages. Some specific cases of long captures or |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1278 | JSON-formatted logs may require larger values. You may also need to |
| 1279 | increase "tune.http.logurilen" if your request URIs are truncated. |
Willy Tarreau | 18324f5 | 2014-06-27 18:10:07 +0200 | [diff] [blame] | 1280 | |
Dragan Dosen | 7ad3154 | 2015-09-28 17:16:47 +0200 | [diff] [blame] | 1281 | <format> is the log format used when generating syslog messages. It may be |
| 1282 | one of the following : |
| 1283 | |
Emeric Brun | 0237c4e | 2020-11-27 16:24:34 +0100 | [diff] [blame] | 1284 | local Analog to rfc3164 syslog message format except that hostname |
| 1285 | field is stripped. This is the default. |
| 1286 | Note: option "log-send-hostname" switches the default to |
| 1287 | rfc3164. |
| 1288 | |
| 1289 | rfc3164 The RFC3164 syslog message format. |
Dragan Dosen | 7ad3154 | 2015-09-28 17:16:47 +0200 | [diff] [blame] | 1290 | (https://tools.ietf.org/html/rfc3164) |
| 1291 | |
| 1292 | rfc5424 The RFC5424 syslog message format. |
| 1293 | (https://tools.ietf.org/html/rfc5424) |
| 1294 | |
Emeric Brun | 5464885 | 2020-07-06 15:54:06 +0200 | [diff] [blame] | 1295 | priority A message containing only a level plus syslog facility between |
| 1296 | angle brackets such as '<63>', followed by the text. The PID, |
| 1297 | date, time, process name and system name are omitted. This is |
| 1298 | designed to be used with a local log server. |
| 1299 | |
Willy Tarreau | e8746a0 | 2018-11-12 08:45:00 +0100 | [diff] [blame] | 1300 | short A message containing only a level between angle brackets such as |
| 1301 | '<3>', followed by the text. The PID, date, time, process name |
| 1302 | and system name are omitted. This is designed to be used with a |
| 1303 | local log server. This format is compatible with what the systemd |
| 1304 | logger consumes. |
| 1305 | |
Emeric Brun | 5464885 | 2020-07-06 15:54:06 +0200 | [diff] [blame] | 1306 | timed A message containing only a level between angle brackets such as |
| 1307 | '<3>', followed by ISO date and by the text. The PID, process |
| 1308 | name and system name are omitted. This is designed to be |
| 1309 | used with a local log server. |
| 1310 | |
| 1311 | iso A message containing only the ISO date, followed by the text. |
| 1312 | The PID, process name and system name are omitted. This is |
| 1313 | designed to be used with a local log server. |
| 1314 | |
Willy Tarreau | c1b0645 | 2018-11-12 11:57:56 +0100 | [diff] [blame] | 1315 | raw A message containing only the text. The level, PID, date, time, |
| 1316 | process name and system name are omitted. This is designed to be |
| 1317 | used in containers or during development, where the severity only |
| 1318 | depends on the file descriptor used (stdout/stderr). |
| 1319 | |
Frédéric Lécaille | d690dfa | 2019-04-25 10:52:17 +0200 | [diff] [blame] | 1320 | <ranges> A list of comma-separated ranges to identify the logs to sample. |
| 1321 | This is used to balance the load of the logs to send to the log |
| 1322 | server. The limits of the ranges cannot be null. They are numbered |
| 1323 | from 1. The size or period (in number of logs) of the sample must be |
| 1324 | set with <sample_size> parameter. |
| 1325 | |
| 1326 | <sample_size> |
| 1327 | The size of the sample in number of logs to consider when balancing |
| 1328 | their logging loads. It is used to balance the load of the logs to |
| 1329 | send to the syslog server. This size must be greater or equal to the |
| 1330 | maximum of the high limits of the ranges. |
| 1331 | (see also <ranges> parameter). |
| 1332 | |
Robert Tsai | 81ae195 | 2007-12-05 10:47:29 +0100 | [diff] [blame] | 1333 | <facility> must be one of the 24 standard syslog facilities : |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1334 | |
Willy Tarreau | e8746a0 | 2018-11-12 08:45:00 +0100 | [diff] [blame] | 1335 | kern user mail daemon auth syslog lpr news |
| 1336 | uucp cron auth2 ftp ntp audit alert cron2 |
| 1337 | local0 local1 local2 local3 local4 local5 local6 local7 |
| 1338 | |
Willy Tarreau | c1b0645 | 2018-11-12 11:57:56 +0100 | [diff] [blame] | 1339 | Note that the facility is ignored for the "short" and "raw" |
| 1340 | formats, but still required as a positional field. It is |
| 1341 | recommended to use "daemon" in this case to make it clear that |
| 1342 | it's only supposed to be used locally. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1343 | |
| 1344 | An optional level can be specified to filter outgoing messages. By default, |
Willy Tarreau | f7edefa | 2009-05-10 17:20:05 +0200 | [diff] [blame] | 1345 | all messages are sent. If a maximum level is specified, only messages with a |
| 1346 | severity at least as important as this level will be sent. An optional minimum |
| 1347 | level can be specified. If it is set, logs emitted with a more severe level |
| 1348 | than this one will be capped to this level. This is used to avoid sending |
| 1349 | "emerg" messages on all terminals on some default syslog configurations. |
| 1350 | Eight levels are known : |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1351 | |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 1352 | emerg alert crit err warning notice info debug |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1353 | |
Joe Williams | df5b38f | 2010-12-29 17:05:48 +0100 | [diff] [blame] | 1354 | log-send-hostname [<string>] |
| 1355 | Sets the hostname field in the syslog header. If optional "string" parameter |
| 1356 | is set the header is set to the string contents, otherwise uses the hostname |
| 1357 | of the system. Generally used if one is not relaying logs through an |
| 1358 | intermediate syslog server or for simply customizing the hostname printed in |
| 1359 | the logs. |
| 1360 | |
Kevinm | 48936af | 2010-12-22 16:08:21 +0000 | [diff] [blame] | 1361 | log-tag <string> |
| 1362 | Sets the tag field in the syslog header to this string. It defaults to the |
| 1363 | program name as launched from the command line, which usually is "haproxy". |
| 1364 | Sometimes it can be useful to differentiate between multiple processes |
Willy Tarreau | 094af4e | 2015-01-07 15:03:42 +0100 | [diff] [blame] | 1365 | running on the same host. See also the per-proxy "log-tag" directive. |
Kevinm | 48936af | 2010-12-22 16:08:21 +0000 | [diff] [blame] | 1366 | |
Thierry FOURNIER | 90da191 | 2015-03-05 11:17:06 +0100 | [diff] [blame] | 1367 | lua-load <file> |
Thierry Fournier | 59f11be | 2020-11-29 00:37:41 +0100 | [diff] [blame] | 1368 | This global directive loads and executes a Lua file in the shared context |
| 1369 | that is visible to all threads. Any variable set in such a context is visible |
| 1370 | from any thread. This is the easiest and recommended way to load Lua programs |
| 1371 | but it will not scale well if a lot of Lua calls are performed, as only one |
| 1372 | thread may be running on the global state at a time. A program loaded this |
| 1373 | way will always see 0 in the "core.thread" variable. This directive can be |
Thierry FOURNIER | 90da191 | 2015-03-05 11:17:06 +0100 | [diff] [blame] | 1374 | used multiple times. |
| 1375 | |
Thierry Fournier | 59f11be | 2020-11-29 00:37:41 +0100 | [diff] [blame] | 1376 | lua-load-per-thread <file> |
| 1377 | This global directive loads and executes a Lua file into each started thread. |
| 1378 | Any global variable has a thread-local visibility so that each thread could |
| 1379 | see a different value. As such it is strongly recommended not to use global |
| 1380 | variables in programs loaded this way. An independent copy is loaded and |
| 1381 | initialized for each thread, everything is done sequentially and in the |
| 1382 | thread's numeric order from 1 to nbthread. If some operations need to be |
| 1383 | performed only once, the program should check the "core.thread" variable to |
| 1384 | figure what thread is being initialized. Programs loaded this way will run |
| 1385 | concurrently on all threads and will be highly scalable. This is the |
| 1386 | recommended way to load simple functions that register sample-fetches, |
| 1387 | converters, actions or services once it is certain the program doesn't depend |
| 1388 | on global variables. For the sake of simplicity, the directive is available |
| 1389 | even if only one thread is used and even if threads are disabled (in which |
| 1390 | case it will be equivalent to lua-load). This directive can be used multiple |
| 1391 | times. |
| 1392 | |
Tim Duesterhus | dd74b5f | 2020-01-12 13:55:40 +0100 | [diff] [blame] | 1393 | lua-prepend-path <string> [<type>] |
| 1394 | Prepends the given string followed by a semicolon to Lua's package.<type> |
| 1395 | variable. |
| 1396 | <type> must either be "path" or "cpath". If <type> is not given it defaults |
| 1397 | to "path". |
| 1398 | |
| 1399 | Lua's paths are semicolon delimited lists of patterns that specify how the |
| 1400 | `require` function attempts to find the source file of a library. Question |
| 1401 | marks (?) within a pattern will be replaced by module name. The path is |
| 1402 | evaluated left to right. This implies that paths that are prepended later |
| 1403 | will be checked earlier. |
| 1404 | |
| 1405 | As an example by specifying the following path: |
| 1406 | |
| 1407 | lua-prepend-path /usr/share/haproxy-lua/?/init.lua |
| 1408 | lua-prepend-path /usr/share/haproxy-lua/?.lua |
| 1409 | |
| 1410 | When `require "example"` is being called Lua will first attempt to load the |
| 1411 | /usr/share/haproxy-lua/example.lua script, if that does not exist the |
| 1412 | /usr/share/haproxy-lua/example/init.lua will be attempted and the default |
| 1413 | paths if that does not exist either. |
| 1414 | |
| 1415 | See https://www.lua.org/pil/8.1.html for the details within the Lua |
| 1416 | documentation. |
| 1417 | |
William Lallemand | 4cfede8 | 2017-11-24 22:02:34 +0100 | [diff] [blame] | 1418 | master-worker [no-exit-on-failure] |
William Lallemand | e202b1e | 2017-06-01 17:38:56 +0200 | [diff] [blame] | 1419 | Master-worker mode. It is equivalent to the command line "-W" argument. |
| 1420 | This mode will launch a "master" which will monitor the "workers". Using |
| 1421 | this mode, you can reload HAProxy directly by sending a SIGUSR2 signal to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1422 | the master. The master-worker mode is compatible either with the foreground |
William Lallemand | e202b1e | 2017-06-01 17:38:56 +0200 | [diff] [blame] | 1423 | or daemon mode. It is recommended to use this mode with multiprocess and |
| 1424 | systemd. |
William Lallemand | 4cfede8 | 2017-11-24 22:02:34 +0100 | [diff] [blame] | 1425 | By default, if a worker exits with a bad return code, in the case of a |
| 1426 | segfault for example, all workers will be killed, and the master will leave. |
| 1427 | It is convenient to combine this behavior with Restart=on-failure in a |
| 1428 | systemd unit file in order to relaunch the whole process. If you don't want |
| 1429 | this behavior, you must use the keyword "no-exit-on-failure". |
William Lallemand | e202b1e | 2017-06-01 17:38:56 +0200 | [diff] [blame] | 1430 | |
William Lallemand | 4cfede8 | 2017-11-24 22:02:34 +0100 | [diff] [blame] | 1431 | See also "-W" in the management guide. |
William Lallemand | e202b1e | 2017-06-01 17:38:56 +0200 | [diff] [blame] | 1432 | |
William Lallemand | 27edc4b | 2019-05-07 17:49:33 +0200 | [diff] [blame] | 1433 | mworker-max-reloads <number> |
| 1434 | In master-worker mode, this option limits the number of time a worker can |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 1435 | survive to a reload. If the worker did not leave after a reload, once its |
William Lallemand | 27edc4b | 2019-05-07 17:49:33 +0200 | [diff] [blame] | 1436 | number of reloads is greater than this number, the worker will receive a |
| 1437 | SIGTERM. This option helps to keep under control the number of workers. |
| 1438 | See also "show proc" in the Management Guide. |
| 1439 | |
Willy Tarreau | f42d794 | 2020-10-20 11:54:49 +0200 | [diff] [blame] | 1440 | nbproc <number> (deprecated) |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1441 | Creates <number> processes when going daemon. This requires the "daemon" |
| 1442 | mode. By default, only one process is created, which is the recommended mode |
| 1443 | of operation. For systems limited to small sets of file descriptors per |
Willy Tarreau | 149ab77 | 2019-01-26 14:27:06 +0100 | [diff] [blame] | 1444 | process, it may be needed to fork multiple daemons. When set to a value |
| 1445 | larger than 1, threads are automatically disabled. USING MULTIPLE PROCESSES |
Willy Tarreau | f42d794 | 2020-10-20 11:54:49 +0200 | [diff] [blame] | 1446 | IS HARDER TO DEBUG AND IS REALLY DISCOURAGED. This directive is deprecated |
| 1447 | and scheduled for removal in 2.5. Please use "nbthread" instead. See also |
| 1448 | "daemon" and "nbthread". |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1449 | |
Christopher Faulet | be0faa2 | 2017-08-29 15:37:10 +0200 | [diff] [blame] | 1450 | nbthread <number> |
| 1451 | This setting is only available when support for threads was built in. It |
Willy Tarreau | 26f6ae1 | 2019-02-02 12:56:15 +0100 | [diff] [blame] | 1452 | makes haproxy run on <number> threads. This is exclusive with "nbproc". While |
| 1453 | "nbproc" historically used to be the only way to use multiple processors, it |
| 1454 | also involved a number of shortcomings related to the lack of synchronization |
| 1455 | between processes (health-checks, peers, stick-tables, stats, ...) which do |
| 1456 | not affect threads. As such, any modern configuration is strongly encouraged |
Willy Tarreau | 149ab77 | 2019-01-26 14:27:06 +0100 | [diff] [blame] | 1457 | to migrate away from "nbproc" to "nbthread". "nbthread" also works when |
| 1458 | HAProxy is started in foreground. On some platforms supporting CPU affinity, |
| 1459 | when nbproc is not used, the default "nbthread" value is automatically set to |
| 1460 | the number of CPUs the process is bound to upon startup. This means that the |
| 1461 | thread count can easily be adjusted from the calling process using commands |
| 1462 | like "taskset" or "cpuset". Otherwise, this value defaults to 1. The default |
| 1463 | value is reported in the output of "haproxy -vv". See also "nbproc". |
Christopher Faulet | be0faa2 | 2017-08-29 15:37:10 +0200 | [diff] [blame] | 1464 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1465 | pidfile <pidfile> |
MIZUTA Takeshi | c32f394 | 2020-08-26 13:46:19 +0900 | [diff] [blame] | 1466 | Writes PIDs of all daemons into file <pidfile> when daemon mode or writes PID |
| 1467 | of master process into file <pidfile> when master-worker mode. This option is |
| 1468 | equivalent to the "-p" command line argument. The file must be accessible to |
| 1469 | the user starting the process. See also "daemon" and "master-worker". |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1470 | |
Willy Tarreau | 119e50e | 2020-05-22 13:53:29 +0200 | [diff] [blame] | 1471 | pp2-never-send-local |
| 1472 | A bug in the PROXY protocol v2 implementation was present in HAProxy up to |
| 1473 | version 2.1, causing it to emit a PROXY command instead of a LOCAL command |
| 1474 | for health checks. This is particularly minor but confuses some servers' |
| 1475 | logs. Sadly, the bug was discovered very late and revealed that some servers |
| 1476 | which possibly only tested their PROXY protocol implementation against |
| 1477 | HAProxy fail to properly handle the LOCAL command, and permanently remain in |
| 1478 | the "down" state when HAProxy checks them. When this happens, it is possible |
| 1479 | to enable this global option to revert to the older (bogus) behavior for the |
| 1480 | time it takes to contact the affected components' vendors and get them fixed. |
| 1481 | This option is disabled by default and acts on all servers having the |
| 1482 | "send-proxy-v2" statement. |
| 1483 | |
Willy Tarreau | 1d54972 | 2016-02-16 12:41:57 +0100 | [diff] [blame] | 1484 | presetenv <name> <value> |
| 1485 | Sets environment variable <name> to value <value>. If the variable exists, it |
| 1486 | is NOT overwritten. The changes immediately take effect so that the next line |
| 1487 | in the configuration file sees the new value. See also "setenv", "resetenv", |
| 1488 | and "unsetenv". |
| 1489 | |
| 1490 | resetenv [<name> ...] |
| 1491 | Removes all environment variables except the ones specified in argument. It |
| 1492 | allows to use a clean controlled environment before setting new values with |
| 1493 | setenv or unsetenv. Please note that some internal functions may make use of |
| 1494 | some environment variables, such as time manipulation functions, but also |
| 1495 | OpenSSL or even external checks. This must be used with extreme care and only |
| 1496 | after complete validation. The changes immediately take effect so that the |
| 1497 | next line in the configuration file sees the new environment. See also |
| 1498 | "setenv", "presetenv", and "unsetenv". |
| 1499 | |
Christopher Faulet | ff4121f | 2017-11-22 16:38:49 +0100 | [diff] [blame] | 1500 | stats bind-process [ all | odd | even | <process_num>[-[process_num>]] ] ... |
Willy Tarreau | 35b7b16 | 2012-10-22 23:17:18 +0200 | [diff] [blame] | 1501 | Limits the stats socket to a certain set of processes numbers. By default the |
| 1502 | stats socket is bound to all processes, causing a warning to be emitted when |
| 1503 | nbproc is greater than 1 because there is no way to select the target process |
| 1504 | when connecting. However, by using this setting, it becomes possible to pin |
| 1505 | the stats socket to a specific set of processes, typically the first one. The |
| 1506 | warning will automatically be disabled when this setting is used, whatever |
Willy Tarreau | a9db57e | 2013-01-18 11:29:29 +0100 | [diff] [blame] | 1507 | the number of processes used. The maximum process ID depends on the machine's |
Christopher Faulet | ff4121f | 2017-11-22 16:38:49 +0100 | [diff] [blame] | 1508 | word size (32 or 64). Ranges can be partially defined. The higher bound can |
| 1509 | be omitted. In such case, it is replaced by the corresponding maximum |
| 1510 | value. A better option consists in using the "process" setting of the "stats |
| 1511 | socket" line to force the process on each line. |
Willy Tarreau | 35b7b16 | 2012-10-22 23:17:18 +0200 | [diff] [blame] | 1512 | |
Baptiste Assmann | 5626f48 | 2015-08-23 10:00:10 +0200 | [diff] [blame] | 1513 | server-state-base <directory> |
| 1514 | Specifies the directory prefix to be prepended in front of all servers state |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 1515 | file names which do not start with a '/'. See also "server-state-file", |
| 1516 | "load-server-state-from-file" and "server-state-file-name". |
Baptiste Assmann | ef1f0fc | 2015-08-23 10:06:39 +0200 | [diff] [blame] | 1517 | |
| 1518 | server-state-file <file> |
| 1519 | Specifies the path to the file containing state of servers. If the path starts |
| 1520 | with a slash ('/'), it is considered absolute, otherwise it is considered |
| 1521 | relative to the directory specified using "server-state-base" (if set) or to |
| 1522 | the current directory. Before reloading HAProxy, it is possible to save the |
| 1523 | servers' current state using the stats command "show servers state". The |
| 1524 | output of this command must be written in the file pointed by <file>. When |
| 1525 | starting up, before handling traffic, HAProxy will read, load and apply state |
| 1526 | for each server found in the file and available in its current running |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 1527 | configuration. See also "server-state-base" and "show servers state", |
| 1528 | "load-server-state-from-file" and "server-state-file-name" |
Baptiste Assmann | 5626f48 | 2015-08-23 10:00:10 +0200 | [diff] [blame] | 1529 | |
Willy Tarreau | 1d54972 | 2016-02-16 12:41:57 +0100 | [diff] [blame] | 1530 | setenv <name> <value> |
| 1531 | Sets environment variable <name> to value <value>. If the variable exists, it |
| 1532 | is overwritten. The changes immediately take effect so that the next line in |
| 1533 | the configuration file sees the new value. See also "presetenv", "resetenv", |
| 1534 | and "unsetenv". |
| 1535 | |
Willy Tarreau | 636848a | 2019-04-15 19:38:50 +0200 | [diff] [blame] | 1536 | set-dumpable |
| 1537 | This option is better left disabled by default and enabled only upon a |
William Dauchy | ec73098 | 2019-10-27 20:08:10 +0100 | [diff] [blame] | 1538 | developer's request. If it has been enabled, it may still be forcibly |
| 1539 | disabled by prefixing it with the "no" keyword. It has no impact on |
| 1540 | performance nor stability but will try hard to re-enable core dumps that were |
| 1541 | possibly disabled by file size limitations (ulimit -f), core size limitations |
| 1542 | (ulimit -c), or "dumpability" of a process after changing its UID/GID (such |
| 1543 | as /proc/sys/fs/suid_dumpable on Linux). Core dumps might still be limited by |
| 1544 | the current directory's permissions (check what directory the file is started |
| 1545 | from), the chroot directory's permission (it may be needed to temporarily |
| 1546 | disable the chroot directive or to move it to a dedicated writable location), |
| 1547 | or any other system-specific constraint. For example, some Linux flavours are |
| 1548 | notorious for replacing the default core file with a path to an executable |
| 1549 | not even installed on the system (check /proc/sys/kernel/core_pattern). Often, |
| 1550 | simply writing "core", "core.%p" or "/var/log/core/core.%p" addresses the |
| 1551 | issue. When trying to enable this option waiting for a rare issue to |
| 1552 | re-appear, it's often a good idea to first try to obtain such a dump by |
| 1553 | issuing, for example, "kill -11" to the haproxy process and verify that it |
| 1554 | leaves a core where expected when dying. |
Willy Tarreau | 636848a | 2019-04-15 19:38:50 +0200 | [diff] [blame] | 1555 | |
Willy Tarreau | 610f04b | 2014-02-13 11:36:41 +0100 | [diff] [blame] | 1556 | ssl-default-bind-ciphers <ciphers> |
| 1557 | This setting is only available when support for OpenSSL was built in. It sets |
| 1558 | the default string describing the list of cipher algorithms ("cipher suite") |
Bertrand Jacquin | 8cf7c1e | 2019-02-03 18:35:25 +0000 | [diff] [blame] | 1559 | that are negotiated during the SSL/TLS handshake up to TLSv1.2 for all |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 1560 | "bind" lines which do not explicitly define theirs. The format of the string |
Bertrand Jacquin | 4f03ab0 | 2019-02-03 18:48:49 +0000 | [diff] [blame] | 1561 | is defined in "man 1 ciphers" from OpenSSL man pages. For background |
| 1562 | information and recommendations see e.g. |
| 1563 | (https://wiki.mozilla.org/Security/Server_Side_TLS) and |
| 1564 | (https://mozilla.github.io/server-side-tls/ssl-config-generator/). For TLSv1.3 |
| 1565 | cipher configuration, please check the "ssl-default-bind-ciphersuites" keyword. |
| 1566 | Please check the "bind" keyword for more information. |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 1567 | |
| 1568 | ssl-default-bind-ciphersuites <ciphersuites> |
| 1569 | This setting is only available when support for OpenSSL was built in and |
| 1570 | OpenSSL 1.1.1 or later was used to build HAProxy. It sets the default string |
| 1571 | describing the list of cipher algorithms ("cipher suite") that are negotiated |
| 1572 | during the TLSv1.3 handshake for all "bind" lines which do not explicitly define |
| 1573 | theirs. The format of the string is defined in |
Bertrand Jacquin | 4f03ab0 | 2019-02-03 18:48:49 +0000 | [diff] [blame] | 1574 | "man 1 ciphers" from OpenSSL man pages under the section "ciphersuites". For |
| 1575 | cipher configuration for TLSv1.2 and earlier, please check the |
| 1576 | "ssl-default-bind-ciphers" keyword. Please check the "bind" keyword for more |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 1577 | information. |
Willy Tarreau | 610f04b | 2014-02-13 11:36:41 +0100 | [diff] [blame] | 1578 | |
Jerome Magnin | b203ff6 | 2020-04-03 15:28:22 +0200 | [diff] [blame] | 1579 | ssl-default-bind-curves <curves> |
| 1580 | This setting is only available when support for OpenSSL was built in. It sets |
| 1581 | the default string describing the list of elliptic curves algorithms ("curve |
| 1582 | suite") that are negotiated during the SSL/TLS handshake with ECDHE. The format |
| 1583 | of the string is a colon-delimited list of curve name. |
| 1584 | Please check the "bind" keyword for more information. |
| 1585 | |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 1586 | ssl-default-bind-options [<option>]... |
| 1587 | This setting is only available when support for OpenSSL was built in. It sets |
| 1588 | default ssl-options to force on all "bind" lines. Please check the "bind" |
| 1589 | keyword to see available options. |
| 1590 | |
| 1591 | Example: |
| 1592 | global |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 1593 | ssl-default-bind-options ssl-min-ver TLSv1.0 no-tls-tickets |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 1594 | |
Willy Tarreau | 610f04b | 2014-02-13 11:36:41 +0100 | [diff] [blame] | 1595 | ssl-default-server-ciphers <ciphers> |
| 1596 | This setting is only available when support for OpenSSL was built in. It |
| 1597 | sets the default string describing the list of cipher algorithms that are |
Bertrand Jacquin | 8cf7c1e | 2019-02-03 18:35:25 +0000 | [diff] [blame] | 1598 | negotiated during the SSL/TLS handshake up to TLSv1.2 with the server, |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 1599 | for all "server" lines which do not explicitly define theirs. The format of |
Bertrand Jacquin | 4f03ab0 | 2019-02-03 18:48:49 +0000 | [diff] [blame] | 1600 | the string is defined in "man 1 ciphers" from OpenSSL man pages. For background |
| 1601 | information and recommendations see e.g. |
| 1602 | (https://wiki.mozilla.org/Security/Server_Side_TLS) and |
| 1603 | (https://mozilla.github.io/server-side-tls/ssl-config-generator/). |
| 1604 | For TLSv1.3 cipher configuration, please check the |
| 1605 | "ssl-default-server-ciphersuites" keyword. Please check the "server" keyword |
| 1606 | for more information. |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 1607 | |
| 1608 | ssl-default-server-ciphersuites <ciphersuites> |
| 1609 | This setting is only available when support for OpenSSL was built in and |
| 1610 | OpenSSL 1.1.1 or later was used to build HAProxy. It sets the default |
| 1611 | string describing the list of cipher algorithms that are negotiated during |
| 1612 | the TLSv1.3 handshake with the server, for all "server" lines which do not |
| 1613 | explicitly define theirs. The format of the string is defined in |
Bertrand Jacquin | 4f03ab0 | 2019-02-03 18:48:49 +0000 | [diff] [blame] | 1614 | "man 1 ciphers" from OpenSSL man pages under the section "ciphersuites". For |
| 1615 | cipher configuration for TLSv1.2 and earlier, please check the |
| 1616 | "ssl-default-server-ciphers" keyword. Please check the "server" keyword for |
| 1617 | more information. |
Willy Tarreau | 610f04b | 2014-02-13 11:36:41 +0100 | [diff] [blame] | 1618 | |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 1619 | ssl-default-server-options [<option>]... |
| 1620 | This setting is only available when support for OpenSSL was built in. It sets |
| 1621 | default ssl-options to force on all "server" lines. Please check the "server" |
| 1622 | keyword to see available options. |
| 1623 | |
Remi Gacogne | 47783ef | 2015-05-29 15:53:22 +0200 | [diff] [blame] | 1624 | ssl-dh-param-file <file> |
| 1625 | This setting is only available when support for OpenSSL was built in. It sets |
| 1626 | the default DH parameters that are used during the SSL/TLS handshake when |
| 1627 | ephemeral Diffie-Hellman (DHE) key exchange is used, for all "bind" lines |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1628 | which do not explicitly define theirs. It will be overridden by custom DH |
Remi Gacogne | 47783ef | 2015-05-29 15:53:22 +0200 | [diff] [blame] | 1629 | parameters found in a bind certificate file if any. If custom DH parameters |
Cyril Bonté | 307ee1e | 2015-09-28 23:16:06 +0200 | [diff] [blame] | 1630 | are not specified either by using ssl-dh-param-file or by setting them |
| 1631 | directly in the certificate file, pre-generated DH parameters of the size |
| 1632 | specified by tune.ssl.default-dh-param will be used. Custom parameters are |
| 1633 | known to be more secure and therefore their use is recommended. |
Remi Gacogne | 47783ef | 2015-05-29 15:53:22 +0200 | [diff] [blame] | 1634 | Custom DH parameters may be generated by using the OpenSSL command |
| 1635 | "openssl dhparam <size>", where size should be at least 2048, as 1024-bit DH |
| 1636 | parameters should not be considered secure anymore. |
| 1637 | |
William Lallemand | 8e8581e | 2020-10-20 17:36:46 +0200 | [diff] [blame] | 1638 | ssl-load-extra-del-ext |
| 1639 | This setting allows to configure the way HAProxy does the lookup for the |
| 1640 | extra SSL files. By default HAProxy adds a new extension to the filename. |
William Lallemand | 089c138 | 2020-10-23 17:35:12 +0200 | [diff] [blame] | 1641 | (ex: with "foobar.crt" load "foobar.crt.key"). With this option enabled, |
William Lallemand | 8e8581e | 2020-10-20 17:36:46 +0200 | [diff] [blame] | 1642 | HAProxy removes the extension before adding the new one (ex: with |
William Lallemand | 089c138 | 2020-10-23 17:35:12 +0200 | [diff] [blame] | 1643 | "foobar.crt" load "foobar.key"). |
| 1644 | |
| 1645 | Your crt file must have a ".crt" extension for this option to work. |
William Lallemand | 8e8581e | 2020-10-20 17:36:46 +0200 | [diff] [blame] | 1646 | |
| 1647 | This option is not compatible with bundle extensions (.ecdsa, .rsa. .dsa) |
| 1648 | and won't try to remove them. |
| 1649 | |
| 1650 | This option is disabled by default. See also "ssl-load-extra-files". |
| 1651 | |
William Lallemand | 4c5adbf | 2020-02-24 14:23:22 +0100 | [diff] [blame] | 1652 | ssl-load-extra-files <none|all|bundle|sctl|ocsp|issuer|key>* |
William Lallemand | 3af48e7 | 2020-02-03 17:15:52 +0100 | [diff] [blame] | 1653 | This setting alters the way HAProxy will look for unspecified files during |
Jerome Magnin | 587be9c | 2020-09-07 11:55:57 +0200 | [diff] [blame] | 1654 | the loading of the SSL certificates associated to "bind" lines. It does not |
| 1655 | apply to certificates used for client authentication on "server" lines. |
William Lallemand | 3af48e7 | 2020-02-03 17:15:52 +0100 | [diff] [blame] | 1656 | |
| 1657 | By default, HAProxy discovers automatically a lot of files not specified in |
| 1658 | the configuration, and you may want to disable this behavior if you want to |
| 1659 | optimize the startup time. |
| 1660 | |
| 1661 | "none": Only load the files specified in the configuration. Don't try to load |
| 1662 | a certificate bundle if the file does not exist. In the case of a directory, |
| 1663 | it won't try to bundle the certificates if they have the same basename. |
| 1664 | |
| 1665 | "all": This is the default behavior, it will try to load everything, |
William Lallemand | 4c5adbf | 2020-02-24 14:23:22 +0100 | [diff] [blame] | 1666 | bundles, sctl, ocsp, issuer, key. |
William Lallemand | 3af48e7 | 2020-02-03 17:15:52 +0100 | [diff] [blame] | 1667 | |
| 1668 | "bundle": When a file specified in the configuration does not exist, HAProxy |
William Lallemand | f9ff3ec | 2020-10-02 17:57:44 +0200 | [diff] [blame] | 1669 | will try to load a "cert bundle". |
| 1670 | |
| 1671 | Starting from HAProxy 2.3, the bundles are not loaded in the same OpenSSL |
| 1672 | certificate store, instead it will loads each certificate in a separate |
| 1673 | store which is equivalent to declaring multiple "crt". OpenSSL 1.1.1 is |
| 1674 | required to achieve this. Which means that bundles are now used only for |
| 1675 | backward compatibility and are not mandatory anymore to do an hybrid RSA/ECC |
| 1676 | bind configuration.. |
| 1677 | |
| 1678 | To associate these PEM files into a "cert bundle" that is recognized by |
| 1679 | haproxy, they must be named in the following way: All PEM files that are to |
| 1680 | be bundled must have the same base name, with a suffix indicating the key |
| 1681 | type. Currently, three suffixes are supported: rsa, dsa and ecdsa. For |
| 1682 | example, if www.example.com has two PEM files, an RSA file and an ECDSA |
| 1683 | file, they must be named: "example.pem.rsa" and "example.pem.ecdsa". The |
| 1684 | first part of the filename is arbitrary; only the suffix matters. To load |
| 1685 | this bundle into haproxy, specify the base name only: |
| 1686 | |
| 1687 | Example : bind :8443 ssl crt example.pem |
| 1688 | |
| 1689 | Note that the suffix is not given to haproxy; this tells haproxy to look for |
| 1690 | a cert bundle. |
| 1691 | |
| 1692 | HAProxy will load all PEM files in the bundle as if they were configured |
| 1693 | separately in several "crt". |
| 1694 | |
| 1695 | The bundle loading does not have an impact anymore on the directory loading |
| 1696 | since files are loading separately. |
| 1697 | |
| 1698 | On the CLI, bundles are seen as separate files, and the bundle extension is |
| 1699 | required to commit them. |
| 1700 | |
William Dauchy | 57dd6f1 | 2020-10-06 15:22:37 +0200 | [diff] [blame] | 1701 | OCSP files (.ocsp), issuer files (.issuer), Certificate Transparency (.sctl) |
William Lallemand | f9ff3ec | 2020-10-02 17:57:44 +0200 | [diff] [blame] | 1702 | as well as private keys (.key) are supported with multi-cert bundling. |
William Lallemand | 3af48e7 | 2020-02-03 17:15:52 +0100 | [diff] [blame] | 1703 | |
| 1704 | "sctl": Try to load "<basename>.sctl" for each crt keyword. |
| 1705 | |
| 1706 | "ocsp": Try to load "<basename>.ocsp" for each crt keyword. |
| 1707 | |
| 1708 | "issuer": Try to load "<basename>.issuer" if the issuer of the OCSP file is |
| 1709 | not provided in the PEM file. |
| 1710 | |
William Lallemand | 4c5adbf | 2020-02-24 14:23:22 +0100 | [diff] [blame] | 1711 | "key": If the private key was not provided by the PEM file, try to load a |
| 1712 | file "<basename>.key" containing a private key. |
| 1713 | |
William Lallemand | 3af48e7 | 2020-02-03 17:15:52 +0100 | [diff] [blame] | 1714 | The default behavior is "all". |
| 1715 | |
| 1716 | Example: |
| 1717 | ssl-load-extra-files bundle sctl |
| 1718 | ssl-load-extra-files sctl ocsp issuer |
| 1719 | ssl-load-extra-files none |
| 1720 | |
| 1721 | See also: "crt", section 5.1 about bind options. |
| 1722 | |
Emeric Brun | 850efd5 | 2014-01-29 12:24:34 +0100 | [diff] [blame] | 1723 | ssl-server-verify [none|required] |
| 1724 | The default behavior for SSL verify on servers side. If specified to 'none', |
| 1725 | servers certificates are not verified. The default is 'required' except if |
| 1726 | forced using cmdline option '-dV'. |
| 1727 | |
Emmanuel Hocdet | c3b7e74 | 2020-04-22 11:06:19 +0200 | [diff] [blame] | 1728 | ssl-skip-self-issued-ca |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 1729 | Self issued CA, aka x509 root CA, is the anchor for chain validation: as a |
Emmanuel Hocdet | c3b7e74 | 2020-04-22 11:06:19 +0200 | [diff] [blame] | 1730 | server is useless to send it, client must have it. Standard configuration |
| 1731 | need to not include such CA in PEM file. This option allows you to keep such |
| 1732 | CA in PEM file without sending it to the client. Use case is to provide |
| 1733 | issuer for ocsp without the need for '.issuer' file and be able to share it |
| 1734 | with 'issuers-chain-path'. This concerns all certificates without intermediate |
| 1735 | certificates. It's useless for BoringSSL, .issuer is ignored because ocsp |
William Lallemand | 9a1d839 | 2020-08-10 17:28:23 +0200 | [diff] [blame] | 1736 | bits does not need it. Requires at least OpenSSL 1.0.2. |
Emmanuel Hocdet | c3b7e74 | 2020-04-22 11:06:19 +0200 | [diff] [blame] | 1737 | |
Willy Tarreau | abb175f | 2012-09-24 12:43:26 +0200 | [diff] [blame] | 1738 | stats socket [<address:port>|<path>] [param*] |
| 1739 | Binds a UNIX socket to <path> or a TCPv4/v6 address to <address:port>. |
| 1740 | Connections to this socket will return various statistics outputs and even |
| 1741 | allow some commands to be issued to change some runtime settings. Please |
Willy Tarreau | 1af20c7 | 2017-06-23 16:01:14 +0200 | [diff] [blame] | 1742 | consult section 9.3 "Unix Socket commands" of Management Guide for more |
Kevin Decherf | 949c720 | 2015-10-13 23:26:44 +0200 | [diff] [blame] | 1743 | details. |
Willy Tarreau | 6162db2 | 2009-10-10 17:13:00 +0200 | [diff] [blame] | 1744 | |
Willy Tarreau | abb175f | 2012-09-24 12:43:26 +0200 | [diff] [blame] | 1745 | All parameters supported by "bind" lines are supported, for instance to |
| 1746 | restrict access to some users or their access rights. Please consult |
| 1747 | section 5.1 for more information. |
Willy Tarreau | fbee713 | 2007-10-18 13:53:22 +0200 | [diff] [blame] | 1748 | |
| 1749 | stats timeout <timeout, in milliseconds> |
| 1750 | The default timeout on the stats socket is set to 10 seconds. It is possible |
| 1751 | to change this value with "stats timeout". The value must be passed in |
Willy Tarreau | befdff1 | 2007-12-02 22:27:38 +0100 | [diff] [blame] | 1752 | milliseconds, or be suffixed by a time unit among { us, ms, s, m, h, d }. |
Willy Tarreau | fbee713 | 2007-10-18 13:53:22 +0200 | [diff] [blame] | 1753 | |
| 1754 | stats maxconn <connections> |
| 1755 | By default, the stats socket is limited to 10 concurrent connections. It is |
| 1756 | possible to change this value with "stats maxconn". |
| 1757 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1758 | uid <number> |
| 1759 | Changes the process' user ID to <number>. It is recommended that the user ID |
| 1760 | is dedicated to HAProxy or to a small set of similar daemons. HAProxy must |
| 1761 | be started with superuser privileges in order to be able to switch to another |
| 1762 | one. See also "gid" and "user". |
| 1763 | |
| 1764 | ulimit-n <number> |
| 1765 | Sets the maximum number of per-process file-descriptors to <number>. By |
| 1766 | default, it is automatically computed, so it is recommended not to use this |
| 1767 | option. |
| 1768 | |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 1769 | unix-bind [ prefix <prefix> ] [ mode <mode> ] [ user <user> ] [ uid <uid> ] |
| 1770 | [ group <group> ] [ gid <gid> ] |
| 1771 | |
| 1772 | Fixes common settings to UNIX listening sockets declared in "bind" statements. |
| 1773 | This is mainly used to simplify declaration of those UNIX sockets and reduce |
| 1774 | the risk of errors, since those settings are most commonly required but are |
| 1775 | also process-specific. The <prefix> setting can be used to force all socket |
| 1776 | path to be relative to that directory. This might be needed to access another |
| 1777 | component's chroot. Note that those paths are resolved before haproxy chroots |
| 1778 | itself, so they are absolute. The <mode>, <user>, <uid>, <group> and <gid> |
| 1779 | all have the same meaning as their homonyms used by the "bind" statement. If |
| 1780 | both are specified, the "bind" statement has priority, meaning that the |
| 1781 | "unix-bind" settings may be seen as process-wide default settings. |
| 1782 | |
Willy Tarreau | 1d54972 | 2016-02-16 12:41:57 +0100 | [diff] [blame] | 1783 | unsetenv [<name> ...] |
| 1784 | Removes environment variables specified in arguments. This can be useful to |
| 1785 | hide some sensitive information that are occasionally inherited from the |
| 1786 | user's environment during some operations. Variables which did not exist are |
| 1787 | silently ignored so that after the operation, it is certain that none of |
| 1788 | these variables remain. The changes immediately take effect so that the next |
| 1789 | line in the configuration file will not see these variables. See also |
| 1790 | "setenv", "presetenv", and "resetenv". |
| 1791 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1792 | user <user name> |
| 1793 | Similar to "uid" but uses the UID of user name <user name> from /etc/passwd. |
| 1794 | See also "uid" and "group". |
| 1795 | |
Krzysztof Piotr Oledzki | 48cb2ae | 2009-10-02 22:51:14 +0200 | [diff] [blame] | 1796 | node <name> |
| 1797 | Only letters, digits, hyphen and underscore are allowed, like in DNS names. |
| 1798 | |
| 1799 | This statement is useful in HA configurations where two or more processes or |
| 1800 | servers share the same IP address. By setting a different node-name on all |
| 1801 | nodes, it becomes easy to immediately spot what server is handling the |
| 1802 | traffic. |
| 1803 | |
| 1804 | description <text> |
| 1805 | Add a text that describes the instance. |
| 1806 | |
| 1807 | Please note that it is required to escape certain characters (# for example) |
| 1808 | and this text is inserted into a html page so you should avoid using |
| 1809 | "<" and ">" characters. |
| 1810 | |
Thomas Holmes | db04f19 | 2015-05-18 13:21:39 +0100 | [diff] [blame] | 1811 | 51degrees-data-file <file path> |
| 1812 | The path of the 51Degrees data file to provide device detection services. The |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1813 | file should be unzipped and accessible by HAProxy with relevant permissions. |
Thomas Holmes | db04f19 | 2015-05-18 13:21:39 +0100 | [diff] [blame] | 1814 | |
Dragan Dosen | ae6d39a | 2015-06-29 16:43:27 +0200 | [diff] [blame] | 1815 | Please note that this option is only available when haproxy has been |
Thomas Holmes | db04f19 | 2015-05-18 13:21:39 +0100 | [diff] [blame] | 1816 | compiled with USE_51DEGREES. |
| 1817 | |
Ben Shillito | f25e8e5 | 2016-12-02 14:25:37 +0000 | [diff] [blame] | 1818 | 51degrees-property-name-list [<string> ...] |
Thomas Holmes | db04f19 | 2015-05-18 13:21:39 +0100 | [diff] [blame] | 1819 | A list of 51Degrees property names to be load from the dataset. A full list |
| 1820 | of names is available on the 51Degrees website: |
| 1821 | https://51degrees.com/resources/property-dictionary |
| 1822 | |
Dragan Dosen | ae6d39a | 2015-06-29 16:43:27 +0200 | [diff] [blame] | 1823 | Please note that this option is only available when haproxy has been |
Thomas Holmes | db04f19 | 2015-05-18 13:21:39 +0100 | [diff] [blame] | 1824 | compiled with USE_51DEGREES. |
| 1825 | |
Dragan Dosen | 93b38d9 | 2015-06-29 16:43:25 +0200 | [diff] [blame] | 1826 | 51degrees-property-separator <char> |
Thomas Holmes | db04f19 | 2015-05-18 13:21:39 +0100 | [diff] [blame] | 1827 | A char that will be appended to every property value in a response header |
| 1828 | containing 51Degrees results. If not set that will be set as ','. |
| 1829 | |
Dragan Dosen | ae6d39a | 2015-06-29 16:43:27 +0200 | [diff] [blame] | 1830 | Please note that this option is only available when haproxy has been |
| 1831 | compiled with USE_51DEGREES. |
| 1832 | |
| 1833 | 51degrees-cache-size <number> |
| 1834 | Sets the size of the 51Degrees converter cache to <number> entries. This |
| 1835 | is an LRU cache which reminds previous device detections and their results. |
| 1836 | By default, this cache is disabled. |
| 1837 | |
| 1838 | Please note that this option is only available when haproxy has been |
Thomas Holmes | db04f19 | 2015-05-18 13:21:39 +0100 | [diff] [blame] | 1839 | compiled with USE_51DEGREES. |
| 1840 | |
Willy Tarreau | b3cc9f2 | 2019-04-19 16:03:32 +0200 | [diff] [blame] | 1841 | wurfl-data-file <file path> |
| 1842 | The path of the WURFL data file to provide device detection services. The |
| 1843 | file should be accessible by HAProxy with relevant permissions. |
| 1844 | |
| 1845 | Please note that this option is only available when haproxy has been compiled |
| 1846 | with USE_WURFL=1. |
| 1847 | |
| 1848 | wurfl-information-list [<capability>]* |
| 1849 | A space-delimited list of WURFL capabilities, virtual capabilities, property |
| 1850 | names we plan to use in injected headers. A full list of capability and |
| 1851 | virtual capability names is available on the Scientiamobile website : |
| 1852 | |
| 1853 | https://www.scientiamobile.com/wurflCapability |
| 1854 | |
| 1855 | Valid WURFL properties are: |
| 1856 | - wurfl_id Contains the device ID of the matched device. |
| 1857 | |
| 1858 | - wurfl_root_id Contains the device root ID of the matched |
| 1859 | device. |
| 1860 | |
| 1861 | - wurfl_isdevroot Tells if the matched device is a root device. |
| 1862 | Possible values are "TRUE" or "FALSE". |
| 1863 | |
| 1864 | - wurfl_useragent The original useragent coming with this |
| 1865 | particular web request. |
| 1866 | |
| 1867 | - wurfl_api_version Contains a string representing the currently |
| 1868 | used Libwurfl API version. |
| 1869 | |
Willy Tarreau | b3cc9f2 | 2019-04-19 16:03:32 +0200 | [diff] [blame] | 1870 | - wurfl_info A string containing information on the parsed |
| 1871 | wurfl.xml and its full path. |
| 1872 | |
| 1873 | - wurfl_last_load_time Contains the UNIX timestamp of the last time |
| 1874 | WURFL has been loaded successfully. |
| 1875 | |
| 1876 | - wurfl_normalized_useragent The normalized useragent. |
| 1877 | |
Willy Tarreau | b3cc9f2 | 2019-04-19 16:03:32 +0200 | [diff] [blame] | 1878 | Please note that this option is only available when haproxy has been compiled |
| 1879 | with USE_WURFL=1. |
| 1880 | |
| 1881 | wurfl-information-list-separator <char> |
| 1882 | A char that will be used to separate values in a response header containing |
| 1883 | WURFL results. If not set that a comma (',') will be used by default. |
| 1884 | |
| 1885 | Please note that this option is only available when haproxy has been compiled |
| 1886 | with USE_WURFL=1. |
| 1887 | |
| 1888 | wurfl-patch-file [<file path>] |
| 1889 | A list of WURFL patch file paths. Note that patches are loaded during startup |
| 1890 | thus before the chroot. |
| 1891 | |
| 1892 | Please note that this option is only available when haproxy has been compiled |
| 1893 | with USE_WURFL=1. |
| 1894 | |
paulborile | bad132c | 2019-04-18 11:57:04 +0200 | [diff] [blame] | 1895 | wurfl-cache-size <size> |
| 1896 | Sets the WURFL Useragent cache size. For faster lookups, already processed user |
| 1897 | agents are kept in a LRU cache : |
Willy Tarreau | b3cc9f2 | 2019-04-19 16:03:32 +0200 | [diff] [blame] | 1898 | - "0" : no cache is used. |
paulborile | bad132c | 2019-04-18 11:57:04 +0200 | [diff] [blame] | 1899 | - <size> : size of lru cache in elements. |
Willy Tarreau | b3cc9f2 | 2019-04-19 16:03:32 +0200 | [diff] [blame] | 1900 | |
| 1901 | Please note that this option is only available when haproxy has been compiled |
| 1902 | with USE_WURFL=1. |
| 1903 | |
William Dauchy | 0fec3ab | 2019-10-27 20:08:11 +0100 | [diff] [blame] | 1904 | strict-limits |
William Dauchy | a519460 | 2020-03-28 19:29:58 +0100 | [diff] [blame] | 1905 | Makes process fail at startup when a setrlimit fails. Haproxy tries to set the |
| 1906 | best setrlimit according to what has been calculated. If it fails, it will |
| 1907 | emit a warning. This option is here to guarantee an explicit failure of |
| 1908 | haproxy when those limits fail. It is enabled by default. It may still be |
| 1909 | forcibly disabled by prefixing it with the "no" keyword. |
William Dauchy | 0fec3ab | 2019-10-27 20:08:11 +0100 | [diff] [blame] | 1910 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 1911 | 3.2. Performance tuning |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1912 | ----------------------- |
| 1913 | |
Willy Tarreau | beb859a | 2018-11-22 18:07:59 +0100 | [diff] [blame] | 1914 | busy-polling |
| 1915 | In some situations, especially when dealing with low latency on processors |
| 1916 | supporting a variable frequency or when running inside virtual machines, each |
| 1917 | time the process waits for an I/O using the poller, the processor goes back |
| 1918 | to sleep or is offered to another VM for a long time, and it causes |
| 1919 | excessively high latencies. This option provides a solution preventing the |
| 1920 | processor from sleeping by always using a null timeout on the pollers. This |
| 1921 | results in a significant latency reduction (30 to 100 microseconds observed) |
| 1922 | at the expense of a risk to overheat the processor. It may even be used with |
| 1923 | threads, in which case improperly bound threads may heavily conflict, |
| 1924 | resulting in a worse performance and high values for the CPU stolen fields |
| 1925 | in "show info" output, indicating which threads are misconfigured. It is |
| 1926 | important not to let the process run on the same processor as the network |
| 1927 | interrupts when this option is used. It is also better to avoid using it on |
| 1928 | multiple CPU threads sharing the same core. This option is disabled by |
| 1929 | default. If it has been enabled, it may still be forcibly disabled by |
| 1930 | prefixing it with the "no" keyword. It is ignored by the "select" and |
| 1931 | "poll" pollers. |
| 1932 | |
William Dauchy | 3894d97 | 2019-12-28 15:36:02 +0100 | [diff] [blame] | 1933 | This option is automatically disabled on old processes in the context of |
| 1934 | seamless reload; it avoids too much cpu conflicts when multiple processes |
| 1935 | stay around for some time waiting for the end of their current connections. |
| 1936 | |
Willy Tarreau | 1746eec | 2014-04-25 10:46:47 +0200 | [diff] [blame] | 1937 | max-spread-checks <delay in milliseconds> |
| 1938 | By default, haproxy tries to spread the start of health checks across the |
| 1939 | smallest health check interval of all the servers in a farm. The principle is |
| 1940 | to avoid hammering services running on the same server. But when using large |
| 1941 | check intervals (10 seconds or more), the last servers in the farm take some |
| 1942 | time before starting to be tested, which can be a problem. This parameter is |
| 1943 | used to enforce an upper bound on delay between the first and the last check, |
| 1944 | even if the servers' check intervals are larger. When servers run with |
| 1945 | shorter intervals, their intervals will be respected though. |
| 1946 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1947 | maxconn <number> |
| 1948 | Sets the maximum per-process number of concurrent connections to <number>. It |
| 1949 | is equivalent to the command-line argument "-n". Proxies will stop accepting |
| 1950 | connections when this limit is reached. The "ulimit-n" parameter is |
Willy Tarreau | 8274e10 | 2014-06-19 15:31:25 +0200 | [diff] [blame] | 1951 | automatically adjusted according to this value. See also "ulimit-n". Note: |
| 1952 | the "select" poller cannot reliably use more than 1024 file descriptors on |
| 1953 | some platforms. If your platform only supports select and reports "select |
| 1954 | FAILED" on startup, you need to reduce maxconn until it works (slightly |
Willy Tarreau | b28f344 | 2019-03-04 08:13:43 +0100 | [diff] [blame] | 1955 | below 500 in general). If this value is not set, it will automatically be |
| 1956 | calculated based on the current file descriptors limit reported by the |
| 1957 | "ulimit -n" command, possibly reduced to a lower value if a memory limit |
| 1958 | is enforced, based on the buffer size, memory allocated to compression, SSL |
| 1959 | cache size, and use or not of SSL and the associated maxsslconn (which can |
| 1960 | also be automatic). |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 1961 | |
Willy Tarreau | 81c25d0 | 2011-09-07 15:17:21 +0200 | [diff] [blame] | 1962 | maxconnrate <number> |
| 1963 | Sets the maximum per-process number of connections per second to <number>. |
| 1964 | Proxies will stop accepting connections when this limit is reached. It can be |
| 1965 | used to limit the global capacity regardless of each frontend capacity. It is |
| 1966 | important to note that this can only be used as a service protection measure, |
| 1967 | as there will not necessarily be a fair share between frontends when the |
| 1968 | limit is reached, so it's a good idea to also limit each frontend to some |
| 1969 | value close to its expected share. Also, lowering tune.maxaccept can improve |
| 1970 | fairness. |
| 1971 | |
William Lallemand | d85f917 | 2012-11-09 17:05:39 +0100 | [diff] [blame] | 1972 | maxcomprate <number> |
| 1973 | Sets the maximum per-process input compression rate to <number> kilobytes |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1974 | per second. For each session, if the maximum is reached, the compression |
William Lallemand | d85f917 | 2012-11-09 17:05:39 +0100 | [diff] [blame] | 1975 | level will be decreased during the session. If the maximum is reached at the |
| 1976 | beginning of a session, the session will not compress at all. If the maximum |
| 1977 | is not reached, the compression level will be increased up to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 1978 | tune.comp.maxlevel. A value of zero means there is no limit, this is the |
William Lallemand | d85f917 | 2012-11-09 17:05:39 +0100 | [diff] [blame] | 1979 | default value. |
| 1980 | |
William Lallemand | 072a2bf | 2012-11-20 17:01:01 +0100 | [diff] [blame] | 1981 | maxcompcpuusage <number> |
| 1982 | Sets the maximum CPU usage HAProxy can reach before stopping the compression |
| 1983 | for new requests or decreasing the compression level of current requests. |
| 1984 | It works like 'maxcomprate' but measures CPU usage instead of incoming data |
| 1985 | bandwidth. The value is expressed in percent of the CPU used by haproxy. In |
| 1986 | case of multiple processes (nbproc > 1), each process manages its individual |
| 1987 | usage. A value of 100 disable the limit. The default value is 100. Setting |
| 1988 | a lower value will prevent the compression work from slowing the whole |
| 1989 | process down and from introducing high latencies. |
| 1990 | |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 1991 | maxpipes <number> |
| 1992 | Sets the maximum per-process number of pipes to <number>. Currently, pipes |
| 1993 | are only used by kernel-based tcp splicing. Since a pipe contains two file |
| 1994 | descriptors, the "ulimit-n" value will be increased accordingly. The default |
| 1995 | value is maxconn/4, which seems to be more than enough for most heavy usages. |
| 1996 | The splice code dynamically allocates and releases pipes, and can fall back |
| 1997 | to standard copy, so setting this value too low may only impact performance. |
| 1998 | |
Willy Tarreau | 93e7c00 | 2013-10-07 18:51:07 +0200 | [diff] [blame] | 1999 | maxsessrate <number> |
| 2000 | Sets the maximum per-process number of sessions per second to <number>. |
| 2001 | Proxies will stop accepting connections when this limit is reached. It can be |
| 2002 | used to limit the global capacity regardless of each frontend capacity. It is |
| 2003 | important to note that this can only be used as a service protection measure, |
| 2004 | as there will not necessarily be a fair share between frontends when the |
| 2005 | limit is reached, so it's a good idea to also limit each frontend to some |
| 2006 | value close to its expected share. Also, lowering tune.maxaccept can improve |
| 2007 | fairness. |
| 2008 | |
Willy Tarreau | 403edff | 2012-09-06 11:58:37 +0200 | [diff] [blame] | 2009 | maxsslconn <number> |
| 2010 | Sets the maximum per-process number of concurrent SSL connections to |
| 2011 | <number>. By default there is no SSL-specific limit, which means that the |
| 2012 | global maxconn setting will apply to all connections. Setting this limit |
| 2013 | avoids having openssl use too much memory and crash when malloc returns NULL |
| 2014 | (since it unfortunately does not reliably check for such conditions). Note |
| 2015 | that the limit applies both to incoming and outgoing connections, so one |
| 2016 | connection which is deciphered then ciphered accounts for 2 SSL connections. |
Willy Tarreau | d025648 | 2015-01-15 21:45:22 +0100 | [diff] [blame] | 2017 | If this value is not set, but a memory limit is enforced, this value will be |
| 2018 | automatically computed based on the memory limit, maxconn, the buffer size, |
| 2019 | memory allocated to compression, SSL cache size, and use of SSL in either |
| 2020 | frontends, backends or both. If neither maxconn nor maxsslconn are specified |
| 2021 | when there is a memory limit, haproxy will automatically adjust these values |
| 2022 | so that 100% of the connections can be made over SSL with no risk, and will |
| 2023 | consider the sides where it is enabled (frontend, backend, both). |
Willy Tarreau | 403edff | 2012-09-06 11:58:37 +0200 | [diff] [blame] | 2024 | |
Willy Tarreau | e43d532 | 2013-10-07 20:01:52 +0200 | [diff] [blame] | 2025 | maxsslrate <number> |
| 2026 | Sets the maximum per-process number of SSL sessions per second to <number>. |
| 2027 | SSL listeners will stop accepting connections when this limit is reached. It |
| 2028 | can be used to limit the global SSL CPU usage regardless of each frontend |
| 2029 | capacity. It is important to note that this can only be used as a service |
| 2030 | protection measure, as there will not necessarily be a fair share between |
| 2031 | frontends when the limit is reached, so it's a good idea to also limit each |
| 2032 | frontend to some value close to its expected share. It is also important to |
| 2033 | note that the sessions are accounted before they enter the SSL stack and not |
| 2034 | after, which also protects the stack against bad handshakes. Also, lowering |
| 2035 | tune.maxaccept can improve fairness. |
| 2036 | |
William Lallemand | 9d5f548 | 2012-11-07 16:12:57 +0100 | [diff] [blame] | 2037 | maxzlibmem <number> |
| 2038 | Sets the maximum amount of RAM in megabytes per process usable by the zlib. |
| 2039 | When the maximum amount is reached, future sessions will not compress as long |
| 2040 | as RAM is unavailable. When sets to 0, there is no limit. |
William Lallemand | e3a7d99 | 2012-11-20 11:25:20 +0100 | [diff] [blame] | 2041 | The default value is 0. The value is available in bytes on the UNIX socket |
| 2042 | with "show info" on the line "MaxZlibMemUsage", the memory used by zlib is |
| 2043 | "ZlibMemUsage" in bytes. |
| 2044 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 2045 | noepoll |
| 2046 | Disables the use of the "epoll" event polling system on Linux. It is |
| 2047 | equivalent to the command-line argument "-de". The next polling system |
Willy Tarreau | e9f49e7 | 2012-11-11 17:42:00 +0100 | [diff] [blame] | 2048 | used will generally be "poll". See also "nopoll". |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 2049 | |
| 2050 | nokqueue |
| 2051 | Disables the use of the "kqueue" event polling system on BSD. It is |
| 2052 | equivalent to the command-line argument "-dk". The next polling system |
| 2053 | used will generally be "poll". See also "nopoll". |
| 2054 | |
Emmanuel Hocdet | 0ba4f48 | 2019-04-08 16:53:32 +0000 | [diff] [blame] | 2055 | noevports |
| 2056 | Disables the use of the event ports event polling system on SunOS systems |
| 2057 | derived from Solaris 10 and later. It is equivalent to the command-line |
| 2058 | argument "-dv". The next polling system used will generally be "poll". See |
| 2059 | also "nopoll". |
| 2060 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 2061 | nopoll |
| 2062 | Disables the use of the "poll" event polling system. It is equivalent to the |
| 2063 | command-line argument "-dp". The next polling system used will be "select". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 2064 | It should never be needed to disable "poll" since it's available on all |
Emmanuel Hocdet | 0ba4f48 | 2019-04-08 16:53:32 +0000 | [diff] [blame] | 2065 | platforms supported by HAProxy. See also "nokqueue", "noepoll" and |
| 2066 | "noevports". |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 2067 | |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 2068 | nosplice |
| 2069 | Disables the use of kernel tcp splicing between sockets on Linux. It is |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2070 | equivalent to the command line argument "-dS". Data will then be copied |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 2071 | using conventional and more portable recv/send calls. Kernel tcp splicing is |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 2072 | limited to some very recent instances of kernel 2.6. Most versions between |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 2073 | 2.6.25 and 2.6.28 are buggy and will forward corrupted data, so they must not |
| 2074 | be used. This option makes it easier to globally disable kernel splicing in |
| 2075 | case of doubt. See also "option splice-auto", "option splice-request" and |
| 2076 | "option splice-response". |
| 2077 | |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 2078 | nogetaddrinfo |
| 2079 | Disables the use of getaddrinfo(3) for name resolving. It is equivalent to |
| 2080 | the command line argument "-dG". Deprecated gethostbyname(3) will be used. |
| 2081 | |
Lukas Tribus | a0bcbdc | 2016-09-12 21:42:20 +0000 | [diff] [blame] | 2082 | noreuseport |
| 2083 | Disables the use of SO_REUSEPORT - see socket(7). It is equivalent to the |
| 2084 | command line argument "-dR". |
| 2085 | |
Willy Tarreau | d2d3348 | 2019-04-25 17:09:07 +0200 | [diff] [blame] | 2086 | profiling.tasks { auto | on | off } |
| 2087 | Enables ('on') or disables ('off') per-task CPU profiling. When set to 'auto' |
| 2088 | the profiling automatically turns on a thread when it starts to suffer from |
| 2089 | an average latency of 1000 microseconds or higher as reported in the |
| 2090 | "avg_loop_us" activity field, and automatically turns off when the latency |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 2091 | returns below 990 microseconds (this value is an average over the last 1024 |
Willy Tarreau | d2d3348 | 2019-04-25 17:09:07 +0200 | [diff] [blame] | 2092 | loops so it does not vary quickly and tends to significantly smooth short |
| 2093 | spikes). It may also spontaneously trigger from time to time on overloaded |
| 2094 | systems, containers, or virtual machines, or when the system swaps (which |
| 2095 | must absolutely never happen on a load balancer). |
| 2096 | |
| 2097 | CPU profiling per task can be very convenient to report where the time is |
| 2098 | spent and which requests have what effect on which other request. Enabling |
| 2099 | it will typically affect the overall's performance by less than 1%, thus it |
| 2100 | is recommended to leave it to the default 'auto' value so that it only |
| 2101 | operates when a problem is identified. This feature requires a system |
Willy Tarreau | 75c62c2 | 2018-11-22 11:02:09 +0100 | [diff] [blame] | 2102 | supporting the clock_gettime(2) syscall with clock identifiers |
| 2103 | CLOCK_MONOTONIC and CLOCK_THREAD_CPUTIME_ID, otherwise the reported time will |
| 2104 | be zero. This option may be changed at run time using "set profiling" on the |
| 2105 | CLI. |
| 2106 | |
Willy Tarreau | fe255b7 | 2007-10-14 23:09:26 +0200 | [diff] [blame] | 2107 | spread-checks <0..50, in percent> |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 2108 | Sometimes it is desirable to avoid sending agent and health checks to |
| 2109 | servers at exact intervals, for instance when many logical servers are |
| 2110 | located on the same physical server. With the help of this parameter, it |
| 2111 | becomes possible to add some randomness in the check interval between 0 |
| 2112 | and +/- 50%. A value between 2 and 5 seems to show good results. The |
| 2113 | default value remains at 0. |
Willy Tarreau | fe255b7 | 2007-10-14 23:09:26 +0200 | [diff] [blame] | 2114 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2115 | ssl-engine <name> [algo <comma-separated list of algorithms>] |
Grant Zhang | 872f9c2 | 2017-01-21 01:10:18 +0000 | [diff] [blame] | 2116 | Sets the OpenSSL engine to <name>. List of valid values for <name> may be |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2117 | obtained using the command "openssl engine". This statement may be used |
Grant Zhang | 872f9c2 | 2017-01-21 01:10:18 +0000 | [diff] [blame] | 2118 | multiple times, it will simply enable multiple crypto engines. Referencing an |
| 2119 | unsupported engine will prevent haproxy from starting. Note that many engines |
| 2120 | will lead to lower HTTPS performance than pure software with recent |
| 2121 | processors. The optional command "algo" sets the default algorithms an ENGINE |
| 2122 | will supply using the OPENSSL function ENGINE_set_default_string(). A value |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2123 | of "ALL" uses the engine for all cryptographic operations. If no list of |
| 2124 | algo is specified then the value of "ALL" is used. A comma-separated list |
Grant Zhang | 872f9c2 | 2017-01-21 01:10:18 +0000 | [diff] [blame] | 2125 | of different algorithms may be specified, including: RSA, DSA, DH, EC, RAND, |
| 2126 | CIPHERS, DIGESTS, PKEY, PKEY_CRYPTO, PKEY_ASN1. This is the same format that |
| 2127 | openssl configuration file uses: |
| 2128 | https://www.openssl.org/docs/man1.0.2/apps/config.html |
| 2129 | |
Grant Zhang | fa6c7ee | 2017-01-14 01:42:15 +0000 | [diff] [blame] | 2130 | ssl-mode-async |
| 2131 | Adds SSL_MODE_ASYNC mode to the SSL context. This enables asynchronous TLS |
Emeric Brun | 3854e01 | 2017-05-17 20:42:48 +0200 | [diff] [blame] | 2132 | I/O operations if asynchronous capable SSL engines are used. The current |
Emeric Brun | b5e42a8 | 2017-06-06 12:35:14 +0000 | [diff] [blame] | 2133 | implementation supports a maximum of 32 engines. The Openssl ASYNC API |
| 2134 | doesn't support moving read/write buffers and is not compliant with |
| 2135 | haproxy's buffer management. So the asynchronous mode is disabled on |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 2136 | read/write operations (it is only enabled during initial and renegotiation |
Emeric Brun | b5e42a8 | 2017-06-06 12:35:14 +0000 | [diff] [blame] | 2137 | handshakes). |
Grant Zhang | fa6c7ee | 2017-01-14 01:42:15 +0000 | [diff] [blame] | 2138 | |
Willy Tarreau | 33cb065 | 2014-12-23 22:52:37 +0100 | [diff] [blame] | 2139 | tune.buffers.limit <number> |
| 2140 | Sets a hard limit on the number of buffers which may be allocated per process. |
| 2141 | The default value is zero which means unlimited. The minimum non-zero value |
| 2142 | will always be greater than "tune.buffers.reserve" and should ideally always |
| 2143 | be about twice as large. Forcing this value can be particularly useful to |
| 2144 | limit the amount of memory a process may take, while retaining a sane |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2145 | behavior. When this limit is reached, sessions which need a buffer wait for |
Willy Tarreau | 33cb065 | 2014-12-23 22:52:37 +0100 | [diff] [blame] | 2146 | another one to be released by another session. Since buffers are dynamically |
| 2147 | allocated and released, the waiting time is very short and not perceptible |
| 2148 | provided that limits remain reasonable. In fact sometimes reducing the limit |
| 2149 | may even increase performance by increasing the CPU cache's efficiency. Tests |
| 2150 | have shown good results on average HTTP traffic with a limit to 1/10 of the |
| 2151 | expected global maxconn setting, which also significantly reduces memory |
| 2152 | usage. The memory savings come from the fact that a number of connections |
| 2153 | will not allocate 2*tune.bufsize. It is best not to touch this value unless |
| 2154 | advised to do so by an haproxy core developer. |
| 2155 | |
Willy Tarreau | 1058ae7 | 2014-12-23 22:40:40 +0100 | [diff] [blame] | 2156 | tune.buffers.reserve <number> |
| 2157 | Sets the number of buffers which are pre-allocated and reserved for use only |
| 2158 | during memory shortage conditions resulting in failed memory allocations. The |
| 2159 | minimum value is 2 and is also the default. There is no reason a user would |
| 2160 | want to change this value, it's mostly aimed at haproxy core developers. |
| 2161 | |
Willy Tarreau | 27a674e | 2009-08-17 07:23:33 +0200 | [diff] [blame] | 2162 | tune.bufsize <number> |
| 2163 | Sets the buffer size to this size (in bytes). Lower values allow more |
| 2164 | sessions to coexist in the same amount of RAM, and higher values allow some |
| 2165 | applications with very large cookies to work. The default value is 16384 and |
| 2166 | can be changed at build time. It is strongly recommended not to change this |
| 2167 | from the default value, as very low values will break some services such as |
| 2168 | statistics, and values larger than default size will increase memory usage, |
| 2169 | possibly causing the system to run out of memory. At least the global maxconn |
Willy Tarreau | 45a66cc | 2017-11-24 11:28:00 +0100 | [diff] [blame] | 2170 | parameter should be decreased by the same factor as this one is increased. In |
| 2171 | addition, use of HTTP/2 mandates that this value must be 16384 or more. If an |
| 2172 | HTTP request is larger than (tune.bufsize - tune.maxrewrite), haproxy will |
Dmitry Sivachenko | f6f4f7b | 2012-10-21 18:10:25 +0400 | [diff] [blame] | 2173 | return HTTP 400 (Bad Request) error. Similarly if an HTTP response is larger |
Willy Tarreau | c77d364 | 2018-12-12 06:19:42 +0100 | [diff] [blame] | 2174 | than this size, haproxy will return HTTP 502 (Bad Gateway). Note that the |
| 2175 | value set using this parameter will automatically be rounded up to the next |
| 2176 | multiple of 8 on 32-bit machines and 16 on 64-bit machines. |
Willy Tarreau | 27a674e | 2009-08-17 07:23:33 +0200 | [diff] [blame] | 2177 | |
Christopher Faulet | bb9fb8b | 2020-11-25 17:20:57 +0100 | [diff] [blame] | 2178 | tune.chksize <number> (deprecated) |
| 2179 | This option is deprecated and ignored. |
Willy Tarreau | 43961d5 | 2010-10-04 20:39:20 +0200 | [diff] [blame] | 2180 | |
William Lallemand | f374783 | 2012-11-09 12:33:10 +0100 | [diff] [blame] | 2181 | tune.comp.maxlevel <number> |
| 2182 | Sets the maximum compression level. The compression level affects CPU |
| 2183 | usage during compression. This value affects CPU usage during compression. |
| 2184 | Each session using compression initializes the compression algorithm with |
| 2185 | this value. The default value is 1. |
| 2186 | |
Willy Tarreau | c299e1e | 2019-02-27 11:35:12 +0100 | [diff] [blame] | 2187 | tune.fail-alloc |
| 2188 | If compiled with DEBUG_FAIL_ALLOC, gives the percentage of chances an |
| 2189 | allocation attempt fails. Must be between 0 (no failure) and 100 (no |
| 2190 | success). This is useful to debug and make sure memory failures are handled |
| 2191 | gracefully. |
| 2192 | |
Willy Tarreau | bc52bec | 2020-06-18 08:58:47 +0200 | [diff] [blame] | 2193 | tune.fd.edge-triggered { on | off } [ EXPERIMENTAL ] |
| 2194 | Enables ('on') or disables ('off') the edge-triggered polling mode for FDs |
| 2195 | that support it. This is currently only support with epoll. It may noticeably |
| 2196 | reduce the number of epoll_ctl() calls and slightly improve performance in |
| 2197 | certain scenarios. This is still experimental, it may result in frozen |
| 2198 | connections if bugs are still present, and is disabled by default. |
| 2199 | |
Willy Tarreau | fe20e5b | 2017-07-27 11:42:14 +0200 | [diff] [blame] | 2200 | tune.h2.header-table-size <number> |
| 2201 | Sets the HTTP/2 dynamic header table size. It defaults to 4096 bytes and |
| 2202 | cannot be larger than 65536 bytes. A larger value may help certain clients |
| 2203 | send more compact requests, depending on their capabilities. This amount of |
| 2204 | memory is consumed for each HTTP/2 connection. It is recommended not to |
| 2205 | change it. |
| 2206 | |
Willy Tarreau | e6baec0 | 2017-07-27 11:45:11 +0200 | [diff] [blame] | 2207 | tune.h2.initial-window-size <number> |
| 2208 | Sets the HTTP/2 initial window size, which is the number of bytes the client |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2209 | can upload before waiting for an acknowledgment from haproxy. This setting |
| 2210 | only affects payload contents (i.e. the body of POST requests), not headers. |
Willy Tarreau | e6baec0 | 2017-07-27 11:45:11 +0200 | [diff] [blame] | 2211 | The default value is 65535, which roughly allows up to 5 Mbps of upload |
| 2212 | bandwidth per client over a network showing a 100 ms ping time, or 500 Mbps |
| 2213 | over a 1-ms local network. It can make sense to increase this value to allow |
| 2214 | faster uploads, or to reduce it to increase fairness when dealing with many |
| 2215 | clients. It doesn't affect resource usage. |
| 2216 | |
Willy Tarreau | 5242ef8 | 2017-07-27 11:47:28 +0200 | [diff] [blame] | 2217 | tune.h2.max-concurrent-streams <number> |
| 2218 | Sets the HTTP/2 maximum number of concurrent streams per connection (ie the |
| 2219 | number of outstanding requests on a single connection). The default value is |
| 2220 | 100. A larger one may slightly improve page load time for complex sites when |
| 2221 | visited over high latency networks, but increases the amount of resources a |
| 2222 | single client may allocate. A value of zero disables the limit so a single |
| 2223 | client may create as many streams as allocatable by haproxy. It is highly |
| 2224 | recommended not to change this value. |
| 2225 | |
Willy Tarreau | a24b35c | 2019-02-21 13:24:36 +0100 | [diff] [blame] | 2226 | tune.h2.max-frame-size <number> |
| 2227 | Sets the HTTP/2 maximum frame size that haproxy announces it is willing to |
| 2228 | receive to its peers. The default value is the largest between 16384 and the |
| 2229 | buffer size (tune.bufsize). In any case, haproxy will not announce support |
| 2230 | for frame sizes larger than buffers. The main purpose of this setting is to |
| 2231 | allow to limit the maximum frame size setting when using large buffers. Too |
| 2232 | large frame sizes might have performance impact or cause some peers to |
| 2233 | misbehave. It is highly recommended not to change this value. |
| 2234 | |
Willy Tarreau | 193b8c6 | 2012-11-22 00:17:38 +0100 | [diff] [blame] | 2235 | tune.http.cookielen <number> |
| 2236 | Sets the maximum length of captured cookies. This is the maximum value that |
| 2237 | the "capture cookie xxx len yyy" will be allowed to take, and any upper value |
| 2238 | will automatically be truncated to this one. It is important not to set too |
| 2239 | high a value because all cookie captures still allocate this size whatever |
| 2240 | their configured value (they share a same pool). This value is per request |
| 2241 | per response, so the memory allocated is twice this value per connection. |
| 2242 | When not specified, the limit is set to 63 characters. It is recommended not |
| 2243 | to change this value. |
| 2244 | |
Stéphane Cottin | 23e9e93 | 2017-05-18 08:58:41 +0200 | [diff] [blame] | 2245 | tune.http.logurilen <number> |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2246 | Sets the maximum length of request URI in logs. This prevents truncating long |
| 2247 | request URIs with valuable query strings in log lines. This is not related |
Stéphane Cottin | 23e9e93 | 2017-05-18 08:58:41 +0200 | [diff] [blame] | 2248 | to syslog limits. If you increase this limit, you may also increase the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2249 | 'log ... len yyy' parameter. Your syslog daemon may also need specific |
Stéphane Cottin | 23e9e93 | 2017-05-18 08:58:41 +0200 | [diff] [blame] | 2250 | configuration directives too. |
| 2251 | The default value is 1024. |
| 2252 | |
Willy Tarreau | ac1932d | 2011-10-24 19:14:41 +0200 | [diff] [blame] | 2253 | tune.http.maxhdr <number> |
| 2254 | Sets the maximum number of headers in a request. When a request comes with a |
| 2255 | number of headers greater than this value (including the first line), it is |
| 2256 | rejected with a "400 Bad Request" status code. Similarly, too large responses |
| 2257 | are blocked with "502 Bad Gateway". The default value is 101, which is enough |
| 2258 | for all usages, considering that the widely deployed Apache server uses the |
| 2259 | same limit. It can be useful to push this limit further to temporarily allow |
Christopher Faulet | 50174f3 | 2017-06-21 16:31:35 +0200 | [diff] [blame] | 2260 | a buggy application to work by the time it gets fixed. The accepted range is |
| 2261 | 1..32767. Keep in mind that each new header consumes 32bits of memory for |
| 2262 | each session, so don't push this limit too high. |
Willy Tarreau | ac1932d | 2011-10-24 19:14:41 +0200 | [diff] [blame] | 2263 | |
Willy Tarreau | 76cc699 | 2020-07-01 18:49:24 +0200 | [diff] [blame] | 2264 | tune.idle-pool.shared { on | off } |
| 2265 | Enables ('on') or disables ('off') sharing of idle connection pools between |
| 2266 | threads for a same server. The default is to share them between threads in |
| 2267 | order to minimize the number of persistent connections to a server, and to |
| 2268 | optimize the connection reuse rate. But to help with debugging or when |
| 2269 | suspecting a bug in HAProxy around connection reuse, it can be convenient to |
| 2270 | forcefully disable this idle pool sharing between multiple threads, and force |
| 2271 | this option to "off". The default is on. |
| 2272 | |
Willy Tarreau | 7e31273 | 2014-02-12 16:35:14 +0100 | [diff] [blame] | 2273 | tune.idletimer <timeout> |
| 2274 | Sets the duration after which haproxy will consider that an empty buffer is |
| 2275 | probably associated with an idle stream. This is used to optimally adjust |
| 2276 | some packet sizes while forwarding large and small data alternatively. The |
| 2277 | decision to use splice() or to send large buffers in SSL is modulated by this |
| 2278 | parameter. The value is in milliseconds between 0 and 65535. A value of zero |
| 2279 | means that haproxy will not try to detect idle streams. The default is 1000, |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2280 | which seems to correctly detect end user pauses (e.g. read a page before |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 2281 | clicking). There should be no reason for changing this value. Please check |
Willy Tarreau | 7e31273 | 2014-02-12 16:35:14 +0100 | [diff] [blame] | 2282 | tune.ssl.maxrecord below. |
| 2283 | |
Willy Tarreau | 7ac908b | 2019-02-27 12:02:18 +0100 | [diff] [blame] | 2284 | tune.listener.multi-queue { on | off } |
| 2285 | Enables ('on') or disables ('off') the listener's multi-queue accept which |
| 2286 | spreads the incoming traffic to all threads a "bind" line is allowed to run |
| 2287 | on instead of taking them for itself. This provides a smoother traffic |
| 2288 | distribution and scales much better, especially in environments where threads |
| 2289 | may be unevenly loaded due to external activity (network interrupts colliding |
| 2290 | with one thread for example). This option is enabled by default, but it may |
| 2291 | be forcefully disabled for troubleshooting or for situations where it is |
| 2292 | estimated that the operating system already provides a good enough |
| 2293 | distribution and connections are extremely short-lived. |
| 2294 | |
Thierry FOURNIER | 90da191 | 2015-03-05 11:17:06 +0100 | [diff] [blame] | 2295 | tune.lua.forced-yield <number> |
| 2296 | This directive forces the Lua engine to execute a yield each <number> of |
Tim Düsterhus | 4896c44 | 2016-11-29 02:15:19 +0100 | [diff] [blame] | 2297 | instructions executed. This permits interrupting a long script and allows the |
Thierry FOURNIER | 90da191 | 2015-03-05 11:17:06 +0100 | [diff] [blame] | 2298 | HAProxy scheduler to process other tasks like accepting connections or |
| 2299 | forwarding traffic. The default value is 10000 instructions. If HAProxy often |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2300 | executes some Lua code but more responsiveness is required, this value can be |
Thierry FOURNIER | 90da191 | 2015-03-05 11:17:06 +0100 | [diff] [blame] | 2301 | lowered. If the Lua code is quite long and its result is absolutely required |
| 2302 | to process the data, the <number> can be increased. |
| 2303 | |
Willy Tarreau | 32f61e2 | 2015-03-18 17:54:59 +0100 | [diff] [blame] | 2304 | tune.lua.maxmem |
| 2305 | Sets the maximum amount of RAM in megabytes per process usable by Lua. By |
| 2306 | default it is zero which means unlimited. It is important to set a limit to |
| 2307 | ensure that a bug in a script will not result in the system running out of |
| 2308 | memory. |
| 2309 | |
Thierry FOURNIER | 90da191 | 2015-03-05 11:17:06 +0100 | [diff] [blame] | 2310 | tune.lua.session-timeout <timeout> |
| 2311 | This is the execution timeout for the Lua sessions. This is useful for |
Thierry FOURNIER | 7dd784b | 2015-10-01 14:49:33 +0200 | [diff] [blame] | 2312 | preventing infinite loops or spending too much time in Lua. This timeout |
| 2313 | counts only the pure Lua runtime. If the Lua does a sleep, the sleep is |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2314 | not taken in account. The default timeout is 4s. |
Thierry FOURNIER | 90da191 | 2015-03-05 11:17:06 +0100 | [diff] [blame] | 2315 | |
| 2316 | tune.lua.task-timeout <timeout> |
| 2317 | Purpose is the same as "tune.lua.session-timeout", but this timeout is |
| 2318 | dedicated to the tasks. By default, this timeout isn't set because a task may |
| 2319 | remain alive during of the lifetime of HAProxy. For example, a task used to |
| 2320 | check servers. |
| 2321 | |
Thierry FOURNIER | 7dd784b | 2015-10-01 14:49:33 +0200 | [diff] [blame] | 2322 | tune.lua.service-timeout <timeout> |
| 2323 | This is the execution timeout for the Lua services. This is useful for |
| 2324 | preventing infinite loops or spending too much time in Lua. This timeout |
| 2325 | counts only the pure Lua runtime. If the Lua does a sleep, the sleep is |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2326 | not taken in account. The default timeout is 4s. |
Thierry FOURNIER | 7dd784b | 2015-10-01 14:49:33 +0200 | [diff] [blame] | 2327 | |
Willy Tarreau | a0250ba | 2008-01-06 11:22:57 +0100 | [diff] [blame] | 2328 | tune.maxaccept <number> |
Willy Tarreau | 16a2147 | 2012-11-19 12:39:59 +0100 | [diff] [blame] | 2329 | Sets the maximum number of consecutive connections a process may accept in a |
| 2330 | row before switching to other work. In single process mode, higher numbers |
| 2331 | give better performance at high connection rates. However in multi-process |
| 2332 | modes, keeping a bit of fairness between processes generally is better to |
| 2333 | increase performance. This value applies individually to each listener, so |
| 2334 | that the number of processes a listener is bound to is taken into account. |
| 2335 | This value defaults to 64. In multi-process mode, it is divided by twice |
| 2336 | the number of processes the listener is bound to. Setting this value to -1 |
| 2337 | completely disables the limitation. It should normally not be needed to tweak |
| 2338 | this value. |
Willy Tarreau | a0250ba | 2008-01-06 11:22:57 +0100 | [diff] [blame] | 2339 | |
| 2340 | tune.maxpollevents <number> |
| 2341 | Sets the maximum amount of events that can be processed at once in a call to |
| 2342 | the polling system. The default value is adapted to the operating system. It |
| 2343 | has been noticed that reducing it below 200 tends to slightly decrease |
| 2344 | latency at the expense of network bandwidth, and increasing it above 200 |
| 2345 | tends to trade latency for slightly increased bandwidth. |
| 2346 | |
Willy Tarreau | 27a674e | 2009-08-17 07:23:33 +0200 | [diff] [blame] | 2347 | tune.maxrewrite <number> |
| 2348 | Sets the reserved buffer space to this size in bytes. The reserved space is |
| 2349 | used for header rewriting or appending. The first reads on sockets will never |
| 2350 | fill more than bufsize-maxrewrite. Historically it has defaulted to half of |
| 2351 | bufsize, though that does not make much sense since there are rarely large |
| 2352 | numbers of headers to add. Setting it too high prevents processing of large |
| 2353 | requests or responses. Setting it too low prevents addition of new headers |
| 2354 | to already large requests or to POST requests. It is generally wise to set it |
| 2355 | to about 1024. It is automatically readjusted to half of bufsize if it is |
| 2356 | larger than that. This means you don't have to worry about it when changing |
| 2357 | bufsize. |
| 2358 | |
Willy Tarreau | f3045d2 | 2015-04-29 16:24:50 +0200 | [diff] [blame] | 2359 | tune.pattern.cache-size <number> |
| 2360 | Sets the size of the pattern lookup cache to <number> entries. This is an LRU |
| 2361 | cache which reminds previous lookups and their results. It is used by ACLs |
| 2362 | and maps on slow pattern lookups, namely the ones using the "sub", "reg", |
| 2363 | "dir", "dom", "end", "bin" match methods as well as the case-insensitive |
| 2364 | strings. It applies to pattern expressions which means that it will be able |
| 2365 | to memorize the result of a lookup among all the patterns specified on a |
| 2366 | configuration line (including all those loaded from files). It automatically |
| 2367 | invalidates entries which are updated using HTTP actions or on the CLI. The |
| 2368 | default cache size is set to 10000 entries, which limits its footprint to |
Willy Tarreau | 403bfbb | 2019-10-23 06:59:31 +0200 | [diff] [blame] | 2369 | about 5 MB per process/thread on 32-bit systems and 8 MB per process/thread |
| 2370 | on 64-bit systems, as caches are thread/process local. There is a very low |
Willy Tarreau | f3045d2 | 2015-04-29 16:24:50 +0200 | [diff] [blame] | 2371 | risk of collision in this cache, which is in the order of the size of the |
| 2372 | cache divided by 2^64. Typically, at 10000 requests per second with the |
| 2373 | default cache size of 10000 entries, there's 1% chance that a brute force |
| 2374 | attack could cause a single collision after 60 years, or 0.1% after 6 years. |
| 2375 | This is considered much lower than the risk of a memory corruption caused by |
| 2376 | aging components. If this is not acceptable, the cache can be disabled by |
| 2377 | setting this parameter to 0. |
| 2378 | |
Willy Tarreau | bd9a0a7 | 2011-10-23 21:14:29 +0200 | [diff] [blame] | 2379 | tune.pipesize <number> |
| 2380 | Sets the kernel pipe buffer size to this size (in bytes). By default, pipes |
| 2381 | are the default size for the system. But sometimes when using TCP splicing, |
| 2382 | it can improve performance to increase pipe sizes, especially if it is |
| 2383 | suspected that pipes are not filled and that many calls to splice() are |
| 2384 | performed. This has an impact on the kernel's memory footprint, so this must |
| 2385 | not be changed if impacts are not understood. |
| 2386 | |
Olivier Houchard | 88698d9 | 2019-04-16 19:07:22 +0200 | [diff] [blame] | 2387 | tune.pool-high-fd-ratio <number> |
| 2388 | This setting sets the max number of file descriptors (in percentage) used by |
| 2389 | haproxy globally against the maximum number of file descriptors haproxy can |
| 2390 | use before we start killing idle connections when we can't reuse a connection |
| 2391 | and we have to create a new one. The default is 25 (one quarter of the file |
| 2392 | descriptor will mean that roughly half of the maximum front connections can |
| 2393 | keep an idle connection behind, anything beyond this probably doesn't make |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 2394 | much sense in the general case when targeting connection reuse). |
Olivier Houchard | 88698d9 | 2019-04-16 19:07:22 +0200 | [diff] [blame] | 2395 | |
Willy Tarreau | 83ca305 | 2020-07-01 18:30:16 +0200 | [diff] [blame] | 2396 | tune.pool-low-fd-ratio <number> |
| 2397 | This setting sets the max number of file descriptors (in percentage) used by |
| 2398 | haproxy globally against the maximum number of file descriptors haproxy can |
| 2399 | use before we stop putting connection into the idle pool for reuse. The |
| 2400 | default is 20. |
| 2401 | |
Willy Tarreau | e803de2 | 2010-01-21 17:43:04 +0100 | [diff] [blame] | 2402 | tune.rcvbuf.client <number> |
| 2403 | tune.rcvbuf.server <number> |
| 2404 | Forces the kernel socket receive buffer size on the client or the server side |
| 2405 | to the specified value in bytes. This value applies to all TCP/HTTP frontends |
| 2406 | and backends. It should normally never be set, and the default size (0) lets |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 2407 | the kernel auto-tune this value depending on the amount of available memory. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2408 | However it can sometimes help to set it to very low values (e.g. 4096) in |
Willy Tarreau | e803de2 | 2010-01-21 17:43:04 +0100 | [diff] [blame] | 2409 | order to save kernel memory by preventing it from buffering too large amounts |
| 2410 | of received data. Lower values will significantly increase CPU usage though. |
| 2411 | |
Willy Tarreau | b22fc30 | 2015-12-14 12:04:35 +0100 | [diff] [blame] | 2412 | tune.recv_enough <number> |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2413 | HAProxy uses some hints to detect that a short read indicates the end of the |
Willy Tarreau | b22fc30 | 2015-12-14 12:04:35 +0100 | [diff] [blame] | 2414 | socket buffers. One of them is that a read returns more than <recv_enough> |
| 2415 | bytes, which defaults to 10136 (7 segments of 1448 each). This default value |
| 2416 | may be changed by this setting to better deal with workloads involving lots |
| 2417 | of short messages such as telnet or SSH sessions. |
| 2418 | |
Olivier Houchard | 1599b80 | 2018-05-24 18:59:04 +0200 | [diff] [blame] | 2419 | tune.runqueue-depth <number> |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 2420 | Sets the maximum amount of task that can be processed at once when running |
Olivier Houchard | 1599b80 | 2018-05-24 18:59:04 +0200 | [diff] [blame] | 2421 | tasks. The default value is 200. Increasing it may incur latency when |
Willy Tarreau | e7723bd | 2020-06-24 11:11:02 +0200 | [diff] [blame] | 2422 | dealing with I/Os, making it too small can incur extra overhead. When |
| 2423 | experimenting with much larger values, it may be useful to also enable |
| 2424 | tune.sched.low-latency to limit the maximum latency to the lowest possible. |
| 2425 | |
| 2426 | tune.sched.low-latency { on | off } |
| 2427 | Enables ('on') or disables ('off') the low-latency task scheduler. By default |
| 2428 | haproxy processes tasks from several classes one class at a time as this is |
| 2429 | the most efficient. But when running with large values of tune.runqueue-depth |
| 2430 | this can have a measurable effect on request or connection latency. When this |
| 2431 | low-latency setting is enabled, tasks of lower priority classes will always |
| 2432 | be executed before other ones if they exist. This will permit to lower the |
| 2433 | maximum latency experienced by new requests or connections in the middle of |
| 2434 | massive traffic, at the expense of a higher impact on this large traffic. |
| 2435 | For regular usage it is better to leave this off. The default value is off. |
Olivier Houchard | 1599b80 | 2018-05-24 18:59:04 +0200 | [diff] [blame] | 2436 | |
Willy Tarreau | e803de2 | 2010-01-21 17:43:04 +0100 | [diff] [blame] | 2437 | tune.sndbuf.client <number> |
| 2438 | tune.sndbuf.server <number> |
| 2439 | Forces the kernel socket send buffer size on the client or the server side to |
| 2440 | the specified value in bytes. This value applies to all TCP/HTTP frontends |
| 2441 | and backends. It should normally never be set, and the default size (0) lets |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 2442 | the kernel auto-tune this value depending on the amount of available memory. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2443 | However it can sometimes help to set it to very low values (e.g. 4096) in |
Willy Tarreau | e803de2 | 2010-01-21 17:43:04 +0100 | [diff] [blame] | 2444 | order to save kernel memory by preventing it from buffering too large amounts |
| 2445 | of received data. Lower values will significantly increase CPU usage though. |
| 2446 | Another use case is to prevent write timeouts with extremely slow clients due |
| 2447 | to the kernel waiting for a large part of the buffer to be read before |
| 2448 | notifying haproxy again. |
| 2449 | |
Willy Tarreau | 6ec58db | 2012-11-16 16:32:15 +0100 | [diff] [blame] | 2450 | tune.ssl.cachesize <number> |
Emeric Brun | af9619d | 2012-11-28 18:47:52 +0100 | [diff] [blame] | 2451 | Sets the size of the global SSL session cache, in a number of blocks. A block |
| 2452 | is large enough to contain an encoded session without peer certificate. |
| 2453 | An encoded session with peer certificate is stored in multiple blocks |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 2454 | depending on the size of the peer certificate. A block uses approximately |
Emeric Brun | af9619d | 2012-11-28 18:47:52 +0100 | [diff] [blame] | 2455 | 200 bytes of memory. The default value may be forced at build time, otherwise |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2456 | defaults to 20000. When the cache is full, the most idle entries are purged |
Emeric Brun | af9619d | 2012-11-28 18:47:52 +0100 | [diff] [blame] | 2457 | and reassigned. Higher values reduce the occurrence of such a purge, hence |
| 2458 | the number of CPU-intensive SSL handshakes by ensuring that all users keep |
| 2459 | their session as long as possible. All entries are pre-allocated upon startup |
Emeric Brun | 22890a1 | 2012-12-28 14:41:32 +0100 | [diff] [blame] | 2460 | and are shared between all processes if "nbproc" is greater than 1. Setting |
| 2461 | this value to 0 disables the SSL session cache. |
Willy Tarreau | 6ec58db | 2012-11-16 16:32:15 +0100 | [diff] [blame] | 2462 | |
Emeric Brun | 8dc6039 | 2014-05-09 13:52:00 +0200 | [diff] [blame] | 2463 | tune.ssl.force-private-cache |
Lukas Tribus | 2793578 | 2018-10-01 02:00:16 +0200 | [diff] [blame] | 2464 | This option disables SSL session cache sharing between all processes. It |
Emeric Brun | 8dc6039 | 2014-05-09 13:52:00 +0200 | [diff] [blame] | 2465 | should normally not be used since it will force many renegotiations due to |
| 2466 | clients hitting a random process. But it may be required on some operating |
| 2467 | systems where none of the SSL cache synchronization method may be used. In |
| 2468 | this case, adding a first layer of hash-based load balancing before the SSL |
| 2469 | layer might limit the impact of the lack of session sharing. |
| 2470 | |
William Lallemand | 7d42ef5 | 2020-07-06 11:41:30 +0200 | [diff] [blame] | 2471 | tune.ssl.keylog { on | off } |
| 2472 | This option activates the logging of the TLS keys. It should be used with |
| 2473 | care as it will consume more memory per SSL session and could decrease |
| 2474 | performances. This is disabled by default. |
| 2475 | |
| 2476 | These sample fetches should be used to generate the SSLKEYLOGFILE that is |
| 2477 | required to decipher traffic with wireshark. |
| 2478 | |
| 2479 | https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format |
| 2480 | |
| 2481 | The SSLKEYLOG is a series of lines which are formatted this way: |
| 2482 | |
| 2483 | <Label> <space> <ClientRandom> <space> <Secret> |
| 2484 | |
| 2485 | The ClientRandom is provided by the %[ssl_fc_client_random,hex] sample |
| 2486 | fetch, the secret and the Label could be find in the array below. You need |
| 2487 | to generate a SSLKEYLOGFILE with all the labels in this array. |
| 2488 | |
| 2489 | The following sample fetches are hexadecimal strings and does not need to be |
| 2490 | converted. |
| 2491 | |
| 2492 | SSLKEYLOGFILE Label | Sample fetches for the Secrets |
| 2493 | --------------------------------|----------------------------------------- |
| 2494 | CLIENT_EARLY_TRAFFIC_SECRET | %[ssl_fc_client_early_traffic_secret] |
| 2495 | CLIENT_HANDSHAKE_TRAFFIC_SECRET | %[ssl_fc_client_handshake_traffic_secret] |
| 2496 | SERVER_HANDSHAKE_TRAFFIC_SECRET | %[ssl_fc_server_handshake_traffic_secret] |
| 2497 | CLIENT_TRAFFIC_SECRET_0 | %[ssl_fc_client_traffic_secret_0] |
| 2498 | SERVER_TRAFFIC_SECRET_0 | %[ssl_fc_server_traffic_secret_0] |
William Lallemand | d742b6c | 2020-07-07 10:14:56 +0200 | [diff] [blame] | 2499 | EXPORTER_SECRET | %[ssl_fc_exporter_secret] |
| 2500 | EARLY_EXPORTER_SECRET | %[ssl_fc_early_exporter_secret] |
William Lallemand | 7d42ef5 | 2020-07-06 11:41:30 +0200 | [diff] [blame] | 2501 | |
| 2502 | This is only available with OpenSSL 1.1.1, and useful with TLS1.3 session. |
| 2503 | |
| 2504 | If you want to generate the content of a SSLKEYLOGFILE with TLS < 1.3, you |
| 2505 | only need this line: |
| 2506 | |
| 2507 | "CLIENT_RANDOM %[ssl_fc_client_random,hex] %[ssl_fc_session_key,hex]" |
| 2508 | |
Emeric Brun | 4f65bff | 2012-11-16 15:11:00 +0100 | [diff] [blame] | 2509 | tune.ssl.lifetime <timeout> |
| 2510 | Sets how long a cached SSL session may remain valid. This time is expressed |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 2511 | in seconds and defaults to 300 (5 min). It is important to understand that it |
Emeric Brun | 4f65bff | 2012-11-16 15:11:00 +0100 | [diff] [blame] | 2512 | does not guarantee that sessions will last that long, because if the cache is |
| 2513 | full, the longest idle sessions will be purged despite their configured |
| 2514 | lifetime. The real usefulness of this setting is to prevent sessions from |
| 2515 | being used for too long. |
| 2516 | |
Willy Tarreau | bfd5946 | 2013-02-21 07:46:09 +0100 | [diff] [blame] | 2517 | tune.ssl.maxrecord <number> |
| 2518 | Sets the maximum amount of bytes passed to SSL_write() at a time. Default |
| 2519 | value 0 means there is no limit. Over SSL/TLS, the client can decipher the |
| 2520 | data only once it has received a full record. With large records, it means |
| 2521 | that clients might have to download up to 16kB of data before starting to |
| 2522 | process them. Limiting the value can improve page load times on browsers |
| 2523 | located over high latency or low bandwidth networks. It is suggested to find |
| 2524 | optimal values which fit into 1 or 2 TCP segments (generally 1448 bytes over |
| 2525 | Ethernet with TCP timestamps enabled, or 1460 when timestamps are disabled), |
| 2526 | keeping in mind that SSL/TLS add some overhead. Typical values of 1419 and |
| 2527 | 2859 gave good results during tests. Use "strace -e trace=write" to find the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2528 | best value. HAProxy will automatically switch to this setting after an idle |
Willy Tarreau | 7e31273 | 2014-02-12 16:35:14 +0100 | [diff] [blame] | 2529 | stream has been detected (see tune.idletimer above). |
Willy Tarreau | bfd5946 | 2013-02-21 07:46:09 +0100 | [diff] [blame] | 2530 | |
Remi Gacogne | f46cd6e | 2014-06-12 14:58:40 +0200 | [diff] [blame] | 2531 | tune.ssl.default-dh-param <number> |
| 2532 | Sets the maximum size of the Diffie-Hellman parameters used for generating |
| 2533 | the ephemeral/temporary Diffie-Hellman key in case of DHE key exchange. The |
| 2534 | final size will try to match the size of the server's RSA (or DSA) key (e.g, |
| 2535 | a 2048 bits temporary DH key for a 2048 bits RSA key), but will not exceed |
Willy Tarreau | 3ba77d2 | 2020-05-08 09:31:18 +0200 | [diff] [blame] | 2536 | this maximum value. Default value if 2048. Only 1024 or higher values are |
Remi Gacogne | f46cd6e | 2014-06-12 14:58:40 +0200 | [diff] [blame] | 2537 | allowed. Higher values will increase the CPU load, and values greater than |
| 2538 | 1024 bits are not supported by Java 7 and earlier clients. This value is not |
Remi Gacogne | 47783ef | 2015-05-29 15:53:22 +0200 | [diff] [blame] | 2539 | used if static Diffie-Hellman parameters are supplied either directly |
| 2540 | in the certificate file or by using the ssl-dh-param-file parameter. |
Remi Gacogne | f46cd6e | 2014-06-12 14:58:40 +0200 | [diff] [blame] | 2541 | |
Christopher Faulet | 31af49d | 2015-06-09 17:29:50 +0200 | [diff] [blame] | 2542 | tune.ssl.ssl-ctx-cache-size <number> |
| 2543 | Sets the size of the cache used to store generated certificates to <number> |
| 2544 | entries. This is a LRU cache. Because generating a SSL certificate |
| 2545 | dynamically is expensive, they are cached. The default cache size is set to |
| 2546 | 1000 entries. |
| 2547 | |
Thierry FOURNIER | 5bf7732 | 2017-02-25 12:45:22 +0100 | [diff] [blame] | 2548 | tune.ssl.capture-cipherlist-size <number> |
| 2549 | Sets the maximum size of the buffer used for capturing client-hello cipher |
| 2550 | list. If the value is 0 (default value) the capture is disabled, otherwise |
| 2551 | a buffer is allocated for each SSL/TLS connection. |
| 2552 | |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 2553 | tune.vars.global-max-size <size> |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 2554 | tune.vars.proc-max-size <size> |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 2555 | tune.vars.reqres-max-size <size> |
| 2556 | tune.vars.sess-max-size <size> |
| 2557 | tune.vars.txn-max-size <size> |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 2558 | These five tunes help to manage the maximum amount of memory used by the |
| 2559 | variables system. "global" limits the overall amount of memory available for |
| 2560 | all scopes. "proc" limits the memory for the process scope, "sess" limits the |
| 2561 | memory for the session scope, "txn" for the transaction scope, and "reqres" |
| 2562 | limits the memory for each request or response processing. |
| 2563 | Memory accounting is hierarchical, meaning more coarse grained limits include |
| 2564 | the finer grained ones: "proc" includes "sess", "sess" includes "txn", and |
| 2565 | "txn" includes "reqres". |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 2566 | |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 2567 | For example, when "tune.vars.sess-max-size" is limited to 100, |
| 2568 | "tune.vars.txn-max-size" and "tune.vars.reqres-max-size" cannot exceed |
| 2569 | 100 either. If we create a variable "txn.var" that contains 100 bytes, |
| 2570 | all available space is consumed. |
| 2571 | Notice that exceeding the limits at runtime will not result in an error |
| 2572 | message, but values might be cut off or corrupted. So make sure to accurately |
| 2573 | plan for the amount of space needed to store all your variables. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 2574 | |
William Lallemand | a509e4c | 2012-11-07 16:54:34 +0100 | [diff] [blame] | 2575 | tune.zlib.memlevel <number> |
| 2576 | Sets the memLevel parameter in zlib initialization for each session. It |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 2577 | defines how much memory should be allocated for the internal compression |
William Lallemand | a509e4c | 2012-11-07 16:54:34 +0100 | [diff] [blame] | 2578 | state. A value of 1 uses minimum memory but is slow and reduces compression |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2579 | ratio, a value of 9 uses maximum memory for optimal speed. Can be a value |
William Lallemand | a509e4c | 2012-11-07 16:54:34 +0100 | [diff] [blame] | 2580 | between 1 and 9. The default value is 8. |
| 2581 | |
| 2582 | tune.zlib.windowsize <number> |
| 2583 | Sets the window size (the size of the history buffer) as a parameter of the |
| 2584 | zlib initialization for each session. Larger values of this parameter result |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 2585 | in better compression at the expense of memory usage. Can be a value between |
| 2586 | 8 and 15. The default value is 15. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 2587 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 2588 | 3.3. Debugging |
| 2589 | -------------- |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 2590 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 2591 | quiet |
| 2592 | Do not display any message during startup. It is equivalent to the command- |
| 2593 | line argument "-q". |
| 2594 | |
Willy Tarreau | 3eb10b8 | 2020-04-15 16:42:39 +0200 | [diff] [blame] | 2595 | zero-warning |
| 2596 | When this option is set, haproxy will refuse to start if any warning was |
| 2597 | emitted while processing the configuration. It is highly recommended to set |
| 2598 | this option on configurations that are not changed often, as it helps detect |
| 2599 | subtle mistakes and keep the configuration clean and forward-compatible. Note |
| 2600 | that "haproxy -c" will also report errors in such a case. This option is |
| 2601 | equivalent to command line argument "-dW". |
| 2602 | |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2603 | |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2604 | 3.4. Userlists |
| 2605 | -------------- |
| 2606 | It is possible to control access to frontend/backend/listen sections or to |
| 2607 | http stats by allowing only authenticated and authorized users. To do this, |
| 2608 | it is required to create at least one userlist and to define users. |
| 2609 | |
| 2610 | userlist <listname> |
Cyril Bonté | 78caf84 | 2010-03-10 22:41:43 +0100 | [diff] [blame] | 2611 | Creates new userlist with name <listname>. Many independent userlists can be |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2612 | used to store authentication & authorization data for independent customers. |
| 2613 | |
| 2614 | group <groupname> [users <user>,<user>,(...)] |
Cyril Bonté | 78caf84 | 2010-03-10 22:41:43 +0100 | [diff] [blame] | 2615 | Adds group <groupname> to the current userlist. It is also possible to |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2616 | attach users to this group by using a comma separated list of names |
| 2617 | proceeded by "users" keyword. |
| 2618 | |
Cyril Bonté | f0c6061 | 2010-02-06 14:44:47 +0100 | [diff] [blame] | 2619 | user <username> [password|insecure-password <password>] |
| 2620 | [groups <group>,<group>,(...)] |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2621 | Adds user <username> to the current userlist. Both secure (encrypted) and |
| 2622 | insecure (unencrypted) passwords can be used. Encrypted passwords are |
Daniel Schneller | d06f31c | 2017-11-06 16:51:04 +0100 | [diff] [blame] | 2623 | evaluated using the crypt(3) function, so depending on the system's |
| 2624 | capabilities, different algorithms are supported. For example, modern Glibc |
| 2625 | based Linux systems support MD5, SHA-256, SHA-512, and, of course, the |
| 2626 | classic DES-based method of encrypting passwords. |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2627 | |
Daniel Schneller | d06f31c | 2017-11-06 16:51:04 +0100 | [diff] [blame] | 2628 | Attention: Be aware that using encrypted passwords might cause significantly |
| 2629 | increased CPU usage, depending on the number of requests, and the algorithm |
| 2630 | used. For any of the hashed variants, the password for each request must |
| 2631 | be processed through the chosen algorithm, before it can be compared to the |
| 2632 | value specified in the config file. Most current algorithms are deliberately |
| 2633 | designed to be expensive to compute to achieve resistance against brute |
| 2634 | force attacks. They do not simply salt/hash the clear text password once, |
| 2635 | but thousands of times. This can quickly become a major factor in haproxy's |
| 2636 | overall CPU consumption! |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2637 | |
| 2638 | Example: |
Cyril Bonté | f0c6061 | 2010-02-06 14:44:47 +0100 | [diff] [blame] | 2639 | userlist L1 |
| 2640 | group G1 users tiger,scott |
| 2641 | group G2 users xdb,scott |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2642 | |
Cyril Bonté | f0c6061 | 2010-02-06 14:44:47 +0100 | [diff] [blame] | 2643 | user tiger password $6$k6y3o.eP$JlKBx9za9667qe4(...)xHSwRv6J.C0/D7cV91 |
| 2644 | user scott insecure-password elgato |
| 2645 | user xdb insecure-password hello |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2646 | |
Cyril Bonté | f0c6061 | 2010-02-06 14:44:47 +0100 | [diff] [blame] | 2647 | userlist L2 |
| 2648 | group G1 |
| 2649 | group G2 |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2650 | |
Cyril Bonté | f0c6061 | 2010-02-06 14:44:47 +0100 | [diff] [blame] | 2651 | user tiger password $6$k6y3o.eP$JlKBx(...)xHSwRv6J.C0/D7cV91 groups G1 |
| 2652 | user scott insecure-password elgato groups G1,G2 |
| 2653 | user xdb insecure-password hello groups G2 |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 2654 | |
| 2655 | Please note that both lists are functionally identical. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 2656 | |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2657 | |
| 2658 | 3.5. Peers |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 2659 | ---------- |
Emeric Brun | 9490095 | 2015-06-11 18:25:54 +0200 | [diff] [blame] | 2660 | It is possible to propagate entries of any data-types in stick-tables between |
| 2661 | several haproxy instances over TCP connections in a multi-master fashion. Each |
| 2662 | instance pushes its local updates and insertions to remote peers. The pushed |
| 2663 | values overwrite remote ones without aggregation. Interrupted exchanges are |
| 2664 | automatically detected and recovered from the last known point. |
| 2665 | In addition, during a soft restart, the old process connects to the new one |
| 2666 | using such a TCP connection to push all its entries before the new process |
| 2667 | tries to connect to other peers. That ensures very fast replication during a |
| 2668 | reload, it typically takes a fraction of a second even for large tables. |
| 2669 | Note that Server IDs are used to identify servers remotely, so it is important |
| 2670 | that configurations look similar or at least that the same IDs are forced on |
| 2671 | each server on all participants. |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2672 | |
| 2673 | peers <peersect> |
Jamie Gloudon | 801a0a3 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 2674 | Creates a new peer list with name <peersect>. It is an independent section, |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2675 | which is referenced by one or more stick-tables. |
| 2676 | |
Frédéric Lécaille | 2f167b3 | 2019-01-11 14:13:54 +0100 | [diff] [blame] | 2677 | bind [<address>]:<port_range> [, ...] [param*] |
| 2678 | Defines the binding parameters of the local peer of this "peers" section. |
| 2679 | Such lines are not supported with "peer" line in the same "peers" section. |
| 2680 | |
Willy Tarreau | 77e4bd1 | 2015-05-01 20:02:17 +0200 | [diff] [blame] | 2681 | disabled |
| 2682 | Disables a peers section. It disables both listening and any synchronization |
| 2683 | related to this section. This is provided to disable synchronization of stick |
| 2684 | tables without having to comment out all "peers" references. |
| 2685 | |
Frédéric Lécaille | 2f167b3 | 2019-01-11 14:13:54 +0100 | [diff] [blame] | 2686 | default-bind [param*] |
| 2687 | Defines the binding parameters for the local peer, excepted its address. |
| 2688 | |
| 2689 | default-server [param*] |
| 2690 | Change default options for a server in a "peers" section. |
| 2691 | |
| 2692 | Arguments: |
| 2693 | <param*> is a list of parameters for this server. The "default-server" |
| 2694 | keyword accepts an important number of options and has a complete |
| 2695 | section dedicated to it. Please refer to section 5 for more |
| 2696 | details. |
| 2697 | |
| 2698 | |
| 2699 | See also: "server" and section 5 about server options |
| 2700 | |
Willy Tarreau | 77e4bd1 | 2015-05-01 20:02:17 +0200 | [diff] [blame] | 2701 | enable |
| 2702 | This re-enables a disabled peers section which was previously disabled. |
| 2703 | |
Jan Wagner | 3e67860 | 2020-12-17 22:22:32 +0100 | [diff] [blame] | 2704 | log <address> [len <length>] [format <format>] [sample <ranges>:<sample_size>] |
Frédéric Lécaille | b6f759b | 2019-11-05 09:57:45 +0100 | [diff] [blame] | 2705 | <facility> [<level> [<minlevel>]] |
| 2706 | "peers" sections support the same "log" keyword as for the proxies to |
| 2707 | log information about the "peers" listener. See "log" option for proxies for |
| 2708 | more details. |
| 2709 | |
Frédéric Lécaille | 2f167b3 | 2019-01-11 14:13:54 +0100 | [diff] [blame] | 2710 | peer <peername> <ip>:<port> [param*] |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2711 | Defines a peer inside a peers section. |
| 2712 | If <peername> is set to the local peer name (by default hostname, or forced |
Dragan Dosen | 13cd54c | 2020-06-18 18:24:05 +0200 | [diff] [blame] | 2713 | using "-L" command line option or "localpeer" global configuration setting), |
| 2714 | haproxy will listen for incoming remote peer connection on <ip>:<port>. |
| 2715 | Otherwise, <ip>:<port> defines where to connect to in order to join the |
| 2716 | remote peer, and <peername> is used at the protocol level to identify and |
| 2717 | validate the remote peer on the server side. |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2718 | |
| 2719 | During a soft restart, local peer <ip>:<port> is used by the old instance to |
| 2720 | connect the new one and initiate a complete replication (teaching process). |
| 2721 | |
| 2722 | It is strongly recommended to have the exact same peers declaration on all |
Dragan Dosen | 13cd54c | 2020-06-18 18:24:05 +0200 | [diff] [blame] | 2723 | peers and to only rely on the "-L" command line argument or the "localpeer" |
| 2724 | global configuration setting to change the local peer name. This makes it |
| 2725 | easier to maintain coherent configuration files across all peers. |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2726 | |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 2727 | You may want to reference some environment variables in the address |
| 2728 | parameter, see section 2.3 about environment variables. |
Willy Tarreau | dad36a3 | 2013-03-11 01:20:04 +0100 | [diff] [blame] | 2729 | |
Frédéric Lécaille | 2f167b3 | 2019-01-11 14:13:54 +0100 | [diff] [blame] | 2730 | Note: "peer" keyword may transparently be replaced by "server" keyword (see |
| 2731 | "server" keyword explanation below). |
| 2732 | |
| 2733 | server <peername> [<ip>:<port>] [param*] |
Michael Prokop | 4438c60 | 2019-05-24 10:25:45 +0200 | [diff] [blame] | 2734 | As previously mentioned, "peer" keyword may be replaced by "server" keyword |
Frédéric Lécaille | 2f167b3 | 2019-01-11 14:13:54 +0100 | [diff] [blame] | 2735 | with a support for all "server" parameters found in 5.2 paragraph. |
| 2736 | If the underlying peer is local, <ip>:<port> parameters must not be present. |
| 2737 | These parameters must be provided on a "bind" line (see "bind" keyword |
| 2738 | of this "peers" section). |
| 2739 | Some of these parameters are irrelevant for "peers" sections. |
| 2740 | |
| 2741 | |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 2742 | Example: |
Frédéric Lécaille | 2f167b3 | 2019-01-11 14:13:54 +0100 | [diff] [blame] | 2743 | # The old way. |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2744 | peers mypeers |
Willy Tarreau | f7b30a9 | 2010-12-06 22:59:17 +0100 | [diff] [blame] | 2745 | peer haproxy1 192.168.0.1:1024 |
| 2746 | peer haproxy2 192.168.0.2:1024 |
| 2747 | peer haproxy3 10.2.0.1:1024 |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2748 | |
| 2749 | backend mybackend |
| 2750 | mode tcp |
| 2751 | balance roundrobin |
| 2752 | stick-table type ip size 20k peers mypeers |
| 2753 | stick on src |
| 2754 | |
Willy Tarreau | f7b30a9 | 2010-12-06 22:59:17 +0100 | [diff] [blame] | 2755 | server srv1 192.168.0.30:80 |
| 2756 | server srv2 192.168.0.31:80 |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2757 | |
Frédéric Lécaille | 2f167b3 | 2019-01-11 14:13:54 +0100 | [diff] [blame] | 2758 | Example: |
| 2759 | peers mypeers |
| 2760 | bind 127.0.0.11:10001 ssl crt mycerts/pem |
| 2761 | default-server ssl verify none |
| 2762 | server hostA 127.0.0.10:10000 |
| 2763 | server hostB #local peer |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 2764 | |
Frédéric Lécaille | 4f5b77c | 2019-03-18 14:05:58 +0100 | [diff] [blame] | 2765 | |
| 2766 | table <tablename> type {ip | integer | string [len <length>] | binary [len <length>]} |
| 2767 | size <size> [expire <expire>] [nopurge] [store <data_type>]* |
| 2768 | |
| 2769 | Configure a stickiness table for the current section. This line is parsed |
| 2770 | exactly the same way as the "stick-table" keyword in others section, except |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 2771 | for the "peers" argument which is not required here and with an additional |
Frédéric Lécaille | 4f5b77c | 2019-03-18 14:05:58 +0100 | [diff] [blame] | 2772 | mandatory first parameter to designate the stick-table. Contrary to others |
| 2773 | sections, there may be several "table" lines in "peers" sections (see also |
| 2774 | "stick-table" keyword). |
| 2775 | |
| 2776 | Also be aware of the fact that "peers" sections have their own stick-table |
| 2777 | namespaces to avoid collisions between stick-table names identical in |
| 2778 | different "peers" section. This is internally handled prepending the "peers" |
| 2779 | sections names to the name of the stick-tables followed by a '/' character. |
| 2780 | If somewhere else in the configuration file you have to refer to such |
| 2781 | stick-tables declared in "peers" sections you must use the prefixed version |
| 2782 | of the stick-table name as follows: |
| 2783 | |
| 2784 | peers mypeers |
| 2785 | peer A ... |
| 2786 | peer B ... |
| 2787 | table t1 ... |
| 2788 | |
| 2789 | frontend fe1 |
| 2790 | tcp-request content track-sc0 src table mypeers/t1 |
| 2791 | |
| 2792 | This is also this prefixed version of the stick-table names which must be |
| 2793 | used to refer to stick-tables through the CLI. |
| 2794 | |
| 2795 | About "peers" protocol, as only "peers" belonging to the same section may |
| 2796 | communicate with each others, there is no need to do such a distinction. |
| 2797 | Several "peers" sections may declare stick-tables with the same name. |
| 2798 | This is shorter version of the stick-table name which is sent over the network. |
| 2799 | There is only a '/' character as prefix to avoid stick-table name collisions between |
| 2800 | stick-tables declared as backends and stick-table declared in "peers" sections |
| 2801 | as follows in this weird but supported configuration: |
| 2802 | |
| 2803 | peers mypeers |
| 2804 | peer A ... |
| 2805 | peer B ... |
| 2806 | table t1 type string size 10m store gpc0 |
| 2807 | |
| 2808 | backend t1 |
| 2809 | stick-table type string size 10m store gpc0 peers mypeers |
| 2810 | |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 2811 | Here "t1" table declared in "mypeers" section has "mypeers/t1" as global name. |
Frédéric Lécaille | 4f5b77c | 2019-03-18 14:05:58 +0100 | [diff] [blame] | 2812 | "t1" table declared as a backend as "t1" as global name. But at peer protocol |
| 2813 | level the former table is named "/t1", the latter is again named "t1". |
| 2814 | |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 2815 | 3.6. Mailers |
| 2816 | ------------ |
| 2817 | It is possible to send email alerts when the state of servers changes. |
| 2818 | If configured email alerts are sent to each mailer that is configured |
| 2819 | in a mailers section. Email is sent to mailers using SMTP. |
| 2820 | |
Pieter Baauw | 386a127 | 2015-08-16 15:26:24 +0200 | [diff] [blame] | 2821 | mailers <mailersect> |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 2822 | Creates a new mailer list with the name <mailersect>. It is an |
| 2823 | independent section which is referenced by one or more proxies. |
| 2824 | |
| 2825 | mailer <mailername> <ip>:<port> |
| 2826 | Defines a mailer inside a mailers section. |
| 2827 | |
| 2828 | Example: |
| 2829 | mailers mymailers |
| 2830 | mailer smtp1 192.168.0.1:587 |
| 2831 | mailer smtp2 192.168.0.2:587 |
| 2832 | |
| 2833 | backend mybackend |
| 2834 | mode tcp |
| 2835 | balance roundrobin |
| 2836 | |
| 2837 | email-alert mailers mymailers |
| 2838 | email-alert from test1@horms.org |
| 2839 | email-alert to test2@horms.org |
| 2840 | |
| 2841 | server srv1 192.168.0.30:80 |
| 2842 | server srv2 192.168.0.31:80 |
| 2843 | |
Pieter Baauw | 235fcfc | 2016-02-13 15:33:40 +0100 | [diff] [blame] | 2844 | timeout mail <time> |
| 2845 | Defines the time available for a mail/connection to be made and send to |
| 2846 | the mail-server. If not defined the default value is 10 seconds. To allow |
| 2847 | for at least two SYN-ACK packets to be send during initial TCP handshake it |
| 2848 | is advised to keep this value above 4 seconds. |
| 2849 | |
| 2850 | Example: |
| 2851 | mailers mymailers |
| 2852 | timeout mail 20s |
| 2853 | mailer smtp1 192.168.0.1:587 |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 2854 | |
William Lallemand | c951552 | 2019-06-12 16:32:11 +0200 | [diff] [blame] | 2855 | 3.7. Programs |
| 2856 | ------------- |
| 2857 | In master-worker mode, it is possible to launch external binaries with the |
| 2858 | master, these processes are called programs. These programs are launched and |
| 2859 | managed the same way as the workers. |
| 2860 | |
| 2861 | During a reload of HAProxy, those processes are dealing with the same |
| 2862 | sequence as a worker: |
| 2863 | |
| 2864 | - the master is re-executed |
| 2865 | - the master sends a SIGUSR1 signal to the program |
| 2866 | - if "option start-on-reload" is not disabled, the master launches a new |
| 2867 | instance of the program |
| 2868 | |
| 2869 | During a stop, or restart, a SIGTERM is sent to the programs. |
| 2870 | |
| 2871 | program <name> |
| 2872 | This is a new program section, this section will create an instance <name> |
| 2873 | which is visible in "show proc" on the master CLI. (See "9.4. Master CLI" in |
| 2874 | the management guide). |
| 2875 | |
| 2876 | command <command> [arguments*] |
| 2877 | Define the command to start with optional arguments. The command is looked |
| 2878 | up in the current PATH if it does not include an absolute path. This is a |
| 2879 | mandatory option of the program section. Arguments containing spaces must |
| 2880 | be enclosed in quotes or double quotes or be prefixed by a backslash. |
| 2881 | |
Andrew Heberle | 9723696 | 2019-07-12 11:50:26 +0800 | [diff] [blame] | 2882 | user <user name> |
| 2883 | Changes the executed command user ID to the <user name> from /etc/passwd. |
| 2884 | See also "group". |
| 2885 | |
| 2886 | group <group name> |
| 2887 | Changes the executed command group ID to the <group name> from /etc/group. |
| 2888 | See also "user". |
| 2889 | |
William Lallemand | c951552 | 2019-06-12 16:32:11 +0200 | [diff] [blame] | 2890 | option start-on-reload |
| 2891 | no option start-on-reload |
| 2892 | Start (or not) a new instance of the program upon a reload of the master. |
| 2893 | The default is to start a new instance. This option may only be used in a |
| 2894 | program section. |
| 2895 | |
| 2896 | |
Christopher Faulet | 76edc0f | 2020-01-13 15:52:01 +0100 | [diff] [blame] | 2897 | 3.8. HTTP-errors |
| 2898 | ---------------- |
| 2899 | |
| 2900 | It is possible to globally declare several groups of HTTP errors, to be |
| 2901 | imported afterwards in any proxy section. Same group may be referenced at |
| 2902 | several places and can be fully or partially imported. |
| 2903 | |
| 2904 | http-errors <name> |
| 2905 | Create a new http-errors group with the name <name>. It is an independent |
| 2906 | section that may be referenced by one or more proxies using its name. |
| 2907 | |
| 2908 | errorfile <code> <file> |
| 2909 | Associate a file contents to an HTTP error code |
| 2910 | |
| 2911 | Arguments : |
| 2912 | <code> is the HTTP status code. Currently, HAProxy is capable of |
Christopher Faulet | 612f2ea | 2020-05-27 09:57:28 +0200 | [diff] [blame] | 2913 | generating codes 200, 400, 401, 403, 404, 405, 407, 408, 410, |
| 2914 | 425, 429, 500, 502, 503, and 504. |
Christopher Faulet | 76edc0f | 2020-01-13 15:52:01 +0100 | [diff] [blame] | 2915 | |
| 2916 | <file> designates a file containing the full HTTP response. It is |
| 2917 | recommended to follow the common practice of appending ".http" to |
| 2918 | the filename so that people do not confuse the response with HTML |
| 2919 | error pages, and to use absolute paths, since files are read |
| 2920 | before any chroot is performed. |
| 2921 | |
| 2922 | Please referrers to "errorfile" keyword in section 4 for details. |
| 2923 | |
| 2924 | Example: |
| 2925 | http-errors website-1 |
| 2926 | errorfile 400 /etc/haproxy/errorfiles/site1/400.http |
| 2927 | errorfile 404 /etc/haproxy/errorfiles/site1/404.http |
| 2928 | errorfile 408 /dev/null # work around Chrome pre-connect bug |
| 2929 | |
| 2930 | http-errors website-2 |
| 2931 | errorfile 400 /etc/haproxy/errorfiles/site2/400.http |
| 2932 | errorfile 404 /etc/haproxy/errorfiles/site2/404.http |
| 2933 | errorfile 408 /dev/null # work around Chrome pre-connect bug |
| 2934 | |
Emeric Brun | 99c453d | 2020-05-25 15:01:04 +0200 | [diff] [blame] | 2935 | 3.9. Rings |
| 2936 | ---------- |
| 2937 | |
| 2938 | It is possible to globally declare ring-buffers, to be used as target for log |
| 2939 | servers or traces. |
| 2940 | |
| 2941 | ring <ringname> |
| 2942 | Creates a new ring-buffer with name <ringname>. |
| 2943 | |
| 2944 | description <text> |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 2945 | The description is an optional description string of the ring. It will |
Emeric Brun | 99c453d | 2020-05-25 15:01:04 +0200 | [diff] [blame] | 2946 | appear on CLI. By default, <name> is reused to fill this field. |
| 2947 | |
| 2948 | format <format> |
| 2949 | Format used to store events into the ring buffer. |
| 2950 | |
| 2951 | Arguments: |
| 2952 | <format> is the log format used when generating syslog messages. It may be |
| 2953 | one of the following : |
| 2954 | |
| 2955 | iso A message containing only the ISO date, followed by the text. |
| 2956 | The PID, process name and system name are omitted. This is |
| 2957 | designed to be used with a local log server. |
| 2958 | |
Emeric Brun | 0237c4e | 2020-11-27 16:24:34 +0100 | [diff] [blame] | 2959 | local Analog to rfc3164 syslog message format except that hostname |
| 2960 | field is stripped. This is the default. |
| 2961 | Note: option "log-send-hostname" switches the default to |
| 2962 | rfc3164. |
| 2963 | |
Emeric Brun | 99c453d | 2020-05-25 15:01:04 +0200 | [diff] [blame] | 2964 | raw A message containing only the text. The level, PID, date, time, |
| 2965 | process name and system name are omitted. This is designed to be |
| 2966 | used in containers or during development, where the severity |
| 2967 | only depends on the file descriptor used (stdout/stderr). This |
| 2968 | is the default. |
| 2969 | |
Emeric Brun | 0237c4e | 2020-11-27 16:24:34 +0100 | [diff] [blame] | 2970 | rfc3164 The RFC3164 syslog message format. |
Emeric Brun | 99c453d | 2020-05-25 15:01:04 +0200 | [diff] [blame] | 2971 | (https://tools.ietf.org/html/rfc3164) |
| 2972 | |
| 2973 | rfc5424 The RFC5424 syslog message format. |
| 2974 | (https://tools.ietf.org/html/rfc5424) |
| 2975 | |
| 2976 | short A message containing only a level between angle brackets such as |
| 2977 | '<3>', followed by the text. The PID, date, time, process name |
| 2978 | and system name are omitted. This is designed to be used with a |
| 2979 | local log server. This format is compatible with what the systemd |
| 2980 | logger consumes. |
| 2981 | |
Emeric Brun | 5464885 | 2020-07-06 15:54:06 +0200 | [diff] [blame] | 2982 | priority A message containing only a level plus syslog facility between angle |
| 2983 | brackets such as '<63>', followed by the text. The PID, date, time, |
| 2984 | process name and system name are omitted. This is designed to be used |
| 2985 | with a local log server. |
| 2986 | |
Emeric Brun | 99c453d | 2020-05-25 15:01:04 +0200 | [diff] [blame] | 2987 | timed A message containing only a level between angle brackets such as |
| 2988 | '<3>', followed by ISO date and by the text. The PID, process |
| 2989 | name and system name are omitted. This is designed to be |
| 2990 | used with a local log server. |
| 2991 | |
| 2992 | maxlen <length> |
| 2993 | The maximum length of an event message stored into the ring, |
| 2994 | including formatted header. If an event message is longer than |
| 2995 | <length>, it will be truncated to this length. |
| 2996 | |
Emeric Brun | 494c505 | 2020-05-28 11:13:15 +0200 | [diff] [blame] | 2997 | server <name> <address> [param*] |
| 2998 | Used to configure a syslog tcp server to forward messages from ring buffer. |
| 2999 | This supports for all "server" parameters found in 5.2 paragraph. Some of |
| 3000 | these parameters are irrelevant for "ring" sections. Important point: there |
| 3001 | is little reason to add more than one server to a ring, because all servers |
| 3002 | will receive the exact same copy of the ring contents, and as such the ring |
| 3003 | will progress at the speed of the slowest server. If one server does not |
| 3004 | respond, it will prevent old messages from being purged and may block new |
| 3005 | messages from being inserted into the ring. The proper way to send messages |
| 3006 | to multiple servers is to use one distinct ring per log server, not to |
Emeric Brun | 9755647 | 2020-05-30 01:42:45 +0200 | [diff] [blame] | 3007 | attach multiple servers to the same ring. Note that specific server directive |
| 3008 | "log-proto" is used to set the protocol used to send messages. |
Emeric Brun | 494c505 | 2020-05-28 11:13:15 +0200 | [diff] [blame] | 3009 | |
Emeric Brun | 99c453d | 2020-05-25 15:01:04 +0200 | [diff] [blame] | 3010 | size <size> |
| 3011 | This is the optional size in bytes for the ring-buffer. Default value is |
| 3012 | set to BUFSIZE. |
| 3013 | |
Emeric Brun | 494c505 | 2020-05-28 11:13:15 +0200 | [diff] [blame] | 3014 | timeout connect <timeout> |
| 3015 | Set the maximum time to wait for a connection attempt to a server to succeed. |
| 3016 | |
| 3017 | Arguments : |
| 3018 | <timeout> is the timeout value specified in milliseconds by default, but |
| 3019 | can be in any other unit if the number is suffixed by the unit, |
| 3020 | as explained at the top of this document. |
| 3021 | |
| 3022 | timeout server <timeout> |
| 3023 | Set the maximum time for pending data staying into output buffer. |
| 3024 | |
| 3025 | Arguments : |
| 3026 | <timeout> is the timeout value specified in milliseconds by default, but |
| 3027 | can be in any other unit if the number is suffixed by the unit, |
| 3028 | as explained at the top of this document. |
| 3029 | |
Emeric Brun | 99c453d | 2020-05-25 15:01:04 +0200 | [diff] [blame] | 3030 | Example: |
| 3031 | global |
| 3032 | log ring@myring local7 |
| 3033 | |
| 3034 | ring myring |
| 3035 | description "My local buffer" |
| 3036 | format rfc3164 |
| 3037 | maxlen 1200 |
| 3038 | size 32764 |
Emeric Brun | 494c505 | 2020-05-28 11:13:15 +0200 | [diff] [blame] | 3039 | timeout connect 5s |
| 3040 | timeout server 10s |
Emeric Brun | 9755647 | 2020-05-30 01:42:45 +0200 | [diff] [blame] | 3041 | server mysyslogsrv 127.0.0.1:6514 log-proto octet-count |
Emeric Brun | 99c453d | 2020-05-25 15:01:04 +0200 | [diff] [blame] | 3042 | |
Emeric Brun | 12941c8 | 2020-07-07 14:19:42 +0200 | [diff] [blame] | 3043 | 3.10. Log forwarding |
| 3044 | ------------------- |
| 3045 | |
| 3046 | It is possible to declare one or multiple log forwarding section, |
| 3047 | haproxy will forward all received log messages to a log servers list. |
| 3048 | |
| 3049 | log-forward <name> |
| 3050 | Creates a new log forwarder proxy identified as <name>. |
| 3051 | |
Emeric Brun | cbb7bf7 | 2020-10-05 14:39:35 +0200 | [diff] [blame] | 3052 | backlog <conns> |
| 3053 | Give hints to the system about the approximate listen backlog desired size |
| 3054 | on connections accept. |
| 3055 | |
| 3056 | bind <addr> [param*] |
| 3057 | Used to configure a stream log listener to receive messages to forward. |
Emeric Brun | da46c1c | 2020-10-08 08:39:02 +0200 | [diff] [blame] | 3058 | This supports the "bind" parameters found in 5.1 paragraph including |
| 3059 | those about ssl but some statements such as "alpn" may be irrelevant for |
| 3060 | syslog protocol over TCP. |
| 3061 | Those listeners support both "Octet Counting" and "Non-Transparent-Framing" |
Emeric Brun | cbb7bf7 | 2020-10-05 14:39:35 +0200 | [diff] [blame] | 3062 | modes as defined in rfc-6587. |
| 3063 | |
Willy Tarreau | 76aaa7f | 2020-09-16 15:07:22 +0200 | [diff] [blame] | 3064 | dgram-bind <addr> [param*] |
Emeric Brun | cbb7bf7 | 2020-10-05 14:39:35 +0200 | [diff] [blame] | 3065 | Used to configure a datagram log listener to receive messages to forward. |
| 3066 | Addresses must be in IPv4 or IPv6 form,followed by a port. This supports |
| 3067 | for some of the "bind" parameters found in 5.1 paragraph among which |
| 3068 | "interface", "namespace" or "transparent", the other ones being |
Willy Tarreau | 26ff5da | 2020-09-16 15:22:19 +0200 | [diff] [blame] | 3069 | silently ignored as irrelevant for UDP/syslog case. |
Emeric Brun | 12941c8 | 2020-07-07 14:19:42 +0200 | [diff] [blame] | 3070 | |
| 3071 | log global |
Jan Wagner | 3e67860 | 2020-12-17 22:22:32 +0100 | [diff] [blame] | 3072 | log <address> [len <length>] [format <format>] [sample <ranges>:<sample_size>] |
Emeric Brun | 12941c8 | 2020-07-07 14:19:42 +0200 | [diff] [blame] | 3073 | <facility> [<level> [<minlevel>]] |
| 3074 | Used to configure target log servers. See more details on proxies |
| 3075 | documentation. |
| 3076 | If no format specified, haproxy tries to keep the incoming log format. |
| 3077 | Configured facility is ignored, except if incoming message does not |
| 3078 | present a facility but one is mandatory on the outgoing format. |
| 3079 | If there is no timestamp available in the input format, but the field |
| 3080 | exists in output format, haproxy will use the local date. |
| 3081 | |
| 3082 | Example: |
| 3083 | global |
| 3084 | log stderr format iso local7 |
| 3085 | |
| 3086 | ring myring |
| 3087 | description "My local buffer" |
| 3088 | format rfc5424 |
| 3089 | maxlen 1200 |
| 3090 | size 32764 |
| 3091 | timeout connect 5s |
| 3092 | timeout server 10s |
| 3093 | # syslog tcp server |
| 3094 | server mysyslogsrv 127.0.0.1:514 log-proto octet-count |
| 3095 | |
| 3096 | log-forward sylog-loadb |
Emeric Brun | cbb7bf7 | 2020-10-05 14:39:35 +0200 | [diff] [blame] | 3097 | dgram-bind 127.0.0.1:1514 |
| 3098 | bind 127.0.0.1:1514 |
Emeric Brun | 12941c8 | 2020-07-07 14:19:42 +0200 | [diff] [blame] | 3099 | # all messages on stderr |
| 3100 | log global |
| 3101 | # all messages on local tcp syslog server |
| 3102 | log ring@myring local0 |
| 3103 | # load balance messages on 4 udp syslog servers |
| 3104 | log 127.0.0.1:10001 sample 1:4 local0 |
| 3105 | log 127.0.0.1:10002 sample 2:4 local0 |
| 3106 | log 127.0.0.1:10003 sample 3:4 local0 |
| 3107 | log 127.0.0.1:10004 sample 4:4 local0 |
Christopher Faulet | 76edc0f | 2020-01-13 15:52:01 +0100 | [diff] [blame] | 3108 | |
Emeric Brun | cbb7bf7 | 2020-10-05 14:39:35 +0200 | [diff] [blame] | 3109 | maxconn <conns> |
| 3110 | Fix the maximum number of concurrent connections on a log forwarder. |
| 3111 | 10 is the default. |
| 3112 | |
| 3113 | timeout client <timeout> |
| 3114 | Set the maximum inactivity time on the client side. |
| 3115 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 3116 | 4. Proxies |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 3117 | ---------- |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3118 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 3119 | Proxy configuration can be located in a set of sections : |
William Lallemand | 6e62fb6 | 2015-04-28 16:55:23 +0200 | [diff] [blame] | 3120 | - defaults [<name>] |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 3121 | - frontend <name> |
| 3122 | - backend <name> |
| 3123 | - listen <name> |
| 3124 | |
| 3125 | A "defaults" section sets default parameters for all other sections following |
| 3126 | its declaration. Those default parameters are reset by the next "defaults" |
| 3127 | section. See below for the list of parameters which can be set in a "defaults" |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3128 | section. The name is optional but its use is encouraged for better readability. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 3129 | |
| 3130 | A "frontend" section describes a set of listening sockets accepting client |
| 3131 | connections. |
| 3132 | |
| 3133 | A "backend" section describes a set of servers to which the proxy will connect |
| 3134 | to forward incoming connections. |
| 3135 | |
| 3136 | A "listen" section defines a complete proxy with its frontend and backend |
| 3137 | parts combined in one section. It is generally useful for TCP-only traffic. |
| 3138 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3139 | All proxy names must be formed from upper and lower case letters, digits, |
| 3140 | '-' (dash), '_' (underscore) , '.' (dot) and ':' (colon). ACL names are |
| 3141 | case-sensitive, which means that "www" and "WWW" are two different proxies. |
| 3142 | |
| 3143 | Historically, all proxy names could overlap, it just caused troubles in the |
| 3144 | logs. Since the introduction of content switching, it is mandatory that two |
| 3145 | proxies with overlapping capabilities (frontend/backend) have different names. |
| 3146 | However, it is still permitted that a frontend and a backend share the same |
| 3147 | name, as this configuration seems to be commonly encountered. |
| 3148 | |
| 3149 | Right now, two major proxy modes are supported : "tcp", also known as layer 4, |
| 3150 | and "http", also known as layer 7. In layer 4 mode, HAProxy simply forwards |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 3151 | bidirectional traffic between two sides. In layer 7 mode, HAProxy analyzes the |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3152 | protocol, and can interact with it by allowing, blocking, switching, adding, |
| 3153 | modifying, or removing arbitrary contents in requests or responses, based on |
| 3154 | arbitrary criteria. |
| 3155 | |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 3156 | In HTTP mode, the processing applied to requests and responses flowing over |
| 3157 | a connection depends in the combination of the frontend's HTTP options and |
Julien Pivotto | 21ad315 | 2019-12-10 13:11:17 +0100 | [diff] [blame] | 3158 | the backend's. HAProxy supports 3 connection modes : |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 3159 | |
| 3160 | - KAL : keep alive ("option http-keep-alive") which is the default mode : all |
| 3161 | requests and responses are processed, and connections remain open but idle |
| 3162 | between responses and new requests. |
| 3163 | |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 3164 | - SCL: server close ("option http-server-close") : the server-facing |
| 3165 | connection is closed after the end of the response is received, but the |
| 3166 | client-facing connection remains open. |
| 3167 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 3168 | - CLO: close ("option httpclose"): the connection is closed after the end of |
| 3169 | the response and "Connection: close" appended in both directions. |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 3170 | |
| 3171 | The effective mode that will be applied to a connection passing through a |
| 3172 | frontend and a backend can be determined by both proxy modes according to the |
| 3173 | following matrix, but in short, the modes are symmetric, keep-alive is the |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 3174 | weakest option and close is the strongest. |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 3175 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 3176 | Backend mode |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 3177 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 3178 | | KAL | SCL | CLO |
| 3179 | ----+-----+-----+---- |
| 3180 | KAL | KAL | SCL | CLO |
| 3181 | ----+-----+-----+---- |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 3182 | mode SCL | SCL | SCL | CLO |
| 3183 | ----+-----+-----+---- |
| 3184 | CLO | CLO | CLO | CLO |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 3185 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3186 | |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 3187 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 3188 | 4.1. Proxy keywords matrix |
| 3189 | -------------------------- |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3190 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 3191 | The following list of keywords is supported. Most of them may only be used in a |
| 3192 | limited set of section types. Some of them are marked as "deprecated" because |
| 3193 | they are inherited from an old syntax which may be confusing or functionally |
| 3194 | limited, and there are new recommended keywords to replace them. Keywords |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 3195 | marked with "(*)" can be optionally inverted using the "no" prefix, e.g. "no |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 3196 | option contstats". This makes sense when the option has been enabled by default |
Willy Tarreau | 3842f00 | 2009-06-14 11:39:52 +0200 | [diff] [blame] | 3197 | and must be disabled for a specific instance. Such options may also be prefixed |
| 3198 | with "default" in order to restore default settings regardless of what has been |
| 3199 | specified in a previous "defaults" section. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3200 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 3201 | |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3202 | keyword defaults frontend listen backend |
| 3203 | ------------------------------------+----------+----------+---------+--------- |
| 3204 | acl - X X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3205 | backlog X X X - |
| 3206 | balance X - X X |
| 3207 | bind - X X - |
| 3208 | bind-process X X X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3209 | capture cookie - X X - |
| 3210 | capture request header - X X - |
| 3211 | capture response header - X X - |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 3212 | clitcpka-cnt X X X - |
| 3213 | clitcpka-idle X X X - |
| 3214 | clitcpka-intvl X X X - |
William Lallemand | 82fe75c | 2012-10-23 10:25:10 +0200 | [diff] [blame] | 3215 | compression X X X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3216 | cookie X - X X |
Thierry FOURNIER | a0a1b75 | 2015-05-26 17:44:32 +0200 | [diff] [blame] | 3217 | declare capture - X X - |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3218 | default-server X - X X |
| 3219 | default_backend X X X - |
| 3220 | description - X X X |
| 3221 | disabled X X X X |
| 3222 | dispatch - - X X |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 3223 | email-alert from X X X X |
Simon Horman | 64e3416 | 2015-02-06 11:11:57 +0900 | [diff] [blame] | 3224 | email-alert level X X X X |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 3225 | email-alert mailers X X X X |
| 3226 | email-alert myhostname X X X X |
| 3227 | email-alert to X X X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3228 | enabled X X X X |
| 3229 | errorfile X X X X |
Christopher Faulet | 76edc0f | 2020-01-13 15:52:01 +0100 | [diff] [blame] | 3230 | errorfiles X X X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3231 | errorloc X X X X |
| 3232 | errorloc302 X X X X |
| 3233 | -- keyword -------------------------- defaults - frontend - listen -- backend - |
| 3234 | errorloc303 X X X X |
Cyril Bonté | 4288c5a | 2018-03-12 22:02:59 +0100 | [diff] [blame] | 3235 | force-persist - - X X |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 3236 | filter - X X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3237 | fullconn X - X X |
| 3238 | grace X X X X |
| 3239 | hash-type X - X X |
Christopher Faulet | 6d0c3df | 2020-01-22 09:26:35 +0100 | [diff] [blame] | 3240 | http-after-response - X X X |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 3241 | http-check comment X - X X |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 3242 | http-check connect X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3243 | http-check disable-on-404 X - X X |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 3244 | http-check expect X - X X |
Peter Gervai | 8912ae6 | 2020-06-11 18:26:36 +0200 | [diff] [blame] | 3245 | http-check send X - X X |
Willy Tarreau | 7ab6aff | 2010-10-12 06:30:16 +0200 | [diff] [blame] | 3246 | http-check send-state X - X X |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 3247 | http-check set-var X - X X |
| 3248 | http-check unset-var X - X X |
Christopher Faulet | 3b967c1 | 2020-05-15 15:47:44 +0200 | [diff] [blame] | 3249 | http-error X X X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3250 | http-request - X X X |
Willy Tarreau | e365c0b | 2013-06-11 16:06:12 +0200 | [diff] [blame] | 3251 | http-response - X X X |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 3252 | http-reuse X - X X |
Baptiste Assmann | 2c42ef5 | 2013-10-09 21:57:02 +0200 | [diff] [blame] | 3253 | http-send-name-header - - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3254 | id - X X X |
Cyril Bonté | 4288c5a | 2018-03-12 22:02:59 +0100 | [diff] [blame] | 3255 | ignore-persist - - X X |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 3256 | load-server-state-from-file X - X X |
William Lallemand | 0f99e34 | 2011-10-12 17:50:54 +0200 | [diff] [blame] | 3257 | log (*) X X X X |
Willy Tarreau | fb4e7ea | 2015-01-07 14:55:17 +0100 | [diff] [blame] | 3258 | log-format X X X - |
Dragan Dosen | 7ad3154 | 2015-09-28 17:16:47 +0200 | [diff] [blame] | 3259 | log-format-sd X X X - |
Willy Tarreau | 094af4e | 2015-01-07 15:03:42 +0100 | [diff] [blame] | 3260 | log-tag X X X X |
Willy Tarreau | c35362a | 2014-04-25 13:58:37 +0200 | [diff] [blame] | 3261 | max-keep-alive-queue X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3262 | maxconn X X X - |
| 3263 | mode X X X X |
| 3264 | monitor fail - X X - |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3265 | monitor-uri X X X - |
| 3266 | option abortonclose (*) X - X X |
| 3267 | option accept-invalid-http-request (*) X X X - |
| 3268 | option accept-invalid-http-response (*) X - X X |
| 3269 | option allbackups (*) X - X X |
| 3270 | option checkcache (*) X - X X |
| 3271 | option clitcpka (*) X X X - |
| 3272 | option contstats (*) X X X - |
Christopher Faulet | 89aed32 | 2020-06-02 17:33:56 +0200 | [diff] [blame] | 3273 | option disable-h2-upgrade (*) X X X - |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3274 | option dontlog-normal (*) X X X - |
| 3275 | option dontlognull (*) X X X - |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3276 | -- keyword -------------------------- defaults - frontend - listen -- backend - |
| 3277 | option forwardfor X X X X |
Christopher Faulet | 98fbe95 | 2019-07-22 16:18:24 +0200 | [diff] [blame] | 3278 | option h1-case-adjust-bogus-client (*) X X X - |
| 3279 | option h1-case-adjust-bogus-server (*) X - X X |
Willy Tarreau | 9fbe18e | 2015-05-01 22:42:08 +0200 | [diff] [blame] | 3280 | option http-buffer-request (*) X X X X |
Willy Tarreau | 82649f9 | 2015-05-01 22:40:51 +0200 | [diff] [blame] | 3281 | option http-ignore-probes (*) X X X - |
Willy Tarreau | 16bfb02 | 2010-01-16 19:48:41 +0100 | [diff] [blame] | 3282 | option http-keep-alive (*) X X X X |
Willy Tarreau | 96e3121 | 2011-05-30 18:10:30 +0200 | [diff] [blame] | 3283 | option http-no-delay (*) X X X X |
Christopher Faulet | 98db976 | 2018-09-21 10:25:19 +0200 | [diff] [blame] | 3284 | option http-pretend-keepalive (*) X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3285 | option http-server-close (*) X X X X |
| 3286 | option http-use-proxy-header (*) X X X - |
| 3287 | option httpchk X - X X |
| 3288 | option httpclose (*) X X X X |
Freddy Spierenburg | e88b773 | 2019-03-25 14:35:17 +0100 | [diff] [blame] | 3289 | option httplog X X X - |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3290 | option http_proxy (*) X X X X |
Jamie Gloudon | 801a0a3 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 3291 | option independent-streams (*) X X X X |
Gabor Lekeny | b4c81e4 | 2010-09-29 18:17:05 +0200 | [diff] [blame] | 3292 | option ldap-check X - X X |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 3293 | option external-check X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3294 | option log-health-checks (*) X - X X |
| 3295 | option log-separate-errors (*) X X X - |
| 3296 | option logasap (*) X X X - |
| 3297 | option mysql-check X - X X |
| 3298 | option nolinger (*) X X X X |
| 3299 | option originalto X X X X |
| 3300 | option persist (*) X - X X |
Baptiste Assmann | 809e22a | 2015-10-12 20:22:55 +0200 | [diff] [blame] | 3301 | option pgsql-check X - X X |
| 3302 | option prefer-last-server (*) X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3303 | option redispatch (*) X - X X |
Hervé COMMOWICK | ec032d6 | 2011-08-05 16:23:48 +0200 | [diff] [blame] | 3304 | option redis-check X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3305 | option smtpchk X - X X |
| 3306 | option socket-stats (*) X X X - |
| 3307 | option splice-auto (*) X X X X |
| 3308 | option splice-request (*) X X X X |
| 3309 | option splice-response (*) X X X X |
Christopher Faulet | ba7bc16 | 2016-11-07 21:07:38 +0100 | [diff] [blame] | 3310 | option spop-check - - - X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3311 | option srvtcpka (*) X - X X |
| 3312 | option ssl-hello-chk X - X X |
| 3313 | -- keyword -------------------------- defaults - frontend - listen -- backend - |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 3314 | option tcp-check X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3315 | option tcp-smart-accept (*) X X X - |
| 3316 | option tcp-smart-connect (*) X - X X |
| 3317 | option tcpka X X X X |
| 3318 | option tcplog X X X X |
| 3319 | option transparent (*) X - X X |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 3320 | external-check command X - X X |
| 3321 | external-check path X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3322 | persist rdp-cookie X - X X |
| 3323 | rate-limit sessions X X X - |
| 3324 | redirect - X X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3325 | -- keyword -------------------------- defaults - frontend - listen -- backend - |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3326 | retries X - X X |
Olivier Houchard | a254a37 | 2019-04-05 15:30:12 +0200 | [diff] [blame] | 3327 | retry-on X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3328 | server - - X X |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 3329 | server-state-file-name X - X X |
Frédéric Lécaille | cb4502e | 2017-04-20 13:36:25 +0200 | [diff] [blame] | 3330 | server-template - - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3331 | source X - X X |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 3332 | srvtcpka-cnt X - X X |
| 3333 | srvtcpka-idle X - X X |
| 3334 | srvtcpka-intvl X - X X |
Baptiste Assmann | 5a54921 | 2015-10-12 20:30:24 +0200 | [diff] [blame] | 3335 | stats admin - X X X |
| 3336 | stats auth X X X X |
| 3337 | stats enable X X X X |
| 3338 | stats hide-version X X X X |
| 3339 | stats http-request - X X X |
| 3340 | stats realm X X X X |
| 3341 | stats refresh X X X X |
| 3342 | stats scope X X X X |
| 3343 | stats show-desc X X X X |
| 3344 | stats show-legends X X X X |
| 3345 | stats show-node X X X X |
| 3346 | stats uri X X X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3347 | -- keyword -------------------------- defaults - frontend - listen -- backend - |
| 3348 | stick match - - X X |
| 3349 | stick on - - X X |
| 3350 | stick store-request - - X X |
Willy Tarreau | d8dc99f | 2011-07-01 11:33:25 +0200 | [diff] [blame] | 3351 | stick store-response - - X X |
Adam Spiers | 68af3c1 | 2017-04-06 16:31:39 +0100 | [diff] [blame] | 3352 | stick-table - X X X |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 3353 | tcp-check comment X - X X |
Christopher Faulet | 404f919 | 2020-04-09 23:13:54 +0200 | [diff] [blame] | 3354 | tcp-check connect X - X X |
| 3355 | tcp-check expect X - X X |
| 3356 | tcp-check send X - X X |
Christopher Faulet | b50b3e6 | 2020-05-05 18:43:43 +0200 | [diff] [blame] | 3357 | tcp-check send-lf X - X X |
Christopher Faulet | 404f919 | 2020-04-09 23:13:54 +0200 | [diff] [blame] | 3358 | tcp-check send-binary X - X X |
Christopher Faulet | b50b3e6 | 2020-05-05 18:43:43 +0200 | [diff] [blame] | 3359 | tcp-check send-binary-lf X - X X |
Christopher Faulet | 404f919 | 2020-04-09 23:13:54 +0200 | [diff] [blame] | 3360 | tcp-check set-var X - X X |
| 3361 | tcp-check unset-var X - X X |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 3362 | tcp-request connection - X X - |
| 3363 | tcp-request content - X X X |
Willy Tarreau | a56235c | 2010-09-14 11:31:36 +0200 | [diff] [blame] | 3364 | tcp-request inspect-delay - X X X |
Willy Tarreau | 4f61429 | 2016-10-21 17:49:36 +0200 | [diff] [blame] | 3365 | tcp-request session - X X - |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 3366 | tcp-response content - - X X |
| 3367 | tcp-response inspect-delay - - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3368 | timeout check X - X X |
| 3369 | timeout client X X X - |
Willy Tarreau | 05cdd96 | 2014-05-10 14:30:07 +0200 | [diff] [blame] | 3370 | timeout client-fin X X X - |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3371 | timeout connect X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3372 | timeout http-keep-alive X X X X |
| 3373 | timeout http-request X X X X |
| 3374 | timeout queue X - X X |
| 3375 | timeout server X - X X |
Willy Tarreau | 05cdd96 | 2014-05-10 14:30:07 +0200 | [diff] [blame] | 3376 | timeout server-fin X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3377 | timeout tarpit X X X X |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 3378 | timeout tunnel X - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3379 | transparent (deprecated) X - X X |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 3380 | unique-id-format X X X - |
| 3381 | unique-id-header X X X - |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3382 | use_backend - X X - |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 3383 | use-fcgi-app - - X X |
Willy Tarreau | 4a5cade | 2012-04-05 21:09:48 +0200 | [diff] [blame] | 3384 | use-server - - X X |
Willy Tarreau | 5c6f7b3 | 2010-02-26 13:34:29 +0100 | [diff] [blame] | 3385 | ------------------------------------+----------+----------+---------+--------- |
| 3386 | keyword defaults frontend listen backend |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 3387 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3388 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 3389 | 4.2. Alphabetically sorted keywords reference |
| 3390 | --------------------------------------------- |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3391 | |
| 3392 | This section provides a description of each keyword and its usage. |
| 3393 | |
| 3394 | |
| 3395 | acl <aclname> <criterion> [flags] [operator] <value> ... |
| 3396 | Declare or complete an access list. |
| 3397 | May be used in sections : defaults | frontend | listen | backend |
| 3398 | no | yes | yes | yes |
| 3399 | Example: |
| 3400 | acl invalid_src src 0.0.0.0/7 224.0.0.0/3 |
| 3401 | acl invalid_src src_port 0:1023 |
| 3402 | acl local_dst hdr(host) -i localhost |
| 3403 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 3404 | See section 7 about ACL usage. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3405 | |
| 3406 | |
Willy Tarreau | c73ce2b | 2008-01-06 10:55:10 +0100 | [diff] [blame] | 3407 | backlog <conns> |
| 3408 | Give hints to the system about the approximate listen backlog desired size |
| 3409 | May be used in sections : defaults | frontend | listen | backend |
| 3410 | yes | yes | yes | no |
| 3411 | Arguments : |
| 3412 | <conns> is the number of pending connections. Depending on the operating |
| 3413 | system, it may represent the number of already acknowledged |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 3414 | connections, of non-acknowledged ones, or both. |
Willy Tarreau | c73ce2b | 2008-01-06 10:55:10 +0100 | [diff] [blame] | 3415 | |
| 3416 | In order to protect against SYN flood attacks, one solution is to increase |
| 3417 | the system's SYN backlog size. Depending on the system, sometimes it is just |
| 3418 | tunable via a system parameter, sometimes it is not adjustable at all, and |
| 3419 | sometimes the system relies on hints given by the application at the time of |
| 3420 | the listen() syscall. By default, HAProxy passes the frontend's maxconn value |
| 3421 | to the listen() syscall. On systems which can make use of this value, it can |
| 3422 | sometimes be useful to be able to specify a different value, hence this |
| 3423 | backlog parameter. |
| 3424 | |
| 3425 | On Linux 2.4, the parameter is ignored by the system. On Linux 2.6, it is |
| 3426 | used as a hint and the system accepts up to the smallest greater power of |
| 3427 | two, and never more than some limits (usually 32768). |
| 3428 | |
| 3429 | See also : "maxconn" and the target operating system's tuning guide. |
| 3430 | |
| 3431 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3432 | balance <algorithm> [ <arguments> ] |
Willy Tarreau | 226071e | 2014-04-10 11:55:45 +0200 | [diff] [blame] | 3433 | balance url_param <param> [check_post] |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3434 | Define the load balancing algorithm to be used in a backend. |
| 3435 | May be used in sections : defaults | frontend | listen | backend |
| 3436 | yes | no | yes | yes |
| 3437 | Arguments : |
| 3438 | <algorithm> is the algorithm used to select a server when doing load |
| 3439 | balancing. This only applies when no persistence information |
| 3440 | is available, or when a connection is redispatched to another |
| 3441 | server. <algorithm> may be one of the following : |
| 3442 | |
| 3443 | roundrobin Each server is used in turns, according to their weights. |
| 3444 | This is the smoothest and fairest algorithm when the server's |
| 3445 | processing time remains equally distributed. This algorithm |
| 3446 | is dynamic, which means that server weights may be adjusted |
Willy Tarreau | 9757a38 | 2009-10-03 12:56:50 +0200 | [diff] [blame] | 3447 | on the fly for slow starts for instance. It is limited by |
Godbach | a34bdc0 | 2013-07-22 07:44:53 +0800 | [diff] [blame] | 3448 | design to 4095 active servers per backend. Note that in some |
Willy Tarreau | 9757a38 | 2009-10-03 12:56:50 +0200 | [diff] [blame] | 3449 | large farms, when a server becomes up after having been down |
| 3450 | for a very short time, it may sometimes take a few hundreds |
| 3451 | requests for it to be re-integrated into the farm and start |
| 3452 | receiving traffic. This is normal, though very rare. It is |
| 3453 | indicated here in case you would have the chance to observe |
| 3454 | it, so that you don't worry. |
| 3455 | |
| 3456 | static-rr Each server is used in turns, according to their weights. |
| 3457 | This algorithm is as similar to roundrobin except that it is |
| 3458 | static, which means that changing a server's weight on the |
| 3459 | fly will have no effect. On the other hand, it has no design |
| 3460 | limitation on the number of servers, and when a server goes |
| 3461 | up, it is always immediately reintroduced into the farm, once |
| 3462 | the full map is recomputed. It also uses slightly less CPU to |
| 3463 | run (around -1%). |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3464 | |
Willy Tarreau | 2d2a7f8 | 2008-03-17 12:07:56 +0100 | [diff] [blame] | 3465 | leastconn The server with the lowest number of connections receives the |
| 3466 | connection. Round-robin is performed within groups of servers |
| 3467 | of the same load to ensure that all servers will be used. Use |
| 3468 | of this algorithm is recommended where very long sessions are |
| 3469 | expected, such as LDAP, SQL, TSE, etc... but is not very well |
| 3470 | suited for protocols using short sessions such as HTTP. This |
| 3471 | algorithm is dynamic, which means that server weights may be |
Willy Tarreau | 8c855f6 | 2020-10-22 17:41:45 +0200 | [diff] [blame] | 3472 | adjusted on the fly for slow starts for instance. It will |
| 3473 | also consider the number of queued connections in addition to |
| 3474 | the established ones in order to minimize queuing. |
Willy Tarreau | 2d2a7f8 | 2008-03-17 12:07:56 +0100 | [diff] [blame] | 3475 | |
Willy Tarreau | f09c660 | 2012-02-13 17:12:08 +0100 | [diff] [blame] | 3476 | first The first server with available connection slots receives the |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 3477 | connection. The servers are chosen from the lowest numeric |
Willy Tarreau | f09c660 | 2012-02-13 17:12:08 +0100 | [diff] [blame] | 3478 | identifier to the highest (see server parameter "id"), which |
| 3479 | defaults to the server's position in the farm. Once a server |
Willy Tarreau | 64559c5 | 2012-04-07 09:08:45 +0200 | [diff] [blame] | 3480 | reaches its maxconn value, the next server is used. It does |
Willy Tarreau | f09c660 | 2012-02-13 17:12:08 +0100 | [diff] [blame] | 3481 | not make sense to use this algorithm without setting maxconn. |
| 3482 | The purpose of this algorithm is to always use the smallest |
| 3483 | number of servers so that extra servers can be powered off |
| 3484 | during non-intensive hours. This algorithm ignores the server |
| 3485 | weight, and brings more benefit to long session such as RDP |
Willy Tarreau | 64559c5 | 2012-04-07 09:08:45 +0200 | [diff] [blame] | 3486 | or IMAP than HTTP, though it can be useful there too. In |
| 3487 | order to use this algorithm efficiently, it is recommended |
| 3488 | that a cloud controller regularly checks server usage to turn |
| 3489 | them off when unused, and regularly checks backend queue to |
| 3490 | turn new servers on when the queue inflates. Alternatively, |
| 3491 | using "http-check send-state" may inform servers on the load. |
Willy Tarreau | f09c660 | 2012-02-13 17:12:08 +0100 | [diff] [blame] | 3492 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3493 | source The source IP address is hashed and divided by the total |
| 3494 | weight of the running servers to designate which server will |
| 3495 | receive the request. This ensures that the same client IP |
| 3496 | address will always reach the same server as long as no |
| 3497 | server goes down or up. If the hash result changes due to the |
| 3498 | number of running servers changing, many clients will be |
| 3499 | directed to a different server. This algorithm is generally |
| 3500 | used in TCP mode where no cookie may be inserted. It may also |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 3501 | be used on the Internet to provide a best-effort stickiness |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3502 | to clients which refuse session cookies. This algorithm is |
Willy Tarreau | 6b2e11b | 2009-10-01 07:52:15 +0200 | [diff] [blame] | 3503 | static by default, which means that changing a server's |
| 3504 | weight on the fly will have no effect, but this can be |
| 3505 | changed using "hash-type". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3506 | |
Oskar Stolc | 8dc4184 | 2012-05-19 10:19:54 +0100 | [diff] [blame] | 3507 | uri This algorithm hashes either the left part of the URI (before |
| 3508 | the question mark) or the whole URI (if the "whole" parameter |
| 3509 | is present) and divides the hash value by the total weight of |
| 3510 | the running servers. The result designates which server will |
| 3511 | receive the request. This ensures that the same URI will |
| 3512 | always be directed to the same server as long as no server |
| 3513 | goes up or down. This is used with proxy caches and |
| 3514 | anti-virus proxies in order to maximize the cache hit rate. |
| 3515 | Note that this algorithm may only be used in an HTTP backend. |
| 3516 | This algorithm is static by default, which means that |
| 3517 | changing a server's weight on the fly will have no effect, |
| 3518 | but this can be changed using "hash-type". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3519 | |
Oskar Stolc | 8dc4184 | 2012-05-19 10:19:54 +0100 | [diff] [blame] | 3520 | This algorithm supports two optional parameters "len" and |
Marek Majkowski | 9c30fc1 | 2008-04-27 23:25:55 +0200 | [diff] [blame] | 3521 | "depth", both followed by a positive integer number. These |
| 3522 | options may be helpful when it is needed to balance servers |
| 3523 | based on the beginning of the URI only. The "len" parameter |
| 3524 | indicates that the algorithm should only consider that many |
| 3525 | characters at the beginning of the URI to compute the hash. |
| 3526 | Note that having "len" set to 1 rarely makes sense since most |
| 3527 | URIs start with a leading "/". |
| 3528 | |
| 3529 | The "depth" parameter indicates the maximum directory depth |
| 3530 | to be used to compute the hash. One level is counted for each |
| 3531 | slash in the request. If both parameters are specified, the |
| 3532 | evaluation stops when either is reached. |
| 3533 | |
Willy Tarreau | 57a3741 | 2020-09-23 08:56:29 +0200 | [diff] [blame] | 3534 | A "path-only" parameter indicates that the hashing key starts |
| 3535 | at the first '/' of the path. This can be used to ignore the |
| 3536 | authority part of absolute URIs, and to make sure that HTTP/1 |
| 3537 | and HTTP/2 URIs will provide the same hash. |
| 3538 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3539 | url_param The URL parameter specified in argument will be looked up in |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 3540 | the query string of each HTTP GET request. |
| 3541 | |
| 3542 | If the modifier "check_post" is used, then an HTTP POST |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 3543 | request entity will be searched for the parameter argument, |
| 3544 | when it is not found in a query string after a question mark |
Willy Tarreau | 226071e | 2014-04-10 11:55:45 +0200 | [diff] [blame] | 3545 | ('?') in the URL. The message body will only start to be |
| 3546 | analyzed once either the advertised amount of data has been |
| 3547 | received or the request buffer is full. In the unlikely event |
| 3548 | that chunked encoding is used, only the first chunk is |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 3549 | scanned. Parameter values separated by a chunk boundary, may |
Willy Tarreau | 226071e | 2014-04-10 11:55:45 +0200 | [diff] [blame] | 3550 | be randomly balanced if at all. This keyword used to support |
| 3551 | an optional <max_wait> parameter which is now ignored. |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 3552 | |
| 3553 | If the parameter is found followed by an equal sign ('=') and |
| 3554 | a value, then the value is hashed and divided by the total |
| 3555 | weight of the running servers. The result designates which |
| 3556 | server will receive the request. |
| 3557 | |
| 3558 | This is used to track user identifiers in requests and ensure |
| 3559 | that a same user ID will always be sent to the same server as |
| 3560 | long as no server goes up or down. If no value is found or if |
| 3561 | the parameter is not found, then a round robin algorithm is |
| 3562 | applied. Note that this algorithm may only be used in an HTTP |
Willy Tarreau | 6b2e11b | 2009-10-01 07:52:15 +0200 | [diff] [blame] | 3563 | backend. This algorithm is static by default, which means |
| 3564 | that changing a server's weight on the fly will have no |
| 3565 | effect, but this can be changed using "hash-type". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3566 | |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 3567 | hdr(<name>) The HTTP header <name> will be looked up in each HTTP |
| 3568 | request. Just as with the equivalent ACL 'hdr()' function, |
| 3569 | the header name in parenthesis is not case sensitive. If the |
| 3570 | header is absent or if it does not contain any value, the |
| 3571 | roundrobin algorithm is applied instead. |
Benoit | affb481 | 2009-03-25 13:02:10 +0100 | [diff] [blame] | 3572 | |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 3573 | An optional 'use_domain_only' parameter is available, for |
Benoit | affb481 | 2009-03-25 13:02:10 +0100 | [diff] [blame] | 3574 | reducing the hash algorithm to the main domain part with some |
| 3575 | specific headers such as 'Host'. For instance, in the Host |
| 3576 | value "haproxy.1wt.eu", only "1wt" will be considered. |
| 3577 | |
Willy Tarreau | 6b2e11b | 2009-10-01 07:52:15 +0200 | [diff] [blame] | 3578 | This algorithm is static by default, which means that |
| 3579 | changing a server's weight on the fly will have no effect, |
| 3580 | but this can be changed using "hash-type". |
| 3581 | |
Willy Tarreau | 21c741a | 2019-01-14 18:14:27 +0100 | [diff] [blame] | 3582 | random |
| 3583 | random(<draws>) |
| 3584 | A random number will be used as the key for the consistent |
Willy Tarreau | 760e81d | 2018-05-03 07:20:40 +0200 | [diff] [blame] | 3585 | hashing function. This means that the servers' weights are |
| 3586 | respected, dynamic weight changes immediately take effect, as |
| 3587 | well as new server additions. Random load balancing can be |
| 3588 | useful with large farms or when servers are frequently added |
Willy Tarreau | 21c741a | 2019-01-14 18:14:27 +0100 | [diff] [blame] | 3589 | or removed as it may avoid the hammering effect that could |
| 3590 | result from roundrobin or leastconn in this situation. The |
| 3591 | hash-balance-factor directive can be used to further improve |
| 3592 | fairness of the load balancing, especially in situations |
| 3593 | where servers show highly variable response times. When an |
| 3594 | argument <draws> is present, it must be an integer value one |
| 3595 | or greater, indicating the number of draws before selecting |
| 3596 | the least loaded of these servers. It was indeed demonstrated |
| 3597 | that picking the least loaded of two servers is enough to |
| 3598 | significantly improve the fairness of the algorithm, by |
| 3599 | always avoiding to pick the most loaded server within a farm |
| 3600 | and getting rid of any bias that could be induced by the |
| 3601 | unfair distribution of the consistent list. Higher values N |
| 3602 | will take away N-1 of the highest loaded servers at the |
| 3603 | expense of performance. With very high values, the algorithm |
| 3604 | will converge towards the leastconn's result but much slower. |
| 3605 | The default value is 2, which generally shows very good |
| 3606 | distribution and performance. This algorithm is also known as |
| 3607 | the Power of Two Random Choices and is described here : |
| 3608 | http://www.eecs.harvard.edu/~michaelm/postscripts/handbook2001.pdf |
Willy Tarreau | 760e81d | 2018-05-03 07:20:40 +0200 | [diff] [blame] | 3609 | |
Emeric Brun | 736aa23 | 2009-06-30 17:56:00 +0200 | [diff] [blame] | 3610 | rdp-cookie |
Hervé COMMOWICK | a3eb39c | 2011-08-05 18:48:51 +0200 | [diff] [blame] | 3611 | rdp-cookie(<name>) |
Emeric Brun | 736aa23 | 2009-06-30 17:56:00 +0200 | [diff] [blame] | 3612 | The RDP cookie <name> (or "mstshash" if omitted) will be |
| 3613 | looked up and hashed for each incoming TCP request. Just as |
| 3614 | with the equivalent ACL 'req_rdp_cookie()' function, the name |
| 3615 | is not case-sensitive. This mechanism is useful as a degraded |
| 3616 | persistence mode, as it makes it possible to always send the |
| 3617 | same user (or the same session ID) to the same server. If the |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 3618 | cookie is not found, the normal roundrobin algorithm is |
Emeric Brun | 736aa23 | 2009-06-30 17:56:00 +0200 | [diff] [blame] | 3619 | used instead. |
| 3620 | |
| 3621 | Note that for this to work, the frontend must ensure that an |
| 3622 | RDP cookie is already present in the request buffer. For this |
| 3623 | you must use 'tcp-request content accept' rule combined with |
| 3624 | a 'req_rdp_cookie_cnt' ACL. |
| 3625 | |
Willy Tarreau | 6b2e11b | 2009-10-01 07:52:15 +0200 | [diff] [blame] | 3626 | This algorithm is static by default, which means that |
| 3627 | changing a server's weight on the fly will have no effect, |
| 3628 | but this can be changed using "hash-type". |
| 3629 | |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 3630 | See also the rdp_cookie pattern fetch function. |
Simon Horman | ab814e0 | 2011-06-24 14:50:20 +0900 | [diff] [blame] | 3631 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3632 | <arguments> is an optional list of arguments which may be needed by some |
Marek Majkowski | 9c30fc1 | 2008-04-27 23:25:55 +0200 | [diff] [blame] | 3633 | algorithms. Right now, only "url_param" and "uri" support an |
| 3634 | optional argument. |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 3635 | |
Willy Tarreau | 3cd9af2 | 2009-03-15 14:06:41 +0100 | [diff] [blame] | 3636 | The load balancing algorithm of a backend is set to roundrobin when no other |
| 3637 | algorithm, mode nor option have been set. The algorithm may only be set once |
| 3638 | for each backend. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3639 | |
Lukas Tribus | 80512b1 | 2018-10-27 20:07:40 +0200 | [diff] [blame] | 3640 | With authentication schemes that require the same connection like NTLM, URI |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 3641 | based algorithms must not be used, as they would cause subsequent requests |
Lukas Tribus | 80512b1 | 2018-10-27 20:07:40 +0200 | [diff] [blame] | 3642 | to be routed to different backend servers, breaking the invalid assumptions |
| 3643 | NTLM relies on. |
| 3644 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3645 | Examples : |
| 3646 | balance roundrobin |
| 3647 | balance url_param userid |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 3648 | balance url_param session_id check_post 64 |
Benoit | affb481 | 2009-03-25 13:02:10 +0100 | [diff] [blame] | 3649 | balance hdr(User-Agent) |
| 3650 | balance hdr(host) |
| 3651 | balance hdr(Host) use_domain_only |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 3652 | |
| 3653 | Note: the following caveats and limitations on using the "check_post" |
| 3654 | extension with "url_param" must be considered : |
| 3655 | |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 3656 | - all POST requests are eligible for consideration, because there is no way |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 3657 | to determine if the parameters will be found in the body or entity which |
| 3658 | may contain binary data. Therefore another method may be required to |
| 3659 | restrict consideration of POST requests that have no URL parameters in |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 3660 | the body. (see acl http_end) |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 3661 | |
| 3662 | - using a <max_wait> value larger than the request buffer size does not |
| 3663 | make sense and is useless. The buffer size is set at build time, and |
| 3664 | defaults to 16 kB. |
| 3665 | |
| 3666 | - Content-Encoding is not supported, the parameter search will probably |
| 3667 | fail; and load balancing will fall back to Round Robin. |
| 3668 | |
| 3669 | - Expect: 100-continue is not supported, load balancing will fall back to |
| 3670 | Round Robin. |
| 3671 | |
Lukas Tribus | 2395368 | 2017-04-28 13:24:30 +0000 | [diff] [blame] | 3672 | - Transfer-Encoding (RFC7230 3.3.1) is only supported in the first chunk. |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 3673 | If the entire parameter value is not present in the first chunk, the |
| 3674 | selection of server is undefined (actually, defined by how little |
| 3675 | actually appeared in the first chunk). |
| 3676 | |
| 3677 | - This feature does not support generation of a 100, 411 or 501 response. |
| 3678 | |
| 3679 | - In some cases, requesting "check_post" MAY attempt to scan the entire |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 3680 | contents of a message body. Scanning normally terminates when linear |
matt.farnsworth@nokia.com | 1c2ab96 | 2008-04-14 20:47:37 +0200 | [diff] [blame] | 3681 | white space or control characters are found, indicating the end of what |
| 3682 | might be a URL parameter list. This is probably not a concern with SGML |
| 3683 | type message bodies. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3684 | |
Willy Tarreau | 294d0f0 | 2015-08-10 19:40:12 +0200 | [diff] [blame] | 3685 | See also : "dispatch", "cookie", "transparent", "hash-type" and "http_proxy". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3686 | |
| 3687 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 3688 | bind [<address>]:<port_range> [, ...] [param*] |
| 3689 | bind /<path> [, ...] [param*] |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3690 | Define one or several listening addresses and/or ports in a frontend. |
| 3691 | May be used in sections : defaults | frontend | listen | backend |
| 3692 | no | yes | yes | no |
| 3693 | Arguments : |
Willy Tarreau | b1e52e8 | 2008-01-13 14:49:51 +0100 | [diff] [blame] | 3694 | <address> is optional and can be a host name, an IPv4 address, an IPv6 |
| 3695 | address, or '*'. It designates the address the frontend will |
| 3696 | listen on. If unset, all IPv4 addresses of the system will be |
| 3697 | listened on. The same will apply for '*' or the system's |
David du Colombier | 9c938da | 2011-03-17 10:40:27 +0100 | [diff] [blame] | 3698 | special address "0.0.0.0". The IPv6 equivalent is '::'. |
Willy Tarreau | 2470928 | 2013-03-10 21:32:12 +0100 | [diff] [blame] | 3699 | Optionally, an address family prefix may be used before the |
| 3700 | address to force the family regardless of the address format, |
| 3701 | which can be useful to specify a path to a unix socket with |
| 3702 | no slash ('/'). Currently supported prefixes are : |
| 3703 | - 'ipv4@' -> address is always IPv4 |
| 3704 | - 'ipv6@' -> address is always IPv6 |
Emeric Brun | 3835c0d | 2020-07-07 09:46:09 +0200 | [diff] [blame] | 3705 | - 'udp@' -> address is resolved as IPv4 or IPv6 and |
Emeric Brun | 12941c8 | 2020-07-07 14:19:42 +0200 | [diff] [blame] | 3706 | protocol UDP is used. Currently those listeners are |
| 3707 | supported only in log-forward sections. |
Emeric Brun | 3835c0d | 2020-07-07 09:46:09 +0200 | [diff] [blame] | 3708 | - 'udp4@' -> address is always IPv4 and protocol UDP |
Emeric Brun | 12941c8 | 2020-07-07 14:19:42 +0200 | [diff] [blame] | 3709 | is used. Currently those listeners are supported |
| 3710 | only in log-forward sections. |
Emeric Brun | 3835c0d | 2020-07-07 09:46:09 +0200 | [diff] [blame] | 3711 | - 'udp6@' -> address is always IPv6 and protocol UDP |
Emeric Brun | 12941c8 | 2020-07-07 14:19:42 +0200 | [diff] [blame] | 3712 | is used. Currently those listeners are supported |
| 3713 | only in log-forward sections. |
Willy Tarreau | 2470928 | 2013-03-10 21:32:12 +0100 | [diff] [blame] | 3714 | - 'unix@' -> address is a path to a local unix socket |
Willy Tarreau | 70f72e0 | 2014-07-08 00:37:50 +0200 | [diff] [blame] | 3715 | - 'abns@' -> address is in abstract namespace (Linux only). |
| 3716 | Note: since abstract sockets are not "rebindable", they |
| 3717 | do not cope well with multi-process mode during |
| 3718 | soft-restart, so it is better to avoid them if |
| 3719 | nbproc is greater than 1. The effect is that if the |
| 3720 | new process fails to start, only one of the old ones |
| 3721 | will be able to rebind to the socket. |
Willy Tarreau | 40aa070 | 2013-03-10 23:51:38 +0100 | [diff] [blame] | 3722 | - 'fd@<n>' -> use file descriptor <n> inherited from the |
| 3723 | parent. The fd must be bound and may or may not already |
| 3724 | be listening. |
William Lallemand | 2fe7dd0 | 2018-09-11 16:51:29 +0200 | [diff] [blame] | 3725 | - 'sockpair@<n>'-> like fd@ but you must use the fd of a |
| 3726 | connected unix socket or of a socketpair. The bind waits |
| 3727 | to receive a FD over the unix socket and uses it as if it |
| 3728 | was the FD of an accept(). Should be used carefully. |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 3729 | You may want to reference some environment variables in the |
| 3730 | address parameter, see section 2.3 about environment |
| 3731 | variables. |
Willy Tarreau | b1e52e8 | 2008-01-13 14:49:51 +0100 | [diff] [blame] | 3732 | |
Willy Tarreau | c5011ca | 2010-03-22 11:53:56 +0100 | [diff] [blame] | 3733 | <port_range> is either a unique TCP port, or a port range for which the |
| 3734 | proxy will accept connections for the IP address specified |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 3735 | above. The port is mandatory for TCP listeners. Note that in |
| 3736 | the case of an IPv6 address, the port is always the number |
| 3737 | after the last colon (':'). A range can either be : |
Willy Tarreau | c5011ca | 2010-03-22 11:53:56 +0100 | [diff] [blame] | 3738 | - a numerical port (ex: '80') |
| 3739 | - a dash-delimited ports range explicitly stating the lower |
| 3740 | and upper bounds (ex: '2000-2100') which are included in |
| 3741 | the range. |
| 3742 | |
| 3743 | Particular care must be taken against port ranges, because |
| 3744 | every <address:port> couple consumes one socket (= a file |
| 3745 | descriptor), so it's easy to consume lots of descriptors |
| 3746 | with a simple range, and to run out of sockets. Also, each |
| 3747 | <address:port> couple must be used only once among all |
| 3748 | instances running on a same system. Please note that binding |
| 3749 | to ports lower than 1024 generally require particular |
Jamie Gloudon | 801a0a3 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 3750 | privileges to start the program, which are independent of |
Willy Tarreau | c5011ca | 2010-03-22 11:53:56 +0100 | [diff] [blame] | 3751 | the 'uid' parameter. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3752 | |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 3753 | <path> is a UNIX socket path beginning with a slash ('/'). This is |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 3754 | alternative to the TCP listening port. HAProxy will then |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 3755 | receive UNIX connections on the socket located at this place. |
| 3756 | The path must begin with a slash and by default is absolute. |
| 3757 | It can be relative to the prefix defined by "unix-bind" in |
| 3758 | the global section. Note that the total length of the prefix |
| 3759 | followed by the socket path cannot exceed some system limits |
| 3760 | for UNIX sockets, which commonly are set to 107 characters. |
| 3761 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 3762 | <param*> is a list of parameters common to all sockets declared on the |
| 3763 | same line. These numerous parameters depend on OS and build |
| 3764 | options and have a complete section dedicated to them. Please |
| 3765 | refer to section 5 to for more details. |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 3766 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3767 | It is possible to specify a list of address:port combinations delimited by |
| 3768 | commas. The frontend will then listen on all of these addresses. There is no |
| 3769 | fixed limit to the number of addresses and ports which can be listened on in |
| 3770 | a frontend, as well as there is no limit to the number of "bind" statements |
| 3771 | in a frontend. |
| 3772 | |
| 3773 | Example : |
| 3774 | listen http_proxy |
| 3775 | bind :80,:443 |
| 3776 | bind 10.0.0.1:10080,10.0.0.1:10443 |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 3777 | bind /var/run/ssl-frontend.sock user root mode 600 accept-proxy |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3778 | |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 3779 | listen http_https_proxy |
| 3780 | bind :80 |
Cyril Bonté | 0d44fc6 | 2012-10-09 22:45:33 +0200 | [diff] [blame] | 3781 | bind :443 ssl crt /etc/haproxy/site.pem |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 3782 | |
Willy Tarreau | 2470928 | 2013-03-10 21:32:12 +0100 | [diff] [blame] | 3783 | listen http_https_proxy_explicit |
| 3784 | bind ipv6@:80 |
| 3785 | bind ipv4@public_ssl:443 ssl crt /etc/haproxy/site.pem |
| 3786 | bind unix@ssl-frontend.sock user root mode 600 accept-proxy |
| 3787 | |
Willy Tarreau | dad36a3 | 2013-03-11 01:20:04 +0100 | [diff] [blame] | 3788 | listen external_bind_app1 |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 3789 | bind "fd@${FD_APP1}" |
Willy Tarreau | dad36a3 | 2013-03-11 01:20:04 +0100 | [diff] [blame] | 3790 | |
Willy Tarreau | 55dcaf6 | 2015-09-27 15:03:15 +0200 | [diff] [blame] | 3791 | Note: regarding Linux's abstract namespace sockets, HAProxy uses the whole |
| 3792 | sun_path length is used for the address length. Some other programs |
| 3793 | such as socat use the string length only by default. Pass the option |
| 3794 | ",unix-tightsocklen=0" to any abstract socket definition in socat to |
| 3795 | make it compatible with HAProxy's. |
| 3796 | |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 3797 | See also : "source", "option forwardfor", "unix-bind" and the PROXY protocol |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 3798 | documentation, and section 5 about bind options. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3799 | |
| 3800 | |
Christopher Faulet | ff4121f | 2017-11-22 16:38:49 +0100 | [diff] [blame] | 3801 | bind-process [ all | odd | even | <process_num>[-[<process_num>]] ] ... |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3802 | Limit visibility of an instance to a certain set of processes numbers. |
| 3803 | May be used in sections : defaults | frontend | listen | backend |
| 3804 | yes | yes | yes | yes |
| 3805 | Arguments : |
| 3806 | all All process will see this instance. This is the default. It |
| 3807 | may be used to override a default value. |
| 3808 | |
Willy Tarreau | a9db57e | 2013-01-18 11:29:29 +0100 | [diff] [blame] | 3809 | odd This instance will be enabled on processes 1,3,5,...63. This |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3810 | option may be combined with other numbers. |
| 3811 | |
Willy Tarreau | a9db57e | 2013-01-18 11:29:29 +0100 | [diff] [blame] | 3812 | even This instance will be enabled on processes 2,4,6,...64. This |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3813 | option may be combined with other numbers. Do not use it |
| 3814 | with less than 2 processes otherwise some instances might be |
| 3815 | missing from all processes. |
| 3816 | |
Christopher Faulet | ff4121f | 2017-11-22 16:38:49 +0100 | [diff] [blame] | 3817 | process_num The instance will be enabled on this process number or range, |
Willy Tarreau | a9db57e | 2013-01-18 11:29:29 +0100 | [diff] [blame] | 3818 | whose values must all be between 1 and 32 or 64 depending on |
Christopher Faulet | ff4121f | 2017-11-22 16:38:49 +0100 | [diff] [blame] | 3819 | the machine's word size. Ranges can be partially defined. The |
| 3820 | higher bound can be omitted. In such case, it is replaced by |
| 3821 | the corresponding maximum value. If a proxy is bound to |
| 3822 | process numbers greater than the configured global.nbproc, it |
| 3823 | will either be forced to process #1 if a single process was |
Willy Tarreau | 102df61 | 2014-05-07 23:56:38 +0200 | [diff] [blame] | 3824 | specified, or to all processes otherwise. |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3825 | |
| 3826 | This keyword limits binding of certain instances to certain processes. This |
| 3827 | is useful in order not to have too many processes listening to the same |
| 3828 | ports. For instance, on a dual-core machine, it might make sense to set |
| 3829 | 'nbproc 2' in the global section, then distributes the listeners among 'odd' |
| 3830 | and 'even' instances. |
| 3831 | |
Willy Tarreau | a9db57e | 2013-01-18 11:29:29 +0100 | [diff] [blame] | 3832 | At the moment, it is not possible to reference more than 32 or 64 processes |
| 3833 | using this keyword, but this should be more than enough for most setups. |
| 3834 | Please note that 'all' really means all processes regardless of the machine's |
| 3835 | word size, and is not limited to the first 32 or 64. |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3836 | |
Willy Tarreau | 6ae1ba6 | 2014-05-07 19:01:58 +0200 | [diff] [blame] | 3837 | Each "bind" line may further be limited to a subset of the proxy's processes, |
| 3838 | please consult the "process" bind keyword in section 5.1. |
| 3839 | |
Willy Tarreau | b369a04 | 2014-09-16 13:21:03 +0200 | [diff] [blame] | 3840 | When a frontend has no explicit "bind-process" line, it tries to bind to all |
| 3841 | the processes referenced by its "bind" lines. That means that frontends can |
| 3842 | easily adapt to their listeners' processes. |
| 3843 | |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3844 | If some backends are referenced by frontends bound to other processes, the |
| 3845 | backend automatically inherits the frontend's processes. |
| 3846 | |
| 3847 | Example : |
| 3848 | listen app_ip1 |
| 3849 | bind 10.0.0.1:80 |
Willy Tarreau | bfcd311 | 2010-10-23 11:22:08 +0200 | [diff] [blame] | 3850 | bind-process odd |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3851 | |
| 3852 | listen app_ip2 |
| 3853 | bind 10.0.0.2:80 |
Willy Tarreau | bfcd311 | 2010-10-23 11:22:08 +0200 | [diff] [blame] | 3854 | bind-process even |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3855 | |
| 3856 | listen management |
| 3857 | bind 10.0.0.3:80 |
Willy Tarreau | bfcd311 | 2010-10-23 11:22:08 +0200 | [diff] [blame] | 3858 | bind-process 1 2 3 4 |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3859 | |
Willy Tarreau | 110ecc1 | 2012-11-15 17:50:01 +0100 | [diff] [blame] | 3860 | listen management |
| 3861 | bind 10.0.0.4:80 |
| 3862 | bind-process 1-4 |
| 3863 | |
Willy Tarreau | 6ae1ba6 | 2014-05-07 19:01:58 +0200 | [diff] [blame] | 3864 | See also : "nbproc" in global section, and "process" in section 5.1. |
Willy Tarreau | 0b9c02c | 2009-02-04 22:05:05 +0100 | [diff] [blame] | 3865 | |
| 3866 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3867 | capture cookie <name> len <length> |
| 3868 | Capture and log a cookie in the request and in the response. |
| 3869 | May be used in sections : defaults | frontend | listen | backend |
| 3870 | no | yes | yes | no |
| 3871 | Arguments : |
| 3872 | <name> is the beginning of the name of the cookie to capture. In order |
| 3873 | to match the exact name, simply suffix the name with an equal |
| 3874 | sign ('='). The full name will appear in the logs, which is |
| 3875 | useful with application servers which adjust both the cookie name |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 3876 | and value (e.g. ASPSESSIONXXX). |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3877 | |
| 3878 | <length> is the maximum number of characters to report in the logs, which |
| 3879 | include the cookie name, the equal sign and the value, all in the |
| 3880 | standard "name=value" form. The string will be truncated on the |
| 3881 | right if it exceeds <length>. |
| 3882 | |
| 3883 | Only the first cookie is captured. Both the "cookie" request headers and the |
| 3884 | "set-cookie" response headers are monitored. This is particularly useful to |
| 3885 | check for application bugs causing session crossing or stealing between |
| 3886 | users, because generally the user's cookies can only change on a login page. |
| 3887 | |
| 3888 | When the cookie was not presented by the client, the associated log column |
| 3889 | will report "-". When a request does not cause a cookie to be assigned by the |
| 3890 | server, a "-" is reported in the response column. |
| 3891 | |
| 3892 | The capture is performed in the frontend only because it is necessary that |
| 3893 | the log format does not change for a given frontend depending on the |
| 3894 | backends. This may change in the future. Note that there can be only one |
Willy Tarreau | 193b8c6 | 2012-11-22 00:17:38 +0100 | [diff] [blame] | 3895 | "capture cookie" statement in a frontend. The maximum capture length is set |
| 3896 | by the global "tune.http.cookielen" setting and defaults to 63 characters. It |
| 3897 | is not possible to specify a capture in a "defaults" section. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3898 | |
| 3899 | Example: |
| 3900 | capture cookie ASPSESSION len 32 |
| 3901 | |
| 3902 | See also : "capture request header", "capture response header" as well as |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 3903 | section 8 about logging. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3904 | |
| 3905 | |
| 3906 | capture request header <name> len <length> |
Willy Tarreau | 4460d03 | 2012-11-21 23:37:37 +0100 | [diff] [blame] | 3907 | Capture and log the last occurrence of the specified request header. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3908 | May be used in sections : defaults | frontend | listen | backend |
| 3909 | no | yes | yes | no |
| 3910 | Arguments : |
| 3911 | <name> is the name of the header to capture. The header names are not |
Willy Tarreau | d2a4aa2 | 2008-01-31 15:28:22 +0100 | [diff] [blame] | 3912 | case-sensitive, but it is a common practice to write them as they |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3913 | appear in the requests, with the first letter of each word in |
| 3914 | upper case. The header name will not appear in the logs, only the |
| 3915 | value is reported, but the position in the logs is respected. |
| 3916 | |
| 3917 | <length> is the maximum number of characters to extract from the value and |
| 3918 | report in the logs. The string will be truncated on the right if |
| 3919 | it exceeds <length>. |
| 3920 | |
Willy Tarreau | 4460d03 | 2012-11-21 23:37:37 +0100 | [diff] [blame] | 3921 | The complete value of the last occurrence of the header is captured. The |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3922 | value will be added to the logs between braces ('{}'). If multiple headers |
| 3923 | are captured, they will be delimited by a vertical bar ('|') and will appear |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 3924 | in the same order they were declared in the configuration. Non-existent |
| 3925 | headers will be logged just as an empty string. Common uses for request |
| 3926 | header captures include the "Host" field in virtual hosting environments, the |
| 3927 | "Content-length" when uploads are supported, "User-agent" to quickly |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 3928 | differentiate between real users and robots, and "X-Forwarded-For" in proxied |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 3929 | environments to find where the request came from. |
| 3930 | |
| 3931 | Note that when capturing headers such as "User-agent", some spaces may be |
| 3932 | logged, making the log analysis more difficult. Thus be careful about what |
| 3933 | you log if you know your log parser is not smart enough to rely on the |
| 3934 | braces. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3935 | |
Willy Tarreau | 0900abb | 2012-11-22 00:21:46 +0100 | [diff] [blame] | 3936 | There is no limit to the number of captured request headers nor to their |
| 3937 | length, though it is wise to keep them low to limit memory usage per session. |
| 3938 | In order to keep log format consistent for a same frontend, header captures |
| 3939 | can only be declared in a frontend. It is not possible to specify a capture |
| 3940 | in a "defaults" section. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3941 | |
| 3942 | Example: |
| 3943 | capture request header Host len 15 |
| 3944 | capture request header X-Forwarded-For len 15 |
Cyril Bonté | d1b0f7c | 2015-10-26 22:37:39 +0100 | [diff] [blame] | 3945 | capture request header Referer len 15 |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3946 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 3947 | See also : "capture cookie", "capture response header" as well as section 8 |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3948 | about logging. |
| 3949 | |
| 3950 | |
| 3951 | capture response header <name> len <length> |
Willy Tarreau | 4460d03 | 2012-11-21 23:37:37 +0100 | [diff] [blame] | 3952 | Capture and log the last occurrence of the specified response header. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3953 | May be used in sections : defaults | frontend | listen | backend |
| 3954 | no | yes | yes | no |
| 3955 | Arguments : |
| 3956 | <name> is the name of the header to capture. The header names are not |
Willy Tarreau | d2a4aa2 | 2008-01-31 15:28:22 +0100 | [diff] [blame] | 3957 | case-sensitive, but it is a common practice to write them as they |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3958 | appear in the response, with the first letter of each word in |
| 3959 | upper case. The header name will not appear in the logs, only the |
| 3960 | value is reported, but the position in the logs is respected. |
| 3961 | |
| 3962 | <length> is the maximum number of characters to extract from the value and |
| 3963 | report in the logs. The string will be truncated on the right if |
| 3964 | it exceeds <length>. |
| 3965 | |
Willy Tarreau | 4460d03 | 2012-11-21 23:37:37 +0100 | [diff] [blame] | 3966 | The complete value of the last occurrence of the header is captured. The |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3967 | result will be added to the logs between braces ('{}') after the captured |
| 3968 | request headers. If multiple headers are captured, they will be delimited by |
| 3969 | a vertical bar ('|') and will appear in the same order they were declared in |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 3970 | the configuration. Non-existent headers will be logged just as an empty |
| 3971 | string. Common uses for response header captures include the "Content-length" |
| 3972 | header which indicates how many bytes are expected to be returned, the |
| 3973 | "Location" header to track redirections. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3974 | |
Willy Tarreau | 0900abb | 2012-11-22 00:21:46 +0100 | [diff] [blame] | 3975 | There is no limit to the number of captured response headers nor to their |
| 3976 | length, though it is wise to keep them low to limit memory usage per session. |
| 3977 | In order to keep log format consistent for a same frontend, header captures |
| 3978 | can only be declared in a frontend. It is not possible to specify a capture |
| 3979 | in a "defaults" section. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3980 | |
| 3981 | Example: |
| 3982 | capture response header Content-length len 9 |
| 3983 | capture response header Location len 15 |
| 3984 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 3985 | See also : "capture cookie", "capture request header" as well as section 8 |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 3986 | about logging. |
| 3987 | |
| 3988 | |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 3989 | clitcpka-cnt <count> |
| 3990 | Sets the maximum number of keepalive probes TCP should send before dropping |
| 3991 | the connection on the client side. |
| 3992 | May be used in sections : defaults | frontend | listen | backend |
| 3993 | yes | yes | yes | no |
| 3994 | Arguments : |
| 3995 | <count> is the maximum number of keepalive probes. |
| 3996 | |
| 3997 | This keyword corresponds to the socket option TCP_KEEPCNT. If this keyword |
| 3998 | is not specified, system-wide TCP parameter (tcp_keepalive_probes) is used. |
Willy Tarreau | 5254321 | 2020-07-09 05:58:51 +0200 | [diff] [blame] | 3999 | The availability of this setting depends on the operating system. It is |
| 4000 | known to work on Linux. |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 4001 | |
| 4002 | See also : "option clitcpka", "clitcpka-idle", "clitcpka-intvl". |
| 4003 | |
| 4004 | |
| 4005 | clitcpka-idle <timeout> |
| 4006 | Sets the time the connection needs to remain idle before TCP starts sending |
| 4007 | keepalive probes, if enabled the sending of TCP keepalive packets on the |
| 4008 | client side. |
| 4009 | May be used in sections : defaults | frontend | listen | backend |
| 4010 | yes | yes | yes | no |
| 4011 | Arguments : |
| 4012 | <timeout> is the time the connection needs to remain idle before TCP starts |
| 4013 | sending keepalive probes. It is specified in seconds by default, |
| 4014 | but can be in any other unit if the number is suffixed by the |
| 4015 | unit, as explained at the top of this document. |
| 4016 | |
| 4017 | This keyword corresponds to the socket option TCP_KEEPIDLE. If this keyword |
| 4018 | is not specified, system-wide TCP parameter (tcp_keepalive_time) is used. |
Willy Tarreau | 5254321 | 2020-07-09 05:58:51 +0200 | [diff] [blame] | 4019 | The availability of this setting depends on the operating system. It is |
| 4020 | known to work on Linux. |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 4021 | |
| 4022 | See also : "option clitcpka", "clitcpka-cnt", "clitcpka-intvl". |
| 4023 | |
| 4024 | |
| 4025 | clitcpka-intvl <timeout> |
| 4026 | Sets the time between individual keepalive probes on the client side. |
| 4027 | May be used in sections : defaults | frontend | listen | backend |
| 4028 | yes | yes | yes | no |
| 4029 | Arguments : |
| 4030 | <timeout> is the time between individual keepalive probes. It is specified |
| 4031 | in seconds by default, but can be in any other unit if the number |
| 4032 | is suffixed by the unit, as explained at the top of this |
| 4033 | document. |
| 4034 | |
| 4035 | This keyword corresponds to the socket option TCP_KEEPINTVL. If this keyword |
| 4036 | is not specified, system-wide TCP parameter (tcp_keepalive_intvl) is used. |
Willy Tarreau | 5254321 | 2020-07-09 05:58:51 +0200 | [diff] [blame] | 4037 | The availability of this setting depends on the operating system. It is |
| 4038 | known to work on Linux. |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 4039 | |
| 4040 | See also : "option clitcpka", "clitcpka-cnt", "clitcpka-idle". |
| 4041 | |
| 4042 | |
Cyril Bonté | 316a8cf | 2012-11-11 13:38:27 +0100 | [diff] [blame] | 4043 | compression algo <algorithm> ... |
| 4044 | compression type <mime type> ... |
Willy Tarreau | 70737d1 | 2012-10-27 00:34:28 +0200 | [diff] [blame] | 4045 | compression offload |
William Lallemand | 82fe75c | 2012-10-23 10:25:10 +0200 | [diff] [blame] | 4046 | Enable HTTP compression. |
| 4047 | May be used in sections : defaults | frontend | listen | backend |
| 4048 | yes | yes | yes | yes |
| 4049 | Arguments : |
Cyril Bonté | 316a8cf | 2012-11-11 13:38:27 +0100 | [diff] [blame] | 4050 | algo is followed by the list of supported compression algorithms. |
| 4051 | type is followed by the list of MIME types that will be compressed. |
| 4052 | offload makes haproxy work as a compression offloader only (see notes). |
| 4053 | |
| 4054 | The currently supported algorithms are : |
Willy Tarreau | c91840a | 2015-03-28 17:00:39 +0100 | [diff] [blame] | 4055 | identity this is mostly for debugging, and it was useful for developing |
| 4056 | the compression feature. Identity does not apply any change on |
| 4057 | data. |
Cyril Bonté | 316a8cf | 2012-11-11 13:38:27 +0100 | [diff] [blame] | 4058 | |
Willy Tarreau | c91840a | 2015-03-28 17:00:39 +0100 | [diff] [blame] | 4059 | gzip applies gzip compression. This setting is only available when |
Baptiste Assmann | f085d63 | 2015-12-21 17:57:32 +0100 | [diff] [blame] | 4060 | support for zlib or libslz was built in. |
Willy Tarreau | c91840a | 2015-03-28 17:00:39 +0100 | [diff] [blame] | 4061 | |
| 4062 | deflate same as "gzip", but with deflate algorithm and zlib format. |
| 4063 | Note that this algorithm has ambiguous support on many |
| 4064 | browsers and no support at all from recent ones. It is |
| 4065 | strongly recommended not to use it for anything else than |
| 4066 | experimentation. This setting is only available when support |
Baptiste Assmann | f085d63 | 2015-12-21 17:57:32 +0100 | [diff] [blame] | 4067 | for zlib or libslz was built in. |
Cyril Bonté | 316a8cf | 2012-11-11 13:38:27 +0100 | [diff] [blame] | 4068 | |
Willy Tarreau | c91840a | 2015-03-28 17:00:39 +0100 | [diff] [blame] | 4069 | raw-deflate same as "deflate" without the zlib wrapper, and used as an |
| 4070 | alternative when the browser wants "deflate". All major |
| 4071 | browsers understand it and despite violating the standards, |
| 4072 | it is known to work better than "deflate", at least on MSIE |
| 4073 | and some versions of Safari. Do not use it in conjunction |
| 4074 | with "deflate", use either one or the other since both react |
| 4075 | to the same Accept-Encoding token. This setting is only |
Baptiste Assmann | f085d63 | 2015-12-21 17:57:32 +0100 | [diff] [blame] | 4076 | available when support for zlib or libslz was built in. |
Cyril Bonté | 316a8cf | 2012-11-11 13:38:27 +0100 | [diff] [blame] | 4077 | |
Dmitry Sivachenko | 87c208b | 2012-11-22 20:03:26 +0400 | [diff] [blame] | 4078 | Compression will be activated depending on the Accept-Encoding request |
Cyril Bonté | 316a8cf | 2012-11-11 13:38:27 +0100 | [diff] [blame] | 4079 | header. With identity, it does not take care of that header. |
Dmitry Sivachenko | c9f3b45 | 2012-11-28 17:47:11 +0400 | [diff] [blame] | 4080 | If backend servers support HTTP compression, these directives |
| 4081 | will be no-op: haproxy will see the compressed response and will not |
| 4082 | compress again. If backend servers do not support HTTP compression and |
| 4083 | there is Accept-Encoding header in request, haproxy will compress the |
| 4084 | matching response. |
Willy Tarreau | 70737d1 | 2012-10-27 00:34:28 +0200 | [diff] [blame] | 4085 | |
| 4086 | The "offload" setting makes haproxy remove the Accept-Encoding header to |
| 4087 | prevent backend servers from compressing responses. It is strongly |
| 4088 | recommended not to do this because this means that all the compression work |
| 4089 | will be done on the single point where haproxy is located. However in some |
| 4090 | deployment scenarios, haproxy may be installed in front of a buggy gateway |
Dmitry Sivachenko | c9f3b45 | 2012-11-28 17:47:11 +0400 | [diff] [blame] | 4091 | with broken HTTP compression implementation which can't be turned off. |
| 4092 | In that case haproxy can be used to prevent that gateway from emitting |
| 4093 | invalid payloads. In this case, simply removing the header in the |
| 4094 | configuration does not work because it applies before the header is parsed, |
| 4095 | so that prevents haproxy from compressing. The "offload" setting should |
Willy Tarreau | ffea9fd | 2014-07-12 16:37:02 +0200 | [diff] [blame] | 4096 | then be used for such scenarios. Note: for now, the "offload" setting is |
| 4097 | ignored when set in a defaults section. |
William Lallemand | 82fe75c | 2012-10-23 10:25:10 +0200 | [diff] [blame] | 4098 | |
William Lallemand | 0509744 | 2012-11-20 12:14:28 +0100 | [diff] [blame] | 4099 | Compression is disabled when: |
Baptiste Assmann | 650d53d | 2013-01-05 15:44:44 +0100 | [diff] [blame] | 4100 | * the request does not advertise a supported compression algorithm in the |
| 4101 | "Accept-Encoding" header |
| 4102 | * the response message is not HTTP/1.1 |
Tim Duesterhus | bb48c9a | 2019-01-30 23:46:04 +0100 | [diff] [blame] | 4103 | * HTTP status code is not one of 200, 201, 202, or 203 |
Baptiste Assmann | 650d53d | 2013-01-05 15:44:44 +0100 | [diff] [blame] | 4104 | * response contain neither a "Content-Length" header nor a |
| 4105 | "Transfer-Encoding" whose last value is "chunked" |
| 4106 | * response contains a "Content-Type" header whose first value starts with |
| 4107 | "multipart" |
| 4108 | * the response contains the "no-transform" value in the "Cache-control" |
| 4109 | header |
| 4110 | * User-Agent matches "Mozilla/4" unless it is MSIE 6 with XP SP2, or MSIE 7 |
| 4111 | and later |
| 4112 | * The response contains a "Content-Encoding" header, indicating that the |
| 4113 | response is already compressed (see compression offload) |
Tim Duesterhus | bb48c9a | 2019-01-30 23:46:04 +0100 | [diff] [blame] | 4114 | * The response contains an invalid "ETag" header or multiple ETag headers |
William Lallemand | 0509744 | 2012-11-20 12:14:28 +0100 | [diff] [blame] | 4115 | |
Tim Duesterhus | b229f01 | 2019-01-29 16:38:56 +0100 | [diff] [blame] | 4116 | Note: The compression does not emit the Warning header. |
William Lallemand | 0509744 | 2012-11-20 12:14:28 +0100 | [diff] [blame] | 4117 | |
William Lallemand | 82fe75c | 2012-10-23 10:25:10 +0200 | [diff] [blame] | 4118 | Examples : |
| 4119 | compression algo gzip |
| 4120 | compression type text/html text/plain |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4121 | |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 4122 | |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 4123 | cookie <name> [ rewrite | insert | prefix ] [ indirect ] [ nocache ] |
Willy Tarreau | 4992dd2 | 2012-05-31 21:02:17 +0200 | [diff] [blame] | 4124 | [ postonly ] [ preserve ] [ httponly ] [ secure ] |
| 4125 | [ domain <domain> ]* [ maxidle <idle> ] [ maxlife <life> ] |
Christopher Faulet | 2f53390 | 2020-01-21 11:06:48 +0100 | [diff] [blame] | 4126 | [ dynamic ] [ attr <value> ]* |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4127 | Enable cookie-based persistence in a backend. |
| 4128 | May be used in sections : defaults | frontend | listen | backend |
| 4129 | yes | no | yes | yes |
| 4130 | Arguments : |
| 4131 | <name> is the name of the cookie which will be monitored, modified or |
| 4132 | inserted in order to bring persistence. This cookie is sent to |
| 4133 | the client via a "Set-Cookie" header in the response, and is |
| 4134 | brought back by the client in a "Cookie" header in all requests. |
| 4135 | Special care should be taken to choose a name which does not |
| 4136 | conflict with any likely application cookie. Also, if the same |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4137 | backends are subject to be used by the same clients (e.g. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4138 | HTTP/HTTPS), care should be taken to use different cookie names |
| 4139 | between all backends if persistence between them is not desired. |
| 4140 | |
| 4141 | rewrite This keyword indicates that the cookie will be provided by the |
| 4142 | server and that haproxy will have to modify its value to set the |
| 4143 | server's identifier in it. This mode is handy when the management |
| 4144 | of complex combinations of "Set-cookie" and "Cache-control" |
| 4145 | headers is left to the application. The application can then |
| 4146 | decide whether or not it is appropriate to emit a persistence |
Lukas Tribus | f01a9cd | 2016-02-03 18:09:37 +0100 | [diff] [blame] | 4147 | cookie. Since all responses should be monitored, this mode |
| 4148 | doesn't work in HTTP tunnel mode. Unless the application |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4149 | behavior is very complex and/or broken, it is advised not to |
Lukas Tribus | f01a9cd | 2016-02-03 18:09:37 +0100 | [diff] [blame] | 4150 | start with this mode for new deployments. This keyword is |
| 4151 | incompatible with "insert" and "prefix". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4152 | |
| 4153 | insert This keyword indicates that the persistence cookie will have to |
Willy Tarreau | a79094d | 2010-08-31 22:54:15 +0200 | [diff] [blame] | 4154 | be inserted by haproxy in server responses if the client did not |
Willy Tarreau | ba4c5be | 2010-10-23 12:46:42 +0200 | [diff] [blame] | 4155 | |
Willy Tarreau | a79094d | 2010-08-31 22:54:15 +0200 | [diff] [blame] | 4156 | already have a cookie that would have permitted it to access this |
Willy Tarreau | ba4c5be | 2010-10-23 12:46:42 +0200 | [diff] [blame] | 4157 | server. When used without the "preserve" option, if the server |
Michael Prokop | 4438c60 | 2019-05-24 10:25:45 +0200 | [diff] [blame] | 4158 | emits a cookie with the same name, it will be removed before |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4159 | processing. For this reason, this mode can be used to upgrade |
Willy Tarreau | ba4c5be | 2010-10-23 12:46:42 +0200 | [diff] [blame] | 4160 | existing configurations running in the "rewrite" mode. The cookie |
| 4161 | will only be a session cookie and will not be stored on the |
| 4162 | client's disk. By default, unless the "indirect" option is added, |
| 4163 | the server will see the cookies emitted by the client. Due to |
| 4164 | caching effects, it is generally wise to add the "nocache" or |
| 4165 | "postonly" keywords (see below). The "insert" keyword is not |
| 4166 | compatible with "rewrite" and "prefix". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4167 | |
| 4168 | prefix This keyword indicates that instead of relying on a dedicated |
| 4169 | cookie for the persistence, an existing one will be completed. |
| 4170 | This may be needed in some specific environments where the client |
| 4171 | does not support more than one single cookie and the application |
| 4172 | already needs it. In this case, whenever the server sets a cookie |
| 4173 | named <name>, it will be prefixed with the server's identifier |
| 4174 | and a delimiter. The prefix will be removed from all client |
| 4175 | requests so that the server still finds the cookie it emitted. |
| 4176 | Since all requests and responses are subject to being modified, |
Lukas Tribus | f01a9cd | 2016-02-03 18:09:37 +0100 | [diff] [blame] | 4177 | this mode doesn't work with tunnel mode. The "prefix" keyword is |
Willy Tarreau | 37229df | 2011-10-17 12:24:55 +0200 | [diff] [blame] | 4178 | not compatible with "rewrite" and "insert". Note: it is highly |
| 4179 | recommended not to use "indirect" with "prefix", otherwise server |
| 4180 | cookie updates would not be sent to clients. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4181 | |
Willy Tarreau | a79094d | 2010-08-31 22:54:15 +0200 | [diff] [blame] | 4182 | indirect When this option is specified, no cookie will be emitted to a |
| 4183 | client which already has a valid one for the server which has |
| 4184 | processed the request. If the server sets such a cookie itself, |
Willy Tarreau | ba4c5be | 2010-10-23 12:46:42 +0200 | [diff] [blame] | 4185 | it will be removed, unless the "preserve" option is also set. In |
| 4186 | "insert" mode, this will additionally remove cookies from the |
| 4187 | requests transmitted to the server, making the persistence |
| 4188 | mechanism totally transparent from an application point of view. |
Willy Tarreau | 37229df | 2011-10-17 12:24:55 +0200 | [diff] [blame] | 4189 | Note: it is highly recommended not to use "indirect" with |
| 4190 | "prefix", otherwise server cookie updates would not be sent to |
| 4191 | clients. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4192 | |
| 4193 | nocache This option is recommended in conjunction with the insert mode |
| 4194 | when there is a cache between the client and HAProxy, as it |
| 4195 | ensures that a cacheable response will be tagged non-cacheable if |
| 4196 | a cookie needs to be inserted. This is important because if all |
| 4197 | persistence cookies are added on a cacheable home page for |
| 4198 | instance, then all customers will then fetch the page from an |
| 4199 | outer cache and will all share the same persistence cookie, |
| 4200 | leading to one server receiving much more traffic than others. |
| 4201 | See also the "insert" and "postonly" options. |
| 4202 | |
| 4203 | postonly This option ensures that cookie insertion will only be performed |
| 4204 | on responses to POST requests. It is an alternative to the |
| 4205 | "nocache" option, because POST responses are not cacheable, so |
| 4206 | this ensures that the persistence cookie will never get cached. |
| 4207 | Since most sites do not need any sort of persistence before the |
| 4208 | first POST which generally is a login request, this is a very |
| 4209 | efficient method to optimize caching without risking to find a |
| 4210 | persistence cookie in the cache. |
| 4211 | See also the "insert" and "nocache" options. |
| 4212 | |
Willy Tarreau | ba4c5be | 2010-10-23 12:46:42 +0200 | [diff] [blame] | 4213 | preserve This option may only be used with "insert" and/or "indirect". It |
| 4214 | allows the server to emit the persistence cookie itself. In this |
| 4215 | case, if a cookie is found in the response, haproxy will leave it |
| 4216 | untouched. This is useful in order to end persistence after a |
| 4217 | logout request for instance. For this, the server just has to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4218 | emit a cookie with an invalid value (e.g. empty) or with a date in |
Willy Tarreau | ba4c5be | 2010-10-23 12:46:42 +0200 | [diff] [blame] | 4219 | the past. By combining this mechanism with the "disable-on-404" |
| 4220 | check option, it is possible to perform a completely graceful |
| 4221 | shutdown because users will definitely leave the server after |
| 4222 | they logout. |
| 4223 | |
Willy Tarreau | 4992dd2 | 2012-05-31 21:02:17 +0200 | [diff] [blame] | 4224 | httponly This option tells haproxy to add an "HttpOnly" cookie attribute |
| 4225 | when a cookie is inserted. This attribute is used so that a |
| 4226 | user agent doesn't share the cookie with non-HTTP components. |
| 4227 | Please check RFC6265 for more information on this attribute. |
| 4228 | |
| 4229 | secure This option tells haproxy to add a "Secure" cookie attribute when |
| 4230 | a cookie is inserted. This attribute is used so that a user agent |
| 4231 | never emits this cookie over non-secure channels, which means |
| 4232 | that a cookie learned with this flag will be presented only over |
| 4233 | SSL/TLS connections. Please check RFC6265 for more information on |
| 4234 | this attribute. |
| 4235 | |
Krzysztof Piotr Oledzki | efe3b6f | 2008-05-23 23:49:32 +0200 | [diff] [blame] | 4236 | domain This option allows to specify the domain at which a cookie is |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 4237 | inserted. It requires exactly one parameter: a valid domain |
Willy Tarreau | 68a897b | 2009-12-03 23:28:34 +0100 | [diff] [blame] | 4238 | name. If the domain begins with a dot, the browser is allowed to |
| 4239 | use it for any host ending with that name. It is also possible to |
| 4240 | specify several domain names by invoking this option multiple |
| 4241 | times. Some browsers might have small limits on the number of |
| 4242 | domains, so be careful when doing that. For the record, sending |
| 4243 | 10 domains to MSIE 6 or Firefox 2 works as expected. |
Krzysztof Piotr Oledzki | efe3b6f | 2008-05-23 23:49:32 +0200 | [diff] [blame] | 4244 | |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 4245 | maxidle This option allows inserted cookies to be ignored after some idle |
| 4246 | time. It only works with insert-mode cookies. When a cookie is |
| 4247 | sent to the client, the date this cookie was emitted is sent too. |
| 4248 | Upon further presentations of this cookie, if the date is older |
| 4249 | than the delay indicated by the parameter (in seconds), it will |
| 4250 | be ignored. Otherwise, it will be refreshed if needed when the |
| 4251 | response is sent to the client. This is particularly useful to |
| 4252 | prevent users who never close their browsers from remaining for |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4253 | too long on the same server (e.g. after a farm size change). When |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 4254 | this option is set and a cookie has no date, it is always |
| 4255 | accepted, but gets refreshed in the response. This maintains the |
| 4256 | ability for admins to access their sites. Cookies that have a |
| 4257 | date in the future further than 24 hours are ignored. Doing so |
| 4258 | lets admins fix timezone issues without risking kicking users off |
| 4259 | the site. |
| 4260 | |
| 4261 | maxlife This option allows inserted cookies to be ignored after some life |
| 4262 | time, whether they're in use or not. It only works with insert |
| 4263 | mode cookies. When a cookie is first sent to the client, the date |
| 4264 | this cookie was emitted is sent too. Upon further presentations |
| 4265 | of this cookie, if the date is older than the delay indicated by |
| 4266 | the parameter (in seconds), it will be ignored. If the cookie in |
| 4267 | the request has no date, it is accepted and a date will be set. |
| 4268 | Cookies that have a date in the future further than 24 hours are |
| 4269 | ignored. Doing so lets admins fix timezone issues without risking |
| 4270 | kicking users off the site. Contrary to maxidle, this value is |
| 4271 | not refreshed, only the first visit date counts. Both maxidle and |
| 4272 | maxlife may be used at the time. This is particularly useful to |
| 4273 | prevent users who never close their browsers from remaining for |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4274 | too long on the same server (e.g. after a farm size change). This |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 4275 | is stronger than the maxidle method in that it forces a |
| 4276 | redispatch after some absolute delay. |
| 4277 | |
Olivier Houchard | 4e69404 | 2017-03-14 20:01:29 +0100 | [diff] [blame] | 4278 | dynamic Activate dynamic cookies. When used, a session cookie is |
| 4279 | dynamically created for each server, based on the IP and port |
| 4280 | of the server, and a secret key, specified in the |
| 4281 | "dynamic-cookie-key" backend directive. |
| 4282 | The cookie will be regenerated each time the IP address change, |
| 4283 | and is only generated for IPv4/IPv6. |
| 4284 | |
Christopher Faulet | 2f53390 | 2020-01-21 11:06:48 +0100 | [diff] [blame] | 4285 | attr This option tells haproxy to add an extra attribute when a |
| 4286 | cookie is inserted. The attribute value can contain any |
| 4287 | characters except control ones or ";". This option may be |
| 4288 | repeated. |
| 4289 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4290 | There can be only one persistence cookie per HTTP backend, and it can be |
| 4291 | declared in a defaults section. The value of the cookie will be the value |
| 4292 | indicated after the "cookie" keyword in a "server" statement. If no cookie |
| 4293 | is declared for a given server, the cookie is not set. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 4294 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4295 | Examples : |
| 4296 | cookie JSESSIONID prefix |
| 4297 | cookie SRV insert indirect nocache |
| 4298 | cookie SRV insert postonly indirect |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 4299 | cookie SRV insert indirect nocache maxidle 30m maxlife 8h |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4300 | |
Willy Tarreau | 294d0f0 | 2015-08-10 19:40:12 +0200 | [diff] [blame] | 4301 | See also : "balance source", "capture cookie", "server" and "ignore-persist". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4302 | |
Willy Tarreau | 983e01e | 2010-01-11 18:42:06 +0100 | [diff] [blame] | 4303 | |
Thierry FOURNIER | a0a1b75 | 2015-05-26 17:44:32 +0200 | [diff] [blame] | 4304 | declare capture [ request | response ] len <length> |
| 4305 | Declares a capture slot. |
| 4306 | May be used in sections : defaults | frontend | listen | backend |
| 4307 | no | yes | yes | no |
| 4308 | Arguments: |
| 4309 | <length> is the length allowed for the capture. |
| 4310 | |
| 4311 | This declaration is only available in the frontend or listen section, but the |
| 4312 | reserved slot can be used in the backends. The "request" keyword allocates a |
| 4313 | capture slot for use in the request, and "response" allocates a capture slot |
| 4314 | for use in the response. |
| 4315 | |
| 4316 | See also: "capture-req", "capture-res" (sample converters), |
Baptiste Assmann | 5ac425c | 2015-10-21 23:13:46 +0200 | [diff] [blame] | 4317 | "capture.req.hdr", "capture.res.hdr" (sample fetches), |
Thierry FOURNIER | a0a1b75 | 2015-05-26 17:44:32 +0200 | [diff] [blame] | 4318 | "http-request capture" and "http-response capture". |
| 4319 | |
| 4320 | |
Krzysztof Piotr Oledzki | c6df066 | 2010-01-05 16:38:49 +0100 | [diff] [blame] | 4321 | default-server [param*] |
| 4322 | Change default options for a server in a backend |
| 4323 | May be used in sections : defaults | frontend | listen | backend |
| 4324 | yes | no | yes | yes |
| 4325 | Arguments: |
Willy Tarreau | 983e01e | 2010-01-11 18:42:06 +0100 | [diff] [blame] | 4326 | <param*> is a list of parameters for this server. The "default-server" |
| 4327 | keyword accepts an important number of options and has a complete |
| 4328 | section dedicated to it. Please refer to section 5 for more |
| 4329 | details. |
Krzysztof Piotr Oledzki | c6df066 | 2010-01-05 16:38:49 +0100 | [diff] [blame] | 4330 | |
Willy Tarreau | 983e01e | 2010-01-11 18:42:06 +0100 | [diff] [blame] | 4331 | Example : |
Krzysztof Piotr Oledzki | c6df066 | 2010-01-05 16:38:49 +0100 | [diff] [blame] | 4332 | default-server inter 1000 weight 13 |
| 4333 | |
| 4334 | See also: "server" and section 5 about server options |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4335 | |
Willy Tarreau | 983e01e | 2010-01-11 18:42:06 +0100 | [diff] [blame] | 4336 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4337 | default_backend <backend> |
| 4338 | Specify the backend to use when no "use_backend" rule has been matched. |
| 4339 | May be used in sections : defaults | frontend | listen | backend |
| 4340 | yes | yes | yes | no |
| 4341 | Arguments : |
| 4342 | <backend> is the name of the backend to use. |
| 4343 | |
| 4344 | When doing content-switching between frontend and backends using the |
| 4345 | "use_backend" keyword, it is often useful to indicate which backend will be |
| 4346 | used when no rule has matched. It generally is the dynamic backend which |
| 4347 | will catch all undetermined requests. |
| 4348 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4349 | Example : |
| 4350 | |
| 4351 | use_backend dynamic if url_dyn |
| 4352 | use_backend static if url_css url_img extension_img |
| 4353 | default_backend dynamic |
| 4354 | |
Willy Tarreau | 98d0485 | 2015-05-26 12:18:29 +0200 | [diff] [blame] | 4355 | See also : "use_backend" |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4356 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4357 | |
Baptiste Assmann | 27f5134 | 2013-10-09 06:51:49 +0200 | [diff] [blame] | 4358 | description <string> |
| 4359 | Describe a listen, frontend or backend. |
| 4360 | May be used in sections : defaults | frontend | listen | backend |
| 4361 | no | yes | yes | yes |
| 4362 | Arguments : string |
| 4363 | |
| 4364 | Allows to add a sentence to describe the related object in the HAProxy HTML |
| 4365 | stats page. The description will be printed on the right of the object name |
| 4366 | it describes. |
| 4367 | No need to backslash spaces in the <string> arguments. |
| 4368 | |
| 4369 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4370 | disabled |
| 4371 | Disable a proxy, frontend or backend. |
| 4372 | May be used in sections : defaults | frontend | listen | backend |
| 4373 | yes | yes | yes | yes |
| 4374 | Arguments : none |
| 4375 | |
| 4376 | The "disabled" keyword is used to disable an instance, mainly in order to |
| 4377 | liberate a listening port or to temporarily disable a service. The instance |
| 4378 | will still be created and its configuration will be checked, but it will be |
| 4379 | created in the "stopped" state and will appear as such in the statistics. It |
| 4380 | will not receive any traffic nor will it send any health-checks or logs. It |
| 4381 | is possible to disable many instances at once by adding the "disabled" |
| 4382 | keyword in a "defaults" section. |
| 4383 | |
| 4384 | See also : "enabled" |
| 4385 | |
| 4386 | |
Willy Tarreau | 5ce9457 | 2010-06-07 14:35:41 +0200 | [diff] [blame] | 4387 | dispatch <address>:<port> |
| 4388 | Set a default server address |
| 4389 | May be used in sections : defaults | frontend | listen | backend |
| 4390 | no | no | yes | yes |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 4391 | Arguments : |
Willy Tarreau | 5ce9457 | 2010-06-07 14:35:41 +0200 | [diff] [blame] | 4392 | |
| 4393 | <address> is the IPv4 address of the default server. Alternatively, a |
| 4394 | resolvable hostname is supported, but this name will be resolved |
| 4395 | during start-up. |
| 4396 | |
| 4397 | <ports> is a mandatory port specification. All connections will be sent |
| 4398 | to this port, and it is not permitted to use port offsets as is |
| 4399 | possible with normal servers. |
| 4400 | |
Willy Tarreau | 787aed5 | 2011-04-15 06:45:37 +0200 | [diff] [blame] | 4401 | The "dispatch" keyword designates a default server for use when no other |
Willy Tarreau | 5ce9457 | 2010-06-07 14:35:41 +0200 | [diff] [blame] | 4402 | server can take the connection. In the past it was used to forward non |
| 4403 | persistent connections to an auxiliary load balancer. Due to its simple |
| 4404 | syntax, it has also been used for simple TCP relays. It is recommended not to |
| 4405 | use it for more clarity, and to use the "server" directive instead. |
| 4406 | |
| 4407 | See also : "server" |
| 4408 | |
Olivier Houchard | 4e69404 | 2017-03-14 20:01:29 +0100 | [diff] [blame] | 4409 | |
| 4410 | dynamic-cookie-key <string> |
| 4411 | Set the dynamic cookie secret key for a backend. |
| 4412 | May be used in sections : defaults | frontend | listen | backend |
| 4413 | yes | no | yes | yes |
| 4414 | Arguments : The secret key to be used. |
| 4415 | |
| 4416 | When dynamic cookies are enabled (see the "dynamic" directive for cookie), |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4417 | a dynamic cookie is created for each server (unless one is explicitly |
Olivier Houchard | 4e69404 | 2017-03-14 20:01:29 +0100 | [diff] [blame] | 4418 | specified on the "server" line), using a hash of the IP address of the |
| 4419 | server, the TCP port, and the secret key. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4420 | That way, we can ensure session persistence across multiple load-balancers, |
Olivier Houchard | 4e69404 | 2017-03-14 20:01:29 +0100 | [diff] [blame] | 4421 | even if servers are dynamically added or removed. |
Willy Tarreau | 5ce9457 | 2010-06-07 14:35:41 +0200 | [diff] [blame] | 4422 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4423 | enabled |
| 4424 | Enable a proxy, frontend or backend. |
| 4425 | May be used in sections : defaults | frontend | listen | backend |
| 4426 | yes | yes | yes | yes |
| 4427 | Arguments : none |
| 4428 | |
| 4429 | The "enabled" keyword is used to explicitly enable an instance, when the |
| 4430 | defaults has been set to "disabled". This is very rarely used. |
| 4431 | |
| 4432 | See also : "disabled" |
| 4433 | |
| 4434 | |
| 4435 | errorfile <code> <file> |
| 4436 | Return a file contents instead of errors generated by HAProxy |
| 4437 | May be used in sections : defaults | frontend | listen | backend |
| 4438 | yes | yes | yes | yes |
| 4439 | Arguments : |
| 4440 | <code> is the HTTP status code. Currently, HAProxy is capable of |
Christopher Faulet | 612f2ea | 2020-05-27 09:57:28 +0200 | [diff] [blame] | 4441 | generating codes 200, 400, 401, 403, 404, 405, 407, 408, 410, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 4442 | 413, 425, 429, 500, 502, 503, and 504. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4443 | |
| 4444 | <file> designates a file containing the full HTTP response. It is |
Willy Tarreau | d2a4aa2 | 2008-01-31 15:28:22 +0100 | [diff] [blame] | 4445 | recommended to follow the common practice of appending ".http" to |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4446 | the filename so that people do not confuse the response with HTML |
Willy Tarreau | 59140a2 | 2009-02-22 12:02:30 +0100 | [diff] [blame] | 4447 | error pages, and to use absolute paths, since files are read |
| 4448 | before any chroot is performed. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4449 | |
| 4450 | It is important to understand that this keyword is not meant to rewrite |
| 4451 | errors returned by the server, but errors detected and returned by HAProxy. |
| 4452 | This is why the list of supported errors is limited to a small set. |
| 4453 | |
Willy Tarreau | ae94d4d | 2011-05-11 16:28:49 +0200 | [diff] [blame] | 4454 | Code 200 is emitted in response to requests matching a "monitor-uri" rule. |
| 4455 | |
Christopher Faulet | 7017067 | 2020-05-18 17:42:48 +0200 | [diff] [blame] | 4456 | The files are parsed when HAProxy starts and must be valid according to the |
| 4457 | HTTP specification. They should not exceed the configured buffer size |
| 4458 | (BUFSIZE), which generally is 16 kB, otherwise an internal error will be |
| 4459 | returned. It is also wise not to put any reference to local contents |
| 4460 | (e.g. images) in order to avoid loops between the client and HAProxy when all |
| 4461 | servers are down, causing an error to be returned instead of an |
| 4462 | image. Finally, The response cannot exceed (tune.bufsize - tune.maxrewrite) |
| 4463 | so that "http-after-response" rules still have room to operate (see |
| 4464 | "tune.maxrewrite"). |
Willy Tarreau | 59140a2 | 2009-02-22 12:02:30 +0100 | [diff] [blame] | 4465 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4466 | The files are read at the same time as the configuration and kept in memory. |
| 4467 | For this reason, the errors continue to be returned even when the process is |
| 4468 | chrooted, and no file change is considered while the process is running. A |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 4469 | simple method for developing those files consists in associating them to the |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4470 | 403 status code and interrogating a blocked URL. |
| 4471 | |
Christopher Faulet | 3b967c1 | 2020-05-15 15:47:44 +0200 | [diff] [blame] | 4472 | See also : "http-error", "errorloc", "errorloc302", "errorloc303" |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4473 | |
Willy Tarreau | 59140a2 | 2009-02-22 12:02:30 +0100 | [diff] [blame] | 4474 | Example : |
| 4475 | errorfile 400 /etc/haproxy/errorfiles/400badreq.http |
Willy Tarreau | 989222a | 2016-01-15 10:26:26 +0100 | [diff] [blame] | 4476 | errorfile 408 /dev/null # work around Chrome pre-connect bug |
Willy Tarreau | 59140a2 | 2009-02-22 12:02:30 +0100 | [diff] [blame] | 4477 | errorfile 403 /etc/haproxy/errorfiles/403forbid.http |
| 4478 | errorfile 503 /etc/haproxy/errorfiles/503sorry.http |
| 4479 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4480 | |
Christopher Faulet | 76edc0f | 2020-01-13 15:52:01 +0100 | [diff] [blame] | 4481 | errorfiles <name> [<code> ...] |
| 4482 | Import, fully or partially, the error files defined in the <name> http-errors |
| 4483 | section. |
| 4484 | May be used in sections : defaults | frontend | listen | backend |
| 4485 | yes | yes | yes | yes |
| 4486 | Arguments : |
| 4487 | <name> is the name of an existing http-errors section. |
| 4488 | |
| 4489 | <code> is a HTTP status code. Several status code may be listed. |
Christopher Faulet | 612f2ea | 2020-05-27 09:57:28 +0200 | [diff] [blame] | 4490 | Currently, HAProxy is capable of generating codes 200, 400, 401, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 4491 | 403, 404, 405, 407, 408, 410, 413, 425, 429, 500, 502, 503, and 504. |
Christopher Faulet | 76edc0f | 2020-01-13 15:52:01 +0100 | [diff] [blame] | 4492 | |
| 4493 | Errors defined in the http-errors section with the name <name> are imported |
| 4494 | in the current proxy. If no status code is specified, all error files of the |
| 4495 | http-errors section are imported. Otherwise, only error files associated to |
| 4496 | the listed status code are imported. Those error files override the already |
| 4497 | defined custom errors for the proxy. And they may be overridden by following |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 4498 | ones. Functionally, it is exactly the same as declaring all error files by |
Christopher Faulet | 76edc0f | 2020-01-13 15:52:01 +0100 | [diff] [blame] | 4499 | hand using "errorfile" directives. |
| 4500 | |
Christopher Faulet | 3b967c1 | 2020-05-15 15:47:44 +0200 | [diff] [blame] | 4501 | See also : "http-error", "errorfile", "errorloc", "errorloc302" , |
| 4502 | "errorloc303" and section 3.8 about http-errors. |
Christopher Faulet | 76edc0f | 2020-01-13 15:52:01 +0100 | [diff] [blame] | 4503 | |
| 4504 | Example : |
| 4505 | errorfiles generic |
| 4506 | errorfiles site-1 403 404 |
| 4507 | |
| 4508 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4509 | errorloc <code> <url> |
| 4510 | errorloc302 <code> <url> |
| 4511 | Return an HTTP redirection to a URL instead of errors generated by HAProxy |
| 4512 | May be used in sections : defaults | frontend | listen | backend |
| 4513 | yes | yes | yes | yes |
| 4514 | Arguments : |
| 4515 | <code> is the HTTP status code. Currently, HAProxy is capable of |
Christopher Faulet | 612f2ea | 2020-05-27 09:57:28 +0200 | [diff] [blame] | 4516 | generating codes 200, 400, 401, 403, 404, 405, 407, 408, 410, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 4517 | 413, 425, 429, 500, 502, 503, and 504. |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4518 | |
| 4519 | <url> it is the exact contents of the "Location" header. It may contain |
| 4520 | either a relative URI to an error page hosted on the same site, |
| 4521 | or an absolute URI designating an error page on another site. |
| 4522 | Special care should be given to relative URIs to avoid redirect |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4523 | loops if the URI itself may generate the same error (e.g. 500). |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4524 | |
| 4525 | It is important to understand that this keyword is not meant to rewrite |
| 4526 | errors returned by the server, but errors detected and returned by HAProxy. |
| 4527 | This is why the list of supported errors is limited to a small set. |
| 4528 | |
Willy Tarreau | ae94d4d | 2011-05-11 16:28:49 +0200 | [diff] [blame] | 4529 | Code 200 is emitted in response to requests matching a "monitor-uri" rule. |
| 4530 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4531 | Note that both keyword return the HTTP 302 status code, which tells the |
| 4532 | client to fetch the designated URL using the same HTTP method. This can be |
| 4533 | quite problematic in case of non-GET methods such as POST, because the URL |
| 4534 | sent to the client might not be allowed for something other than GET. To |
Willy Tarreau | 989222a | 2016-01-15 10:26:26 +0100 | [diff] [blame] | 4535 | work around this problem, please use "errorloc303" which send the HTTP 303 |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4536 | status code, indicating to the client that the URL must be fetched with a GET |
| 4537 | request. |
| 4538 | |
Christopher Faulet | 3b967c1 | 2020-05-15 15:47:44 +0200 | [diff] [blame] | 4539 | See also : "http-error", "errorfile", "errorloc303" |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4540 | |
| 4541 | |
| 4542 | errorloc303 <code> <url> |
| 4543 | Return an HTTP redirection to a URL instead of errors generated by HAProxy |
| 4544 | May be used in sections : defaults | frontend | listen | backend |
| 4545 | yes | yes | yes | yes |
| 4546 | Arguments : |
| 4547 | <code> is the HTTP status code. Currently, HAProxy is capable of |
Christopher Faulet | 612f2ea | 2020-05-27 09:57:28 +0200 | [diff] [blame] | 4548 | generating codes 200, 400, 401, 403, 404, 405, 407, 408, 410, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 4549 | 413, 425, 429, 500, 502, 503, and 504. |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4550 | |
| 4551 | <url> it is the exact contents of the "Location" header. It may contain |
| 4552 | either a relative URI to an error page hosted on the same site, |
| 4553 | or an absolute URI designating an error page on another site. |
| 4554 | Special care should be given to relative URIs to avoid redirect |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4555 | loops if the URI itself may generate the same error (e.g. 500). |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4556 | |
| 4557 | It is important to understand that this keyword is not meant to rewrite |
| 4558 | errors returned by the server, but errors detected and returned by HAProxy. |
| 4559 | This is why the list of supported errors is limited to a small set. |
| 4560 | |
Willy Tarreau | ae94d4d | 2011-05-11 16:28:49 +0200 | [diff] [blame] | 4561 | Code 200 is emitted in response to requests matching a "monitor-uri" rule. |
| 4562 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4563 | Note that both keyword return the HTTP 303 status code, which tells the |
| 4564 | client to fetch the designated URL using the same HTTP GET method. This |
| 4565 | solves the usual problems associated with "errorloc" and the 302 code. It is |
| 4566 | possible that some very old browsers designed before HTTP/1.1 do not support |
Willy Tarreau | d2a4aa2 | 2008-01-31 15:28:22 +0100 | [diff] [blame] | 4567 | it, but no such problem has been reported till now. |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4568 | |
Christopher Faulet | 3b967c1 | 2020-05-15 15:47:44 +0200 | [diff] [blame] | 4569 | See also : "http-error", "errorfile", "errorloc", "errorloc302" |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4570 | |
| 4571 | |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 4572 | email-alert from <emailaddr> |
| 4573 | Declare the from email address to be used in both the envelope and header |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4574 | of email alerts. This is the address that email alerts are sent from. |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 4575 | May be used in sections: defaults | frontend | listen | backend |
| 4576 | yes | yes | yes | yes |
| 4577 | |
| 4578 | Arguments : |
| 4579 | |
| 4580 | <emailaddr> is the from email address to use when sending email alerts |
| 4581 | |
| 4582 | Also requires "email-alert mailers" and "email-alert to" to be set |
| 4583 | and if so sending email alerts is enabled for the proxy. |
| 4584 | |
Simon Horman | 64e3416 | 2015-02-06 11:11:57 +0900 | [diff] [blame] | 4585 | See also : "email-alert level", "email-alert mailers", |
Cyril Bonté | 307ee1e | 2015-09-28 23:16:06 +0200 | [diff] [blame] | 4586 | "email-alert myhostname", "email-alert to", section 3.6 about |
| 4587 | mailers. |
Simon Horman | 64e3416 | 2015-02-06 11:11:57 +0900 | [diff] [blame] | 4588 | |
| 4589 | |
| 4590 | email-alert level <level> |
| 4591 | Declare the maximum log level of messages for which email alerts will be |
| 4592 | sent. This acts as a filter on the sending of email alerts. |
| 4593 | May be used in sections: defaults | frontend | listen | backend |
| 4594 | yes | yes | yes | yes |
| 4595 | |
| 4596 | Arguments : |
| 4597 | |
| 4598 | <level> One of the 8 syslog levels: |
| 4599 | emerg alert crit err warning notice info debug |
| 4600 | The above syslog levels are ordered from lowest to highest. |
| 4601 | |
| 4602 | By default level is alert |
| 4603 | |
| 4604 | Also requires "email-alert from", "email-alert mailers" and |
| 4605 | "email-alert to" to be set and if so sending email alerts is enabled |
| 4606 | for the proxy. |
| 4607 | |
Simon Horman | 1421e21 | 2015-04-30 13:10:35 +0900 | [diff] [blame] | 4608 | Alerts are sent when : |
| 4609 | |
| 4610 | * An un-paused server is marked as down and <level> is alert or lower |
| 4611 | * A paused server is marked as down and <level> is notice or lower |
| 4612 | * A server is marked as up or enters the drain state and <level> |
| 4613 | is notice or lower |
| 4614 | * "option log-health-checks" is enabled, <level> is info or lower, |
| 4615 | and a health check status update occurs |
| 4616 | |
Simon Horman | 64e3416 | 2015-02-06 11:11:57 +0900 | [diff] [blame] | 4617 | See also : "email-alert from", "email-alert mailers", |
| 4618 | "email-alert myhostname", "email-alert to", |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 4619 | section 3.6 about mailers. |
| 4620 | |
| 4621 | |
| 4622 | email-alert mailers <mailersect> |
| 4623 | Declare the mailers to be used when sending email alerts |
| 4624 | May be used in sections: defaults | frontend | listen | backend |
| 4625 | yes | yes | yes | yes |
| 4626 | |
| 4627 | Arguments : |
| 4628 | |
| 4629 | <mailersect> is the name of the mailers section to send email alerts. |
| 4630 | |
| 4631 | Also requires "email-alert from" and "email-alert to" to be set |
| 4632 | and if so sending email alerts is enabled for the proxy. |
| 4633 | |
Simon Horman | 64e3416 | 2015-02-06 11:11:57 +0900 | [diff] [blame] | 4634 | See also : "email-alert from", "email-alert level", "email-alert myhostname", |
| 4635 | "email-alert to", section 3.6 about mailers. |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 4636 | |
| 4637 | |
| 4638 | email-alert myhostname <hostname> |
| 4639 | Declare the to hostname address to be used when communicating with |
| 4640 | mailers. |
| 4641 | May be used in sections: defaults | frontend | listen | backend |
| 4642 | yes | yes | yes | yes |
| 4643 | |
| 4644 | Arguments : |
| 4645 | |
Baptiste Assmann | 738bad9 | 2015-12-21 15:27:53 +0100 | [diff] [blame] | 4646 | <hostname> is the hostname to use when communicating with mailers |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 4647 | |
| 4648 | By default the systems hostname is used. |
| 4649 | |
| 4650 | Also requires "email-alert from", "email-alert mailers" and |
| 4651 | "email-alert to" to be set and if so sending email alerts is enabled |
| 4652 | for the proxy. |
| 4653 | |
Simon Horman | 64e3416 | 2015-02-06 11:11:57 +0900 | [diff] [blame] | 4654 | See also : "email-alert from", "email-alert level", "email-alert mailers", |
| 4655 | "email-alert to", section 3.6 about mailers. |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 4656 | |
| 4657 | |
| 4658 | email-alert to <emailaddr> |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 4659 | Declare both the recipient address in the envelope and to address in the |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 4660 | header of email alerts. This is the address that email alerts are sent to. |
| 4661 | May be used in sections: defaults | frontend | listen | backend |
| 4662 | yes | yes | yes | yes |
| 4663 | |
| 4664 | Arguments : |
| 4665 | |
| 4666 | <emailaddr> is the to email address to use when sending email alerts |
| 4667 | |
| 4668 | Also requires "email-alert mailers" and "email-alert to" to be set |
| 4669 | and if so sending email alerts is enabled for the proxy. |
| 4670 | |
Simon Horman | 64e3416 | 2015-02-06 11:11:57 +0900 | [diff] [blame] | 4671 | See also : "email-alert from", "email-alert level", "email-alert mailers", |
Simon Horman | 51a1cf6 | 2015-02-03 13:00:44 +0900 | [diff] [blame] | 4672 | "email-alert myhostname", section 3.6 about mailers. |
| 4673 | |
| 4674 | |
Willy Tarreau | 4de9149 | 2010-01-22 19:10:05 +0100 | [diff] [blame] | 4675 | force-persist { if | unless } <condition> |
| 4676 | Declare a condition to force persistence on down servers |
| 4677 | May be used in sections: defaults | frontend | listen | backend |
Cyril Bonté | 4288c5a | 2018-03-12 22:02:59 +0100 | [diff] [blame] | 4678 | no | no | yes | yes |
Willy Tarreau | 4de9149 | 2010-01-22 19:10:05 +0100 | [diff] [blame] | 4679 | |
| 4680 | By default, requests are not dispatched to down servers. It is possible to |
| 4681 | force this using "option persist", but it is unconditional and redispatches |
| 4682 | to a valid server if "option redispatch" is set. That leaves with very little |
| 4683 | possibilities to force some requests to reach a server which is artificially |
| 4684 | marked down for maintenance operations. |
| 4685 | |
| 4686 | The "force-persist" statement allows one to declare various ACL-based |
| 4687 | conditions which, when met, will cause a request to ignore the down status of |
| 4688 | a server and still try to connect to it. That makes it possible to start a |
| 4689 | server, still replying an error to the health checks, and run a specially |
| 4690 | configured browser to test the service. Among the handy methods, one could |
| 4691 | use a specific source IP address, or a specific cookie. The cookie also has |
| 4692 | the advantage that it can easily be added/removed on the browser from a test |
| 4693 | page. Once the service is validated, it is then possible to open the service |
| 4694 | to the world by returning a valid response to health checks. |
| 4695 | |
| 4696 | The forced persistence is enabled when an "if" condition is met, or unless an |
| 4697 | "unless" condition is met. The final redispatch is always disabled when this |
| 4698 | is used. |
| 4699 | |
Cyril Bonté | 0d4bf01 | 2010-04-25 23:21:46 +0200 | [diff] [blame] | 4700 | See also : "option redispatch", "ignore-persist", "persist", |
Cyril Bonté | a8e7bbc | 2010-04-25 22:29:29 +0200 | [diff] [blame] | 4701 | and section 7 about ACL usage. |
Willy Tarreau | 4de9149 | 2010-01-22 19:10:05 +0100 | [diff] [blame] | 4702 | |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 4703 | |
| 4704 | filter <name> [param*] |
| 4705 | Add the filter <name> in the filter list attached to the proxy. |
| 4706 | May be used in sections : defaults | frontend | listen | backend |
| 4707 | no | yes | yes | yes |
| 4708 | Arguments : |
| 4709 | <name> is the name of the filter. Officially supported filters are |
| 4710 | referenced in section 9. |
| 4711 | |
Tim Düsterhus | 4896c44 | 2016-11-29 02:15:19 +0100 | [diff] [blame] | 4712 | <param*> is a list of parameters accepted by the filter <name>. The |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 4713 | parsing of these parameters are the responsibility of the |
Tim Düsterhus | 4896c44 | 2016-11-29 02:15:19 +0100 | [diff] [blame] | 4714 | filter. Please refer to the documentation of the corresponding |
| 4715 | filter (section 9) for all details on the supported parameters. |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 4716 | |
| 4717 | Multiple occurrences of the filter line can be used for the same proxy. The |
| 4718 | same filter can be referenced many times if needed. |
| 4719 | |
| 4720 | Example: |
| 4721 | listen |
| 4722 | bind *:80 |
| 4723 | |
| 4724 | filter trace name BEFORE-HTTP-COMP |
| 4725 | filter compression |
| 4726 | filter trace name AFTER-HTTP-COMP |
| 4727 | |
| 4728 | compression algo gzip |
| 4729 | compression offload |
| 4730 | |
| 4731 | server srv1 192.168.0.1:80 |
| 4732 | |
| 4733 | See also : section 9. |
| 4734 | |
Willy Tarreau | 4de9149 | 2010-01-22 19:10:05 +0100 | [diff] [blame] | 4735 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4736 | fullconn <conns> |
| 4737 | Specify at what backend load the servers will reach their maxconn |
| 4738 | May be used in sections : defaults | frontend | listen | backend |
| 4739 | yes | no | yes | yes |
| 4740 | Arguments : |
| 4741 | <conns> is the number of connections on the backend which will make the |
| 4742 | servers use the maximal number of connections. |
| 4743 | |
Willy Tarreau | 198a744 | 2008-01-17 12:05:32 +0100 | [diff] [blame] | 4744 | When a server has a "maxconn" parameter specified, it means that its number |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4745 | of concurrent connections will never go higher. Additionally, if it has a |
Willy Tarreau | 198a744 | 2008-01-17 12:05:32 +0100 | [diff] [blame] | 4746 | "minconn" parameter, it indicates a dynamic limit following the backend's |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4747 | load. The server will then always accept at least <minconn> connections, |
| 4748 | never more than <maxconn>, and the limit will be on the ramp between both |
| 4749 | values when the backend has less than <conns> concurrent connections. This |
| 4750 | makes it possible to limit the load on the servers during normal loads, but |
| 4751 | push it further for important loads without overloading the servers during |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 4752 | exceptional loads. |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4753 | |
Willy Tarreau | fbb7842 | 2011-06-05 15:38:35 +0200 | [diff] [blame] | 4754 | Since it's hard to get this value right, haproxy automatically sets it to |
| 4755 | 10% of the sum of the maxconns of all frontends that may branch to this |
Bertrand Jacquin | 702d44f | 2013-11-19 11:43:06 +0100 | [diff] [blame] | 4756 | backend (based on "use_backend" and "default_backend" rules). That way it's |
| 4757 | safe to leave it unset. However, "use_backend" involving dynamic names are |
| 4758 | not counted since there is no way to know if they could match or not. |
Willy Tarreau | fbb7842 | 2011-06-05 15:38:35 +0200 | [diff] [blame] | 4759 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4760 | Example : |
| 4761 | # The servers will accept between 100 and 1000 concurrent connections each |
| 4762 | # and the maximum of 1000 will be reached when the backend reaches 10000 |
| 4763 | # connections. |
| 4764 | backend dynamic |
| 4765 | fullconn 10000 |
| 4766 | server srv1 dyn1:80 minconn 100 maxconn 1000 |
| 4767 | server srv2 dyn2:80 minconn 100 maxconn 1000 |
| 4768 | |
| 4769 | See also : "maxconn", "server" |
| 4770 | |
| 4771 | |
Willy Tarreau | ab0a519 | 2020-10-09 19:07:01 +0200 | [diff] [blame] | 4772 | grace <time> (deprecated) |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4773 | Maintain a proxy operational for some time after a soft stop |
| 4774 | May be used in sections : defaults | frontend | listen | backend |
Cyril Bonté | 99ed327 | 2010-01-24 23:29:44 +0100 | [diff] [blame] | 4775 | yes | yes | yes | yes |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4776 | Arguments : |
| 4777 | <time> is the time (by default in milliseconds) for which the instance |
| 4778 | will remain operational with the frontend sockets still listening |
| 4779 | when a soft-stop is received via the SIGUSR1 signal. |
| 4780 | |
| 4781 | This may be used to ensure that the services disappear in a certain order. |
| 4782 | This was designed so that frontends which are dedicated to monitoring by an |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 4783 | external equipment fail immediately while other ones remain up for the time |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 4784 | needed by the equipment to detect the failure. |
| 4785 | |
| 4786 | Note that currently, there is very little benefit in using this parameter, |
| 4787 | and it may in fact complicate the soft-reconfiguration process more than |
| 4788 | simplify it. |
| 4789 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 4790 | |
Andrew Rodland | 17be45e | 2016-10-25 17:04:12 -0400 | [diff] [blame] | 4791 | hash-balance-factor <factor> |
| 4792 | Specify the balancing factor for bounded-load consistent hashing |
| 4793 | May be used in sections : defaults | frontend | listen | backend |
| 4794 | yes | no | no | yes |
| 4795 | Arguments : |
| 4796 | <factor> is the control for the maximum number of concurrent requests to |
| 4797 | send to a server, expressed as a percentage of the average number |
Frédéric Lécaille | 93d3316 | 2019-03-06 09:35:59 +0100 | [diff] [blame] | 4798 | of concurrent requests across all of the active servers. |
Andrew Rodland | 17be45e | 2016-10-25 17:04:12 -0400 | [diff] [blame] | 4799 | |
| 4800 | Specifying a "hash-balance-factor" for a server with "hash-type consistent" |
| 4801 | enables an algorithm that prevents any one server from getting too many |
| 4802 | requests at once, even if some hash buckets receive many more requests than |
| 4803 | others. Setting <factor> to 0 (the default) disables the feature. Otherwise, |
| 4804 | <factor> is a percentage greater than 100. For example, if <factor> is 150, |
| 4805 | then no server will be allowed to have a load more than 1.5 times the average. |
| 4806 | If server weights are used, they will be respected. |
| 4807 | |
| 4808 | If the first-choice server is disqualified, the algorithm will choose another |
| 4809 | server based on the request hash, until a server with additional capacity is |
| 4810 | found. A higher <factor> allows more imbalance between the servers, while a |
| 4811 | lower <factor> means that more servers will be checked on average, affecting |
| 4812 | performance. Reasonable values are from 125 to 200. |
| 4813 | |
Willy Tarreau | 760e81d | 2018-05-03 07:20:40 +0200 | [diff] [blame] | 4814 | This setting is also used by "balance random" which internally relies on the |
| 4815 | consistent hashing mechanism. |
| 4816 | |
Andrew Rodland | 17be45e | 2016-10-25 17:04:12 -0400 | [diff] [blame] | 4817 | See also : "balance" and "hash-type". |
| 4818 | |
| 4819 | |
Bhaskar Maddala | b6c0ac9 | 2013-11-05 11:54:02 -0500 | [diff] [blame] | 4820 | hash-type <method> <function> <modifier> |
Willy Tarreau | 6b2e11b | 2009-10-01 07:52:15 +0200 | [diff] [blame] | 4821 | Specify a method to use for mapping hashes to servers |
| 4822 | May be used in sections : defaults | frontend | listen | backend |
| 4823 | yes | no | yes | yes |
| 4824 | Arguments : |
Bhaskar | 98634f0 | 2013-10-29 23:30:51 -0400 | [diff] [blame] | 4825 | <method> is the method used to select a server from the hash computed by |
| 4826 | the <function> : |
Willy Tarreau | 6b2e11b | 2009-10-01 07:52:15 +0200 | [diff] [blame] | 4827 | |
Bhaskar | 98634f0 | 2013-10-29 23:30:51 -0400 | [diff] [blame] | 4828 | map-based the hash table is a static array containing all alive servers. |
| 4829 | The hashes will be very smooth, will consider weights, but |
| 4830 | will be static in that weight changes while a server is up |
| 4831 | will be ignored. This means that there will be no slow start. |
| 4832 | Also, since a server is selected by its position in the array, |
| 4833 | most mappings are changed when the server count changes. This |
| 4834 | means that when a server goes up or down, or when a server is |
| 4835 | added to a farm, most connections will be redistributed to |
| 4836 | different servers. This can be inconvenient with caches for |
| 4837 | instance. |
Willy Tarreau | 798a39c | 2010-11-24 15:04:29 +0100 | [diff] [blame] | 4838 | |
Bhaskar | 98634f0 | 2013-10-29 23:30:51 -0400 | [diff] [blame] | 4839 | consistent the hash table is a tree filled with many occurrences of each |
| 4840 | server. The hash key is looked up in the tree and the closest |
| 4841 | server is chosen. This hash is dynamic, it supports changing |
| 4842 | weights while the servers are up, so it is compatible with the |
| 4843 | slow start feature. It has the advantage that when a server |
| 4844 | goes up or down, only its associations are moved. When a |
| 4845 | server is added to the farm, only a few part of the mappings |
| 4846 | are redistributed, making it an ideal method for caches. |
| 4847 | However, due to its principle, the distribution will never be |
| 4848 | very smooth and it may sometimes be necessary to adjust a |
| 4849 | server's weight or its ID to get a more balanced distribution. |
| 4850 | In order to get the same distribution on multiple load |
| 4851 | balancers, it is important that all servers have the exact |
Bhaskar Maddala | b6c0ac9 | 2013-11-05 11:54:02 -0500 | [diff] [blame] | 4852 | same IDs. Note: consistent hash uses sdbm and avalanche if no |
| 4853 | hash function is specified. |
Bhaskar | 98634f0 | 2013-10-29 23:30:51 -0400 | [diff] [blame] | 4854 | |
| 4855 | <function> is the hash function to be used : |
| 4856 | |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 4857 | sdbm this function was created initially for sdbm (a public-domain |
Bhaskar | 98634f0 | 2013-10-29 23:30:51 -0400 | [diff] [blame] | 4858 | reimplementation of ndbm) database library. It was found to do |
| 4859 | well in scrambling bits, causing better distribution of the keys |
| 4860 | and fewer splits. It also happens to be a good general hashing |
Bhaskar Maddala | b6c0ac9 | 2013-11-05 11:54:02 -0500 | [diff] [blame] | 4861 | function with good distribution, unless the total server weight |
| 4862 | is a multiple of 64, in which case applying the avalanche |
| 4863 | modifier may help. |
Bhaskar | 98634f0 | 2013-10-29 23:30:51 -0400 | [diff] [blame] | 4864 | |
| 4865 | djb2 this function was first proposed by Dan Bernstein many years ago |
| 4866 | on comp.lang.c. Studies have shown that for certain workload this |
Bhaskar Maddala | b6c0ac9 | 2013-11-05 11:54:02 -0500 | [diff] [blame] | 4867 | function provides a better distribution than sdbm. It generally |
| 4868 | works well with text-based inputs though it can perform extremely |
| 4869 | poorly with numeric-only input or when the total server weight is |
| 4870 | a multiple of 33, unless the avalanche modifier is also used. |
| 4871 | |
Willy Tarreau | a0f4271 | 2013-11-14 14:30:35 +0100 | [diff] [blame] | 4872 | wt6 this function was designed for haproxy while testing other |
| 4873 | functions in the past. It is not as smooth as the other ones, but |
| 4874 | is much less sensible to the input data set or to the number of |
| 4875 | servers. It can make sense as an alternative to sdbm+avalanche or |
| 4876 | djb2+avalanche for consistent hashing or when hashing on numeric |
| 4877 | data such as a source IP address or a visitor identifier in a URL |
| 4878 | parameter. |
| 4879 | |
Willy Tarreau | 324f07f | 2015-01-20 19:44:50 +0100 | [diff] [blame] | 4880 | crc32 this is the most common CRC32 implementation as used in Ethernet, |
| 4881 | gzip, PNG, etc. It is slower than the other ones but may provide |
| 4882 | a better distribution or less predictable results especially when |
| 4883 | used on strings. |
| 4884 | |
Bhaskar Maddala | b6c0ac9 | 2013-11-05 11:54:02 -0500 | [diff] [blame] | 4885 | <modifier> indicates an optional method applied after hashing the key : |
| 4886 | |
| 4887 | avalanche This directive indicates that the result from the hash |
| 4888 | function above should not be used in its raw form but that |
| 4889 | a 4-byte full avalanche hash must be applied first. The |
| 4890 | purpose of this step is to mix the resulting bits from the |
| 4891 | previous hash in order to avoid any undesired effect when |
| 4892 | the input contains some limited values or when the number of |
| 4893 | servers is a multiple of one of the hash's components (64 |
| 4894 | for SDBM, 33 for DJB2). Enabling avalanche tends to make the |
| 4895 | result less predictable, but it's also not as smooth as when |
| 4896 | using the original function. Some testing might be needed |
| 4897 | with some workloads. This hash is one of the many proposed |
| 4898 | by Bob Jenkins. |
Willy Tarreau | 6b2e11b | 2009-10-01 07:52:15 +0200 | [diff] [blame] | 4899 | |
Bhaskar | 98634f0 | 2013-10-29 23:30:51 -0400 | [diff] [blame] | 4900 | The default hash type is "map-based" and is recommended for most usages. The |
| 4901 | default function is "sdbm", the selection of a function should be based on |
| 4902 | the range of the values being hashed. |
Willy Tarreau | 6b2e11b | 2009-10-01 07:52:15 +0200 | [diff] [blame] | 4903 | |
Andrew Rodland | 17be45e | 2016-10-25 17:04:12 -0400 | [diff] [blame] | 4904 | See also : "balance", "hash-balance-factor", "server" |
Willy Tarreau | 6b2e11b | 2009-10-01 07:52:15 +0200 | [diff] [blame] | 4905 | |
| 4906 | |
Christopher Faulet | 6d0c3df | 2020-01-22 09:26:35 +0100 | [diff] [blame] | 4907 | http-after-response <action> <options...> [ { if | unless } <condition> ] |
| 4908 | Access control for all Layer 7 responses (server, applet/service and internal |
| 4909 | ones). |
| 4910 | |
| 4911 | May be used in sections: defaults | frontend | listen | backend |
| 4912 | no | yes | yes | yes |
| 4913 | |
| 4914 | The http-after-response statement defines a set of rules which apply to layer |
| 4915 | 7 processing. The rules are evaluated in their declaration order when they |
| 4916 | are met in a frontend, listen or backend section. Any rule may optionally be |
| 4917 | followed by an ACL-based condition, in which case it will only be evaluated |
| 4918 | if the condition is true. Since these rules apply on responses, the backend |
| 4919 | rules are applied first, followed by the frontend's rules. |
| 4920 | |
| 4921 | Unlike http-response rules, these ones are applied on all responses, the |
| 4922 | server ones but also to all responses generated by HAProxy. These rules are |
| 4923 | evaluated at the end of the responses analysis, before the data forwarding. |
| 4924 | |
| 4925 | The first keyword is the rule's action. The supported actions are described |
| 4926 | below. |
| 4927 | |
| 4928 | There is no limit to the number of http-after-response statements per |
| 4929 | instance. |
| 4930 | |
Christopher Faulet | d5ac6de | 2020-12-02 08:40:14 +0100 | [diff] [blame] | 4931 | Note: Errors emitted in early stage of the request parsing are handled by the |
| 4932 | multiplexer at a lower level, before any http analysis. Thus no |
| 4933 | http-after-response ruleset is evaluated on these errors. |
| 4934 | |
Christopher Faulet | 6d0c3df | 2020-01-22 09:26:35 +0100 | [diff] [blame] | 4935 | Example: |
| 4936 | http-after-response set-header Strict-Transport-Security "max-age=31536000" |
| 4937 | http-after-response set-header Cache-Control "no-store,no-cache,private" |
| 4938 | http-after-response set-header Pragma "no-cache" |
| 4939 | |
| 4940 | http-after-response add-header <name> <fmt> [ { if | unless } <condition> ] |
| 4941 | |
| 4942 | This appends an HTTP header field whose name is specified in <name> and whose |
| 4943 | value is defined by <fmt> which follows the log-format rules (see Custom Log |
| 4944 | Format in section 8.2.4). This may be used to send a cookie to a client for |
| 4945 | example, or to pass some internal information. |
| 4946 | This rule is not final, so it is possible to add other similar rules. |
| 4947 | Note that header addition is performed immediately, so one rule might reuse |
| 4948 | the resulting header from a previous rule. |
| 4949 | |
| 4950 | http-after-response allow [ { if | unless } <condition> ] |
| 4951 | |
| 4952 | This stops the evaluation of the rules and lets the response pass the check. |
| 4953 | No further "http-after-response" rules are evaluated. |
| 4954 | |
Maciej Zdeb | ebdd4c5 | 2020-11-20 13:58:48 +0000 | [diff] [blame] | 4955 | http-after-response del-header <name> [ -m <meth> ] [ { if | unless } <condition> ] |
Christopher Faulet | 6d0c3df | 2020-01-22 09:26:35 +0100 | [diff] [blame] | 4956 | |
Maciej Zdeb | ebdd4c5 | 2020-11-20 13:58:48 +0000 | [diff] [blame] | 4957 | This removes all HTTP header fields whose name is specified in <name>. <meth> |
| 4958 | is the matching method, applied on the header name. Supported matching methods |
| 4959 | are "str" (exact match), "beg" (prefix match), "end" (suffix match), "sub" |
| 4960 | (substring match) and "reg" (regex match). If not specified, exact matching |
| 4961 | method is used. |
Christopher Faulet | 6d0c3df | 2020-01-22 09:26:35 +0100 | [diff] [blame] | 4962 | |
| 4963 | http-after-response replace-header <name> <regex-match> <replace-fmt> |
| 4964 | [ { if | unless } <condition> ] |
| 4965 | |
| 4966 | This works like "http-response replace-header". |
| 4967 | |
| 4968 | Example: |
| 4969 | http-after-response replace-header Set-Cookie (C=[^;]*);(.*) \1;ip=%bi;\2 |
| 4970 | |
| 4971 | # applied to: |
| 4972 | Set-Cookie: C=1; expires=Tue, 14-Jun-2016 01:40:45 GMT |
| 4973 | |
| 4974 | # outputs: |
| 4975 | Set-Cookie: C=1;ip=192.168.1.20; expires=Tue, 14-Jun-2016 01:40:45 GMT |
| 4976 | |
| 4977 | # assuming the backend IP is 192.168.1.20. |
| 4978 | |
| 4979 | http-after-response replace-value <name> <regex-match> <replace-fmt> |
| 4980 | [ { if | unless } <condition> ] |
| 4981 | |
| 4982 | This works like "http-response replace-value". |
| 4983 | |
| 4984 | Example: |
| 4985 | http-after-response replace-value Cache-control ^public$ private |
| 4986 | |
| 4987 | # applied to: |
| 4988 | Cache-Control: max-age=3600, public |
| 4989 | |
| 4990 | # outputs: |
| 4991 | Cache-Control: max-age=3600, private |
| 4992 | |
| 4993 | http-after-response set-header <name> <fmt> [ { if | unless } <condition> ] |
| 4994 | |
| 4995 | This does the same as "add-header" except that the header name is first |
| 4996 | removed if it existed. This is useful when passing security information to |
| 4997 | the server, where the header must not be manipulated by external users. |
| 4998 | |
| 4999 | http-after-response set-status <status> [reason <str>] |
| 5000 | [ { if | unless } <condition> ] |
| 5001 | |
| 5002 | This replaces the response status code with <status> which must be an integer |
| 5003 | between 100 and 999. Optionally, a custom reason text can be provided defined |
| 5004 | by <str>, or the default reason for the specified code will be used as a |
| 5005 | fallback. |
| 5006 | |
| 5007 | Example: |
| 5008 | # return "431 Request Header Fields Too Large" |
| 5009 | http-response set-status 431 |
| 5010 | # return "503 Slow Down", custom reason |
| 5011 | http-response set-status 503 reason "Slow Down" |
| 5012 | |
| 5013 | http-after-response set-var(<var-name>) <expr> [ { if | unless } <condition> ] |
| 5014 | |
| 5015 | This is used to set the contents of a variable. The variable is declared |
| 5016 | inline. |
| 5017 | |
| 5018 | Arguments: |
| 5019 | <var-name> The name of the variable starts with an indication about its |
| 5020 | scope. The scopes allowed are: |
| 5021 | "proc" : the variable is shared with the whole process |
| 5022 | "sess" : the variable is shared with the whole session |
| 5023 | "txn" : the variable is shared with the transaction |
| 5024 | (request and response) |
| 5025 | "req" : the variable is shared only during request |
| 5026 | processing |
| 5027 | "res" : the variable is shared only during response |
| 5028 | processing |
| 5029 | This prefix is followed by a name. The separator is a '.'. |
| 5030 | The name may only contain characters 'a-z', 'A-Z', '0-9', '.' |
| 5031 | and '_'. |
| 5032 | |
| 5033 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 5034 | followed by some converters. |
| 5035 | |
| 5036 | Example: |
| 5037 | http-after-response set-var(sess.last_redir) res.hdr(location) |
| 5038 | |
| 5039 | http-after-response strict-mode { on | off } |
| 5040 | |
| 5041 | This enables or disables the strict rewriting mode for following rules. It |
| 5042 | does not affect rules declared before it and it is only applicable on rules |
| 5043 | performing a rewrite on the responses. When the strict mode is enabled, any |
| 5044 | rewrite failure triggers an internal error. Otherwise, such errors are |
| 5045 | silently ignored. The purpose of the strict rewriting mode is to make some |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 5046 | rewrites optional while others must be performed to continue the response |
Christopher Faulet | 6d0c3df | 2020-01-22 09:26:35 +0100 | [diff] [blame] | 5047 | processing. |
| 5048 | |
| 5049 | By default, the strict rewriting mode is enabled. Its value is also reset |
| 5050 | when a ruleset evaluation ends. So, for instance, if you change the mode on |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 5051 | the backend, the default mode is restored when HAProxy starts the frontend |
Christopher Faulet | 6d0c3df | 2020-01-22 09:26:35 +0100 | [diff] [blame] | 5052 | rules evaluation. |
| 5053 | |
| 5054 | http-after-response unset-var(<var-name>) [ { if | unless } <condition> ] |
| 5055 | |
| 5056 | This is used to unset a variable. See "http-after-response set-var" for |
| 5057 | details about <var-name>. |
| 5058 | |
| 5059 | Example: |
| 5060 | http-after-response unset-var(sess.last_redir) |
| 5061 | |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 5062 | |
| 5063 | http-check comment <string> |
| 5064 | Defines a comment for the following the http-check rule, reported in logs if |
| 5065 | it fails. |
| 5066 | May be used in sections : defaults | frontend | listen | backend |
| 5067 | yes | no | yes | yes |
| 5068 | |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 5069 | Arguments : |
| 5070 | <string> is the comment message to add in logs if the following http-check |
| 5071 | rule fails. |
| 5072 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5073 | It only works for connect, send and expect rules. It is useful to make |
| 5074 | user-friendly error reporting. |
| 5075 | |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 5076 | See also : "option httpchk", "http-check connect", "http-check send" and |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 5077 | "http-check expect". |
| 5078 | |
| 5079 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5080 | http-check connect [default] [port <expr>] [addr <ip>] [send-proxy] |
| 5081 | [via-socks4] [ssl] [sni <sni>] [alpn <alpn>] [linger] |
Christopher Faulet | edc6ed9 | 2020-04-23 16:27:59 +0200 | [diff] [blame] | 5082 | [proto <name>] [comment <msg>] |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5083 | Opens a new connection to perform an HTTP health check |
| 5084 | May be used in sections : defaults | frontend | listen | backend |
| 5085 | yes | no | yes | yes |
| 5086 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5087 | Arguments : |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 5088 | comment <msg> defines a message to report if the rule evaluation fails. |
| 5089 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5090 | default Use default options of the server line to do the health |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 5091 | checks. The server options are used only if not redefined. |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5092 | |
| 5093 | port <expr> if not set, check port or server port is used. |
| 5094 | It tells HAProxy where to open the connection to. |
| 5095 | <port> must be a valid TCP port source integer, from 1 to |
| 5096 | 65535 or an sample-fetch expression. |
| 5097 | |
| 5098 | addr <ip> defines the IP address to do the health check. |
| 5099 | |
| 5100 | send-proxy send a PROXY protocol string |
| 5101 | |
| 5102 | via-socks4 enables outgoing health checks using upstream socks4 proxy. |
| 5103 | |
| 5104 | ssl opens a ciphered connection |
| 5105 | |
| 5106 | sni <sni> specifies the SNI to use to do health checks over SSL. |
| 5107 | |
| 5108 | alpn <alpn> defines which protocols to advertise with ALPN. The protocol |
| 5109 | list consists in a comma-delimited list of protocol names, |
| 5110 | for instance: "h2,http/1.1". If it is not set, the server ALPN |
| 5111 | is used. |
| 5112 | |
Christopher Faulet | edc6ed9 | 2020-04-23 16:27:59 +0200 | [diff] [blame] | 5113 | proto <name> forces the multiplexer's protocol to use for this connection. |
| 5114 | It must be an HTTP mux protocol and it must be usable on the |
| 5115 | backend side. The list of available protocols is reported in |
| 5116 | haproxy -vv. |
| 5117 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5118 | linger cleanly close the connection instead of using a single RST. |
| 5119 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5120 | Just like tcp-check health checks, it is possible to configure the connection |
| 5121 | to use to perform HTTP health check. This directive should also be used to |
| 5122 | describe a scenario involving several request/response exchanges, possibly on |
| 5123 | different ports or with different servers. |
| 5124 | |
| 5125 | When there are no TCP port configured on the server line neither server port |
| 5126 | directive, then the first step of the http-check sequence must be to specify |
| 5127 | the port with a "http-check connect". |
| 5128 | |
| 5129 | In an http-check ruleset a 'connect' is required, it is also mandatory to start |
| 5130 | the ruleset with a 'connect' rule. Purpose is to ensure admin know what they |
| 5131 | do. |
| 5132 | |
| 5133 | When a connect must start the ruleset, if may still be preceded by set-var, |
| 5134 | unset-var or comment rules. |
| 5135 | |
| 5136 | Examples : |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5137 | # check HTTP and HTTPs services on a server. |
| 5138 | # first open port 80 thanks to server line port directive, then |
| 5139 | # tcp-check opens port 443, ciphered and run a request on it: |
| 5140 | option httpchk |
| 5141 | |
| 5142 | http-check connect |
Christopher Faulet | a5c14ef | 2020-04-29 14:19:13 +0200 | [diff] [blame] | 5143 | http-check send meth GET uri / ver HTTP/1.1 hdr host haproxy.1wt.eu |
Christopher Faulet | 8021a5f | 2020-04-24 13:53:12 +0200 | [diff] [blame] | 5144 | http-check expect status 200-399 |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5145 | http-check connect port 443 ssl sni haproxy.1wt.eu |
Christopher Faulet | a5c14ef | 2020-04-29 14:19:13 +0200 | [diff] [blame] | 5146 | http-check send meth GET uri / ver HTTP/1.1 hdr host haproxy.1wt.eu |
Christopher Faulet | 8021a5f | 2020-04-24 13:53:12 +0200 | [diff] [blame] | 5147 | http-check expect status 200-399 |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5148 | |
| 5149 | server www 10.0.0.1 check port 80 |
| 5150 | |
| 5151 | See also : "option httpchk", "http-check send", "http-check expect" |
Christopher Faulet | 6d0c3df | 2020-01-22 09:26:35 +0100 | [diff] [blame] | 5152 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5153 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 5154 | http-check disable-on-404 |
| 5155 | Enable a maintenance mode upon HTTP/404 response to health-checks |
| 5156 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 5157 | yes | no | yes | yes |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 5158 | Arguments : none |
| 5159 | |
| 5160 | When this option is set, a server which returns an HTTP code 404 will be |
| 5161 | excluded from further load-balancing, but will still receive persistent |
| 5162 | connections. This provides a very convenient method for Web administrators |
| 5163 | to perform a graceful shutdown of their servers. It is also important to note |
| 5164 | that a server which is detected as failed while it was in this mode will not |
| 5165 | generate an alert, just a notice. If the server responds 2xx or 3xx again, it |
| 5166 | will immediately be reinserted into the farm. The status on the stats page |
| 5167 | reports "NOLB" for a server in this mode. It is important to note that this |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5168 | option only works in conjunction with the "httpchk" option. If this option |
| 5169 | is used with "http-check expect", then it has precedence over it so that 404 |
Christopher Faulet | fa8b89a | 2020-11-20 18:54:13 +0100 | [diff] [blame] | 5170 | responses will still be considered as soft-stop. Note also that a stopped |
| 5171 | server will stay stopped even if it replies 404s. This option is only |
| 5172 | evaluated for running servers. |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5173 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5174 | See also : "option httpchk" and "http-check expect". |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5175 | |
| 5176 | |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 5177 | http-check expect [min-recv <int>] [comment <msg>] |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5178 | [ok-status <st>] [error-status <st>] [tout-status <st>] |
| 5179 | [on-success <fmt>] [on-error <fmt>] [status-code <expr>] |
| 5180 | [!] <match> <pattern> |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 5181 | Make HTTP health checks consider response contents or specific status codes |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5182 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | 1ee51a6 | 2011-08-19 20:04:17 +0200 | [diff] [blame] | 5183 | yes | no | yes | yes |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5184 | |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5185 | Arguments : |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 5186 | comment <msg> defines a message to report if the rule evaluation fails. |
| 5187 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5188 | min-recv is optional and can define the minimum amount of data required to |
| 5189 | evaluate the current expect rule. If the number of received bytes |
| 5190 | is under this limit, the check will wait for more data. This |
| 5191 | option can be used to resolve some ambiguous matching rules or to |
| 5192 | avoid executing costly regex matches on content known to be still |
| 5193 | incomplete. If an exact string is used, the minimum between the |
| 5194 | string length and this parameter is used. This parameter is |
| 5195 | ignored if it is set to -1. If the expect rule does not match, |
| 5196 | the check will wait for more data. If set to 0, the evaluation |
| 5197 | result is always conclusive. |
| 5198 | |
| 5199 | ok-status <st> is optional and can be used to set the check status if |
| 5200 | the expect rule is successfully evaluated and if it is |
| 5201 | the last rule in the tcp-check ruleset. "L7OK", "L7OKC", |
Christopher Faulet | d888f0f | 2020-05-07 07:40:17 +0200 | [diff] [blame] | 5202 | "L6OK" and "L4OK" are supported : |
| 5203 | - L7OK : check passed on layer 7 |
Christopher Faulet | 83662b5 | 2020-11-20 17:47:47 +0100 | [diff] [blame] | 5204 | - L7OKC : check conditionally passed on layer 7, set |
| 5205 | server to NOLB state. |
Christopher Faulet | d888f0f | 2020-05-07 07:40:17 +0200 | [diff] [blame] | 5206 | - L6OK : check passed on layer 6 |
| 5207 | - L4OK : check passed on layer 4 |
| 5208 | By default "L7OK" is used. |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5209 | |
| 5210 | error-status <st> is optional and can be used to set the check status if |
| 5211 | an error occurred during the expect rule evaluation. |
Christopher Faulet | 83662b5 | 2020-11-20 17:47:47 +0100 | [diff] [blame] | 5212 | "L7OKC", "L7RSP", "L7STS", "L6RSP" and "L4CON" are |
| 5213 | supported : |
| 5214 | - L7OKC : check conditionally passed on layer 7, set |
| 5215 | server to NOLB state. |
Christopher Faulet | d888f0f | 2020-05-07 07:40:17 +0200 | [diff] [blame] | 5216 | - L7RSP : layer 7 invalid response - protocol error |
| 5217 | - L7STS : layer 7 response error, for example HTTP 5xx |
| 5218 | - L6RSP : layer 6 invalid response - protocol error |
| 5219 | - L4CON : layer 1-4 connection problem |
| 5220 | By default "L7RSP" is used. |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5221 | |
| 5222 | tout-status <st> is optional and can be used to set the check status if |
| 5223 | a timeout occurred during the expect rule evaluation. |
Christopher Faulet | d888f0f | 2020-05-07 07:40:17 +0200 | [diff] [blame] | 5224 | "L7TOUT", "L6TOUT", and "L4TOUT" are supported : |
| 5225 | - L7TOUT : layer 7 (HTTP/SMTP) timeout |
| 5226 | - L6TOUT : layer 6 (SSL) timeout |
| 5227 | - L4TOUT : layer 1-4 timeout |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5228 | By default "L7TOUT" is used. |
| 5229 | |
| 5230 | on-success <fmt> is optional and can be used to customize the |
| 5231 | informational message reported in logs if the expect |
| 5232 | rule is successfully evaluated and if it is the last rule |
| 5233 | in the tcp-check ruleset. <fmt> is a log-format string. |
| 5234 | |
| 5235 | on-error <fmt> is optional and can be used to customize the |
| 5236 | informational message reported in logs if an error |
| 5237 | occurred during the expect rule evaluation. <fmt> is a |
| 5238 | log-format string. |
| 5239 | |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5240 | <match> is a keyword indicating how to look for a specific pattern in the |
Christopher Faulet | b559426 | 2020-05-05 20:23:13 +0200 | [diff] [blame] | 5241 | response. The keyword may be one of "status", "rstatus", "hdr", |
| 5242 | "fhdr", "string", or "rstring". The keyword may be preceded by an |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5243 | exclamation mark ("!") to negate the match. Spaces are allowed |
| 5244 | between the exclamation mark and the keyword. See below for more |
| 5245 | details on the supported keywords. |
| 5246 | |
Christopher Faulet | 3970819 | 2020-05-05 10:47:36 +0200 | [diff] [blame] | 5247 | <pattern> is the pattern to look for. It may be a string, a regular |
| 5248 | expression or a more complex pattern with several arguments. If |
| 5249 | the string pattern contains spaces, they must be escaped with the |
| 5250 | usual backslash ('\'). |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5251 | |
| 5252 | By default, "option httpchk" considers that response statuses 2xx and 3xx |
| 5253 | are valid, and that others are invalid. When "http-check expect" is used, |
| 5254 | it defines what is considered valid or invalid. Only one "http-check" |
| 5255 | statement is supported in a backend. If a server fails to respond or times |
| 5256 | out, the check obviously fails. The available matches are : |
| 5257 | |
Christopher Faulet | 8021a5f | 2020-04-24 13:53:12 +0200 | [diff] [blame] | 5258 | status <codes> : test the status codes found parsing <codes> string. it |
| 5259 | must be a comma-separated list of status codes or range |
| 5260 | codes. A health check response will be considered as |
| 5261 | valid if the response's status code matches any status |
| 5262 | code or is inside any range of the list. If the "status" |
| 5263 | keyword is prefixed with "!", then the response will be |
| 5264 | considered invalid if the status code matches. |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5265 | |
| 5266 | rstatus <regex> : test a regular expression for the HTTP status code. |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 5267 | A health check response will be considered valid if the |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5268 | response's status code matches the expression. If the |
| 5269 | "rstatus" keyword is prefixed with "!", then the response |
| 5270 | will be considered invalid if the status code matches. |
| 5271 | This is mostly used to check for multiple codes. |
| 5272 | |
Christopher Faulet | b559426 | 2020-05-05 20:23:13 +0200 | [diff] [blame] | 5273 | hdr { name | name-lf } [ -m <meth> ] <name> |
| 5274 | [ { value | value-lf } [ -m <meth> ] <value> : |
Christopher Faulet | 3970819 | 2020-05-05 10:47:36 +0200 | [diff] [blame] | 5275 | test the specified header pattern on the HTTP response |
| 5276 | headers. The name pattern is mandatory but the value |
| 5277 | pattern is optional. If not specified, only the header |
| 5278 | presence is verified. <meth> is the matching method, |
| 5279 | applied on the header name or the header value. Supported |
| 5280 | matching methods are "str" (exact match), "beg" (prefix |
| 5281 | match), "end" (suffix match), "sub" (substring match) or |
| 5282 | "reg" (regex match). If not specified, exact matching |
Christopher Faulet | b559426 | 2020-05-05 20:23:13 +0200 | [diff] [blame] | 5283 | method is used. If the "name-lf" parameter is used, |
| 5284 | <name> is evaluated as a log-format string. If "value-lf" |
| 5285 | parameter is used, <value> is evaluated as a log-format |
| 5286 | string. These parameters cannot be used with the regex |
| 5287 | matching method. Finally, the header value is considered |
| 5288 | as comma-separated list. Note that matchings are case |
| 5289 | insensitive on the header names. |
| 5290 | |
| 5291 | fhdr { name | name-lf } [ -m <meth> ] <name> |
| 5292 | [ { value | value-lf } [ -m <meth> ] <value> : |
| 5293 | test the specified full header pattern on the HTTP |
| 5294 | response headers. It does exactly the same than "hdr" |
| 5295 | keyword, except the full header value is tested, commas |
| 5296 | are not considered as delimiters. |
Christopher Faulet | 3970819 | 2020-05-05 10:47:36 +0200 | [diff] [blame] | 5297 | |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5298 | string <string> : test the exact string match in the HTTP response body. |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 5299 | A health check response will be considered valid if the |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5300 | response's body contains this exact string. If the |
| 5301 | "string" keyword is prefixed with "!", then the response |
| 5302 | will be considered invalid if the body contains this |
| 5303 | string. This can be used to look for a mandatory word at |
| 5304 | the end of a dynamic page, or to detect a failure when a |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 5305 | specific error appears on the check page (e.g. a stack |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5306 | trace). |
| 5307 | |
| 5308 | rstring <regex> : test a regular expression on the HTTP response body. |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 5309 | A health check response will be considered valid if the |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5310 | response's body matches this expression. If the "rstring" |
| 5311 | keyword is prefixed with "!", then the response will be |
| 5312 | considered invalid if the body matches the expression. |
| 5313 | This can be used to look for a mandatory word at the end |
| 5314 | of a dynamic page, or to detect a failure when a specific |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 5315 | error appears on the check page (e.g. a stack trace). |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5316 | |
Christopher Faulet | aaab083 | 2020-05-05 15:54:22 +0200 | [diff] [blame] | 5317 | string-lf <fmt> : test a log-format string match in the HTTP response body. |
| 5318 | A health check response will be considered valid if the |
| 5319 | response's body contains the string resulting of the |
| 5320 | evaluation of <fmt>, which follows the log-format rules. |
| 5321 | If prefixed with "!", then the response will be |
| 5322 | considered invalid if the body contains the string. |
| 5323 | |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5324 | It is important to note that the responses will be limited to a certain size |
Christopher Faulet | bb9fb8b | 2020-11-25 17:20:57 +0100 | [diff] [blame] | 5325 | defined by the global "tune.bufsize" option, which defaults to 16384 bytes. |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5326 | Thus, too large responses may not contain the mandatory pattern when using |
| 5327 | "string" or "rstring". If a large response is absolutely required, it is |
| 5328 | possible to change the default max size by setting the global variable. |
| 5329 | However, it is worth keeping in mind that parsing very large responses can |
| 5330 | waste some CPU cycles, especially when regular expressions are used, and that |
| 5331 | it is always better to focus the checks on smaller resources. |
| 5332 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5333 | In an http-check ruleset, the last expect rule may be implicit. If no expect |
| 5334 | rule is specified after the last "http-check send", an implicit expect rule |
| 5335 | is defined to match on 2xx or 3xx status codes. It means this rule is also |
| 5336 | defined if there is no "http-check" rule at all, when only "option httpchk" |
| 5337 | is set. |
Cyril Bonté | 32602d2 | 2015-01-30 00:07:07 +0100 | [diff] [blame] | 5338 | |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5339 | Last, if "http-check expect" is combined with "http-check disable-on-404", |
| 5340 | then this last one has precedence when the server responds with 404. |
| 5341 | |
| 5342 | Examples : |
| 5343 | # only accept status 200 as valid |
Christopher Faulet | 8021a5f | 2020-04-24 13:53:12 +0200 | [diff] [blame] | 5344 | http-check expect status 200,201,300-310 |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5345 | |
Christopher Faulet | 3970819 | 2020-05-05 10:47:36 +0200 | [diff] [blame] | 5346 | # be sure a sessid coookie is set |
| 5347 | http-check expect header name "set-cookie" value -m beg "sessid=" |
| 5348 | |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5349 | # consider SQL errors as errors |
Willy Tarreau | 8f2a1e7 | 2011-01-06 16:36:10 +0100 | [diff] [blame] | 5350 | http-check expect ! string SQL\ Error |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5351 | |
| 5352 | # consider status 5xx only as errors |
Willy Tarreau | 8f2a1e7 | 2011-01-06 16:36:10 +0100 | [diff] [blame] | 5353 | http-check expect ! rstatus ^5 |
Willy Tarreau | bd74154 | 2010-03-16 18:46:54 +0100 | [diff] [blame] | 5354 | |
| 5355 | # check that we have a correct hexadecimal tag before /html |
Jarno Huuskonen | e5ae702 | 2017-04-03 14:36:21 +0300 | [diff] [blame] | 5356 | http-check expect rstring <!--tag:[0-9a-f]*--></html> |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 5357 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5358 | See also : "option httpchk", "http-check connect", "http-check disable-on-404" |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5359 | and "http-check send". |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 5360 | |
| 5361 | |
Christopher Faulet | 7c95f5f | 2020-05-06 15:06:34 +0200 | [diff] [blame] | 5362 | http-check send [meth <method>] [{ uri <uri> | uri-lf <fmt> }>] [ver <version>] |
Christopher Faulet | 574e7bd | 2020-05-06 15:38:58 +0200 | [diff] [blame] | 5363 | [hdr <name> <fmt>]* [{ body <string> | body-lf <fmt> }] |
| 5364 | [comment <msg>] |
Christopher Faulet | 8acb128 | 2020-04-09 08:44:06 +0200 | [diff] [blame] | 5365 | Add a possible list of headers and/or a body to the request sent during HTTP |
| 5366 | health checks. |
| 5367 | May be used in sections : defaults | frontend | listen | backend |
| 5368 | yes | no | yes | yes |
| 5369 | Arguments : |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 5370 | comment <msg> defines a message to report if the rule evaluation fails. |
| 5371 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5372 | meth <method> is the optional HTTP method used with the requests. When not |
| 5373 | set, the "OPTIONS" method is used, as it generally requires |
| 5374 | low server processing and is easy to filter out from the |
| 5375 | logs. Any method may be used, though it is not recommended |
| 5376 | to invent non-standard ones. |
| 5377 | |
Christopher Faulet | 7c95f5f | 2020-05-06 15:06:34 +0200 | [diff] [blame] | 5378 | uri <uri> is optional and set the URI referenced in the HTTP requests |
| 5379 | to the string <uri>. It defaults to "/" which is accessible |
| 5380 | by default on almost any server, but may be changed to any |
| 5381 | other URI. Query strings are permitted. |
| 5382 | |
| 5383 | uri-lf <fmt> is optional and set the URI referenced in the HTTP requests |
| 5384 | using the log-format string <fmt>. It defaults to "/" which |
| 5385 | is accessible by default on almost any server, but may be |
| 5386 | changed to any other URI. Query strings are permitted. |
Christopher Faulet | 8acb128 | 2020-04-09 08:44:06 +0200 | [diff] [blame] | 5387 | |
Christopher Faulet | 907701b | 2020-04-28 09:37:00 +0200 | [diff] [blame] | 5388 | ver <version> is the optional HTTP version string. It defaults to |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5389 | "HTTP/1.0" but some servers might behave incorrectly in HTTP |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 5390 | 1.0, so turning it to HTTP/1.1 may sometimes help. Note that |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5391 | the Host field is mandatory in HTTP/1.1, use "hdr" argument |
| 5392 | to add it. |
| 5393 | |
| 5394 | hdr <name> <fmt> adds the HTTP header field whose name is specified in |
| 5395 | <name> and whose value is defined by <fmt>, which follows |
| 5396 | to the log-format rules. |
| 5397 | |
| 5398 | body <string> add the body defined by <string> to the request sent during |
| 5399 | HTTP health checks. If defined, the "Content-Length" header |
| 5400 | is thus automatically added to the request. |
Christopher Faulet | 8acb128 | 2020-04-09 08:44:06 +0200 | [diff] [blame] | 5401 | |
Christopher Faulet | 574e7bd | 2020-05-06 15:38:58 +0200 | [diff] [blame] | 5402 | body-lf <fmt> add the body defined by the log-format string <fmt> to the |
| 5403 | request sent during HTTP health checks. If defined, the |
| 5404 | "Content-Length" header is thus automatically added to the |
| 5405 | request. |
| 5406 | |
Christopher Faulet | 8acb128 | 2020-04-09 08:44:06 +0200 | [diff] [blame] | 5407 | In addition to the request line defined by the "option httpchk" directive, |
| 5408 | this one is the valid way to add some headers and optionally a body to the |
| 5409 | request sent during HTTP health checks. If a body is defined, the associate |
Christopher Faulet | 9df910c | 2020-04-29 14:20:47 +0200 | [diff] [blame] | 5410 | "Content-Length" header is automatically added. Thus, this header or |
| 5411 | "Transfer-encoding" header should not be present in the request provided by |
| 5412 | "http-check send". If so, it will be ignored. The old trick consisting to add |
| 5413 | headers after the version string on the "option httpchk" line is now |
Amaury Denoyelle | 6d975f0 | 2020-12-22 14:08:52 +0100 | [diff] [blame] | 5414 | deprecated. |
Christopher Faulet | 8acb128 | 2020-04-09 08:44:06 +0200 | [diff] [blame] | 5415 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5416 | Also "http-check send" doesn't support HTTP keep-alive. Keep in mind that it |
Amaury Denoyelle | 6d975f0 | 2020-12-22 14:08:52 +0100 | [diff] [blame] | 5417 | will automatically append a "Connection: close" header, unless a Connection |
| 5418 | header has already already been configured via a hdr entry. |
Christopher Faulet | 9df910c | 2020-04-29 14:20:47 +0200 | [diff] [blame] | 5419 | |
| 5420 | Note that the Host header and the request authority, when both defined, are |
| 5421 | automatically synchronized. It means when the HTTP request is sent, when a |
| 5422 | Host is inserted in the request, the request authority is accordingly |
| 5423 | updated. Thus, don't be surprised if the Host header value overwrites the |
| 5424 | configured request authority. |
| 5425 | |
| 5426 | Note also for now, no Host header is automatically added in HTTP/1.1 or above |
| 5427 | requests. You should add it explicitly. |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5428 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5429 | See also : "option httpchk", "http-check send-state" and "http-check expect". |
Christopher Faulet | 8acb128 | 2020-04-09 08:44:06 +0200 | [diff] [blame] | 5430 | |
| 5431 | |
Willy Tarreau | ef78104 | 2010-01-27 11:53:01 +0100 | [diff] [blame] | 5432 | http-check send-state |
| 5433 | Enable emission of a state header with HTTP health checks |
| 5434 | May be used in sections : defaults | frontend | listen | backend |
| 5435 | yes | no | yes | yes |
| 5436 | Arguments : none |
| 5437 | |
| 5438 | When this option is set, haproxy will systematically send a special header |
| 5439 | "X-Haproxy-Server-State" with a list of parameters indicating to each server |
| 5440 | how they are seen by haproxy. This can be used for instance when a server is |
| 5441 | manipulated without access to haproxy and the operator needs to know whether |
| 5442 | haproxy still sees it up or not, or if the server is the last one in a farm. |
| 5443 | |
| 5444 | The header is composed of fields delimited by semi-colons, the first of which |
| 5445 | is a word ("UP", "DOWN", "NOLB"), possibly followed by a number of valid |
| 5446 | checks on the total number before transition, just as appears in the stats |
| 5447 | interface. Next headers are in the form "<variable>=<value>", indicating in |
| 5448 | no specific order some values available in the stats interface : |
Joseph Lynch | 514061c | 2015-01-15 17:52:59 -0800 | [diff] [blame] | 5449 | - a variable "address", containing the address of the backend server. |
| 5450 | This corresponds to the <address> field in the server declaration. For |
| 5451 | unix domain sockets, it will read "unix". |
| 5452 | |
| 5453 | - a variable "port", containing the port of the backend server. This |
| 5454 | corresponds to the <port> field in the server declaration. For unix |
| 5455 | domain sockets, it will read "unix". |
| 5456 | |
Willy Tarreau | ef78104 | 2010-01-27 11:53:01 +0100 | [diff] [blame] | 5457 | - a variable "name", containing the name of the backend followed by a slash |
| 5458 | ("/") then the name of the server. This can be used when a server is |
| 5459 | checked in multiple backends. |
| 5460 | |
| 5461 | - a variable "node" containing the name of the haproxy node, as set in the |
| 5462 | global "node" variable, otherwise the system's hostname if unspecified. |
| 5463 | |
| 5464 | - a variable "weight" indicating the weight of the server, a slash ("/") |
| 5465 | and the total weight of the farm (just counting usable servers). This |
| 5466 | helps to know if other servers are available to handle the load when this |
| 5467 | one fails. |
| 5468 | |
| 5469 | - a variable "scur" indicating the current number of concurrent connections |
| 5470 | on the server, followed by a slash ("/") then the total number of |
| 5471 | connections on all servers of the same backend. |
| 5472 | |
| 5473 | - a variable "qcur" indicating the current number of requests in the |
| 5474 | server's queue. |
| 5475 | |
| 5476 | Example of a header received by the application server : |
| 5477 | >>> X-Haproxy-Server-State: UP 2/3; name=bck/srv2; node=lb1; weight=1/2; \ |
| 5478 | scur=13/22; qcur=0 |
| 5479 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5480 | See also : "option httpchk", "http-check disable-on-404" and |
| 5481 | "http-check send". |
Willy Tarreau | ef78104 | 2010-01-27 11:53:01 +0100 | [diff] [blame] | 5482 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5483 | |
| 5484 | http-check set-var(<var-name>) <expr> |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5485 | This operation sets the content of a variable. The variable is declared inline. |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5486 | May be used in sections: defaults | frontend | listen | backend |
| 5487 | yes | no | yes | yes |
| 5488 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5489 | Arguments : |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5490 | <var-name> The name of the variable starts with an indication about its |
| 5491 | scope. The scopes allowed for http-check are: |
| 5492 | "proc" : the variable is shared with the whole process. |
| 5493 | "sess" : the variable is shared with the tcp-check session. |
| 5494 | "check": the variable is declared for the lifetime of the tcp-check. |
| 5495 | This prefix is followed by a name. The separator is a '.'. |
| 5496 | The name may only contain characters 'a-z', 'A-Z', '0-9', '.', |
| 5497 | and '-'. |
| 5498 | |
| 5499 | <expr> Is a sample-fetch expression potentially followed by converters. |
| 5500 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5501 | Examples : |
| 5502 | http-check set-var(check.port) int(1234) |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5503 | |
| 5504 | |
| 5505 | http-check unset-var(<var-name>) |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5506 | Free a reference to a variable within its scope. |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5507 | May be used in sections: defaults | frontend | listen | backend |
| 5508 | yes | no | yes | yes |
| 5509 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5510 | Arguments : |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5511 | <var-name> The name of the variable starts with an indication about its |
| 5512 | scope. The scopes allowed for http-check are: |
| 5513 | "proc" : the variable is shared with the whole process. |
| 5514 | "sess" : the variable is shared with the tcp-check session. |
| 5515 | "check": the variable is declared for the lifetime of the tcp-check. |
| 5516 | This prefix is followed by a name. The separator is a '.'. |
| 5517 | The name may only contain characters 'a-z', 'A-Z', '0-9', '.', |
| 5518 | and '-'. |
| 5519 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 5520 | Examples : |
| 5521 | http-check unset-var(check.port) |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 5522 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5523 | |
Christopher Faulet | 3b967c1 | 2020-05-15 15:47:44 +0200 | [diff] [blame] | 5524 | http-error status <code> [content-type <type>] |
| 5525 | [ { default-errorfiles | errorfile <file> | errorfiles <name> | |
| 5526 | file <file> | lf-file <file> | string <str> | lf-string <fmt> } ] |
| 5527 | [ hdr <name> <fmt> ]* |
| 5528 | Defines a custom error message to use instead of errors generated by HAProxy. |
| 5529 | May be used in sections : defaults | frontend | listen | backend |
| 5530 | yes | yes | yes | yes |
| 5531 | Arguments : |
Ilya Shipitsin | 11057a3 | 2020-06-21 21:18:27 +0500 | [diff] [blame] | 5532 | status <code> is the HTTP status code. It must be specified. |
Christopher Faulet | 3b967c1 | 2020-05-15 15:47:44 +0200 | [diff] [blame] | 5533 | Currently, HAProxy is capable of generating codes |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 5534 | 200, 400, 401, 403, 404, 405, 407, 408, 410, 413, 425, |
| 5535 | 429, 500, 502, 503, and 504. |
Christopher Faulet | 3b967c1 | 2020-05-15 15:47:44 +0200 | [diff] [blame] | 5536 | |
| 5537 | content-type <type> is the response content type, for instance |
| 5538 | "text/plain". This parameter is ignored and should be |
| 5539 | omitted when an errorfile is configured or when the |
| 5540 | payload is empty. Otherwise, it must be defined. |
| 5541 | |
| 5542 | default-errorfiles Reset the previously defined error message for current |
| 5543 | proxy for the status <code>. If used on a backend, the |
| 5544 | frontend error message is used, if defined. If used on |
| 5545 | a frontend, the default error message is used. |
| 5546 | |
| 5547 | errorfile <file> designates a file containing the full HTTP response. |
| 5548 | It is recommended to follow the common practice of |
| 5549 | appending ".http" to the filename so that people do |
| 5550 | not confuse the response with HTML error pages, and to |
| 5551 | use absolute paths, since files are read before any |
| 5552 | chroot is performed. |
| 5553 | |
| 5554 | errorfiles <name> designates the http-errors section to use to import |
| 5555 | the error message with the status code <code>. If no |
| 5556 | such message is found, the proxy's error messages are |
| 5557 | considered. |
| 5558 | |
| 5559 | file <file> specifies the file to use as response payload. If the |
| 5560 | file is not empty, its content-type must be set as |
| 5561 | argument to "content-type", otherwise, any |
| 5562 | "content-type" argument is ignored. <file> is |
| 5563 | considered as a raw string. |
| 5564 | |
| 5565 | string <str> specifies the raw string to use as response payload. |
| 5566 | The content-type must always be set as argument to |
| 5567 | "content-type". |
| 5568 | |
| 5569 | lf-file <file> specifies the file to use as response payload. If the |
| 5570 | file is not empty, its content-type must be set as |
| 5571 | argument to "content-type", otherwise, any |
| 5572 | "content-type" argument is ignored. <file> is |
| 5573 | evaluated as a log-format string. |
| 5574 | |
| 5575 | lf-string <str> specifies the log-format string to use as response |
| 5576 | payload. The content-type must always be set as |
| 5577 | argument to "content-type". |
| 5578 | |
| 5579 | hdr <name> <fmt> adds to the response the HTTP header field whose name |
| 5580 | is specified in <name> and whose value is defined by |
| 5581 | <fmt>, which follows to the log-format rules. |
| 5582 | This parameter is ignored if an errorfile is used. |
| 5583 | |
| 5584 | This directive may be used instead of "errorfile", to define a custom error |
| 5585 | message. As "errorfile" directive, it is used for errors detected and |
| 5586 | returned by HAProxy. If an errorfile is defined, it is parsed when HAProxy |
| 5587 | starts and must be valid according to the HTTP standards. The generated |
| 5588 | response must not exceed the configured buffer size (BUFFSIZE), otherwise an |
| 5589 | internal error will be returned. Finally, if you consider to use some |
| 5590 | http-after-response rules to rewrite these errors, the reserved buffer space |
| 5591 | should be available (see "tune.maxrewrite"). |
| 5592 | |
| 5593 | The files are read at the same time as the configuration and kept in memory. |
| 5594 | For this reason, the errors continue to be returned even when the process is |
| 5595 | chrooted, and no file change is considered while the process is running. |
| 5596 | |
Christopher Faulet | d5ac6de | 2020-12-02 08:40:14 +0100 | [diff] [blame] | 5597 | Note: 400/408/500 errors emitted in early stage of the request parsing are |
| 5598 | handled by the multiplexer at a lower level. No custom formatting is |
| 5599 | supported at this level. Thus only static error messages, defined with |
| 5600 | "errorfile" directive, are supported. However, this limitation only |
| 5601 | exists during the request headers parsing or between two transactions. |
| 5602 | |
Christopher Faulet | 3b967c1 | 2020-05-15 15:47:44 +0200 | [diff] [blame] | 5603 | See also : "errorfile", "errorfiles", "errorloc", "errorloc302", |
| 5604 | "errorloc303" and section 3.8 about http-errors. |
| 5605 | |
| 5606 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5607 | http-request <action> [options...] [ { if | unless } <condition> ] |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 5608 | Access control for Layer 7 requests |
| 5609 | |
| 5610 | May be used in sections: defaults | frontend | listen | backend |
| 5611 | no | yes | yes | yes |
| 5612 | |
Willy Tarreau | 20b0de5 | 2012-12-24 15:45:22 +0100 | [diff] [blame] | 5613 | The http-request statement defines a set of rules which apply to layer 7 |
| 5614 | processing. The rules are evaluated in their declaration order when they are |
| 5615 | met in a frontend, listen or backend section. Any rule may optionally be |
| 5616 | followed by an ACL-based condition, in which case it will only be evaluated |
| 5617 | if the condition is true. |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 5618 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5619 | The first keyword is the rule's action. The supported actions are described |
| 5620 | below. |
Willy Tarreau | 20b0de5 | 2012-12-24 15:45:22 +0100 | [diff] [blame] | 5621 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5622 | There is no limit to the number of http-request statements per instance. |
Willy Tarreau | 20b0de5 | 2012-12-24 15:45:22 +0100 | [diff] [blame] | 5623 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5624 | Example: |
| 5625 | acl nagios src 192.168.129.3 |
| 5626 | acl local_net src 192.168.0.0/16 |
| 5627 | acl auth_ok http_auth(L1) |
Willy Tarreau | 20b0de5 | 2012-12-24 15:45:22 +0100 | [diff] [blame] | 5628 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5629 | http-request allow if nagios |
| 5630 | http-request allow if local_net auth_ok |
| 5631 | http-request auth realm Gimme if local_net auth_ok |
| 5632 | http-request deny |
Willy Tarreau | 81499eb | 2012-12-27 12:19:02 +0100 | [diff] [blame] | 5633 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5634 | Example: |
| 5635 | acl key req.hdr(X-Add-Acl-Key) -m found |
| 5636 | acl add path /addacl |
| 5637 | acl del path /delacl |
Willy Tarreau | 20b0de5 | 2012-12-24 15:45:22 +0100 | [diff] [blame] | 5638 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5639 | acl myhost hdr(Host) -f myhost.lst |
Willy Tarreau | 20b0de5 | 2012-12-24 15:45:22 +0100 | [diff] [blame] | 5640 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5641 | http-request add-acl(myhost.lst) %[req.hdr(X-Add-Acl-Key)] if key add |
| 5642 | http-request del-acl(myhost.lst) %[req.hdr(X-Add-Acl-Key)] if key del |
Thierry FOURNIER | dad3d1d | 2014-04-22 18:07:25 +0200 | [diff] [blame] | 5643 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5644 | Example: |
| 5645 | acl value req.hdr(X-Value) -m found |
| 5646 | acl setmap path /setmap |
| 5647 | acl delmap path /delmap |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5648 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5649 | use_backend bk_appli if { hdr(Host),map_str(map.lst) -m found } |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5650 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5651 | http-request set-map(map.lst) %[src] %[req.hdr(X-Value)] if setmap value |
| 5652 | http-request del-map(map.lst) %[src] if delmap |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5653 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5654 | See also : "stats http-request", section 3.4 about userlists and section 7 |
| 5655 | about ACL usage. |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5656 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5657 | http-request add-acl(<file-name>) <key fmt> [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5658 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5659 | This is used to add a new entry into an ACL. The ACL must be loaded from a |
| 5660 | file (even a dummy empty file). The file name of the ACL to be updated is |
| 5661 | passed between parentheses. It takes one argument: <key fmt>, which follows |
| 5662 | log-format rules, to collect content of the new entry. It performs a lookup |
| 5663 | in the ACL before insertion, to avoid duplicated (or more) values. This |
| 5664 | lookup is done by a linear search and can be expensive with large lists! |
| 5665 | It is the equivalent of the "add acl" command from the stats socket, but can |
| 5666 | be triggered by an HTTP request. |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5667 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5668 | http-request add-header <name> <fmt> [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5669 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5670 | This appends an HTTP header field whose name is specified in <name> and |
| 5671 | whose value is defined by <fmt> which follows the log-format rules (see |
| 5672 | Custom Log Format in section 8.2.4). This is particularly useful to pass |
| 5673 | connection-specific information to the server (e.g. the client's SSL |
| 5674 | certificate), or to combine several headers into one. This rule is not |
| 5675 | final, so it is possible to add other similar rules. Note that header |
| 5676 | addition is performed immediately, so one rule might reuse the resulting |
| 5677 | header from a previous rule. |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5678 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5679 | http-request allow [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5680 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5681 | This stops the evaluation of the rules and lets the request pass the check. |
| 5682 | No further "http-request" rules are evaluated. |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5683 | |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5684 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5685 | http-request auth [realm <realm>] [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5686 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5687 | This stops the evaluation of the rules and immediately responds with an |
| 5688 | HTTP 401 or 407 error code to invite the user to present a valid user name |
| 5689 | and password. No further "http-request" rules are evaluated. An optional |
| 5690 | "realm" parameter is supported, it sets the authentication realm that is |
| 5691 | returned with the response (typically the application's name). |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5692 | |
Christopher Faulet | 612f2ea | 2020-05-27 09:57:28 +0200 | [diff] [blame] | 5693 | The corresponding proxy's error message is used. It may be customized using |
| 5694 | an "errorfile" or an "http-error" directive. For 401 responses, all |
| 5695 | occurrences of the WWW-Authenticate header are removed and replaced by a new |
| 5696 | one with a basic authentication challenge for realm "<realm>". For 407 |
| 5697 | responses, the same is done on the Proxy-Authenticate header. If the error |
| 5698 | message must not be altered, consider to use "http-request return" rule |
| 5699 | instead. |
| 5700 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5701 | Example: |
| 5702 | acl auth_ok http_auth_group(L1) G1 |
| 5703 | http-request auth unless auth_ok |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5704 | |
Jarno Huuskonen | 251a6b7 | 2019-01-04 14:05:02 +0200 | [diff] [blame] | 5705 | http-request cache-use <name> [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 5706 | |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 5707 | See section 6.2 about cache setup. |
Willy Tarreau | a0dc23f | 2015-01-22 20:46:11 +0100 | [diff] [blame] | 5708 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5709 | http-request capture <sample> [ len <length> | id <id> ] |
| 5710 | [ { if | unless } <condition> ] |
Willy Tarreau | a0dc23f | 2015-01-22 20:46:11 +0100 | [diff] [blame] | 5711 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5712 | This captures sample expression <sample> from the request buffer, and |
| 5713 | converts it to a string of at most <len> characters. The resulting string is |
| 5714 | stored into the next request "capture" slot, so it will possibly appear next |
| 5715 | to some captured HTTP headers. It will then automatically appear in the logs, |
| 5716 | and it will be possible to extract it using sample fetch rules to feed it |
| 5717 | into headers or anything. The length should be limited given that this size |
| 5718 | will be allocated for each capture during the whole session life. |
| 5719 | Please check section 7.3 (Fetching samples) and "capture request header" for |
| 5720 | more information. |
Willy Tarreau | a0dc23f | 2015-01-22 20:46:11 +0100 | [diff] [blame] | 5721 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5722 | If the keyword "id" is used instead of "len", the action tries to store the |
| 5723 | captured string in a previously declared capture slot. This is useful to run |
| 5724 | captures in backends. The slot id can be declared by a previous directive |
Baptiste Assmann | 19a69b3 | 2020-01-16 14:34:22 +0100 | [diff] [blame] | 5725 | "http-request capture" or with the "declare capture" keyword. |
| 5726 | |
| 5727 | When using this action in a backend, double check that the relevant |
| 5728 | frontend(s) have the required capture slots otherwise, this rule will be |
| 5729 | ignored at run time. This can't be detected at configuration parsing time |
| 5730 | due to HAProxy's ability to dynamically resolve backend name at runtime. |
Willy Tarreau | a0dc23f | 2015-01-22 20:46:11 +0100 | [diff] [blame] | 5731 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5732 | http-request del-acl(<file-name>) <key fmt> [ { if | unless } <condition> ] |
Willy Tarreau | a0dc23f | 2015-01-22 20:46:11 +0100 | [diff] [blame] | 5733 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5734 | This is used to delete an entry from an ACL. The ACL must be loaded from a |
| 5735 | file (even a dummy empty file). The file name of the ACL to be updated is |
| 5736 | passed between parentheses. It takes one argument: <key fmt>, which follows |
| 5737 | log-format rules, to collect content of the entry to delete. |
| 5738 | It is the equivalent of the "del acl" command from the stats socket, but can |
| 5739 | be triggered by an HTTP request. |
Willy Tarreau | a0dc23f | 2015-01-22 20:46:11 +0100 | [diff] [blame] | 5740 | |
Maciej Zdeb | ebdd4c5 | 2020-11-20 13:58:48 +0000 | [diff] [blame] | 5741 | http-request del-header <name> [ -m <meth> ] [ { if | unless } <condition> ] |
Willy Tarreau | f4c43c1 | 2013-06-11 17:01:13 +0200 | [diff] [blame] | 5742 | |
Maciej Zdeb | ebdd4c5 | 2020-11-20 13:58:48 +0000 | [diff] [blame] | 5743 | This removes all HTTP header fields whose name is specified in <name>. <meth> |
| 5744 | is the matching method, applied on the header name. Supported matching methods |
| 5745 | are "str" (exact match), "beg" (prefix match), "end" (suffix match), "sub" |
| 5746 | (substring match) and "reg" (regex match). If not specified, exact matching |
| 5747 | method is used. |
Willy Tarreau | 9a355ec | 2013-06-11 17:45:46 +0200 | [diff] [blame] | 5748 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5749 | http-request del-map(<file-name>) <key fmt> [ { if | unless } <condition> ] |
Willy Tarreau | 42cf39e | 2013-06-11 18:51:32 +0200 | [diff] [blame] | 5750 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5751 | This is used to delete an entry from a MAP. The MAP must be loaded from a |
| 5752 | file (even a dummy empty file). The file name of the MAP to be updated is |
| 5753 | passed between parentheses. It takes one argument: <key fmt>, which follows |
| 5754 | log-format rules, to collect content of the entry to delete. |
| 5755 | It takes one argument: "file name" It is the equivalent of the "del map" |
| 5756 | command from the stats socket, but can be triggered by an HTTP request. |
Willy Tarreau | 51347ed | 2013-06-11 19:34:13 +0200 | [diff] [blame] | 5757 | |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 5758 | http-request deny [deny_status <status>] [ { if | unless } <condition> ] |
| 5759 | http-request deny [ { status | deny_status } <code>] [content-type <type>] |
| 5760 | [ { default-errorfiles | errorfile <file> | errorfiles <name> | |
| 5761 | file <file> | lf-file <file> | string <str> | lf-string <fmt> } ] |
| 5762 | [ hdr <name> <fmt> ]* |
| 5763 | [ { if | unless } <condition> ] |
Patrick Hemmer | 268a707 | 2018-05-11 12:52:31 -0400 | [diff] [blame] | 5764 | |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 5765 | This stops the evaluation of the rules and immediately rejects the request. |
| 5766 | By default an HTTP 403 error is returned. But the response may be customized |
| 5767 | using same syntax than "http-request return" rules. Thus, see "http-request |
Ilya Shipitsin | 11057a3 | 2020-06-21 21:18:27 +0500 | [diff] [blame] | 5768 | return" for details. For compatibility purpose, when no argument is defined, |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 5769 | or only "deny_status", the argument "default-errorfiles" is implied. It means |
| 5770 | "http-request deny [deny_status <status>]" is an alias of |
| 5771 | "http-request deny [status <status>] default-errorfiles". |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5772 | No further "http-request" rules are evaluated. |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 5773 | See also "http-request return". |
Patrick Hemmer | 268a707 | 2018-05-11 12:52:31 -0400 | [diff] [blame] | 5774 | |
Olivier Houchard | 602bf7d | 2019-05-10 13:59:15 +0200 | [diff] [blame] | 5775 | http-request disable-l7-retry [ { if | unless } <condition> ] |
| 5776 | This disables any attempt to retry the request if it fails for any other |
| 5777 | reason than a connection failure. This can be useful for example to make |
| 5778 | sure POST requests aren't retried on failure. |
| 5779 | |
Baptiste Assmann | 333939c | 2019-01-21 08:34:50 +0100 | [diff] [blame] | 5780 | http-request do-resolve(<var>,<resolvers>,[ipv4,ipv6]) <expr> : |
| 5781 | |
| 5782 | This action performs a DNS resolution of the output of <expr> and stores |
| 5783 | the result in the variable <var>. It uses the DNS resolvers section |
| 5784 | pointed by <resolvers>. |
| 5785 | It is possible to choose a resolution preference using the optional |
| 5786 | arguments 'ipv4' or 'ipv6'. |
| 5787 | When performing the DNS resolution, the client side connection is on |
| 5788 | pause waiting till the end of the resolution. |
| 5789 | If an IP address can be found, it is stored into <var>. If any kind of |
| 5790 | error occurs, then <var> is not set. |
| 5791 | One can use this action to discover a server IP address at run time and |
| 5792 | based on information found in the request (IE a Host header). |
| 5793 | If this action is used to find the server's IP address (using the |
| 5794 | "set-dst" action), then the server IP address in the backend must be set |
| 5795 | to 0.0.0.0. |
| 5796 | |
| 5797 | Example: |
| 5798 | resolvers mydns |
| 5799 | nameserver local 127.0.0.53:53 |
| 5800 | nameserver google 8.8.8.8:53 |
| 5801 | timeout retry 1s |
| 5802 | hold valid 10s |
| 5803 | hold nx 3s |
| 5804 | hold other 3s |
| 5805 | hold obsolete 0s |
| 5806 | accepted_payload_size 8192 |
| 5807 | |
| 5808 | frontend fe |
| 5809 | bind 10.42.0.1:80 |
| 5810 | http-request do-resolve(txn.myip,mydns,ipv4) hdr(Host),lower |
| 5811 | http-request capture var(txn.myip) len 40 |
| 5812 | |
| 5813 | # return 503 when the variable is not set, |
| 5814 | # which mean DNS resolution error |
| 5815 | use_backend b_503 unless { var(txn.myip) -m found } |
| 5816 | |
| 5817 | default_backend be |
| 5818 | |
| 5819 | backend b_503 |
| 5820 | # dummy backend used to return 503. |
| 5821 | # one can use the errorfile directive to send a nice |
| 5822 | # 503 error page to end users |
| 5823 | |
| 5824 | backend be |
| 5825 | # rule to prevent HAProxy from reconnecting to services |
| 5826 | # on the local network (forged DNS name used to scan the network) |
| 5827 | http-request deny if { var(txn.myip) -m ip 127.0.0.0/8 10.0.0.0/8 } |
| 5828 | http-request set-dst var(txn.myip) |
| 5829 | server clear 0.0.0.0:0 |
| 5830 | |
| 5831 | NOTE: Don't forget to set the "protection" rules to ensure HAProxy won't |
| 5832 | be used to scan the network or worst won't loop over itself... |
| 5833 | |
Frédéric Lécaille | 06f5b64 | 2018-11-12 11:01:10 +0100 | [diff] [blame] | 5834 | http-request early-hint <name> <fmt> [ { if | unless } <condition> ] |
| 5835 | |
| 5836 | This is used to build an HTTP 103 Early Hints response prior to any other one. |
| 5837 | This appends an HTTP header field to this response whose name is specified in |
| 5838 | <name> and whose value is defined by <fmt> which follows the log-format rules |
| 5839 | (see Custom Log Format in section 8.2.4). This is particularly useful to pass |
Frédéric Lécaille | 3aac106 | 2018-11-13 09:42:13 +0100 | [diff] [blame] | 5840 | to the client some Link headers to preload resources required to render the |
| 5841 | HTML documents. |
Frédéric Lécaille | 06f5b64 | 2018-11-12 11:01:10 +0100 | [diff] [blame] | 5842 | |
| 5843 | See RFC 8297 for more information. |
| 5844 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5845 | http-request redirect <rule> [ { if | unless } <condition> ] |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 5846 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5847 | This performs an HTTP redirection based on a redirect rule. This is exactly |
| 5848 | the same as the "redirect" statement except that it inserts a redirect rule |
| 5849 | which can be processed in the middle of other "http-request" rules and that |
| 5850 | these rules use the "log-format" strings. See the "redirect" keyword for the |
| 5851 | rule's syntax. |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 5852 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5853 | http-request reject [ { if | unless } <condition> ] |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 5854 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5855 | This stops the evaluation of the rules and immediately closes the connection |
| 5856 | without sending any response. It acts similarly to the |
| 5857 | "tcp-request content reject" rules. It can be useful to force an immediate |
| 5858 | connection closure on HTTP/2 connections. |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 5859 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5860 | http-request replace-header <name> <match-regex> <replace-fmt> |
| 5861 | [ { if | unless } <condition> ] |
Willy Tarreau | a9083d0 | 2015-05-08 15:27:59 +0200 | [diff] [blame] | 5862 | |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 5863 | This matches the value of all occurrences of header field <name> against |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5864 | <match-regex>. Matching is performed case-sensitively. Matching values are |
| 5865 | completely replaced by <replace-fmt>. Format characters are allowed in |
| 5866 | <replace-fmt> and work like <fmt> arguments in "http-request add-header". |
| 5867 | Standard back-references using the backslash ('\') followed by a number are |
| 5868 | supported. |
Thierry FOURNIER | 82bf70d | 2015-05-26 17:58:29 +0200 | [diff] [blame] | 5869 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5870 | This action acts on whole header lines, regardless of the number of values |
| 5871 | they may contain. Thus it is well-suited to process headers naturally |
| 5872 | containing commas in their value, such as If-Modified-Since. Headers that |
| 5873 | contain a comma-separated list of values, such as Accept, should be processed |
| 5874 | using "http-request replace-value". |
William Lallemand | 86d0df0 | 2017-11-24 21:36:45 +0100 | [diff] [blame] | 5875 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5876 | Example: |
| 5877 | http-request replace-header Cookie foo=([^;]*);(.*) foo=\1;ip=%bi;\2 |
| 5878 | |
| 5879 | # applied to: |
| 5880 | Cookie: foo=foobar; expires=Tue, 14-Jun-2016 01:40:45 GMT; |
| 5881 | |
| 5882 | # outputs: |
| 5883 | Cookie: foo=foobar;ip=192.168.1.20; expires=Tue, 14-Jun-2016 01:40:45 GMT; |
| 5884 | |
| 5885 | # assuming the backend IP is 192.168.1.20 |
Willy Tarreau | 09448f7 | 2014-06-25 18:12:15 +0200 | [diff] [blame] | 5886 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5887 | http-request replace-header User-Agent curl foo |
| 5888 | |
| 5889 | # applied to: |
| 5890 | User-Agent: curl/7.47.0 |
Willy Tarreau | 09448f7 | 2014-06-25 18:12:15 +0200 | [diff] [blame] | 5891 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5892 | # outputs: |
| 5893 | User-Agent: foo |
Willy Tarreau | 09448f7 | 2014-06-25 18:12:15 +0200 | [diff] [blame] | 5894 | |
Willy Tarreau | 262c3f1 | 2019-12-17 06:52:51 +0100 | [diff] [blame] | 5895 | http-request replace-path <match-regex> <replace-fmt> |
| 5896 | [ { if | unless } <condition> ] |
| 5897 | |
| 5898 | This works like "replace-header" except that it works on the request's path |
| 5899 | component instead of a header. The path component starts at the first '/' |
Christopher Faulet | 82c8332 | 2020-09-02 14:16:59 +0200 | [diff] [blame] | 5900 | after an optional scheme+authority and ends before the question mark. Thus, |
| 5901 | the replacement does not modify the scheme, the authority and the |
| 5902 | query-string. |
Willy Tarreau | 262c3f1 | 2019-12-17 06:52:51 +0100 | [diff] [blame] | 5903 | |
| 5904 | It is worth noting that regular expressions may be more expensive to evaluate |
| 5905 | than certain ACLs, so rare replacements may benefit from a condition to avoid |
| 5906 | performing the evaluation at all if it does not match. |
| 5907 | |
| 5908 | Example: |
| 5909 | # prefix /foo : turn /bar?q=1 into /foo/bar?q=1 : |
| 5910 | http-request replace-path (.*) /foo\1 |
| 5911 | |
Willy Tarreau | 262c3f1 | 2019-12-17 06:52:51 +0100 | [diff] [blame] | 5912 | # strip /foo : turn /foo/bar?q=1 into /bar?q=1 |
| 5913 | http-request replace-path /foo/(.*) /\1 |
| 5914 | # or more efficient if only some requests match : |
| 5915 | http-request replace-path /foo/(.*) /\1 if { url_beg /foo/ } |
| 5916 | |
Christopher Faulet | 312294f | 2020-09-02 17:17:44 +0200 | [diff] [blame] | 5917 | http-request replace-pathq <match-regex> <replace-fmt> |
| 5918 | [ { if | unless } <condition> ] |
| 5919 | |
| 5920 | This does the same as "http-request replace-path" except that the path |
| 5921 | contains the query-string if any is present. Thus, the path and the |
| 5922 | query-string are replaced. |
| 5923 | |
| 5924 | Example: |
| 5925 | # suffix /foo : turn /bar?q=1 into /bar/foo?q=1 : |
| 5926 | http-request replace-pathq ([^?]*)(\?(.*))? \1/foo\2 |
| 5927 | |
Willy Tarreau | 3381022 | 2019-06-12 17:44:02 +0200 | [diff] [blame] | 5928 | http-request replace-uri <match-regex> <replace-fmt> |
| 5929 | [ { if | unless } <condition> ] |
| 5930 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5931 | This works like "replace-header" except that it works on the request's URI part |
| 5932 | instead of a header. The URI part may contain an optional scheme, authority or |
| 5933 | query string. These are considered to be part of the value that is matched |
| 5934 | against. |
| 5935 | |
| 5936 | It is worth noting that regular expressions may be more expensive to evaluate |
| 5937 | than certain ACLs, so rare replacements may benefit from a condition to avoid |
| 5938 | performing the evaluation at all if it does not match. |
Willy Tarreau | 3381022 | 2019-06-12 17:44:02 +0200 | [diff] [blame] | 5939 | |
Willy Tarreau | 62b5913 | 2019-12-17 06:51:20 +0100 | [diff] [blame] | 5940 | IMPORTANT NOTE: historically in HTTP/1.x, the vast majority of requests sent |
| 5941 | by browsers use the "origin form", which differs from the "absolute form" in |
| 5942 | that they do not contain a scheme nor authority in the URI portion. Mostly |
| 5943 | only requests sent to proxies, those forged by hand and some emitted by |
| 5944 | certain applications use the absolute form. As such, "replace-uri" usually |
| 5945 | works fine most of the time in HTTP/1.x with rules starting with a "/". But |
| 5946 | with HTTP/2, clients are encouraged to send absolute URIs only, which look |
| 5947 | like the ones HTTP/1 clients use to talk to proxies. Such partial replace-uri |
| 5948 | rules may then fail in HTTP/2 when they work in HTTP/1. Either the rules need |
Willy Tarreau | 262c3f1 | 2019-12-17 06:52:51 +0100 | [diff] [blame] | 5949 | to be adapted to optionally match a scheme and authority, or replace-path |
| 5950 | should be used. |
Willy Tarreau | 3381022 | 2019-06-12 17:44:02 +0200 | [diff] [blame] | 5951 | |
Willy Tarreau | 62b5913 | 2019-12-17 06:51:20 +0100 | [diff] [blame] | 5952 | Example: |
| 5953 | # rewrite all "http" absolute requests to "https": |
| 5954 | http-request replace-uri ^http://(.*) https://\1 |
Willy Tarreau | 3381022 | 2019-06-12 17:44:02 +0200 | [diff] [blame] | 5955 | |
Willy Tarreau | 62b5913 | 2019-12-17 06:51:20 +0100 | [diff] [blame] | 5956 | # prefix /foo : turn /bar?q=1 into /foo/bar?q=1 : |
| 5957 | http-request replace-uri ([^/:]*://[^/]*)?(.*) \1/foo\2 |
Willy Tarreau | 3381022 | 2019-06-12 17:44:02 +0200 | [diff] [blame] | 5958 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 5959 | http-request replace-value <name> <match-regex> <replace-fmt> |
| 5960 | [ { if | unless } <condition> ] |
Willy Tarreau | 09448f7 | 2014-06-25 18:12:15 +0200 | [diff] [blame] | 5961 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5962 | This works like "replace-header" except that it matches the regex against |
| 5963 | every comma-delimited value of the header field <name> instead of the |
| 5964 | entire header. This is suited for all headers which are allowed to carry |
| 5965 | more than one value. An example could be the Accept header. |
Willy Tarreau | 09448f7 | 2014-06-25 18:12:15 +0200 | [diff] [blame] | 5966 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5967 | Example: |
| 5968 | http-request replace-value X-Forwarded-For ^192\.168\.(.*)$ 172.16.\1 |
Thierry FOURNIER | 236657b | 2015-08-19 08:25:14 +0200 | [diff] [blame] | 5969 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5970 | # applied to: |
| 5971 | X-Forwarded-For: 192.168.10.1, 192.168.13.24, 10.0.0.37 |
Thierry FOURNIER | e0627bd | 2015-08-04 08:20:33 +0200 | [diff] [blame] | 5972 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 5973 | # outputs: |
| 5974 | X-Forwarded-For: 172.16.10.1, 172.16.13.24, 10.0.0.37 |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 5975 | |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 5976 | http-request return [status <code>] [content-type <type>] |
| 5977 | [ { default-errorfiles | errorfile <file> | errorfiles <name> | |
| 5978 | file <file> | lf-file <file> | string <str> | lf-string <fmt> } ] |
Christopher Faulet | 4a2c142 | 2020-01-31 17:36:01 +0100 | [diff] [blame] | 5979 | [ hdr <name> <fmt> ]* |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 5980 | [ { if | unless } <condition> ] |
| 5981 | |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 5982 | This stops the evaluation of the rules and immediately returns a response. The |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 5983 | default status code used for the response is 200. It can be optionally |
| 5984 | specified as an arguments to "status". The response content-type may also be |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 5985 | specified as an argument to "content-type". Finally the response itself may |
Sébastien Gross | ab87712 | 2020-10-08 10:06:03 +0200 | [diff] [blame] | 5986 | be defined. It can be a full HTTP response specifying the errorfile to use, |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 5987 | or the response payload specifying the file or the string to use. These rules |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 5988 | are followed to create the response : |
| 5989 | |
| 5990 | * If neither the errorfile nor the payload to use is defined, a dummy |
| 5991 | response is returned. Only the "status" argument is considered. It can be |
| 5992 | any code in the range [200, 599]. The "content-type" argument, if any, is |
| 5993 | ignored. |
| 5994 | |
| 5995 | * If "default-errorfiles" argument is set, the proxy's errorfiles are |
| 5996 | considered. If the "status" argument is defined, it must be one of the |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 5997 | status code handled by haproxy (200, 400, 403, 404, 405, 408, 410, 413, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 5998 | 425, 429, 500, 502, 503, and 504). The "content-type" argument, if any, |
| 5999 | is ignored. |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6000 | |
| 6001 | * If a specific errorfile is defined, with an "errorfile" argument, the |
| 6002 | corresponding file, containing a full HTTP response, is returned. Only the |
| 6003 | "status" argument is considered. It must be one of the status code handled |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 6004 | by haproxy (200, 400, 403, 404, 405, 408, 410, 413, 425, 429, 500, 502, 503, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 6005 | and 504). The "content-type" argument, if any, is ignored. |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6006 | |
| 6007 | * If an http-errors section is defined, with an "errorfiles" argument, the |
| 6008 | corresponding file in the specified http-errors section, containing a full |
| 6009 | HTTP response, is returned. Only the "status" argument is considered. It |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 6010 | must be one of the status code handled by haproxy (200, 400, 403, 404, 405, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 6011 | 408, 410, 413, 425, 429, 500, 502, 503, and 504). The "content-type" |
| 6012 | argument, if any, is ignored. |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6013 | |
| 6014 | * If a "file" or a "lf-file" argument is specified, the file's content is |
| 6015 | used as the response payload. If the file is not empty, its content-type |
| 6016 | must be set as argument to "content-type". Otherwise, any "content-type" |
| 6017 | argument is ignored. With a "lf-file" argument, the file's content is |
| 6018 | evaluated as a log-format string. With a "file" argument, it is considered |
| 6019 | as a raw content. |
| 6020 | |
| 6021 | * If a "string" or "lf-string" argument is specified, the defined string is |
| 6022 | used as the response payload. The content-type must always be set as |
| 6023 | argument to "content-type". With a "lf-string" argument, the string is |
| 6024 | evaluated as a log-format string. With a "string" argument, it is |
| 6025 | considered as a raw string. |
| 6026 | |
Sébastien Gross | ab87712 | 2020-10-08 10:06:03 +0200 | [diff] [blame] | 6027 | When the response is not based on an errorfile, it is possible to append HTTP |
Christopher Faulet | 4a2c142 | 2020-01-31 17:36:01 +0100 | [diff] [blame] | 6028 | header fields to the response using "hdr" arguments. Otherwise, all "hdr" |
| 6029 | arguments are ignored. For each one, the header name is specified in <name> |
| 6030 | and its value is defined by <fmt> which follows the log-format rules. |
| 6031 | |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6032 | Note that the generated response must be smaller than a buffer. And to avoid |
| 6033 | any warning, when an errorfile or a raw file is loaded, the buffer space |
Sébastien Gross | ab87712 | 2020-10-08 10:06:03 +0200 | [diff] [blame] | 6034 | reserved for the headers rewriting should also be free. |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6035 | |
| 6036 | No further "http-request" rules are evaluated. |
| 6037 | |
| 6038 | Example: |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 6039 | http-request return errorfile /etc/haproxy/errorfiles/200.http \ |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6040 | if { path /ping } |
| 6041 | |
| 6042 | http-request return content-type image/x-icon file /var/www/favicon.ico \ |
| 6043 | if { path /favicon.ico } |
| 6044 | |
| 6045 | http-request return status 403 content-type text/plain \ |
| 6046 | lf-string "Access denied. IP %[src] is blacklisted." \ |
| 6047 | if { src -f /etc/haproxy/blacklist.lst } |
| 6048 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6049 | http-request sc-inc-gpc0(<sc-id>) [ { if | unless } <condition> ] |
| 6050 | http-request sc-inc-gpc1(<sc-id>) [ { if | unless } <condition> ] |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6051 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6052 | This actions increments the GPC0 or GPC1 counter according with the sticky |
| 6053 | counter designated by <sc-id>. If an error occurs, this action silently fails |
| 6054 | and the actions evaluation continues. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6055 | |
Cédric Dufour | 0d7712d | 2019-11-06 18:38:53 +0100 | [diff] [blame] | 6056 | http-request sc-set-gpt0(<sc-id>) { <int> | <expr> } |
| 6057 | [ { if | unless } <condition> ] |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6058 | |
Cédric Dufour | 0d7712d | 2019-11-06 18:38:53 +0100 | [diff] [blame] | 6059 | This action sets the 32-bit unsigned GPT0 tag according to the sticky counter |
| 6060 | designated by <sc-id> and the value of <int>/<expr>. The expected result is a |
| 6061 | boolean. If an error occurs, this action silently fails and the actions |
| 6062 | evaluation continues. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6063 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6064 | http-request set-dst <expr> [ { if | unless } <condition> ] |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6065 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6066 | This is used to set the destination IP address to the value of specified |
| 6067 | expression. Useful when a proxy in front of HAProxy rewrites destination IP, |
| 6068 | but provides the correct IP in a HTTP header; or you want to mask the IP for |
| 6069 | privacy. If you want to connect to the new address/port, use '0.0.0.0:0' as a |
| 6070 | server address in the backend. |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 6071 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6072 | Arguments: |
| 6073 | <expr> Is a standard HAProxy expression formed by a sample-fetch followed |
| 6074 | by some converters. |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 6075 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6076 | Example: |
| 6077 | http-request set-dst hdr(x-dst) |
| 6078 | http-request set-dst dst,ipmask(24) |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 6079 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6080 | When possible, set-dst preserves the original destination port as long as the |
| 6081 | address family allows it, otherwise the destination port is set to 0. |
Adis Nezirovic | 2fbcafc | 2015-07-06 15:44:30 +0200 | [diff] [blame] | 6082 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6083 | http-request set-dst-port <expr> [ { if | unless } <condition> ] |
Adis Nezirovic | 2fbcafc | 2015-07-06 15:44:30 +0200 | [diff] [blame] | 6084 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6085 | This is used to set the destination port address to the value of specified |
| 6086 | expression. If you want to connect to the new address/port, use '0.0.0.0:0' |
| 6087 | as a server address in the backend. |
Adis Nezirovic | 2fbcafc | 2015-07-06 15:44:30 +0200 | [diff] [blame] | 6088 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6089 | Arguments: |
| 6090 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 6091 | followed by some converters. |
Adis Nezirovic | 2fbcafc | 2015-07-06 15:44:30 +0200 | [diff] [blame] | 6092 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6093 | Example: |
| 6094 | http-request set-dst-port hdr(x-port) |
| 6095 | http-request set-dst-port int(4000) |
Adis Nezirovic | 2fbcafc | 2015-07-06 15:44:30 +0200 | [diff] [blame] | 6096 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6097 | When possible, set-dst-port preserves the original destination address as |
| 6098 | long as the address family supports a port, otherwise it forces the |
| 6099 | destination address to IPv4 "0.0.0.0" before rewriting the port. |
William Lallemand | 44be640 | 2016-05-25 01:51:35 +0200 | [diff] [blame] | 6100 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6101 | http-request set-header <name> <fmt> [ { if | unless } <condition> ] |
William Lallemand | 44be640 | 2016-05-25 01:51:35 +0200 | [diff] [blame] | 6102 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6103 | This does the same as "http-request add-header" except that the header name |
| 6104 | is first removed if it existed. This is useful when passing security |
| 6105 | information to the server, where the header must not be manipulated by |
| 6106 | external users. Note that the new value is computed before the removal so it |
| 6107 | is possible to concatenate a value to an existing header. |
William Lallemand | 44be640 | 2016-05-25 01:51:35 +0200 | [diff] [blame] | 6108 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6109 | Example: |
| 6110 | http-request set-header X-Haproxy-Current-Date %T |
| 6111 | http-request set-header X-SSL %[ssl_fc] |
| 6112 | http-request set-header X-SSL-Session_ID %[ssl_fc_session_id,hex] |
| 6113 | http-request set-header X-SSL-Client-Verify %[ssl_c_verify] |
| 6114 | http-request set-header X-SSL-Client-DN %{+Q}[ssl_c_s_dn] |
| 6115 | http-request set-header X-SSL-Client-CN %{+Q}[ssl_c_s_dn(cn)] |
| 6116 | http-request set-header X-SSL-Issuer %{+Q}[ssl_c_i_dn] |
| 6117 | http-request set-header X-SSL-Client-NotBefore %{+Q}[ssl_c_notbefore] |
| 6118 | http-request set-header X-SSL-Client-NotAfter %{+Q}[ssl_c_notafter] |
William Lallemand | 44be640 | 2016-05-25 01:51:35 +0200 | [diff] [blame] | 6119 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6120 | http-request set-log-level <level> [ { if | unless } <condition> ] |
William Lallemand | 44be640 | 2016-05-25 01:51:35 +0200 | [diff] [blame] | 6121 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6122 | This is used to change the log level of the current request when a certain |
| 6123 | condition is met. Valid levels are the 8 syslog levels (see the "log" |
| 6124 | keyword) plus the special level "silent" which disables logging for this |
| 6125 | request. This rule is not final so the last matching rule wins. This rule |
| 6126 | can be useful to disable health checks coming from another equipment. |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 6127 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6128 | http-request set-map(<file-name>) <key fmt> <value fmt> |
| 6129 | [ { if | unless } <condition> ] |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 6130 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6131 | This is used to add a new entry into a MAP. The MAP must be loaded from a |
| 6132 | file (even a dummy empty file). The file name of the MAP to be updated is |
| 6133 | passed between parentheses. It takes 2 arguments: <key fmt>, which follows |
| 6134 | log-format rules, used to collect MAP key, and <value fmt>, which follows |
| 6135 | log-format rules, used to collect content for the new entry. |
| 6136 | It performs a lookup in the MAP before insertion, to avoid duplicated (or |
| 6137 | more) values. This lookup is done by a linear search and can be expensive |
| 6138 | with large lists! It is the equivalent of the "set map" command from the |
| 6139 | stats socket, but can be triggered by an HTTP request. |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 6140 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6141 | http-request set-mark <mark> [ { if | unless } <condition> ] |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 6142 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6143 | This is used to set the Netfilter MARK on all packets sent to the client to |
| 6144 | the value passed in <mark> on platforms which support it. This value is an |
| 6145 | unsigned 32 bit value which can be matched by netfilter and by the routing |
| 6146 | table. It can be expressed both in decimal or hexadecimal format (prefixed by |
| 6147 | "0x"). This can be useful to force certain packets to take a different route |
| 6148 | (for example a cheaper network path for bulk downloads). This works on Linux |
| 6149 | kernels 2.6.32 and above and requires admin privileges. |
Willy Tarreau | 00005ce | 2016-10-21 15:07:45 +0200 | [diff] [blame] | 6150 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6151 | http-request set-method <fmt> [ { if | unless } <condition> ] |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 6152 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6153 | This rewrites the request method with the result of the evaluation of format |
| 6154 | string <fmt>. There should be very few valid reasons for having to do so as |
| 6155 | this is more likely to break something than to fix it. |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 6156 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6157 | http-request set-nice <nice> [ { if | unless } <condition> ] |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 6158 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6159 | This sets the "nice" factor of the current request being processed. It only |
| 6160 | has effect against the other requests being processed at the same time. |
| 6161 | The default value is 0, unless altered by the "nice" setting on the "bind" |
| 6162 | line. The accepted range is -1024..1024. The higher the value, the nicest |
| 6163 | the request will be. Lower values will make the request more important than |
| 6164 | other ones. This can be useful to improve the speed of some requests, or |
| 6165 | lower the priority of non-important requests. Using this setting without |
| 6166 | prior experimentation can cause some major slowdown. |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 6167 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6168 | http-request set-path <fmt> [ { if | unless } <condition> ] |
Willy Tarreau | 00005ce | 2016-10-21 15:07:45 +0200 | [diff] [blame] | 6169 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6170 | This rewrites the request path with the result of the evaluation of format |
| 6171 | string <fmt>. The query string, if any, is left intact. If a scheme and |
| 6172 | authority is found before the path, they are left intact as well. If the |
| 6173 | request doesn't have a path ("*"), this one is replaced with the format. |
| 6174 | This can be used to prepend a directory component in front of a path for |
| 6175 | example. See also "http-request set-query" and "http-request set-uri". |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 6176 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6177 | Example : |
| 6178 | # prepend the host name before the path |
| 6179 | http-request set-path /%[hdr(host)]%[path] |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 6180 | |
Christopher Faulet | 312294f | 2020-09-02 17:17:44 +0200 | [diff] [blame] | 6181 | http-request set-pathq <fmt> [ { if | unless } <condition> ] |
| 6182 | |
| 6183 | This does the same as "http-request set-path" except that the query-string is |
| 6184 | also rewritten. It may be used to remove the query-string, including the |
| 6185 | question mark (it is not possible using "http-request set-query"). |
| 6186 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6187 | http-request set-priority-class <expr> [ { if | unless } <condition> ] |
Olivier Houchard | ccaa7de | 2017-10-02 11:51:03 +0200 | [diff] [blame] | 6188 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6189 | This is used to set the queue priority class of the current request. |
| 6190 | The value must be a sample expression which converts to an integer in the |
| 6191 | range -2047..2047. Results outside this range will be truncated. |
| 6192 | The priority class determines the order in which queued requests are |
| 6193 | processed. Lower values have higher priority. |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 6194 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6195 | http-request set-priority-offset <expr> [ { if | unless } <condition> ] |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 6196 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6197 | This is used to set the queue priority timestamp offset of the current |
| 6198 | request. The value must be a sample expression which converts to an integer |
| 6199 | in the range -524287..524287. Results outside this range will be truncated. |
| 6200 | When a request is queued, it is ordered first by the priority class, then by |
| 6201 | the current timestamp adjusted by the given offset in milliseconds. Lower |
| 6202 | values have higher priority. |
| 6203 | Note that the resulting timestamp is is only tracked with enough precision |
| 6204 | for 524,287ms (8m44s287ms). If the request is queued long enough to where the |
| 6205 | adjusted timestamp exceeds this value, it will be misidentified as highest |
| 6206 | priority. Thus it is important to set "timeout queue" to a value, where when |
| 6207 | combined with the offset, does not exceed this limit. |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 6208 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6209 | http-request set-query <fmt> [ { if | unless } <condition> ] |
Willy Tarreau | 20b0de5 | 2012-12-24 15:45:22 +0100 | [diff] [blame] | 6210 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6211 | This rewrites the request's query string which appears after the first |
| 6212 | question mark ("?") with the result of the evaluation of format string <fmt>. |
| 6213 | The part prior to the question mark is left intact. If the request doesn't |
| 6214 | contain a question mark and the new value is not empty, then one is added at |
| 6215 | the end of the URI, followed by the new value. If a question mark was |
| 6216 | present, it will never be removed even if the value is empty. This can be |
| 6217 | used to add or remove parameters from the query string. |
Ruoshan Huang | eb5a363 | 2015-12-08 21:00:23 +0800 | [diff] [blame] | 6218 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6219 | See also "http-request set-query" and "http-request set-uri". |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 6220 | |
| 6221 | Example: |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6222 | # replace "%3D" with "=" in the query string |
| 6223 | http-request set-query %[query,regsub(%3D,=,g)] |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 6224 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6225 | http-request set-src <expr> [ { if | unless } <condition> ] |
| 6226 | This is used to set the source IP address to the value of specified |
| 6227 | expression. Useful when a proxy in front of HAProxy rewrites source IP, but |
| 6228 | provides the correct IP in a HTTP header; or you want to mask source IP for |
Olivier Doucet | 56e3120 | 2020-04-21 09:32:56 +0200 | [diff] [blame] | 6229 | privacy. All subsequent calls to "src" fetch will return this value |
| 6230 | (see example). |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6231 | |
| 6232 | Arguments : |
| 6233 | <expr> Is a standard HAProxy expression formed by a sample-fetch followed |
| 6234 | by some converters. |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 6235 | |
Olivier Doucet | 56e3120 | 2020-04-21 09:32:56 +0200 | [diff] [blame] | 6236 | See also "option forwardfor". |
| 6237 | |
Cyril Bonté | 78caf84 | 2010-03-10 22:41:43 +0100 | [diff] [blame] | 6238 | Example: |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6239 | http-request set-src hdr(x-forwarded-for) |
| 6240 | http-request set-src src,ipmask(24) |
| 6241 | |
Olivier Doucet | 56e3120 | 2020-04-21 09:32:56 +0200 | [diff] [blame] | 6242 | # After the masking this will track connections |
| 6243 | # based on the IP address with the last byte zeroed out. |
| 6244 | http-request track-sc0 src |
| 6245 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6246 | When possible, set-src preserves the original source port as long as the |
| 6247 | address family allows it, otherwise the source port is set to 0. |
| 6248 | |
| 6249 | http-request set-src-port <expr> [ { if | unless } <condition> ] |
| 6250 | |
| 6251 | This is used to set the source port address to the value of specified |
| 6252 | expression. |
| 6253 | |
| 6254 | Arguments: |
| 6255 | <expr> Is a standard HAProxy expression formed by a sample-fetch followed |
| 6256 | by some converters. |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 6257 | |
Willy Tarreau | 20b0de5 | 2012-12-24 15:45:22 +0100 | [diff] [blame] | 6258 | Example: |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6259 | http-request set-src-port hdr(x-port) |
| 6260 | http-request set-src-port int(4000) |
| 6261 | |
| 6262 | When possible, set-src-port preserves the original source address as long as |
| 6263 | the address family supports a port, otherwise it forces the source address to |
| 6264 | IPv4 "0.0.0.0" before rewriting the port. |
| 6265 | |
Amaury Denoyelle | 8d22823 | 2020-12-10 13:43:54 +0100 | [diff] [blame] | 6266 | http-request set-timeout server|tunnel { <timeout> | <expr> } |
| 6267 | [ { if | unless } <condition> ] |
| 6268 | |
| 6269 | This action overrides the specified "server" or "tunnel" timeout for the |
| 6270 | current stream only. The timeout can be specified in millisecond or with any |
| 6271 | other unit if the number is suffixed by the unit as explained at the top of |
| 6272 | this document. It is also possible to write an expression which must returns |
| 6273 | a number interpreted as a timeout in millisecond. |
| 6274 | |
| 6275 | Note that the server/tunnel timeouts are only relevant on the backend side |
| 6276 | and thus this rule is only available for the proxies with backend |
| 6277 | capabilities. Also the timeout value must be non-null to obtain the expected |
| 6278 | results. |
| 6279 | |
| 6280 | Example: |
| 6281 | http-request set-timeout server 5s |
| 6282 | http-request set-timeout hdr(host),map_int(host.lst) |
| 6283 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6284 | http-request set-tos <tos> [ { if | unless } <condition> ] |
| 6285 | |
| 6286 | This is used to set the TOS or DSCP field value of packets sent to the client |
| 6287 | to the value passed in <tos> on platforms which support this. This value |
| 6288 | represents the whole 8 bits of the IP TOS field, and can be expressed both in |
| 6289 | decimal or hexadecimal format (prefixed by "0x"). Note that only the 6 higher |
| 6290 | bits are used in DSCP or TOS, and the two lower bits are always 0. This can |
| 6291 | be used to adjust some routing behavior on border routers based on some |
| 6292 | information from the request. |
| 6293 | |
| 6294 | See RFC 2474, 2597, 3260 and 4594 for more information. |
| 6295 | |
| 6296 | http-request set-uri <fmt> [ { if | unless } <condition> ] |
| 6297 | |
| 6298 | This rewrites the request URI with the result of the evaluation of format |
| 6299 | string <fmt>. The scheme, authority, path and query string are all replaced |
| 6300 | at once. This can be used to rewrite hosts in front of proxies, or to |
| 6301 | perform complex modifications to the URI such as moving parts between the |
| 6302 | path and the query string. |
| 6303 | See also "http-request set-path" and "http-request set-query". |
| 6304 | |
| 6305 | http-request set-var(<var-name>) <expr> [ { if | unless } <condition> ] |
| 6306 | |
| 6307 | This is used to set the contents of a variable. The variable is declared |
| 6308 | inline. |
| 6309 | |
| 6310 | Arguments: |
| 6311 | <var-name> The name of the variable starts with an indication about its |
| 6312 | scope. The scopes allowed are: |
| 6313 | "proc" : the variable is shared with the whole process |
| 6314 | "sess" : the variable is shared with the whole session |
| 6315 | "txn" : the variable is shared with the transaction |
| 6316 | (request and response) |
| 6317 | "req" : the variable is shared only during request |
| 6318 | processing |
| 6319 | "res" : the variable is shared only during response |
| 6320 | processing |
| 6321 | This prefix is followed by a name. The separator is a '.'. |
| 6322 | The name may only contain characters 'a-z', 'A-Z', '0-9' |
| 6323 | and '_'. |
| 6324 | |
| 6325 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 6326 | followed by some converters. |
Willy Tarreau | 20b0de5 | 2012-12-24 15:45:22 +0100 | [diff] [blame] | 6327 | |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6328 | Example: |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6329 | http-request set-var(req.my_var) req.fhdr(user-agent),lower |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6330 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6331 | http-request send-spoe-group <engine-name> <group-name> |
| 6332 | [ { if | unless } <condition> ] |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6333 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6334 | This action is used to trigger sending of a group of SPOE messages. To do so, |
| 6335 | the SPOE engine used to send messages must be defined, as well as the SPOE |
| 6336 | group to send. Of course, the SPOE engine must refer to an existing SPOE |
| 6337 | filter. If not engine name is provided on the SPOE filter line, the SPOE |
| 6338 | agent name must be used. |
| 6339 | |
| 6340 | Arguments: |
| 6341 | <engine-name> The SPOE engine name. |
| 6342 | |
| 6343 | <group-name> The SPOE group name as specified in the engine |
| 6344 | configuration. |
| 6345 | |
| 6346 | http-request silent-drop [ { if | unless } <condition> ] |
| 6347 | |
| 6348 | This stops the evaluation of the rules and makes the client-facing connection |
| 6349 | suddenly disappear using a system-dependent way that tries to prevent the |
| 6350 | client from being notified. The effect it then that the client still sees an |
| 6351 | established connection while there's none on HAProxy. The purpose is to |
| 6352 | achieve a comparable effect to "tarpit" except that it doesn't use any local |
| 6353 | resource at all on the machine running HAProxy. It can resist much higher |
| 6354 | loads than "tarpit", and slow down stronger attackers. It is important to |
| 6355 | understand the impact of using this mechanism. All stateful equipment placed |
| 6356 | between the client and HAProxy (firewalls, proxies, load balancers) will also |
| 6357 | keep the established connection for a long time and may suffer from this |
| 6358 | action. |
| 6359 | On modern Linux systems running with enough privileges, the TCP_REPAIR socket |
| 6360 | option is used to block the emission of a TCP reset. On other systems, the |
| 6361 | socket's TTL is reduced to 1 so that the TCP reset doesn't pass the first |
| 6362 | router, though it's still delivered to local networks. Do not use it unless |
| 6363 | you fully understand how it works. |
| 6364 | |
Christopher Faulet | 46f9554 | 2019-12-20 10:07:22 +0100 | [diff] [blame] | 6365 | http-request strict-mode { on | off } |
| 6366 | |
| 6367 | This enables or disables the strict rewriting mode for following rules. It |
| 6368 | does not affect rules declared before it and it is only applicable on rules |
| 6369 | performing a rewrite on the requests. When the strict mode is enabled, any |
| 6370 | rewrite failure triggers an internal error. Otherwise, such errors are |
| 6371 | silently ignored. The purpose of the strict rewriting mode is to make some |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 6372 | rewrites optional while others must be performed to continue the request |
Christopher Faulet | 46f9554 | 2019-12-20 10:07:22 +0100 | [diff] [blame] | 6373 | processing. |
| 6374 | |
Christopher Faulet | 1aea50e | 2020-01-17 16:03:53 +0100 | [diff] [blame] | 6375 | By default, the strict rewriting mode is enabled. Its value is also reset |
Christopher Faulet | 46f9554 | 2019-12-20 10:07:22 +0100 | [diff] [blame] | 6376 | when a ruleset evaluation ends. So, for instance, if you change the mode on |
| 6377 | the frontend, the default mode is restored when HAProxy starts the backend |
| 6378 | rules evaluation. |
| 6379 | |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 6380 | http-request tarpit [deny_status <status>] [ { if | unless } <condition> ] |
| 6381 | http-request tarpit [ { status | deny_status } <code>] [content-type <type>] |
| 6382 | [ { default-errorfiles | errorfile <file> | errorfiles <name> | |
| 6383 | file <file> | lf-file <file> | string <str> | lf-string <fmt> } ] |
| 6384 | [ hdr <name> <fmt> ]* |
| 6385 | [ { if | unless } <condition> ] |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6386 | |
| 6387 | This stops the evaluation of the rules and immediately blocks the request |
| 6388 | without responding for a delay specified by "timeout tarpit" or |
| 6389 | "timeout connect" if the former is not set. After that delay, if the client |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 6390 | is still connected, a response is returned so that the client does not |
| 6391 | suspect it has been tarpitted. Logs will report the flags "PT". The goal of |
| 6392 | the tarpit rule is to slow down robots during an attack when they're limited |
| 6393 | on the number of concurrent requests. It can be very efficient against very |
| 6394 | dumb robots, and will significantly reduce the load on firewalls compared to |
| 6395 | a "deny" rule. But when facing "correctly" developed robots, it can make |
| 6396 | things worse by forcing haproxy and the front firewall to support insane |
| 6397 | number of concurrent connections. By default an HTTP error 500 is returned. |
| 6398 | But the response may be customized using same syntax than |
| 6399 | "http-request return" rules. Thus, see "http-request return" for details. |
Ilya Shipitsin | 11057a3 | 2020-06-21 21:18:27 +0500 | [diff] [blame] | 6400 | For compatibility purpose, when no argument is defined, or only "deny_status", |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 6401 | the argument "default-errorfiles" is implied. It means |
| 6402 | "http-request tarpit [deny_status <status>]" is an alias of |
| 6403 | "http-request tarpit [status <status>] default-errorfiles". |
| 6404 | No further "http-request" rules are evaluated. |
| 6405 | See also "http-request return" and "http-request silent-drop". |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6406 | |
| 6407 | http-request track-sc0 <key> [table <table>] [ { if | unless } <condition> ] |
| 6408 | http-request track-sc1 <key> [table <table>] [ { if | unless } <condition> ] |
| 6409 | http-request track-sc2 <key> [table <table>] [ { if | unless } <condition> ] |
| 6410 | |
| 6411 | This enables tracking of sticky counters from current request. These rules do |
| 6412 | not stop evaluation and do not change default action. The number of counters |
| 6413 | that may be simultaneously tracked by the same connection is set in |
| 6414 | MAX_SESS_STKCTR at build time (reported in haproxy -vv) which defaults to 3, |
Matteo Contrini | 1857b8c | 2020-10-16 17:35:54 +0200 | [diff] [blame] | 6415 | so the track-sc number is between 0 and (MAX_SESS_STKCTR-1). The first |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6416 | "track-sc0" rule executed enables tracking of the counters of the specified |
| 6417 | table as the first set. The first "track-sc1" rule executed enables tracking |
| 6418 | of the counters of the specified table as the second set. The first |
| 6419 | "track-sc2" rule executed enables tracking of the counters of the specified |
| 6420 | table as the third set. It is a recommended practice to use the first set of |
| 6421 | counters for the per-frontend counters and the second set for the per-backend |
| 6422 | ones. But this is just a guideline, all may be used everywhere. |
| 6423 | |
| 6424 | Arguments : |
| 6425 | <key> is mandatory, and is a sample expression rule as described in |
| 6426 | section 7.3. It describes what elements of the incoming request or |
| 6427 | connection will be analyzed, extracted, combined, and used to |
| 6428 | select which table entry to update the counters. |
| 6429 | |
| 6430 | <table> is an optional table to be used instead of the default one, which |
| 6431 | is the stick-table declared in the current proxy. All the counters |
| 6432 | for the matches and updates for the key will then be performed in |
| 6433 | that table until the session ends. |
| 6434 | |
| 6435 | Once a "track-sc*" rule is executed, the key is looked up in the table and if |
| 6436 | it is not found, an entry is allocated for it. Then a pointer to that entry |
| 6437 | is kept during all the session's life, and this entry's counters are updated |
| 6438 | as often as possible, every time the session's counters are updated, and also |
| 6439 | systematically when the session ends. Counters are only updated for events |
| 6440 | that happen after the tracking has been started. As an exception, connection |
| 6441 | counters and request counters are systematically updated so that they reflect |
| 6442 | useful information. |
| 6443 | |
| 6444 | If the entry tracks concurrent connection counters, one connection is counted |
| 6445 | for as long as the entry is tracked, and the entry will not expire during |
| 6446 | that time. Tracking counters also provides a performance advantage over just |
| 6447 | checking the keys, because only one table lookup is performed for all ACL |
| 6448 | checks that make use of it. |
| 6449 | |
| 6450 | http-request unset-var(<var-name>) [ { if | unless } <condition> ] |
| 6451 | |
| 6452 | This is used to unset a variable. See above for details about <var-name>. |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6453 | |
| 6454 | Example: |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6455 | http-request unset-var(req.my_var) |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6456 | |
Christopher Faulet | 579d83b | 2019-11-22 15:34:17 +0100 | [diff] [blame] | 6457 | http-request use-service <service-name> [ { if | unless } <condition> ] |
| 6458 | |
| 6459 | This directive executes the configured HTTP service to reply to the request |
| 6460 | and stops the evaluation of the rules. An HTTP service may choose to reply by |
| 6461 | sending any valid HTTP response or it may immediately close the connection |
| 6462 | without sending any response. Outside natives services, for instance the |
| 6463 | Prometheus exporter, it is possible to write your own services in Lua. No |
| 6464 | further "http-request" rules are evaluated. |
| 6465 | |
| 6466 | Arguments : |
| 6467 | <service-name> is mandatory. It is the service to call |
| 6468 | |
| 6469 | Example: |
| 6470 | http-request use-service prometheus-exporter if { path /metrics } |
| 6471 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6472 | http-request wait-for-handshake [ { if | unless } <condition> ] |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6473 | |
Cyril Bonté | c6ad23b | 2018-10-17 00:14:50 +0200 | [diff] [blame] | 6474 | This will delay the processing of the request until the SSL handshake |
| 6475 | happened. This is mostly useful to delay processing early data until we're |
| 6476 | sure they are valid. |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6477 | |
Willy Tarreau | ef78104 | 2010-01-27 11:53:01 +0100 | [diff] [blame] | 6478 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6479 | http-response <action> <options...> [ { if | unless } <condition> ] |
Willy Tarreau | e365c0b | 2013-06-11 16:06:12 +0200 | [diff] [blame] | 6480 | Access control for Layer 7 responses |
| 6481 | |
| 6482 | May be used in sections: defaults | frontend | listen | backend |
| 6483 | no | yes | yes | yes |
| 6484 | |
| 6485 | The http-response statement defines a set of rules which apply to layer 7 |
| 6486 | processing. The rules are evaluated in their declaration order when they are |
| 6487 | met in a frontend, listen or backend section. Any rule may optionally be |
| 6488 | followed by an ACL-based condition, in which case it will only be evaluated |
| 6489 | if the condition is true. Since these rules apply on responses, the backend |
| 6490 | rules are applied first, followed by the frontend's rules. |
| 6491 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6492 | The first keyword is the rule's action. The supported actions are described |
| 6493 | below. |
Willy Tarreau | e365c0b | 2013-06-11 16:06:12 +0200 | [diff] [blame] | 6494 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6495 | There is no limit to the number of http-response statements per instance. |
Willy Tarreau | e365c0b | 2013-06-11 16:06:12 +0200 | [diff] [blame] | 6496 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6497 | Example: |
| 6498 | acl key_acl res.hdr(X-Acl-Key) -m found |
Thierry FOURNIER | dad3d1d | 2014-04-22 18:07:25 +0200 | [diff] [blame] | 6499 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6500 | acl myhost hdr(Host) -f myhost.lst |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6501 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6502 | http-response add-acl(myhost.lst) %[res.hdr(X-Acl-Key)] if key_acl |
| 6503 | http-response del-acl(myhost.lst) %[res.hdr(X-Acl-Key)] if key_acl |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6504 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6505 | Example: |
| 6506 | acl value res.hdr(X-Value) -m found |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6507 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6508 | use_backend bk_appli if { hdr(Host),map_str(map.lst) -m found } |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6509 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6510 | http-response set-map(map.lst) %[src] %[res.hdr(X-Value)] if value |
| 6511 | http-response del-map(map.lst) %[src] if ! value |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6512 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6513 | See also : "http-request", section 3.4 about userlists and section 7 about |
| 6514 | ACL usage. |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6515 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6516 | http-response add-acl(<file-name>) <key fmt> [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6517 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6518 | This is used to add a new entry into an ACL. The ACL must be loaded from a |
| 6519 | file (even a dummy empty file). The file name of the ACL to be updated is |
| 6520 | passed between parentheses. It takes one argument: <key fmt>, which follows |
| 6521 | log-format rules, to collect content of the new entry. It performs a lookup |
| 6522 | in the ACL before insertion, to avoid duplicated (or more) values. |
| 6523 | This lookup is done by a linear search and can be expensive with large lists! |
| 6524 | It is the equivalent of the "add acl" command from the stats socket, but can |
| 6525 | be triggered by an HTTP response. |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6526 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6527 | http-response add-header <name> <fmt> [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6528 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6529 | This appends an HTTP header field whose name is specified in <name> and whose |
| 6530 | value is defined by <fmt> which follows the log-format rules (see Custom Log |
| 6531 | Format in section 8.2.4). This may be used to send a cookie to a client for |
| 6532 | example, or to pass some internal information. |
| 6533 | This rule is not final, so it is possible to add other similar rules. |
| 6534 | Note that header addition is performed immediately, so one rule might reuse |
| 6535 | the resulting header from a previous rule. |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6536 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6537 | http-response allow [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6538 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6539 | This stops the evaluation of the rules and lets the response pass the check. |
| 6540 | No further "http-response" rules are evaluated for the current section. |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6541 | |
Jarno Huuskonen | 251a6b7 | 2019-01-04 14:05:02 +0200 | [diff] [blame] | 6542 | http-response cache-store <name> [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6543 | |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 6544 | See section 6.2 about cache setup. |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6545 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6546 | http-response capture <sample> id <id> [ { if | unless } <condition> ] |
Sasha Pachev | 218f064 | 2014-06-16 12:05:59 -0600 | [diff] [blame] | 6547 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6548 | This captures sample expression <sample> from the response buffer, and |
| 6549 | converts it to a string. The resulting string is stored into the next request |
| 6550 | "capture" slot, so it will possibly appear next to some captured HTTP |
| 6551 | headers. It will then automatically appear in the logs, and it will be |
| 6552 | possible to extract it using sample fetch rules to feed it into headers or |
| 6553 | anything. Please check section 7.3 (Fetching samples) and |
| 6554 | "capture response header" for more information. |
Thierry FOURNIER | 35d70ef | 2015-08-26 16:21:56 +0200 | [diff] [blame] | 6555 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6556 | The keyword "id" is the id of the capture slot which is used for storing the |
| 6557 | string. The capture slot must be defined in an associated frontend. |
| 6558 | This is useful to run captures in backends. The slot id can be declared by a |
| 6559 | previous directive "http-response capture" or with the "declare capture" |
| 6560 | keyword. |
Baptiste Assmann | 19a69b3 | 2020-01-16 14:34:22 +0100 | [diff] [blame] | 6561 | |
| 6562 | When using this action in a backend, double check that the relevant |
| 6563 | frontend(s) have the required capture slots otherwise, this rule will be |
| 6564 | ignored at run time. This can't be detected at configuration parsing time |
| 6565 | due to HAProxy's ability to dynamically resolve backend name at runtime. |
Thierry FOURNIER | 35d70ef | 2015-08-26 16:21:56 +0200 | [diff] [blame] | 6566 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6567 | http-response del-acl(<file-name>) <key fmt> [ { if | unless } <condition> ] |
Thierry FOURNIER | 35d70ef | 2015-08-26 16:21:56 +0200 | [diff] [blame] | 6568 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6569 | This is used to delete an entry from an ACL. The ACL must be loaded from a |
| 6570 | file (even a dummy empty file). The file name of the ACL to be updated is |
| 6571 | passed between parentheses. It takes one argument: <key fmt>, which follows |
| 6572 | log-format rules, to collect content of the entry to delete. |
| 6573 | It is the equivalent of the "del acl" command from the stats socket, but can |
| 6574 | be triggered by an HTTP response. |
Willy Tarreau | f4c43c1 | 2013-06-11 17:01:13 +0200 | [diff] [blame] | 6575 | |
Maciej Zdeb | ebdd4c5 | 2020-11-20 13:58:48 +0000 | [diff] [blame] | 6576 | http-response del-header <name> [ -m <meth> ] [ { if | unless } <condition> ] |
Willy Tarreau | 9a355ec | 2013-06-11 17:45:46 +0200 | [diff] [blame] | 6577 | |
Maciej Zdeb | ebdd4c5 | 2020-11-20 13:58:48 +0000 | [diff] [blame] | 6578 | This removes all HTTP header fields whose name is specified in <name>. <meth> |
| 6579 | is the matching method, applied on the header name. Supported matching methods |
| 6580 | are "str" (exact match), "beg" (prefix match), "end" (suffix match), "sub" |
| 6581 | (substring match) and "reg" (regex match). If not specified, exact matching |
| 6582 | method is used. |
Willy Tarreau | 42cf39e | 2013-06-11 18:51:32 +0200 | [diff] [blame] | 6583 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6584 | http-response del-map(<file-name>) <key fmt> [ { if | unless } <condition> ] |
Willy Tarreau | 51347ed | 2013-06-11 19:34:13 +0200 | [diff] [blame] | 6585 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6586 | This is used to delete an entry from a MAP. The MAP must be loaded from a |
| 6587 | file (even a dummy empty file). The file name of the MAP to be updated is |
| 6588 | passed between parentheses. It takes one argument: <key fmt>, which follows |
| 6589 | log-format rules, to collect content of the entry to delete. |
| 6590 | It takes one argument: "file name" It is the equivalent of the "del map" |
| 6591 | command from the stats socket, but can be triggered by an HTTP response. |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6592 | |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 6593 | http-response deny [deny_status <status>] [ { if | unless } <condition> ] |
| 6594 | http-response deny [ { status | deny_status } <code>] [content-type <type>] |
| 6595 | [ { default-errorfiles | errorfile <file> | errorfiles <name> | |
| 6596 | file <file> | lf-file <file> | string <str> | lf-string <fmt> } ] |
| 6597 | [ hdr <name> <fmt> ]* |
| 6598 | [ { if | unless } <condition> ] |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6599 | |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 6600 | This stops the evaluation of the rules and immediately rejects the response. |
| 6601 | By default an HTTP 502 error is returned. But the response may be customized |
| 6602 | using same syntax than "http-response return" rules. Thus, see |
Ilya Shipitsin | 11057a3 | 2020-06-21 21:18:27 +0500 | [diff] [blame] | 6603 | "http-response return" for details. For compatibility purpose, when no |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 6604 | argument is defined, or only "deny_status", the argument "default-errorfiles" |
| 6605 | is implied. It means "http-response deny [deny_status <status>]" is an alias |
| 6606 | of "http-response deny [status <status>] default-errorfiles". |
Christopher Faulet | 040c8cd | 2020-01-13 16:43:45 +0100 | [diff] [blame] | 6607 | No further "http-response" rules are evaluated. |
Christopher Faulet | 5cb513a | 2020-05-13 17:56:56 +0200 | [diff] [blame] | 6608 | See also "http-response return". |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6609 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6610 | http-response redirect <rule> [ { if | unless } <condition> ] |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6611 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6612 | This performs an HTTP redirection based on a redirect rule. |
| 6613 | This supports a format string similarly to "http-request redirect" rules, |
| 6614 | with the exception that only the "location" type of redirect is possible on |
| 6615 | the response. See the "redirect" keyword for the rule's syntax. When a |
| 6616 | redirect rule is applied during a response, connections to the server are |
| 6617 | closed so that no data can be forwarded from the server to the client. |
Thierry FOURNIER | e80fada | 2015-05-26 18:06:31 +0200 | [diff] [blame] | 6618 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6619 | http-response replace-header <name> <regex-match> <replace-fmt> |
| 6620 | [ { if | unless } <condition> ] |
Thierry FOURNIER | e80fada | 2015-05-26 18:06:31 +0200 | [diff] [blame] | 6621 | |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 6622 | This works like "http-request replace-header" except that it works on the |
| 6623 | server's response instead of the client's request. |
William Lallemand | 86d0df0 | 2017-11-24 21:36:45 +0100 | [diff] [blame] | 6624 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6625 | Example: |
| 6626 | http-response replace-header Set-Cookie (C=[^;]*);(.*) \1;ip=%bi;\2 |
Willy Tarreau | 51d861a | 2015-05-22 17:30:48 +0200 | [diff] [blame] | 6627 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6628 | # applied to: |
| 6629 | Set-Cookie: C=1; expires=Tue, 14-Jun-2016 01:40:45 GMT |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6630 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6631 | # outputs: |
| 6632 | Set-Cookie: C=1;ip=192.168.1.20; expires=Tue, 14-Jun-2016 01:40:45 GMT |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6633 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6634 | # assuming the backend IP is 192.168.1.20. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6635 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6636 | http-response replace-value <name> <regex-match> <replace-fmt> |
| 6637 | [ { if | unless } <condition> ] |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6638 | |
Tim Duesterhus | 6bd909b | 2020-01-17 15:53:18 +0100 | [diff] [blame] | 6639 | This works like "http-request replace-value" except that it works on the |
Tim Duesterhus | 2252beb | 2019-10-29 00:05:13 +0100 | [diff] [blame] | 6640 | server's response instead of the client's request. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 6641 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6642 | Example: |
| 6643 | http-response replace-value Cache-control ^public$ private |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 6644 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6645 | # applied to: |
| 6646 | Cache-Control: max-age=3600, public |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 6647 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6648 | # outputs: |
| 6649 | Cache-Control: max-age=3600, private |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 6650 | |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6651 | http-response return [status <code>] [content-type <type>] |
| 6652 | [ { default-errorfiles | errorfile <file> | errorfiles <name> | |
| 6653 | file <file> | lf-file <file> | string <str> | lf-string <fmt> } ] |
Christopher Faulet | 4a2c142 | 2020-01-31 17:36:01 +0100 | [diff] [blame] | 6654 | [ hdr <name> <value> ]* |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6655 | [ { if | unless } <condition> ] |
| 6656 | |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 6657 | This stops the evaluation of the rules and immediately returns a response. The |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6658 | default status code used for the response is 200. It can be optionally |
| 6659 | specified as an arguments to "status". The response content-type may also be |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 6660 | specified as an argument to "content-type". Finally the response itself may |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6661 | be defined. If can be a full HTTP response specifying the errorfile to use, |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 6662 | or the response payload specifying the file or the string to use. These rules |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6663 | are followed to create the response : |
| 6664 | |
| 6665 | * If neither the errorfile nor the payload to use is defined, a dummy |
| 6666 | response is returned. Only the "status" argument is considered. It can be |
| 6667 | any code in the range [200, 599]. The "content-type" argument, if any, is |
| 6668 | ignored. |
| 6669 | |
| 6670 | * If "default-errorfiles" argument is set, the proxy's errorfiles are |
| 6671 | considered. If the "status" argument is defined, it must be one of the |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 6672 | status code handled by haproxy (200, 400, 403, 404, 405, 408, 410, 413, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 6673 | 425, 429, 500, 502, 503, and 504). The "content-type" argument, if any, |
| 6674 | is ignored. |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6675 | |
| 6676 | * If a specific errorfile is defined, with an "errorfile" argument, the |
| 6677 | corresponding file, containing a full HTTP response, is returned. Only the |
| 6678 | "status" argument is considered. It must be one of the status code handled |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 6679 | by haproxy (200, 400, 403, 404, 405, 408, 410, 413, 425, 429, 500, 502, 503, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 6680 | and 504). The "content-type" argument, if any, is ignored. |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6681 | |
| 6682 | * If an http-errors section is defined, with an "errorfiles" argument, the |
| 6683 | corresponding file in the specified http-errors section, containing a full |
| 6684 | HTTP response, is returned. Only the "status" argument is considered. It |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 6685 | must be one of the status code handled by haproxy (200, 400, 403, 404, 405, |
Anthonin Bonnefoy | 85048f8 | 2020-06-22 09:17:01 +0200 | [diff] [blame] | 6686 | 408, 410, 413, 425, 429, 500, 502, 503, and 504). The "content-type" |
| 6687 | argument, if any, is ignored. |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6688 | |
| 6689 | * If a "file" or a "lf-file" argument is specified, the file's content is |
| 6690 | used as the response payload. If the file is not empty, its content-type |
| 6691 | must be set as argument to "content-type". Otherwise, any "content-type" |
| 6692 | argument is ignored. With a "lf-file" argument, the file's content is |
| 6693 | evaluated as a log-format string. With a "file" argument, it is considered |
| 6694 | as a raw content. |
| 6695 | |
| 6696 | * If a "string" or "lf-string" argument is specified, the defined string is |
| 6697 | used as the response payload. The content-type must always be set as |
| 6698 | argument to "content-type". With a "lf-string" argument, the string is |
| 6699 | evaluated as a log-format string. With a "string" argument, it is |
| 6700 | considered as a raw string. |
| 6701 | |
Christopher Faulet | 4a2c142 | 2020-01-31 17:36:01 +0100 | [diff] [blame] | 6702 | When the response is not based an errorfile, it is possible to appends HTTP |
| 6703 | header fields to the response using "hdr" arguments. Otherwise, all "hdr" |
| 6704 | arguments are ignored. For each one, the header name is specified in <name> |
| 6705 | and its value is defined by <fmt> which follows the log-format rules. |
| 6706 | |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6707 | Note that the generated response must be smaller than a buffer. And to avoid |
| 6708 | any warning, when an errorfile or a raw file is loaded, the buffer space |
Ilya Shipitsin | 11057a3 | 2020-06-21 21:18:27 +0500 | [diff] [blame] | 6709 | reserved to the headers rewriting should also be free. |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6710 | |
| 6711 | No further "http-response" rules are evaluated. |
| 6712 | |
| 6713 | Example: |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 6714 | http-response return errorfile /etc/haproxy/errorfiles/200.http \ |
Christopher Faulet | 24231ab | 2020-01-24 17:44:23 +0100 | [diff] [blame] | 6715 | if { status eq 404 } |
| 6716 | |
| 6717 | http-response return content-type text/plain \ |
| 6718 | string "This is the end !" \ |
| 6719 | if { status eq 500 } |
| 6720 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6721 | http-response sc-inc-gpc0(<sc-id>) [ { if | unless } <condition> ] |
| 6722 | http-response sc-inc-gpc1(<sc-id>) [ { if | unless } <condition> ] |
Ruoshan Huang | e4edc6b | 2016-07-14 15:07:45 +0800 | [diff] [blame] | 6723 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6724 | This action increments the GPC0 or GPC1 counter according with the sticky |
| 6725 | counter designated by <sc-id>. If an error occurs, this action silently fails |
| 6726 | and the actions evaluation continues. |
Thierry FOURNIER | 236657b | 2015-08-19 08:25:14 +0200 | [diff] [blame] | 6727 | |
Cédric Dufour | 0d7712d | 2019-11-06 18:38:53 +0100 | [diff] [blame] | 6728 | http-response sc-set-gpt0(<sc-id>) { <int> | <expr> } |
| 6729 | [ { if | unless } <condition> ] |
Thierry FOURNIER | e0627bd | 2015-08-04 08:20:33 +0200 | [diff] [blame] | 6730 | |
Cédric Dufour | 0d7712d | 2019-11-06 18:38:53 +0100 | [diff] [blame] | 6731 | This action sets the 32-bit unsigned GPT0 tag according to the sticky counter |
| 6732 | designated by <sc-id> and the value of <int>/<expr>. The expected result is a |
| 6733 | boolean. If an error occurs, this action silently fails and the actions |
| 6734 | evaluation continues. |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 6735 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6736 | http-response send-spoe-group [ { if | unless } <condition> ] |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 6737 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6738 | This action is used to trigger sending of a group of SPOE messages. To do so, |
| 6739 | the SPOE engine used to send messages must be defined, as well as the SPOE |
| 6740 | group to send. Of course, the SPOE engine must refer to an existing SPOE |
| 6741 | filter. If not engine name is provided on the SPOE filter line, the SPOE |
| 6742 | agent name must be used. |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 6743 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6744 | Arguments: |
| 6745 | <engine-name> The SPOE engine name. |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 6746 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6747 | <group-name> The SPOE group name as specified in the engine |
| 6748 | configuration. |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 6749 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6750 | http-response set-header <name> <fmt> [ { if | unless } <condition> ] |
Willy Tarreau | e365c0b | 2013-06-11 16:06:12 +0200 | [diff] [blame] | 6751 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6752 | This does the same as "add-header" except that the header name is first |
| 6753 | removed if it existed. This is useful when passing security information to |
| 6754 | the server, where the header must not be manipulated by external users. |
Willy Tarreau | e365c0b | 2013-06-11 16:06:12 +0200 | [diff] [blame] | 6755 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6756 | http-response set-log-level <level> [ { if | unless } <condition> ] |
| 6757 | |
| 6758 | This is used to change the log level of the current request when a certain |
| 6759 | condition is met. Valid levels are the 8 syslog levels (see the "log" |
| 6760 | keyword) plus the special level "silent" which disables logging for this |
| 6761 | request. This rule is not final so the last matching rule wins. This rule can |
| 6762 | be useful to disable health checks coming from another equipment. |
| 6763 | |
| 6764 | http-response set-map(<file-name>) <key fmt> <value fmt> |
| 6765 | |
| 6766 | This is used to add a new entry into a MAP. The MAP must be loaded from a |
| 6767 | file (even a dummy empty file). The file name of the MAP to be updated is |
| 6768 | passed between parentheses. It takes 2 arguments: <key fmt>, which follows |
| 6769 | log-format rules, used to collect MAP key, and <value fmt>, which follows |
| 6770 | log-format rules, used to collect content for the new entry. It performs a |
| 6771 | lookup in the MAP before insertion, to avoid duplicated (or more) values. |
| 6772 | This lookup is done by a linear search and can be expensive with large lists! |
| 6773 | It is the equivalent of the "set map" command from the stats socket, but can |
| 6774 | be triggered by an HTTP response. |
| 6775 | |
| 6776 | http-response set-mark <mark> [ { if | unless } <condition> ] |
| 6777 | |
| 6778 | This is used to set the Netfilter MARK on all packets sent to the client to |
| 6779 | the value passed in <mark> on platforms which support it. This value is an |
| 6780 | unsigned 32 bit value which can be matched by netfilter and by the routing |
| 6781 | table. It can be expressed both in decimal or hexadecimal format (prefixed |
| 6782 | by "0x"). This can be useful to force certain packets to take a different |
| 6783 | route (for example a cheaper network path for bulk downloads). This works on |
| 6784 | Linux kernels 2.6.32 and above and requires admin privileges. |
| 6785 | |
| 6786 | http-response set-nice <nice> [ { if | unless } <condition> ] |
| 6787 | |
| 6788 | This sets the "nice" factor of the current request being processed. |
| 6789 | It only has effect against the other requests being processed at the same |
| 6790 | time. The default value is 0, unless altered by the "nice" setting on the |
| 6791 | "bind" line. The accepted range is -1024..1024. The higher the value, the |
| 6792 | nicest the request will be. Lower values will make the request more important |
| 6793 | than other ones. This can be useful to improve the speed of some requests, or |
| 6794 | lower the priority of non-important requests. Using this setting without |
| 6795 | prior experimentation can cause some major slowdown. |
| 6796 | |
| 6797 | http-response set-status <status> [reason <str>] |
| 6798 | [ { if | unless } <condition> ] |
| 6799 | |
| 6800 | This replaces the response status code with <status> which must be an integer |
| 6801 | between 100 and 999. Optionally, a custom reason text can be provided defined |
| 6802 | by <str>, or the default reason for the specified code will be used as a |
| 6803 | fallback. |
Ruoshan Huang | eb5a363 | 2015-12-08 21:00:23 +0800 | [diff] [blame] | 6804 | |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6805 | Example: |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6806 | # return "431 Request Header Fields Too Large" |
| 6807 | http-response set-status 431 |
| 6808 | # return "503 Slow Down", custom reason |
| 6809 | http-response set-status 503 reason "Slow Down". |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6810 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6811 | http-response set-tos <tos> [ { if | unless } <condition> ] |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6812 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6813 | This is used to set the TOS or DSCP field value of packets sent to the client |
| 6814 | to the value passed in <tos> on platforms which support this. |
| 6815 | This value represents the whole 8 bits of the IP TOS field, and can be |
| 6816 | expressed both in decimal or hexadecimal format (prefixed by "0x"). Note that |
| 6817 | only the 6 higher bits are used in DSCP or TOS, and the two lower bits are |
| 6818 | always 0. This can be used to adjust some routing behavior on border routers |
| 6819 | based on some information from the request. |
| 6820 | |
| 6821 | See RFC 2474, 2597, 3260 and 4594 for more information. |
| 6822 | |
| 6823 | http-response set-var(<var-name>) <expr> [ { if | unless } <condition> ] |
| 6824 | |
| 6825 | This is used to set the contents of a variable. The variable is declared |
| 6826 | inline. |
| 6827 | |
| 6828 | Arguments: |
| 6829 | <var-name> The name of the variable starts with an indication about its |
| 6830 | scope. The scopes allowed are: |
| 6831 | "proc" : the variable is shared with the whole process |
| 6832 | "sess" : the variable is shared with the whole session |
| 6833 | "txn" : the variable is shared with the transaction |
| 6834 | (request and response) |
| 6835 | "req" : the variable is shared only during request |
| 6836 | processing |
| 6837 | "res" : the variable is shared only during response |
| 6838 | processing |
| 6839 | This prefix is followed by a name. The separator is a '.'. |
| 6840 | The name may only contain characters 'a-z', 'A-Z', '0-9', '.' |
| 6841 | and '_'. |
| 6842 | |
| 6843 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 6844 | followed by some converters. |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6845 | |
| 6846 | Example: |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6847 | http-response set-var(sess.last_redir) res.hdr(location) |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6848 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6849 | http-response silent-drop [ { if | unless } <condition> ] |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6850 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6851 | This stops the evaluation of the rules and makes the client-facing connection |
| 6852 | suddenly disappear using a system-dependent way that tries to prevent the |
| 6853 | client from being notified. The effect it then that the client still sees an |
| 6854 | established connection while there's none on HAProxy. The purpose is to |
| 6855 | achieve a comparable effect to "tarpit" except that it doesn't use any local |
| 6856 | resource at all on the machine running HAProxy. It can resist much higher |
| 6857 | loads than "tarpit", and slow down stronger attackers. It is important to |
| 6858 | understand the impact of using this mechanism. All stateful equipment placed |
| 6859 | between the client and HAProxy (firewalls, proxies, load balancers) will also |
| 6860 | keep the established connection for a long time and may suffer from this |
| 6861 | action. |
| 6862 | On modern Linux systems running with enough privileges, the TCP_REPAIR socket |
| 6863 | option is used to block the emission of a TCP reset. On other systems, the |
| 6864 | socket's TTL is reduced to 1 so that the TCP reset doesn't pass the first |
| 6865 | router, though it's still delivered to local networks. Do not use it unless |
| 6866 | you fully understand how it works. |
Baptiste Assmann | fabcbe0 | 2014-04-24 22:16:59 +0200 | [diff] [blame] | 6867 | |
Christopher Faulet | 46f9554 | 2019-12-20 10:07:22 +0100 | [diff] [blame] | 6868 | http-response strict-mode { on | off } |
| 6869 | |
| 6870 | This enables or disables the strict rewriting mode for following rules. It |
| 6871 | does not affect rules declared before it and it is only applicable on rules |
| 6872 | performing a rewrite on the responses. When the strict mode is enabled, any |
| 6873 | rewrite failure triggers an internal error. Otherwise, such errors are |
| 6874 | silently ignored. The purpose of the strict rewriting mode is to make some |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 6875 | rewrites optional while others must be performed to continue the response |
Christopher Faulet | 46f9554 | 2019-12-20 10:07:22 +0100 | [diff] [blame] | 6876 | processing. |
| 6877 | |
Christopher Faulet | 1aea50e | 2020-01-17 16:03:53 +0100 | [diff] [blame] | 6878 | By default, the strict rewriting mode is enabled. Its value is also reset |
Christopher Faulet | 46f9554 | 2019-12-20 10:07:22 +0100 | [diff] [blame] | 6879 | when a ruleset evaluation ends. So, for instance, if you change the mode on |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 6880 | the backend, the default mode is restored when HAProxy starts the frontend |
Christopher Faulet | 46f9554 | 2019-12-20 10:07:22 +0100 | [diff] [blame] | 6881 | rules evaluation. |
| 6882 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6883 | http-response track-sc0 <key> [table <table>] [ { if | unless } <condition> ] |
| 6884 | http-response track-sc1 <key> [table <table>] [ { if | unless } <condition> ] |
| 6885 | http-response track-sc2 <key> [table <table>] [ { if | unless } <condition> ] |
Willy Tarreau | e365c0b | 2013-06-11 16:06:12 +0200 | [diff] [blame] | 6886 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 6887 | This enables tracking of sticky counters from current response. Please refer |
| 6888 | to "http-request track-sc" for a complete description. The only difference |
| 6889 | from "http-request track-sc" is the <key> sample expression can only make use |
| 6890 | of samples in response (e.g. res.*, status etc.) and samples below Layer 6 |
| 6891 | (e.g. SSL-related samples, see section 7.3.4). If the sample is not |
| 6892 | supported, haproxy will fail and warn while parsing the config. |
| 6893 | |
| 6894 | http-response unset-var(<var-name>) [ { if | unless } <condition> ] |
| 6895 | |
| 6896 | This is used to unset a variable. See "http-response set-var" for details |
| 6897 | about <var-name>. |
| 6898 | |
| 6899 | Example: |
| 6900 | http-response unset-var(sess.last_redir) |
| 6901 | |
Baptiste Assmann | 5ecb77f | 2013-10-06 23:24:13 +0200 | [diff] [blame] | 6902 | |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6903 | http-reuse { never | safe | aggressive | always } |
| 6904 | Declare how idle HTTP connections may be shared between requests |
| 6905 | |
| 6906 | May be used in sections: defaults | frontend | listen | backend |
| 6907 | yes | no | yes | yes |
| 6908 | |
| 6909 | By default, a connection established between haproxy and the backend server |
Olivier Houchard | 86006a5 | 2018-12-14 19:37:49 +0100 | [diff] [blame] | 6910 | which is considered safe for reuse is moved back to the server's idle |
| 6911 | connections pool so that any other request can make use of it. This is the |
| 6912 | "safe" strategy below. |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6913 | |
| 6914 | The argument indicates the desired connection reuse strategy : |
| 6915 | |
Olivier Houchard | 86006a5 | 2018-12-14 19:37:49 +0100 | [diff] [blame] | 6916 | - "never" : idle connections are never shared between sessions. This mode |
| 6917 | may be enforced to cancel a different strategy inherited from |
| 6918 | a defaults section or for troubleshooting. For example, if an |
| 6919 | old bogus application considers that multiple requests over |
| 6920 | the same connection come from the same client and it is not |
| 6921 | possible to fix the application, it may be desirable to |
| 6922 | disable connection sharing in a single backend. An example of |
| 6923 | such an application could be an old haproxy using cookie |
| 6924 | insertion in tunnel mode and not checking any request past the |
| 6925 | first one. |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6926 | |
Olivier Houchard | 86006a5 | 2018-12-14 19:37:49 +0100 | [diff] [blame] | 6927 | - "safe" : this is the default and the recommended strategy. The first |
| 6928 | request of a session is always sent over its own connection, |
| 6929 | and only subsequent requests may be dispatched over other |
| 6930 | existing connections. This ensures that in case the server |
| 6931 | closes the connection when the request is being sent, the |
| 6932 | browser can decide to silently retry it. Since it is exactly |
| 6933 | equivalent to regular keep-alive, there should be no side |
Amaury Denoyelle | 2717965 | 2020-10-14 18:17:12 +0200 | [diff] [blame] | 6934 | effects. There is also a special handling for the connections |
| 6935 | using protocols subject to Head-of-line blocking (backend with |
| 6936 | h2 or fcgi). In this case, when at least one stream is |
| 6937 | processed, the used connection is reserved to handle streams |
| 6938 | of the same session. When no more streams are processed, the |
| 6939 | connection is released and can be reused. |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6940 | |
| 6941 | - "aggressive" : this mode may be useful in webservices environments where |
| 6942 | all servers are not necessarily known and where it would be |
| 6943 | appreciable to deliver most first requests over existing |
| 6944 | connections. In this case, first requests are only delivered |
| 6945 | over existing connections that have been reused at least once, |
| 6946 | proving that the server correctly supports connection reuse. |
| 6947 | It should only be used when it's sure that the client can |
| 6948 | retry a failed request once in a while and where the benefit |
Michael Prokop | 4438c60 | 2019-05-24 10:25:45 +0200 | [diff] [blame] | 6949 | of aggressive connection reuse significantly outweighs the |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6950 | downsides of rare connection failures. |
| 6951 | |
| 6952 | - "always" : this mode is only recommended when the path to the server is |
| 6953 | known for never breaking existing connections quickly after |
| 6954 | releasing them. It allows the first request of a session to be |
| 6955 | sent to an existing connection. This can provide a significant |
| 6956 | performance increase over the "safe" strategy when the backend |
| 6957 | is a cache farm, since such components tend to show a |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 6958 | consistent behavior and will benefit from the connection |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6959 | sharing. It is recommended that the "http-keep-alive" timeout |
| 6960 | remains low in this mode so that no dead connections remain |
| 6961 | usable. In most cases, this will lead to the same performance |
| 6962 | gains as "aggressive" but with more risks. It should only be |
| 6963 | used when it improves the situation over "aggressive". |
| 6964 | |
| 6965 | When http connection sharing is enabled, a great care is taken to respect the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 6966 | connection properties and compatibility. Specifically : |
| 6967 | - connections made with "usesrc" followed by a client-dependent value |
| 6968 | ("client", "clientip", "hdr_ip") are marked private and never shared; |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6969 | |
Amaury Denoyelle | 7239c24 | 2020-10-15 16:41:09 +0200 | [diff] [blame] | 6970 | - connections sent to a server with a variable value as TLS SNI extension |
| 6971 | are marked private and are never shared. This is not the case if the SNI |
| 6972 | is guaranteed to be a constant, as for example using a literal string; |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6973 | |
Lukas Tribus | fd9b68c | 2018-10-27 20:06:59 +0200 | [diff] [blame] | 6974 | - connections with certain bogus authentication schemes (relying on the |
| 6975 | connection) like NTLM are detected, marked private and are never shared; |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6976 | |
Lukas Tribus | e8adfeb | 2019-11-06 11:50:25 +0100 | [diff] [blame] | 6977 | A connection pool is involved and configurable with "pool-max-conn". |
Willy Tarreau | 3063195 | 2015-08-06 15:05:24 +0200 | [diff] [blame] | 6978 | |
| 6979 | Note: connection reuse improves the accuracy of the "server maxconn" setting, |
| 6980 | because almost no new connection will be established while idle connections |
| 6981 | remain available. This is particularly true with the "always" strategy. |
| 6982 | |
| 6983 | See also : "option http-keep-alive", "server maxconn" |
| 6984 | |
| 6985 | |
Mark Lamourine | c2247f0 | 2012-01-04 13:02:01 -0500 | [diff] [blame] | 6986 | http-send-name-header [<header>] |
| 6987 | Add the server name to a request. Use the header string given by <header> |
Mark Lamourine | c2247f0 | 2012-01-04 13:02:01 -0500 | [diff] [blame] | 6988 | May be used in sections: defaults | frontend | listen | backend |
| 6989 | yes | no | yes | yes |
Mark Lamourine | c2247f0 | 2012-01-04 13:02:01 -0500 | [diff] [blame] | 6990 | Arguments : |
Mark Lamourine | c2247f0 | 2012-01-04 13:02:01 -0500 | [diff] [blame] | 6991 | <header> The header string to use to send the server name |
| 6992 | |
Willy Tarreau | 81bef7e | 2019-10-07 14:58:02 +0200 | [diff] [blame] | 6993 | The "http-send-name-header" statement causes the header field named <header> |
| 6994 | to be set to the name of the target server at the moment the request is about |
| 6995 | to be sent on the wire. Any existing occurrences of this header are removed. |
| 6996 | Upon retries and redispatches, the header field is updated to always reflect |
| 6997 | the server being attempted to connect to. Given that this header is modified |
| 6998 | very late in the connection setup, it may have unexpected effects on already |
| 6999 | modified headers. For example using it with transport-level header such as |
| 7000 | connection, content-length, transfer-encoding and so on will likely result in |
| 7001 | invalid requests being sent to the server. Additionally it has been reported |
| 7002 | that this directive is currently being used as a way to overwrite the Host |
| 7003 | header field in outgoing requests; while this trick has been known to work |
| 7004 | as a side effect of the feature for some time, it is not officially supported |
| 7005 | and might possibly not work anymore in a future version depending on the |
| 7006 | technical difficulties this feature induces. A long-term solution instead |
| 7007 | consists in fixing the application which required this trick so that it binds |
| 7008 | to the correct host name. |
Mark Lamourine | c2247f0 | 2012-01-04 13:02:01 -0500 | [diff] [blame] | 7009 | |
| 7010 | See also : "server" |
| 7011 | |
Krzysztof Piotr Oledzki | f58a962 | 2008-02-23 01:19:10 +0100 | [diff] [blame] | 7012 | id <value> |
Willy Tarreau | 53fb4ae | 2009-10-04 23:04:08 +0200 | [diff] [blame] | 7013 | Set a persistent ID to a proxy. |
| 7014 | May be used in sections : defaults | frontend | listen | backend |
| 7015 | no | yes | yes | yes |
| 7016 | Arguments : none |
| 7017 | |
| 7018 | Set a persistent ID for the proxy. This ID must be unique and positive. |
| 7019 | An unused ID will automatically be assigned if unset. The first assigned |
| 7020 | value will be 1. This ID is currently only returned in statistics. |
Krzysztof Piotr Oledzki | f58a962 | 2008-02-23 01:19:10 +0100 | [diff] [blame] | 7021 | |
| 7022 | |
Cyril Bonté | 0d4bf01 | 2010-04-25 23:21:46 +0200 | [diff] [blame] | 7023 | ignore-persist { if | unless } <condition> |
| 7024 | Declare a condition to ignore persistence |
| 7025 | May be used in sections: defaults | frontend | listen | backend |
Cyril Bonté | 4288c5a | 2018-03-12 22:02:59 +0100 | [diff] [blame] | 7026 | no | no | yes | yes |
Cyril Bonté | 0d4bf01 | 2010-04-25 23:21:46 +0200 | [diff] [blame] | 7027 | |
| 7028 | By default, when cookie persistence is enabled, every requests containing |
| 7029 | the cookie are unconditionally persistent (assuming the target server is up |
| 7030 | and running). |
| 7031 | |
| 7032 | The "ignore-persist" statement allows one to declare various ACL-based |
| 7033 | conditions which, when met, will cause a request to ignore persistence. |
| 7034 | This is sometimes useful to load balance requests for static files, which |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 7035 | often don't require persistence. This can also be used to fully disable |
Cyril Bonté | 0d4bf01 | 2010-04-25 23:21:46 +0200 | [diff] [blame] | 7036 | persistence for a specific User-Agent (for example, some web crawler bots). |
| 7037 | |
Cyril Bonté | 0d4bf01 | 2010-04-25 23:21:46 +0200 | [diff] [blame] | 7038 | The persistence is ignored when an "if" condition is met, or unless an |
| 7039 | "unless" condition is met. |
| 7040 | |
Jarno Huuskonen | e5ae702 | 2017-04-03 14:36:21 +0300 | [diff] [blame] | 7041 | Example: |
| 7042 | acl url_static path_beg /static /images /img /css |
| 7043 | acl url_static path_end .gif .png .jpg .css .js |
| 7044 | ignore-persist if url_static |
| 7045 | |
Cyril Bonté | 0d4bf01 | 2010-04-25 23:21:46 +0200 | [diff] [blame] | 7046 | See also : "force-persist", "cookie", and section 7 about ACL usage. |
| 7047 | |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7048 | load-server-state-from-file { global | local | none } |
| 7049 | Allow seamless reload of HAProxy |
| 7050 | May be used in sections: defaults | frontend | listen | backend |
| 7051 | yes | no | yes | yes |
| 7052 | |
| 7053 | This directive points HAProxy to a file where server state from previous |
| 7054 | running process has been saved. That way, when starting up, before handling |
| 7055 | traffic, the new process can apply old states to servers exactly has if no |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7056 | reload occurred. The purpose of the "load-server-state-from-file" directive is |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7057 | to tell haproxy which file to use. For now, only 2 arguments to either prevent |
| 7058 | loading state or load states from a file containing all backends and servers. |
| 7059 | The state file can be generated by running the command "show servers state" |
| 7060 | over the stats socket and redirect output. |
| 7061 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7062 | The format of the file is versioned and is very specific. To understand it, |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7063 | please read the documentation of the "show servers state" command (chapter |
Willy Tarreau | 1af20c7 | 2017-06-23 16:01:14 +0200 | [diff] [blame] | 7064 | 9.3 of Management Guide). |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7065 | |
| 7066 | Arguments: |
| 7067 | global load the content of the file pointed by the global directive |
| 7068 | named "server-state-file". |
| 7069 | |
| 7070 | local load the content of the file pointed by the directive |
| 7071 | "server-state-file-name" if set. If not set, then the backend |
| 7072 | name is used as a file name. |
| 7073 | |
| 7074 | none don't load any stat for this backend |
| 7075 | |
| 7076 | Notes: |
Willy Tarreau | e5a6068 | 2016-11-09 14:54:53 +0100 | [diff] [blame] | 7077 | - server's IP address is preserved across reloads by default, but the |
| 7078 | order can be changed thanks to the server's "init-addr" setting. This |
| 7079 | means that an IP address change performed on the CLI at run time will |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7080 | be preserved, and that any change to the local resolver (e.g. /etc/hosts) |
Willy Tarreau | e5a6068 | 2016-11-09 14:54:53 +0100 | [diff] [blame] | 7081 | will possibly not have any effect if the state file is in use. |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7082 | |
| 7083 | - server's weight is applied from previous running process unless it has |
| 7084 | has changed between previous and new configuration files. |
| 7085 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 7086 | Example: Minimal configuration |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7087 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 7088 | global |
| 7089 | stats socket /tmp/socket |
| 7090 | server-state-file /tmp/server_state |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7091 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 7092 | defaults |
| 7093 | load-server-state-from-file global |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7094 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 7095 | backend bk |
| 7096 | server s1 127.0.0.1:22 check weight 11 |
| 7097 | server s2 127.0.0.1:22 check weight 12 |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7098 | |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7099 | |
| 7100 | Then one can run : |
| 7101 | |
| 7102 | socat /tmp/socket - <<< "show servers state" > /tmp/server_state |
| 7103 | |
| 7104 | Content of the file /tmp/server_state would be like this: |
| 7105 | |
| 7106 | 1 |
| 7107 | # <field names skipped for the doc example> |
| 7108 | 1 bk 1 s1 127.0.0.1 2 0 11 11 4 6 3 4 6 0 0 |
| 7109 | 1 bk 2 s2 127.0.0.1 2 0 12 12 4 6 3 4 6 0 0 |
| 7110 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 7111 | Example: Minimal configuration |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7112 | |
| 7113 | global |
| 7114 | stats socket /tmp/socket |
| 7115 | server-state-base /etc/haproxy/states |
| 7116 | |
| 7117 | defaults |
| 7118 | load-server-state-from-file local |
| 7119 | |
| 7120 | backend bk |
| 7121 | server s1 127.0.0.1:22 check weight 11 |
| 7122 | server s2 127.0.0.1:22 check weight 12 |
| 7123 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 7124 | |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 7125 | Then one can run : |
| 7126 | |
| 7127 | socat /tmp/socket - <<< "show servers state bk" > /etc/haproxy/states/bk |
| 7128 | |
| 7129 | Content of the file /etc/haproxy/states/bk would be like this: |
| 7130 | |
| 7131 | 1 |
| 7132 | # <field names skipped for the doc example> |
| 7133 | 1 bk 1 s1 127.0.0.1 2 0 11 11 4 6 3 4 6 0 0 |
| 7134 | 1 bk 2 s2 127.0.0.1 2 0 12 12 4 6 3 4 6 0 0 |
| 7135 | |
| 7136 | See also: "server-state-file", "server-state-file-name", and |
| 7137 | "show servers state" |
| 7138 | |
Cyril Bonté | 0d4bf01 | 2010-04-25 23:21:46 +0200 | [diff] [blame] | 7139 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7140 | log global |
Jan Wagner | 3e67860 | 2020-12-17 22:22:32 +0100 | [diff] [blame] | 7141 | log <address> [len <length>] [format <format>] [sample <ranges>:<sample_size>] |
Frédéric Lécaille | d690dfa | 2019-04-25 10:52:17 +0200 | [diff] [blame] | 7142 | <facility> [<level> [<minlevel>]] |
William Lallemand | 0f99e34 | 2011-10-12 17:50:54 +0200 | [diff] [blame] | 7143 | no log |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7144 | Enable per-instance logging of events and traffic. |
| 7145 | May be used in sections : defaults | frontend | listen | backend |
| 7146 | yes | yes | yes | yes |
William Lallemand | 0f99e34 | 2011-10-12 17:50:54 +0200 | [diff] [blame] | 7147 | |
| 7148 | Prefix : |
| 7149 | no should be used when the logger list must be flushed. For example, |
| 7150 | if you don't want to inherit from the default logger list. This |
| 7151 | prefix does not allow arguments. |
| 7152 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7153 | Arguments : |
| 7154 | global should be used when the instance's logging parameters are the |
| 7155 | same as the global ones. This is the most common usage. "global" |
| 7156 | replaces <address>, <facility> and <level> with those of the log |
| 7157 | entries found in the "global" section. Only one "log global" |
| 7158 | statement may be used per instance, and this form takes no other |
| 7159 | parameter. |
| 7160 | |
| 7161 | <address> indicates where to send the logs. It takes the same format as |
| 7162 | for the "global" section's logs, and can be one of : |
| 7163 | |
| 7164 | - An IPv4 address optionally followed by a colon (':') and a UDP |
| 7165 | port. If no port is specified, 514 is used by default (the |
| 7166 | standard syslog port). |
| 7167 | |
David du Colombier | 24bb5f5 | 2011-03-17 10:40:23 +0100 | [diff] [blame] | 7168 | - An IPv6 address followed by a colon (':') and optionally a UDP |
| 7169 | port. If no port is specified, 514 is used by default (the |
| 7170 | standard syslog port). |
| 7171 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7172 | - A filesystem path to a UNIX domain socket, keeping in mind |
| 7173 | considerations for chroot (be sure the path is accessible |
| 7174 | inside the chroot) and uid/gid (be sure the path is |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7175 | appropriately writable). |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7176 | |
Willy Tarreau | 5a32ecc | 2018-11-12 07:34:59 +0100 | [diff] [blame] | 7177 | - A file descriptor number in the form "fd@<number>", which may |
| 7178 | point to a pipe, terminal, or socket. In this case unbuffered |
| 7179 | logs are used and one writev() call per log is performed. This |
| 7180 | is a bit expensive but acceptable for most workloads. Messages |
| 7181 | sent this way will not be truncated but may be dropped, in |
| 7182 | which case the DroppedLogs counter will be incremented. The |
| 7183 | writev() call is atomic even on pipes for messages up to |
| 7184 | PIPE_BUF size, which POSIX recommends to be at least 512 and |
| 7185 | which is 4096 bytes on most modern operating systems. Any |
| 7186 | larger message may be interleaved with messages from other |
| 7187 | processes. Exceptionally for debugging purposes the file |
| 7188 | descriptor may also be directed to a file, but doing so will |
| 7189 | significantly slow haproxy down as non-blocking calls will be |
| 7190 | ignored. Also there will be no way to purge nor rotate this |
| 7191 | file without restarting the process. Note that the configured |
| 7192 | syslog format is preserved, so the output is suitable for use |
Willy Tarreau | c1b0645 | 2018-11-12 11:57:56 +0100 | [diff] [blame] | 7193 | with a TCP syslog server. See also the "short" and "raw" |
| 7194 | formats below. |
Willy Tarreau | 5a32ecc | 2018-11-12 07:34:59 +0100 | [diff] [blame] | 7195 | |
| 7196 | - "stdout" / "stderr", which are respectively aliases for "fd@1" |
| 7197 | and "fd@2", see above. |
| 7198 | |
Willy Tarreau | c046d16 | 2019-08-30 15:24:59 +0200 | [diff] [blame] | 7199 | - A ring buffer in the form "ring@<name>", which will correspond |
| 7200 | to an in-memory ring buffer accessible over the CLI using the |
| 7201 | "show events" command, which will also list existing rings and |
| 7202 | their sizes. Such buffers are lost on reload or restart but |
| 7203 | when used as a complement this can help troubleshooting by |
| 7204 | having the logs instantly available. |
| 7205 | |
Willy Tarreau | 5a32ecc | 2018-11-12 07:34:59 +0100 | [diff] [blame] | 7206 | You may want to reference some environment variables in the |
| 7207 | address parameter, see section 2.3 about environment variables. |
Willy Tarreau | dad36a3 | 2013-03-11 01:20:04 +0100 | [diff] [blame] | 7208 | |
Willy Tarreau | 18324f5 | 2014-06-27 18:10:07 +0200 | [diff] [blame] | 7209 | <length> is an optional maximum line length. Log lines larger than this |
| 7210 | value will be truncated before being sent. The reason is that |
| 7211 | syslog servers act differently on log line length. All servers |
| 7212 | support the default value of 1024, but some servers simply drop |
| 7213 | larger lines while others do log them. If a server supports long |
| 7214 | lines, it may make sense to set this value here in order to avoid |
| 7215 | truncating long lines. Similarly, if a server drops long lines, |
| 7216 | it is preferable to truncate them before sending them. Accepted |
| 7217 | values are 80 to 65535 inclusive. The default value of 1024 is |
| 7218 | generally fine for all standard usages. Some specific cases of |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7219 | long captures or JSON-formatted logs may require larger values. |
Willy Tarreau | 18324f5 | 2014-06-27 18:10:07 +0200 | [diff] [blame] | 7220 | |
Frédéric Lécaille | d690dfa | 2019-04-25 10:52:17 +0200 | [diff] [blame] | 7221 | <ranges> A list of comma-separated ranges to identify the logs to sample. |
| 7222 | This is used to balance the load of the logs to send to the log |
| 7223 | server. The limits of the ranges cannot be null. They are numbered |
| 7224 | from 1. The size or period (in number of logs) of the sample must |
| 7225 | be set with <sample_size> parameter. |
| 7226 | |
| 7227 | <sample_size> |
| 7228 | The size of the sample in number of logs to consider when balancing |
| 7229 | their logging loads. It is used to balance the load of the logs to |
| 7230 | send to the syslog server. This size must be greater or equal to the |
| 7231 | maximum of the high limits of the ranges. |
| 7232 | (see also <ranges> parameter). |
| 7233 | |
Willy Tarreau | adb345d | 2018-11-12 07:56:13 +0100 | [diff] [blame] | 7234 | <format> is the log format used when generating syslog messages. It may be |
| 7235 | one of the following : |
| 7236 | |
Emeric Brun | 0237c4e | 2020-11-27 16:24:34 +0100 | [diff] [blame] | 7237 | local Analog to rfc3164 syslog message format except that hostname |
| 7238 | field is stripped. This is the default. |
| 7239 | Note: option "log-send-hostname" switches the default to |
| 7240 | rfc3164. |
| 7241 | |
| 7242 | rfc3164 The RFC3164 syslog message format. |
Willy Tarreau | adb345d | 2018-11-12 07:56:13 +0100 | [diff] [blame] | 7243 | (https://tools.ietf.org/html/rfc3164) |
| 7244 | |
| 7245 | rfc5424 The RFC5424 syslog message format. |
| 7246 | (https://tools.ietf.org/html/rfc5424) |
| 7247 | |
Emeric Brun | 5464885 | 2020-07-06 15:54:06 +0200 | [diff] [blame] | 7248 | priority A message containing only a level plus syslog facility between |
| 7249 | angle brackets such as '<63>', followed by the text. The PID, |
| 7250 | date, time, process name and system name are omitted. This is |
| 7251 | designed to be used with a local log server. |
| 7252 | |
Willy Tarreau | e8746a0 | 2018-11-12 08:45:00 +0100 | [diff] [blame] | 7253 | short A message containing only a level between angle brackets such as |
| 7254 | '<3>', followed by the text. The PID, date, time, process name |
| 7255 | and system name are omitted. This is designed to be used with a |
| 7256 | local log server. This format is compatible with what the |
| 7257 | systemd logger consumes. |
| 7258 | |
Emeric Brun | 5464885 | 2020-07-06 15:54:06 +0200 | [diff] [blame] | 7259 | timed A message containing only a level between angle brackets such as |
| 7260 | '<3>', followed by ISO date and by the text. The PID, process |
| 7261 | name and system name are omitted. This is designed to be |
| 7262 | used with a local log server. |
| 7263 | |
| 7264 | iso A message containing only the ISO date, followed by the text. |
| 7265 | The PID, process name and system name are omitted. This is |
| 7266 | designed to be used with a local log server. |
| 7267 | |
Willy Tarreau | c1b0645 | 2018-11-12 11:57:56 +0100 | [diff] [blame] | 7268 | raw A message containing only the text. The level, PID, date, time, |
| 7269 | process name and system name are omitted. This is designed to |
| 7270 | be used in containers or during development, where the severity |
| 7271 | only depends on the file descriptor used (stdout/stderr). |
| 7272 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7273 | <facility> must be one of the 24 standard syslog facilities : |
| 7274 | |
Willy Tarreau | e8746a0 | 2018-11-12 08:45:00 +0100 | [diff] [blame] | 7275 | kern user mail daemon auth syslog lpr news |
| 7276 | uucp cron auth2 ftp ntp audit alert cron2 |
| 7277 | local0 local1 local2 local3 local4 local5 local6 local7 |
| 7278 | |
Willy Tarreau | c1b0645 | 2018-11-12 11:57:56 +0100 | [diff] [blame] | 7279 | Note that the facility is ignored for the "short" and "raw" |
| 7280 | formats, but still required as a positional field. It is |
| 7281 | recommended to use "daemon" in this case to make it clear that |
| 7282 | it's only supposed to be used locally. |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7283 | |
| 7284 | <level> is optional and can be specified to filter outgoing messages. By |
| 7285 | default, all messages are sent. If a level is specified, only |
| 7286 | messages with a severity at least as important as this level |
Willy Tarreau | f7edefa | 2009-05-10 17:20:05 +0200 | [diff] [blame] | 7287 | will be sent. An optional minimum level can be specified. If it |
| 7288 | is set, logs emitted with a more severe level than this one will |
| 7289 | be capped to this level. This is used to avoid sending "emerg" |
| 7290 | messages on all terminals on some default syslog configurations. |
| 7291 | Eight levels are known : |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7292 | |
| 7293 | emerg alert crit err warning notice info debug |
| 7294 | |
William Lallemand | 0f99e34 | 2011-10-12 17:50:54 +0200 | [diff] [blame] | 7295 | It is important to keep in mind that it is the frontend which decides what to |
| 7296 | log from a connection, and that in case of content switching, the log entries |
| 7297 | from the backend will be ignored. Connections are logged at level "info". |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 7298 | |
| 7299 | However, backend log declaration define how and where servers status changes |
| 7300 | will be logged. Level "notice" will be used to indicate a server going up, |
| 7301 | "warning" will be used for termination signals and definitive service |
| 7302 | termination, and "alert" will be used for when a server goes down. |
| 7303 | |
| 7304 | Note : According to RFC3164, messages are truncated to 1024 bytes before |
| 7305 | being emitted. |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7306 | |
| 7307 | Example : |
| 7308 | log global |
Willy Tarreau | c1b0645 | 2018-11-12 11:57:56 +0100 | [diff] [blame] | 7309 | log stdout format short daemon # send log to systemd |
| 7310 | log stdout format raw daemon # send everything to stdout |
| 7311 | log stderr format raw daemon notice # send important events to stderr |
Willy Tarreau | f7edefa | 2009-05-10 17:20:05 +0200 | [diff] [blame] | 7312 | log 127.0.0.1:514 local0 notice # only send important events |
| 7313 | log 127.0.0.1:514 local0 notice notice # same but limit output level |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 7314 | log "${LOCAL_SYSLOG}:514" local0 notice # send to local server |
Willy Tarreau | dad36a3 | 2013-03-11 01:20:04 +0100 | [diff] [blame] | 7315 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7316 | |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 7317 | log-format <string> |
Willy Tarreau | fb4e7ea | 2015-01-07 14:55:17 +0100 | [diff] [blame] | 7318 | Specifies the log format string to use for traffic logs |
| 7319 | May be used in sections: defaults | frontend | listen | backend |
| 7320 | yes | yes | yes | no |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 7321 | |
Willy Tarreau | fb4e7ea | 2015-01-07 14:55:17 +0100 | [diff] [blame] | 7322 | This directive specifies the log format string that will be used for all logs |
| 7323 | resulting from traffic passing through the frontend using this line. If the |
| 7324 | directive is used in a defaults section, all subsequent frontends will use |
| 7325 | the same log format. Please see section 8.2.4 which covers the log format |
| 7326 | string in depth. |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 7327 | |
Guillaume de Lafond | 29f4560 | 2017-03-31 19:52:15 +0200 | [diff] [blame] | 7328 | "log-format" directive overrides previous "option tcplog", "log-format" and |
| 7329 | "option httplog" directives. |
| 7330 | |
Dragan Dosen | 7ad3154 | 2015-09-28 17:16:47 +0200 | [diff] [blame] | 7331 | log-format-sd <string> |
| 7332 | Specifies the RFC5424 structured-data log format string |
| 7333 | May be used in sections: defaults | frontend | listen | backend |
| 7334 | yes | yes | yes | no |
| 7335 | |
| 7336 | This directive specifies the RFC5424 structured-data log format string that |
| 7337 | will be used for all logs resulting from traffic passing through the frontend |
| 7338 | using this line. If the directive is used in a defaults section, all |
| 7339 | subsequent frontends will use the same log format. Please see section 8.2.4 |
| 7340 | which covers the log format string in depth. |
| 7341 | |
| 7342 | See https://tools.ietf.org/html/rfc5424#section-6.3 for more information |
| 7343 | about the RFC5424 structured-data part. |
| 7344 | |
| 7345 | Note : This log format string will be used only for loggers that have set |
| 7346 | log format to "rfc5424". |
| 7347 | |
| 7348 | Example : |
| 7349 | log-format-sd [exampleSDID@1234\ bytes=\"%B\"\ status=\"%ST\"] |
| 7350 | |
| 7351 | |
Willy Tarreau | 094af4e | 2015-01-07 15:03:42 +0100 | [diff] [blame] | 7352 | log-tag <string> |
| 7353 | Specifies the log tag to use for all outgoing logs |
| 7354 | May be used in sections: defaults | frontend | listen | backend |
| 7355 | yes | yes | yes | yes |
| 7356 | |
| 7357 | Sets the tag field in the syslog header to this string. It defaults to the |
| 7358 | log-tag set in the global section, otherwise the program name as launched |
| 7359 | from the command line, which usually is "haproxy". Sometimes it can be useful |
| 7360 | to differentiate between multiple processes running on the same host, or to |
| 7361 | differentiate customer instances running in the same process. In the backend, |
| 7362 | logs about servers up/down will use this tag. As a hint, it can be convenient |
| 7363 | to set a log-tag related to a hosted customer in a defaults section then put |
| 7364 | all the frontends and backends for that customer, then start another customer |
| 7365 | in a new defaults section. See also the global "log-tag" directive. |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7366 | |
Willy Tarreau | c35362a | 2014-04-25 13:58:37 +0200 | [diff] [blame] | 7367 | max-keep-alive-queue <value> |
| 7368 | Set the maximum server queue size for maintaining keep-alive connections |
| 7369 | May be used in sections: defaults | frontend | listen | backend |
| 7370 | yes | no | yes | yes |
| 7371 | |
| 7372 | HTTP keep-alive tries to reuse the same server connection whenever possible, |
| 7373 | but sometimes it can be counter-productive, for example if a server has a lot |
| 7374 | of connections while other ones are idle. This is especially true for static |
| 7375 | servers. |
| 7376 | |
| 7377 | The purpose of this setting is to set a threshold on the number of queued |
| 7378 | connections at which haproxy stops trying to reuse the same server and prefers |
| 7379 | to find another one. The default value, -1, means there is no limit. A value |
| 7380 | of zero means that keep-alive requests will never be queued. For very close |
| 7381 | servers which can be reached with a low latency and which are not sensible to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7382 | breaking keep-alive, a low value is recommended (e.g. local static server can |
Willy Tarreau | c35362a | 2014-04-25 13:58:37 +0200 | [diff] [blame] | 7383 | use a value of 10 or less). For remote servers suffering from a high latency, |
| 7384 | higher values might be needed to cover for the latency and/or the cost of |
| 7385 | picking a different server. |
| 7386 | |
| 7387 | Note that this has no impact on responses which are maintained to the same |
| 7388 | server consecutively to a 401 response. They will still go to the same server |
| 7389 | even if they have to be queued. |
| 7390 | |
| 7391 | See also : "option http-server-close", "option prefer-last-server", server |
| 7392 | "maxconn" and cookie persistence. |
| 7393 | |
Olivier Houchard | a4d4fdf | 2018-12-14 19:27:06 +0100 | [diff] [blame] | 7394 | max-session-srv-conns <nb> |
| 7395 | Set the maximum number of outgoing connections we can keep idling for a given |
| 7396 | client session. The default is 5 (it precisely equals MAX_SRV_LIST which is |
| 7397 | defined at build time). |
Willy Tarreau | c35362a | 2014-04-25 13:58:37 +0200 | [diff] [blame] | 7398 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7399 | maxconn <conns> |
| 7400 | Fix the maximum number of concurrent connections on a frontend |
| 7401 | May be used in sections : defaults | frontend | listen | backend |
| 7402 | yes | yes | yes | no |
| 7403 | Arguments : |
| 7404 | <conns> is the maximum number of concurrent connections the frontend will |
| 7405 | accept to serve. Excess connections will be queued by the system |
| 7406 | in the socket's listen queue and will be served once a connection |
| 7407 | closes. |
| 7408 | |
| 7409 | If the system supports it, it can be useful on big sites to raise this limit |
| 7410 | very high so that haproxy manages connection queues, instead of leaving the |
| 7411 | clients with unanswered connection attempts. This value should not exceed the |
| 7412 | global maxconn. Also, keep in mind that a connection contains two buffers |
Baptiste Assmann | 79fb45d | 2016-03-06 23:34:31 +0100 | [diff] [blame] | 7413 | of tune.bufsize (16kB by default) each, as well as some other data resulting |
| 7414 | in about 33 kB of RAM being consumed per established connection. That means |
| 7415 | that a medium system equipped with 1GB of RAM can withstand around |
| 7416 | 20000-25000 concurrent connections if properly tuned. |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7417 | |
| 7418 | Also, when <conns> is set to large values, it is possible that the servers |
| 7419 | are not sized to accept such loads, and for this reason it is generally wise |
| 7420 | to assign them some reasonable connection limits. |
| 7421 | |
Willy Tarreau | c8d5b95 | 2019-02-27 17:25:52 +0100 | [diff] [blame] | 7422 | When this value is set to zero, which is the default, the global "maxconn" |
| 7423 | value is used. |
Vincent Bernat | 6341be5 | 2012-06-27 17:18:30 +0200 | [diff] [blame] | 7424 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7425 | See also : "server", global section's "maxconn", "fullconn" |
| 7426 | |
| 7427 | |
Willy Tarreau | 77e0dae | 2020-10-14 15:44:27 +0200 | [diff] [blame] | 7428 | mode { tcp|http } |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7429 | Set the running mode or protocol of the instance |
| 7430 | May be used in sections : defaults | frontend | listen | backend |
| 7431 | yes | yes | yes | yes |
| 7432 | Arguments : |
| 7433 | tcp The instance will work in pure TCP mode. A full-duplex connection |
| 7434 | will be established between clients and servers, and no layer 7 |
| 7435 | examination will be performed. This is the default mode. It |
| 7436 | should be used for SSL, SSH, SMTP, ... |
| 7437 | |
| 7438 | http The instance will work in HTTP mode. The client request will be |
| 7439 | analyzed in depth before connecting to any server. Any request |
| 7440 | which is not RFC-compliant will be rejected. Layer 7 filtering, |
| 7441 | processing and switching will be possible. This is the mode which |
| 7442 | brings HAProxy most of its value. |
| 7443 | |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 7444 | When doing content switching, it is mandatory that the frontend and the |
| 7445 | backend are in the same mode (generally HTTP), otherwise the configuration |
| 7446 | will be refused. |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7447 | |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 7448 | Example : |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7449 | defaults http_instances |
| 7450 | mode http |
| 7451 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7452 | |
Cyril Bonté | f0c6061 | 2010-02-06 14:44:47 +0100 | [diff] [blame] | 7453 | monitor fail { if | unless } <condition> |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7454 | Add a condition to report a failure to a monitor HTTP request. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7455 | May be used in sections : defaults | frontend | listen | backend |
| 7456 | no | yes | yes | no |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7457 | Arguments : |
| 7458 | if <cond> the monitor request will fail if the condition is satisfied, |
| 7459 | and will succeed otherwise. The condition should describe a |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 7460 | combined test which must induce a failure if all conditions |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7461 | are met, for instance a low number of servers both in a |
| 7462 | backend and its backup. |
| 7463 | |
| 7464 | unless <cond> the monitor request will succeed only if the condition is |
| 7465 | satisfied, and will fail otherwise. Such a condition may be |
| 7466 | based on a test on the presence of a minimum number of active |
| 7467 | servers in a list of backends. |
| 7468 | |
| 7469 | This statement adds a condition which can force the response to a monitor |
| 7470 | request to report a failure. By default, when an external component queries |
| 7471 | the URI dedicated to monitoring, a 200 response is returned. When one of the |
| 7472 | conditions above is met, haproxy will return 503 instead of 200. This is |
| 7473 | very useful to report a site failure to an external component which may base |
| 7474 | routing advertisements between multiple sites on the availability reported by |
| 7475 | haproxy. In this case, one would rely on an ACL involving the "nbsrv" |
Willy Tarreau | ae94d4d | 2011-05-11 16:28:49 +0200 | [diff] [blame] | 7476 | criterion. Note that "monitor fail" only works in HTTP mode. Both status |
| 7477 | messages may be tweaked using "errorfile" or "errorloc" if needed. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7478 | |
| 7479 | Example: |
| 7480 | frontend www |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7481 | mode http |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7482 | acl site_dead nbsrv(dynamic) lt 2 |
| 7483 | acl site_dead nbsrv(static) lt 2 |
| 7484 | monitor-uri /site_alive |
| 7485 | monitor fail if site_dead |
| 7486 | |
Willy Tarreau | 9e9919d | 2020-10-14 15:55:23 +0200 | [diff] [blame] | 7487 | See also : "monitor-uri", "errorfile", "errorloc" |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7488 | |
| 7489 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7490 | monitor-uri <uri> |
| 7491 | Intercept a URI used by external components' monitor requests |
| 7492 | May be used in sections : defaults | frontend | listen | backend |
| 7493 | yes | yes | yes | no |
| 7494 | Arguments : |
| 7495 | <uri> is the exact URI which we want to intercept to return HAProxy's |
| 7496 | health status instead of forwarding the request. |
| 7497 | |
| 7498 | When an HTTP request referencing <uri> will be received on a frontend, |
| 7499 | HAProxy will not forward it nor log it, but instead will return either |
| 7500 | "HTTP/1.0 200 OK" or "HTTP/1.0 503 Service unavailable", depending on failure |
| 7501 | conditions defined with "monitor fail". This is normally enough for any |
| 7502 | front-end HTTP probe to detect that the service is UP and running without |
| 7503 | forwarding the request to a backend server. Note that the HTTP method, the |
| 7504 | version and all headers are ignored, but the request must at least be valid |
| 7505 | at the HTTP level. This keyword may only be used with an HTTP-mode frontend. |
| 7506 | |
Willy Tarreau | 721d8e0 | 2017-12-01 18:25:08 +0100 | [diff] [blame] | 7507 | Monitor requests are processed very early, just after the request is parsed |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 7508 | and even before any "http-request". The only rulesets applied before are the |
| 7509 | tcp-request ones. They cannot be logged either, and it is the intended |
| 7510 | purpose. They are only used to report HAProxy's health to an upper component, |
| 7511 | nothing more. However, it is possible to add any number of conditions using |
| 7512 | "monitor fail" and ACLs so that the result can be adjusted to whatever check |
| 7513 | can be imagined (most often the number of available servers in a backend). |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7514 | |
Christopher Faulet | 6072beb | 2020-02-18 15:34:58 +0100 | [diff] [blame] | 7515 | Note: if <uri> starts by a slash ('/'), the matching is performed against the |
| 7516 | request's path instead of the request's uri. It is a workaround to let |
| 7517 | the HTTP/2 requests match the monitor-uri. Indeed, in HTTP/2, clients |
| 7518 | are encouraged to send absolute URIs only. |
| 7519 | |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7520 | Example : |
| 7521 | # Use /haproxy_test to report haproxy's status |
| 7522 | frontend www |
| 7523 | mode http |
| 7524 | monitor-uri /haproxy_test |
| 7525 | |
Willy Tarreau | 9e9919d | 2020-10-14 15:55:23 +0200 | [diff] [blame] | 7526 | See also : "monitor fail" |
Willy Tarreau | 2769aa0 | 2007-12-27 18:26:09 +0100 | [diff] [blame] | 7527 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7528 | |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7529 | option abortonclose |
| 7530 | no option abortonclose |
| 7531 | Enable or disable early dropping of aborted requests pending in queues. |
| 7532 | May be used in sections : defaults | frontend | listen | backend |
| 7533 | yes | no | yes | yes |
| 7534 | Arguments : none |
| 7535 | |
| 7536 | In presence of very high loads, the servers will take some time to respond. |
| 7537 | The per-instance connection queue will inflate, and the response time will |
| 7538 | increase respective to the size of the queue times the average per-session |
| 7539 | response time. When clients will wait for more than a few seconds, they will |
Willy Tarreau | 198a744 | 2008-01-17 12:05:32 +0100 | [diff] [blame] | 7540 | often hit the "STOP" button on their browser, leaving a useless request in |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7541 | the queue, and slowing down other users, and the servers as well, because the |
| 7542 | request will eventually be served, then aborted at the first error |
| 7543 | encountered while delivering the response. |
| 7544 | |
| 7545 | As there is no way to distinguish between a full STOP and a simple output |
| 7546 | close on the client side, HTTP agents should be conservative and consider |
| 7547 | that the client might only have closed its output channel while waiting for |
| 7548 | the response. However, this introduces risks of congestion when lots of users |
| 7549 | do the same, and is completely useless nowadays because probably no client at |
| 7550 | all will close the session while waiting for the response. Some HTTP agents |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7551 | support this behavior (Squid, Apache, HAProxy), and others do not (TUX, most |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7552 | hardware-based load balancers). So the probability for a closed input channel |
Willy Tarreau | 198a744 | 2008-01-17 12:05:32 +0100 | [diff] [blame] | 7553 | to represent a user hitting the "STOP" button is close to 100%, and the risk |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7554 | of being the single component to break rare but valid traffic is extremely |
| 7555 | low, which adds to the temptation to be able to abort a session early while |
| 7556 | still not served and not pollute the servers. |
| 7557 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7558 | In HAProxy, the user can choose the desired behavior using the option |
| 7559 | "abortonclose". By default (without the option) the behavior is HTTP |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7560 | compliant and aborted requests will be served. But when the option is |
| 7561 | specified, a session with an incoming channel closed will be aborted while |
| 7562 | it is still possible, either pending in the queue for a connection slot, or |
| 7563 | during the connection establishment if the server has not yet acknowledged |
| 7564 | the connection request. This considerably reduces the queue size and the load |
| 7565 | on saturated servers when users are tempted to click on STOP, which in turn |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 7566 | reduces the response time for other users. |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7567 | |
| 7568 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7569 | in a specific instance by prepending the "no" keyword before it. |
| 7570 | |
| 7571 | See also : "timeout queue" and server's "maxconn" and "maxqueue" parameters |
| 7572 | |
| 7573 | |
Willy Tarreau | 4076a15 | 2009-04-02 15:18:36 +0200 | [diff] [blame] | 7574 | option accept-invalid-http-request |
| 7575 | no option accept-invalid-http-request |
| 7576 | Enable or disable relaxing of HTTP request parsing |
| 7577 | May be used in sections : defaults | frontend | listen | backend |
| 7578 | yes | yes | yes | no |
| 7579 | Arguments : none |
| 7580 | |
Willy Tarreau | 91852eb | 2015-05-01 13:26:00 +0200 | [diff] [blame] | 7581 | By default, HAProxy complies with RFC7230 in terms of message parsing. This |
Willy Tarreau | 4076a15 | 2009-04-02 15:18:36 +0200 | [diff] [blame] | 7582 | means that invalid characters in header names are not permitted and cause an |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7583 | error to be returned to the client. This is the desired behavior as such |
Willy Tarreau | 4076a15 | 2009-04-02 15:18:36 +0200 | [diff] [blame] | 7584 | forbidden characters are essentially used to build attacks exploiting server |
| 7585 | weaknesses, and bypass security filtering. Sometimes, a buggy browser or |
| 7586 | server will emit invalid header names for whatever reason (configuration, |
| 7587 | implementation) and the issue will not be immediately fixed. In such a case, |
| 7588 | it is possible to relax HAProxy's header name parser to accept any character |
Willy Tarreau | 422246e | 2012-01-07 23:54:13 +0100 | [diff] [blame] | 7589 | even if that does not make sense, by specifying this option. Similarly, the |
| 7590 | list of characters allowed to appear in a URI is well defined by RFC3986, and |
| 7591 | chars 0-31, 32 (space), 34 ('"'), 60 ('<'), 62 ('>'), 92 ('\'), 94 ('^'), 96 |
| 7592 | ('`'), 123 ('{'), 124 ('|'), 125 ('}'), 127 (delete) and anything above are |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7593 | not allowed at all. HAProxy always blocks a number of them (0..32, 127). The |
Willy Tarreau | 91852eb | 2015-05-01 13:26:00 +0200 | [diff] [blame] | 7594 | remaining ones are blocked by default unless this option is enabled. This |
Willy Tarreau | 1331766 | 2015-05-01 13:47:08 +0200 | [diff] [blame] | 7595 | option also relaxes the test on the HTTP version, it allows HTTP/0.9 requests |
| 7596 | to pass through (no version specified) and multiple digits for both the major |
| 7597 | and the minor version. |
Willy Tarreau | 4076a15 | 2009-04-02 15:18:36 +0200 | [diff] [blame] | 7598 | |
| 7599 | This option should never be enabled by default as it hides application bugs |
| 7600 | and open security breaches. It should only be deployed after a problem has |
| 7601 | been confirmed. |
| 7602 | |
| 7603 | When this option is enabled, erroneous header names will still be accepted in |
| 7604 | requests, but the complete request will be captured in order to permit later |
Willy Tarreau | 422246e | 2012-01-07 23:54:13 +0100 | [diff] [blame] | 7605 | analysis using the "show errors" request on the UNIX stats socket. Similarly, |
| 7606 | requests containing invalid chars in the URI part will be logged. Doing this |
Willy Tarreau | 4076a15 | 2009-04-02 15:18:36 +0200 | [diff] [blame] | 7607 | also helps confirming that the issue has been solved. |
| 7608 | |
| 7609 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7610 | in a specific instance by prepending the "no" keyword before it. |
| 7611 | |
| 7612 | See also : "option accept-invalid-http-response" and "show errors" on the |
| 7613 | stats socket. |
| 7614 | |
| 7615 | |
| 7616 | option accept-invalid-http-response |
| 7617 | no option accept-invalid-http-response |
| 7618 | Enable or disable relaxing of HTTP response parsing |
| 7619 | May be used in sections : defaults | frontend | listen | backend |
| 7620 | yes | no | yes | yes |
| 7621 | Arguments : none |
| 7622 | |
Willy Tarreau | 91852eb | 2015-05-01 13:26:00 +0200 | [diff] [blame] | 7623 | By default, HAProxy complies with RFC7230 in terms of message parsing. This |
Willy Tarreau | 4076a15 | 2009-04-02 15:18:36 +0200 | [diff] [blame] | 7624 | means that invalid characters in header names are not permitted and cause an |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7625 | error to be returned to the client. This is the desired behavior as such |
Willy Tarreau | 4076a15 | 2009-04-02 15:18:36 +0200 | [diff] [blame] | 7626 | forbidden characters are essentially used to build attacks exploiting server |
| 7627 | weaknesses, and bypass security filtering. Sometimes, a buggy browser or |
| 7628 | server will emit invalid header names for whatever reason (configuration, |
| 7629 | implementation) and the issue will not be immediately fixed. In such a case, |
| 7630 | it is possible to relax HAProxy's header name parser to accept any character |
Willy Tarreau | 91852eb | 2015-05-01 13:26:00 +0200 | [diff] [blame] | 7631 | even if that does not make sense, by specifying this option. This option also |
| 7632 | relaxes the test on the HTTP version format, it allows multiple digits for |
| 7633 | both the major and the minor version. |
Willy Tarreau | 4076a15 | 2009-04-02 15:18:36 +0200 | [diff] [blame] | 7634 | |
| 7635 | This option should never be enabled by default as it hides application bugs |
| 7636 | and open security breaches. It should only be deployed after a problem has |
| 7637 | been confirmed. |
| 7638 | |
| 7639 | When this option is enabled, erroneous header names will still be accepted in |
| 7640 | responses, but the complete response will be captured in order to permit |
| 7641 | later analysis using the "show errors" request on the UNIX stats socket. |
| 7642 | Doing this also helps confirming that the issue has been solved. |
| 7643 | |
| 7644 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7645 | in a specific instance by prepending the "no" keyword before it. |
| 7646 | |
| 7647 | See also : "option accept-invalid-http-request" and "show errors" on the |
| 7648 | stats socket. |
| 7649 | |
| 7650 | |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7651 | option allbackups |
| 7652 | no option allbackups |
| 7653 | Use either all backup servers at a time or only the first one |
| 7654 | May be used in sections : defaults | frontend | listen | backend |
| 7655 | yes | no | yes | yes |
| 7656 | Arguments : none |
| 7657 | |
| 7658 | By default, the first operational backup server gets all traffic when normal |
| 7659 | servers are all down. Sometimes, it may be preferred to use multiple backups |
| 7660 | at once, because one will not be enough. When "option allbackups" is enabled, |
| 7661 | the load balancing will be performed among all backup servers when all normal |
| 7662 | ones are unavailable. The same load balancing algorithm will be used and the |
| 7663 | servers' weights will be respected. Thus, there will not be any priority |
| 7664 | order between the backup servers anymore. |
| 7665 | |
| 7666 | This option is mostly used with static server farms dedicated to return a |
| 7667 | "sorry" page when an application is completely offline. |
| 7668 | |
| 7669 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7670 | in a specific instance by prepending the "no" keyword before it. |
| 7671 | |
| 7672 | |
| 7673 | option checkcache |
| 7674 | no option checkcache |
Godbach | 7056a35 | 2013-12-11 20:01:07 +0800 | [diff] [blame] | 7675 | Analyze all server responses and block responses with cacheable cookies |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7676 | May be used in sections : defaults | frontend | listen | backend |
| 7677 | yes | no | yes | yes |
| 7678 | Arguments : none |
| 7679 | |
| 7680 | Some high-level frameworks set application cookies everywhere and do not |
| 7681 | always let enough control to the developer to manage how the responses should |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 7682 | be cached. When a session cookie is returned on a cacheable object, there is a |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7683 | high risk of session crossing or stealing between users traversing the same |
| 7684 | caches. In some situations, it is better to block the response than to let |
Willy Tarreau | 3c92c5f | 2011-08-28 09:45:47 +0200 | [diff] [blame] | 7685 | some sensitive session information go in the wild. |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7686 | |
| 7687 | The option "checkcache" enables deep inspection of all server responses for |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 7688 | strict compliance with HTTP specification in terms of cacheability. It |
Willy Tarreau | 198a744 | 2008-01-17 12:05:32 +0100 | [diff] [blame] | 7689 | carefully checks "Cache-control", "Pragma" and "Set-cookie" headers in server |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7690 | response to check if there's a risk of caching a cookie on a client-side |
| 7691 | proxy. When this option is enabled, the only responses which can be delivered |
Willy Tarreau | 198a744 | 2008-01-17 12:05:32 +0100 | [diff] [blame] | 7692 | to the client are : |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7693 | - all those without "Set-Cookie" header; |
Willy Tarreau | c55ddce | 2017-12-21 11:41:38 +0100 | [diff] [blame] | 7694 | - all those with a return code other than 200, 203, 204, 206, 300, 301, |
| 7695 | 404, 405, 410, 414, 501, provided that the server has not set a |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7696 | "Cache-control: public" header field; |
Willy Tarreau | 24ea0bc | 2017-12-21 11:32:55 +0100 | [diff] [blame] | 7697 | - all those that result from a request using a method other than GET, HEAD, |
| 7698 | OPTIONS, TRACE, provided that the server has not set a 'Cache-Control: |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7699 | public' header field; |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7700 | - those with a 'Pragma: no-cache' header |
| 7701 | - those with a 'Cache-control: private' header |
| 7702 | - those with a 'Cache-control: no-store' header |
| 7703 | - those with a 'Cache-control: max-age=0' header |
| 7704 | - those with a 'Cache-control: s-maxage=0' header |
| 7705 | - those with a 'Cache-control: no-cache' header |
| 7706 | - those with a 'Cache-control: no-cache="set-cookie"' header |
| 7707 | - those with a 'Cache-control: no-cache="set-cookie,' header |
| 7708 | (allowing other fields after set-cookie) |
| 7709 | |
| 7710 | If a response doesn't respect these requirements, then it will be blocked |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 7711 | just as if it was from an "http-response deny" rule, with an "HTTP 502 bad |
| 7712 | gateway". The session state shows "PH--" meaning that the proxy blocked the |
| 7713 | response during headers processing. Additionally, an alert will be sent in |
| 7714 | the logs so that admins are informed that there's something to be fixed. |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7715 | |
| 7716 | Due to the high impact on the application, the application should be tested |
| 7717 | in depth with the option enabled before going to production. It is also a |
Willy Tarreau | d2a4aa2 | 2008-01-31 15:28:22 +0100 | [diff] [blame] | 7718 | good practice to always activate it during tests, even if it is not used in |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7719 | production, as it will report potentially dangerous application behaviors. |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7720 | |
| 7721 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7722 | in a specific instance by prepending the "no" keyword before it. |
| 7723 | |
| 7724 | |
| 7725 | option clitcpka |
| 7726 | no option clitcpka |
| 7727 | Enable or disable the sending of TCP keepalive packets on the client side |
| 7728 | May be used in sections : defaults | frontend | listen | backend |
| 7729 | yes | yes | yes | no |
| 7730 | Arguments : none |
| 7731 | |
| 7732 | When there is a firewall or any session-aware component between a client and |
| 7733 | a server, and when the protocol involves very long sessions with long idle |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7734 | periods (e.g. remote desktops), there is a risk that one of the intermediate |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7735 | components decides to expire a session which has remained idle for too long. |
| 7736 | |
| 7737 | Enabling socket-level TCP keep-alives makes the system regularly send packets |
| 7738 | to the other end of the connection, leaving it active. The delay between |
| 7739 | keep-alive probes is controlled by the system only and depends both on the |
| 7740 | operating system and its tuning parameters. |
| 7741 | |
| 7742 | It is important to understand that keep-alive packets are neither emitted nor |
| 7743 | received at the application level. It is only the network stacks which sees |
| 7744 | them. For this reason, even if one side of the proxy already uses keep-alives |
| 7745 | to maintain its connection alive, those keep-alive packets will not be |
| 7746 | forwarded to the other side of the proxy. |
| 7747 | |
| 7748 | Please note that this has nothing to do with HTTP keep-alive. |
| 7749 | |
| 7750 | Using option "clitcpka" enables the emission of TCP keep-alive probes on the |
| 7751 | client side of a connection, which should help when session expirations are |
| 7752 | noticed between HAProxy and a client. |
| 7753 | |
| 7754 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7755 | in a specific instance by prepending the "no" keyword before it. |
| 7756 | |
| 7757 | See also : "option srvtcpka", "option tcpka" |
| 7758 | |
| 7759 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7760 | option contstats |
| 7761 | Enable continuous traffic statistics updates |
| 7762 | May be used in sections : defaults | frontend | listen | backend |
| 7763 | yes | yes | yes | no |
| 7764 | Arguments : none |
| 7765 | |
| 7766 | By default, counters used for statistics calculation are incremented |
| 7767 | only when a session finishes. It works quite well when serving small |
| 7768 | objects, but with big ones (for example large images or archives) or |
| 7769 | with A/V streaming, a graph generated from haproxy counters looks like |
Willy Tarreau | def0d22 | 2016-11-08 22:03:00 +0100 | [diff] [blame] | 7770 | a hedgehog. With this option enabled counters get incremented frequently |
| 7771 | along the session, typically every 5 seconds, which is often enough to |
| 7772 | produce clean graphs. Recounting touches a hotpath directly so it is not |
| 7773 | not enabled by default, as it can cause a lot of wakeups for very large |
| 7774 | session counts and cause a small performance drop. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7775 | |
Christopher Faulet | 89aed32 | 2020-06-02 17:33:56 +0200 | [diff] [blame] | 7776 | option disable-h2-upgrade |
| 7777 | no option disable-h2-upgrade |
| 7778 | Enable or disable the implicit HTTP/2 upgrade from an HTTP/1.x client |
| 7779 | connection. |
| 7780 | May be used in sections : defaults | frontend | listen | backend |
| 7781 | yes | yes | yes | no |
| 7782 | Arguments : none |
| 7783 | |
| 7784 | By default, HAProxy is able to implicitly upgrade an HTTP/1.x client |
| 7785 | connection to an HTTP/2 connection if the first request it receives from a |
| 7786 | given HTTP connection matches the HTTP/2 connection preface (i.e. the string |
| 7787 | "PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n"). This way, it is possible to support |
| 7788 | HTTP/1.x and HTTP/2 clients on a non-SSL connections. This option must be used to |
| 7789 | disable the implicit upgrade. Note this implicit upgrade is only supported |
| 7790 | for HTTP proxies, thus this option too. Note also it is possible to force the |
| 7791 | HTTP/2 on clear connections by specifying "proto h2" on the bind line. |
| 7792 | |
| 7793 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7794 | in a specific instance by prepending the "no" keyword before it. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 7795 | |
Willy Tarreau | c9bd0cc | 2009-05-10 11:57:02 +0200 | [diff] [blame] | 7796 | option dontlog-normal |
| 7797 | no option dontlog-normal |
| 7798 | Enable or disable logging of normal, successful connections |
| 7799 | May be used in sections : defaults | frontend | listen | backend |
| 7800 | yes | yes | yes | no |
| 7801 | Arguments : none |
| 7802 | |
| 7803 | There are large sites dealing with several thousand connections per second |
| 7804 | and for which logging is a major pain. Some of them are even forced to turn |
| 7805 | logs off and cannot debug production issues. Setting this option ensures that |
| 7806 | normal connections, those which experience no error, no timeout, no retry nor |
| 7807 | redispatch, will not be logged. This leaves disk space for anomalies. In HTTP |
| 7808 | mode, the response status code is checked and return codes 5xx will still be |
| 7809 | logged. |
| 7810 | |
| 7811 | It is strongly discouraged to use this option as most of the time, the key to |
| 7812 | complex issues is in the normal logs which will not be logged here. If you |
| 7813 | need to separate logs, see the "log-separate-errors" option instead. |
| 7814 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 7815 | See also : "log", "dontlognull", "log-separate-errors" and section 8 about |
Willy Tarreau | c9bd0cc | 2009-05-10 11:57:02 +0200 | [diff] [blame] | 7816 | logging. |
| 7817 | |
| 7818 | |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7819 | option dontlognull |
| 7820 | no option dontlognull |
| 7821 | Enable or disable logging of null connections |
| 7822 | May be used in sections : defaults | frontend | listen | backend |
| 7823 | yes | yes | yes | no |
| 7824 | Arguments : none |
| 7825 | |
| 7826 | In certain environments, there are components which will regularly connect to |
| 7827 | various systems to ensure that they are still alive. It can be the case from |
| 7828 | another load balancer as well as from monitoring systems. By default, even a |
| 7829 | simple port probe or scan will produce a log. If those connections pollute |
| 7830 | the logs too much, it is possible to enable option "dontlognull" to indicate |
| 7831 | that a connection on which no data has been transferred will not be logged, |
Willy Tarreau | 0f228a0 | 2015-05-01 15:37:53 +0200 | [diff] [blame] | 7832 | which typically corresponds to those probes. Note that errors will still be |
| 7833 | returned to the client and accounted for in the stats. If this is not what is |
| 7834 | desired, option http-ignore-probes can be used instead. |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7835 | |
| 7836 | It is generally recommended not to use this option in uncontrolled |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7837 | environments (e.g. internet), otherwise scans and other malicious activities |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7838 | would not be logged. |
| 7839 | |
| 7840 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7841 | in a specific instance by prepending the "no" keyword before it. |
| 7842 | |
Willy Tarreau | 9e9919d | 2020-10-14 15:55:23 +0200 | [diff] [blame] | 7843 | See also : "log", "http-ignore-probes", "monitor-uri", and |
Willy Tarreau | 0f228a0 | 2015-05-01 15:37:53 +0200 | [diff] [blame] | 7844 | section 8 about logging. |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7845 | |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 7846 | |
Willy Tarreau | 87cf514 | 2011-08-19 22:57:24 +0200 | [diff] [blame] | 7847 | option forwardfor [ except <network> ] [ header <name> ] [ if-none ] |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 7848 | Enable insertion of the X-Forwarded-For header to requests sent to servers |
| 7849 | May be used in sections : defaults | frontend | listen | backend |
| 7850 | yes | yes | yes | yes |
| 7851 | Arguments : |
| 7852 | <network> is an optional argument used to disable this option for sources |
| 7853 | matching <network> |
Ross West | af72a1d | 2008-08-03 10:51:45 +0200 | [diff] [blame] | 7854 | <name> an optional argument to specify a different "X-Forwarded-For" |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 7855 | header name. |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 7856 | |
| 7857 | Since HAProxy works in reverse-proxy mode, the servers see its IP address as |
| 7858 | their client address. This is sometimes annoying when the client's IP address |
| 7859 | is expected in server logs. To solve this problem, the well-known HTTP header |
| 7860 | "X-Forwarded-For" may be added by HAProxy to all requests sent to the server. |
| 7861 | This header contains a value representing the client's IP address. Since this |
| 7862 | header is always appended at the end of the existing header list, the server |
| 7863 | must be configured to always use the last occurrence of this header only. See |
Ross West | af72a1d | 2008-08-03 10:51:45 +0200 | [diff] [blame] | 7864 | the server's manual to find how to enable use of this standard header. Note |
| 7865 | that only the last occurrence of the header must be used, since it is really |
| 7866 | possible that the client has already brought one. |
| 7867 | |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 7868 | The keyword "header" may be used to supply a different header name to replace |
Ross West | af72a1d | 2008-08-03 10:51:45 +0200 | [diff] [blame] | 7869 | the default "X-Forwarded-For". This can be useful where you might already |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7870 | have a "X-Forwarded-For" header from a different application (e.g. stunnel), |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 7871 | and you need preserve it. Also if your backend server doesn't use the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 7872 | "X-Forwarded-For" header and requires different one (e.g. Zeus Web Servers |
Ross West | af72a1d | 2008-08-03 10:51:45 +0200 | [diff] [blame] | 7873 | require "X-Cluster-Client-IP"). |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 7874 | |
| 7875 | Sometimes, a same HAProxy instance may be shared between a direct client |
| 7876 | access and a reverse-proxy access (for instance when an SSL reverse-proxy is |
| 7877 | used to decrypt HTTPS traffic). It is possible to disable the addition of the |
| 7878 | header for a known source address or network by adding the "except" keyword |
| 7879 | followed by the network address. In this case, any source IP matching the |
| 7880 | network will not cause an addition of this header. Most common uses are with |
| 7881 | private networks or 127.0.0.1. |
| 7882 | |
Willy Tarreau | 87cf514 | 2011-08-19 22:57:24 +0200 | [diff] [blame] | 7883 | Alternatively, the keyword "if-none" states that the header will only be |
| 7884 | added if it is not present. This should only be used in perfectly trusted |
| 7885 | environment, as this might cause a security issue if headers reaching haproxy |
| 7886 | are under the control of the end-user. |
| 7887 | |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 7888 | This option may be specified either in the frontend or in the backend. If at |
Ross West | af72a1d | 2008-08-03 10:51:45 +0200 | [diff] [blame] | 7889 | least one of them uses it, the header will be added. Note that the backend's |
| 7890 | setting of the header subargument takes precedence over the frontend's if |
Willy Tarreau | 87cf514 | 2011-08-19 22:57:24 +0200 | [diff] [blame] | 7891 | both are defined. In the case of the "if-none" argument, if at least one of |
| 7892 | the frontend or the backend does not specify it, it wants the addition to be |
| 7893 | mandatory, so it wins. |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 7894 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 7895 | Example : |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 7896 | # Public HTTP address also used by stunnel on the same machine |
| 7897 | frontend www |
| 7898 | mode http |
| 7899 | option forwardfor except 127.0.0.1 # stunnel already adds the header |
| 7900 | |
Ross West | af72a1d | 2008-08-03 10:51:45 +0200 | [diff] [blame] | 7901 | # Those servers want the IP Address in X-Client |
| 7902 | backend www |
| 7903 | mode http |
| 7904 | option forwardfor header X-Client |
| 7905 | |
Willy Tarreau | 87cf514 | 2011-08-19 22:57:24 +0200 | [diff] [blame] | 7906 | See also : "option httpclose", "option http-server-close", |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 7907 | "option http-keep-alive" |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 7908 | |
Willy Tarreau | 8a8e1d9 | 2010-04-05 16:15:16 +0200 | [diff] [blame] | 7909 | |
Christopher Faulet | 98fbe95 | 2019-07-22 16:18:24 +0200 | [diff] [blame] | 7910 | option h1-case-adjust-bogus-client |
| 7911 | no option h1-case-adjust-bogus-client |
| 7912 | Enable or disable the case adjustment of HTTP/1 headers sent to bogus clients |
| 7913 | May be used in sections : defaults | frontend | listen | backend |
| 7914 | yes | yes | yes | no |
| 7915 | Arguments : none |
| 7916 | |
| 7917 | There is no standard case for header names because, as stated in RFC7230, |
| 7918 | they are case-insensitive. So applications must handle them in a case- |
| 7919 | insensitive manner. But some bogus applications violate the standards and |
| 7920 | erroneously rely on the cases most commonly used by browsers. This problem |
| 7921 | becomes critical with HTTP/2 because all header names must be exchanged in |
| 7922 | lower case, and HAProxy follows the same convention. All header names are |
| 7923 | sent in lower case to clients and servers, regardless of the HTTP version. |
| 7924 | |
| 7925 | When HAProxy receives an HTTP/1 response, its header names are converted to |
| 7926 | lower case and manipulated and sent this way to the clients. If a client is |
| 7927 | known to violate the HTTP standards and to fail to process a response coming |
| 7928 | from HAProxy, it is possible to transform the lower case header names to a |
| 7929 | different format when the response is formatted and sent to the client, by |
| 7930 | enabling this option and specifying the list of headers to be reformatted |
| 7931 | using the global directives "h1-case-adjust" or "h1-case-adjust-file". This |
| 7932 | must only be a temporary workaround for the time it takes the client to be |
| 7933 | fixed, because clients which require such workarounds might be vulnerable to |
| 7934 | content smuggling attacks and must absolutely be fixed. |
| 7935 | |
| 7936 | Please note that this option will not affect standards-compliant clients. |
| 7937 | |
| 7938 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7939 | in a specific instance by prepending the "no" keyword before it. |
| 7940 | |
| 7941 | See also: "option h1-case-adjust-bogus-server", "h1-case-adjust", |
| 7942 | "h1-case-adjust-file". |
| 7943 | |
| 7944 | |
| 7945 | option h1-case-adjust-bogus-server |
| 7946 | no option h1-case-adjust-bogus-server |
| 7947 | Enable or disable the case adjustment of HTTP/1 headers sent to bogus servers |
| 7948 | May be used in sections : defaults | frontend | listen | backend |
| 7949 | yes | no | yes | yes |
| 7950 | Arguments : none |
| 7951 | |
| 7952 | There is no standard case for header names because, as stated in RFC7230, |
| 7953 | they are case-insensitive. So applications must handle them in a case- |
| 7954 | insensitive manner. But some bogus applications violate the standards and |
| 7955 | erroneously rely on the cases most commonly used by browsers. This problem |
| 7956 | becomes critical with HTTP/2 because all header names must be exchanged in |
| 7957 | lower case, and HAProxy follows the same convention. All header names are |
| 7958 | sent in lower case to clients and servers, regardless of the HTTP version. |
| 7959 | |
| 7960 | When HAProxy receives an HTTP/1 request, its header names are converted to |
| 7961 | lower case and manipulated and sent this way to the servers. If a server is |
| 7962 | known to violate the HTTP standards and to fail to process a request coming |
| 7963 | from HAProxy, it is possible to transform the lower case header names to a |
| 7964 | different format when the request is formatted and sent to the server, by |
| 7965 | enabling this option and specifying the list of headers to be reformatted |
| 7966 | using the global directives "h1-case-adjust" or "h1-case-adjust-file". This |
| 7967 | must only be a temporary workaround for the time it takes the server to be |
| 7968 | fixed, because servers which require such workarounds might be vulnerable to |
| 7969 | content smuggling attacks and must absolutely be fixed. |
| 7970 | |
| 7971 | Please note that this option will not affect standards-compliant servers. |
| 7972 | |
| 7973 | If this option has been enabled in a "defaults" section, it can be disabled |
| 7974 | in a specific instance by prepending the "no" keyword before it. |
| 7975 | |
| 7976 | See also: "option h1-case-adjust-bogus-client", "h1-case-adjust", |
| 7977 | "h1-case-adjust-file". |
| 7978 | |
| 7979 | |
Willy Tarreau | 9fbe18e | 2015-05-01 22:42:08 +0200 | [diff] [blame] | 7980 | option http-buffer-request |
| 7981 | no option http-buffer-request |
| 7982 | Enable or disable waiting for whole HTTP request body before proceeding |
| 7983 | May be used in sections : defaults | frontend | listen | backend |
| 7984 | yes | yes | yes | yes |
| 7985 | Arguments : none |
| 7986 | |
| 7987 | It is sometimes desirable to wait for the body of an HTTP request before |
| 7988 | taking a decision. This is what is being done by "balance url_param" for |
| 7989 | example. The first use case is to buffer requests from slow clients before |
| 7990 | connecting to the server. Another use case consists in taking the routing |
| 7991 | decision based on the request body's contents. This option placed in a |
| 7992 | frontend or backend forces the HTTP processing to wait until either the whole |
Christopher Faulet | 6db8a2e | 2019-11-19 16:27:25 +0100 | [diff] [blame] | 7993 | body is received or the request buffer is full. It can have undesired side |
| 7994 | effects with some applications abusing HTTP by expecting unbuffered |
| 7995 | transmissions between the frontend and the backend, so this should definitely |
| 7996 | not be used by default. |
Willy Tarreau | 9fbe18e | 2015-05-01 22:42:08 +0200 | [diff] [blame] | 7997 | |
Baptiste Assmann | eccdf43 | 2015-10-28 13:49:01 +0100 | [diff] [blame] | 7998 | See also : "option http-no-delay", "timeout http-request" |
Willy Tarreau | 9fbe18e | 2015-05-01 22:42:08 +0200 | [diff] [blame] | 7999 | |
| 8000 | |
Willy Tarreau | 0f228a0 | 2015-05-01 15:37:53 +0200 | [diff] [blame] | 8001 | option http-ignore-probes |
| 8002 | no option http-ignore-probes |
| 8003 | Enable or disable logging of null connections and request timeouts |
| 8004 | May be used in sections : defaults | frontend | listen | backend |
| 8005 | yes | yes | yes | no |
| 8006 | Arguments : none |
| 8007 | |
| 8008 | Recently some browsers started to implement a "pre-connect" feature |
| 8009 | consisting in speculatively connecting to some recently visited web sites |
| 8010 | just in case the user would like to visit them. This results in many |
| 8011 | connections being established to web sites, which end up in 408 Request |
| 8012 | Timeout if the timeout strikes first, or 400 Bad Request when the browser |
| 8013 | decides to close them first. These ones pollute the log and feed the error |
| 8014 | counters. There was already "option dontlognull" but it's insufficient in |
| 8015 | this case. Instead, this option does the following things : |
| 8016 | - prevent any 400/408 message from being sent to the client if nothing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8017 | was received over a connection before it was closed; |
| 8018 | - prevent any log from being emitted in this situation; |
Willy Tarreau | 0f228a0 | 2015-05-01 15:37:53 +0200 | [diff] [blame] | 8019 | - prevent any error counter from being incremented |
| 8020 | |
| 8021 | That way the empty connection is silently ignored. Note that it is better |
| 8022 | not to use this unless it is clear that it is needed, because it will hide |
| 8023 | real problems. The most common reason for not receiving a request and seeing |
| 8024 | a 408 is due to an MTU inconsistency between the client and an intermediary |
| 8025 | element such as a VPN, which blocks too large packets. These issues are |
| 8026 | generally seen with POST requests as well as GET with large cookies. The logs |
| 8027 | are often the only way to detect them. |
| 8028 | |
| 8029 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8030 | in a specific instance by prepending the "no" keyword before it. |
| 8031 | |
| 8032 | See also : "log", "dontlognull", "errorfile", and section 8 about logging. |
| 8033 | |
| 8034 | |
Willy Tarreau | 16bfb02 | 2010-01-16 19:48:41 +0100 | [diff] [blame] | 8035 | option http-keep-alive |
| 8036 | no option http-keep-alive |
| 8037 | Enable or disable HTTP keep-alive from client to server |
| 8038 | May be used in sections : defaults | frontend | listen | backend |
| 8039 | yes | yes | yes | yes |
| 8040 | Arguments : none |
| 8041 | |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 8042 | By default HAProxy operates in keep-alive mode with regards to persistent |
| 8043 | connections: for each connection it processes each request and response, and |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8044 | leaves the connection idle on both sides between the end of a response and |
| 8045 | the start of a new request. This mode may be changed by several options such |
Christopher Faulet | 159e667 | 2019-07-16 15:09:52 +0200 | [diff] [blame] | 8046 | as "option http-server-close" or "option httpclose". This option allows to |
| 8047 | set back the keep-alive mode, which can be useful when another mode was used |
| 8048 | in a defaults section. |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 8049 | |
| 8050 | Setting "option http-keep-alive" enables HTTP keep-alive mode on the client- |
| 8051 | and server- sides. This provides the lowest latency on the client side (slow |
Willy Tarreau | 16bfb02 | 2010-01-16 19:48:41 +0100 | [diff] [blame] | 8052 | network) and the fastest session reuse on the server side at the expense |
| 8053 | of maintaining idle connections to the servers. In general, it is possible |
| 8054 | with this option to achieve approximately twice the request rate that the |
| 8055 | "http-server-close" option achieves on small objects. There are mainly two |
| 8056 | situations where this option may be useful : |
| 8057 | |
| 8058 | - when the server is non-HTTP compliant and authenticates the connection |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8059 | instead of requests (e.g. NTLM authentication) |
Willy Tarreau | 16bfb02 | 2010-01-16 19:48:41 +0100 | [diff] [blame] | 8060 | |
| 8061 | - when the cost of establishing the connection to the server is significant |
| 8062 | compared to the cost of retrieving the associated object from the server. |
| 8063 | |
| 8064 | This last case can happen when the server is a fast static server of cache. |
| 8065 | In this case, the server will need to be properly tuned to support high enough |
| 8066 | connection counts because connections will last until the client sends another |
| 8067 | request. |
| 8068 | |
| 8069 | If the client request has to go to another backend or another server due to |
| 8070 | content switching or the load balancing algorithm, the idle connection will |
Willy Tarreau | 9420b12 | 2013-12-15 18:58:25 +0100 | [diff] [blame] | 8071 | immediately be closed and a new one re-opened. Option "prefer-last-server" is |
| 8072 | available to try optimize server selection so that if the server currently |
| 8073 | attached to an idle connection is usable, it will be used. |
Willy Tarreau | 16bfb02 | 2010-01-16 19:48:41 +0100 | [diff] [blame] | 8074 | |
Willy Tarreau | 16bfb02 | 2010-01-16 19:48:41 +0100 | [diff] [blame] | 8075 | At the moment, logs will not indicate whether requests came from the same |
| 8076 | session or not. The accept date reported in the logs corresponds to the end |
| 8077 | of the previous request, and the request time corresponds to the time spent |
| 8078 | waiting for a new request. The keep-alive request time is still bound to the |
| 8079 | timeout defined by "timeout http-keep-alive" or "timeout http-request" if |
| 8080 | not set. |
| 8081 | |
Christopher Faulet | 159e667 | 2019-07-16 15:09:52 +0200 | [diff] [blame] | 8082 | This option disables and replaces any previous "option httpclose" or "option |
| 8083 | http-server-close". When backend and frontend options differ, all of these 4 |
| 8084 | options have precedence over "option http-keep-alive". |
Willy Tarreau | 16bfb02 | 2010-01-16 19:48:41 +0100 | [diff] [blame] | 8085 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8086 | See also : "option httpclose",, "option http-server-close", |
Willy Tarreau | 9420b12 | 2013-12-15 18:58:25 +0100 | [diff] [blame] | 8087 | "option prefer-last-server", "option http-pretend-keepalive", |
Frédéric Lécaille | 93d3316 | 2019-03-06 09:35:59 +0100 | [diff] [blame] | 8088 | and "1.1. The HTTP transaction model". |
Willy Tarreau | 16bfb02 | 2010-01-16 19:48:41 +0100 | [diff] [blame] | 8089 | |
| 8090 | |
Willy Tarreau | 96e3121 | 2011-05-30 18:10:30 +0200 | [diff] [blame] | 8091 | option http-no-delay |
| 8092 | no option http-no-delay |
| 8093 | Instruct the system to favor low interactive delays over performance in HTTP |
| 8094 | May be used in sections : defaults | frontend | listen | backend |
| 8095 | yes | yes | yes | yes |
| 8096 | Arguments : none |
| 8097 | |
| 8098 | In HTTP, each payload is unidirectional and has no notion of interactivity. |
| 8099 | Any agent is expected to queue data somewhat for a reasonably low delay. |
| 8100 | There are some very rare server-to-server applications that abuse the HTTP |
| 8101 | protocol and expect the payload phase to be highly interactive, with many |
| 8102 | interleaved data chunks in both directions within a single request. This is |
| 8103 | absolutely not supported by the HTTP specification and will not work across |
| 8104 | most proxies or servers. When such applications attempt to do this through |
| 8105 | haproxy, it works but they will experience high delays due to the network |
| 8106 | optimizations which favor performance by instructing the system to wait for |
| 8107 | enough data to be available in order to only send full packets. Typical |
| 8108 | delays are around 200 ms per round trip. Note that this only happens with |
| 8109 | abnormal uses. Normal uses such as CONNECT requests nor WebSockets are not |
| 8110 | affected. |
| 8111 | |
| 8112 | When "option http-no-delay" is present in either the frontend or the backend |
| 8113 | used by a connection, all such optimizations will be disabled in order to |
| 8114 | make the exchanges as fast as possible. Of course this offers no guarantee on |
| 8115 | the functionality, as it may break at any other place. But if it works via |
| 8116 | HAProxy, it will work as fast as possible. This option should never be used |
| 8117 | by default, and should never be used at all unless such a buggy application |
| 8118 | is discovered. The impact of using this option is an increase of bandwidth |
| 8119 | usage and CPU usage, which may significantly lower performance in high |
| 8120 | latency environments. |
| 8121 | |
Willy Tarreau | 9fbe18e | 2015-05-01 22:42:08 +0200 | [diff] [blame] | 8122 | See also : "option http-buffer-request" |
| 8123 | |
Willy Tarreau | 96e3121 | 2011-05-30 18:10:30 +0200 | [diff] [blame] | 8124 | |
Willy Tarreau | 8a8e1d9 | 2010-04-05 16:15:16 +0200 | [diff] [blame] | 8125 | option http-pretend-keepalive |
| 8126 | no option http-pretend-keepalive |
| 8127 | Define whether haproxy will announce keepalive to the server or not |
| 8128 | May be used in sections : defaults | frontend | listen | backend |
Christopher Faulet | 98db976 | 2018-09-21 10:25:19 +0200 | [diff] [blame] | 8129 | yes | no | yes | yes |
Willy Tarreau | 8a8e1d9 | 2010-04-05 16:15:16 +0200 | [diff] [blame] | 8130 | Arguments : none |
| 8131 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8132 | When running with "option http-server-close" or "option httpclose", haproxy |
Willy Tarreau | 8a8e1d9 | 2010-04-05 16:15:16 +0200 | [diff] [blame] | 8133 | adds a "Connection: close" header to the request forwarded to the server. |
| 8134 | Unfortunately, when some servers see this header, they automatically refrain |
| 8135 | from using the chunked encoding for responses of unknown length, while this |
| 8136 | is totally unrelated. The immediate effect is that this prevents haproxy from |
| 8137 | maintaining the client connection alive. A second effect is that a client or |
| 8138 | a cache could receive an incomplete response without being aware of it, and |
| 8139 | consider the response complete. |
| 8140 | |
| 8141 | By setting "option http-pretend-keepalive", haproxy will make the server |
| 8142 | believe it will keep the connection alive. The server will then not fall back |
| 8143 | to the abnormal undesired above. When haproxy gets the whole response, it |
| 8144 | will close the connection with the server just as it would do with the |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8145 | "option httpclose". That way the client gets a normal response and the |
Willy Tarreau | 8a8e1d9 | 2010-04-05 16:15:16 +0200 | [diff] [blame] | 8146 | connection is correctly closed on the server side. |
| 8147 | |
| 8148 | It is recommended not to enable this option by default, because most servers |
| 8149 | will more efficiently close the connection themselves after the last packet, |
| 8150 | and release its buffers slightly earlier. Also, the added packet on the |
| 8151 | network could slightly reduce the overall peak performance. However it is |
| 8152 | worth noting that when this option is enabled, haproxy will have slightly |
| 8153 | less work to do. So if haproxy is the bottleneck on the whole architecture, |
| 8154 | enabling this option might save a few CPU cycles. |
| 8155 | |
Christopher Faulet | 98db976 | 2018-09-21 10:25:19 +0200 | [diff] [blame] | 8156 | This option may be set in backend and listen sections. Using it in a frontend |
| 8157 | section will be ignored and a warning will be reported during startup. It is |
| 8158 | a backend related option, so there is no real reason to set it on a |
| 8159 | frontend. This option may be combined with "option httpclose", which will |
| 8160 | cause keepalive to be announced to the server and close to be announced to |
| 8161 | the client. This practice is discouraged though. |
Willy Tarreau | 8a8e1d9 | 2010-04-05 16:15:16 +0200 | [diff] [blame] | 8162 | |
| 8163 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8164 | in a specific instance by prepending the "no" keyword before it. |
| 8165 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8166 | See also : "option httpclose", "option http-server-close", and |
Willy Tarreau | 16bfb02 | 2010-01-16 19:48:41 +0100 | [diff] [blame] | 8167 | "option http-keep-alive" |
Willy Tarreau | 8a8e1d9 | 2010-04-05 16:15:16 +0200 | [diff] [blame] | 8168 | |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8169 | |
Willy Tarreau | b608feb | 2010-01-02 22:47:18 +0100 | [diff] [blame] | 8170 | option http-server-close |
| 8171 | no option http-server-close |
| 8172 | Enable or disable HTTP connection closing on the server side |
| 8173 | May be used in sections : defaults | frontend | listen | backend |
| 8174 | yes | yes | yes | yes |
| 8175 | Arguments : none |
| 8176 | |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 8177 | By default HAProxy operates in keep-alive mode with regards to persistent |
| 8178 | connections: for each connection it processes each request and response, and |
| 8179 | leaves the connection idle on both sides between the end of a response and |
| 8180 | the start of a new request. This mode may be changed by several options such |
Christopher Faulet | 159e667 | 2019-07-16 15:09:52 +0200 | [diff] [blame] | 8181 | as "option http-server-close" or "option httpclose". Setting "option |
| 8182 | http-server-close" enables HTTP connection-close mode on the server side |
| 8183 | while keeping the ability to support HTTP keep-alive and pipelining on the |
| 8184 | client side. This provides the lowest latency on the client side (slow |
| 8185 | network) and the fastest session reuse on the server side to save server |
| 8186 | resources, similarly to "option httpclose". It also permits non-keepalive |
| 8187 | capable servers to be served in keep-alive mode to the clients if they |
| 8188 | conform to the requirements of RFC7230. Please note that some servers do not |
| 8189 | always conform to those requirements when they see "Connection: close" in the |
| 8190 | request. The effect will be that keep-alive will never be used. A workaround |
| 8191 | consists in enabling "option http-pretend-keepalive". |
Willy Tarreau | b608feb | 2010-01-02 22:47:18 +0100 | [diff] [blame] | 8192 | |
| 8193 | At the moment, logs will not indicate whether requests came from the same |
| 8194 | session or not. The accept date reported in the logs corresponds to the end |
| 8195 | of the previous request, and the request time corresponds to the time spent |
| 8196 | waiting for a new request. The keep-alive request time is still bound to the |
Willy Tarreau | b16a574 | 2010-01-10 14:46:16 +0100 | [diff] [blame] | 8197 | timeout defined by "timeout http-keep-alive" or "timeout http-request" if |
| 8198 | not set. |
Willy Tarreau | b608feb | 2010-01-02 22:47:18 +0100 | [diff] [blame] | 8199 | |
| 8200 | This option may be set both in a frontend and in a backend. It is enabled if |
| 8201 | at least one of the frontend or backend holding a connection has it enabled. |
Christopher Faulet | 159e667 | 2019-07-16 15:09:52 +0200 | [diff] [blame] | 8202 | It disables and replaces any previous "option httpclose" or "option |
| 8203 | http-keep-alive". Please check section 4 ("Proxies") to see how this option |
| 8204 | combines with others when frontend and backend options differ. |
Willy Tarreau | b608feb | 2010-01-02 22:47:18 +0100 | [diff] [blame] | 8205 | |
| 8206 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8207 | in a specific instance by prepending the "no" keyword before it. |
| 8208 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8209 | See also : "option httpclose", "option http-pretend-keepalive", |
| 8210 | "option http-keep-alive", and "1.1. The HTTP transaction model". |
Willy Tarreau | b608feb | 2010-01-02 22:47:18 +0100 | [diff] [blame] | 8211 | |
Willy Tarreau | 88d349d | 2010-01-25 12:15:43 +0100 | [diff] [blame] | 8212 | option http-use-proxy-header |
Cyril Bonté | f0c6061 | 2010-02-06 14:44:47 +0100 | [diff] [blame] | 8213 | no option http-use-proxy-header |
Willy Tarreau | 88d349d | 2010-01-25 12:15:43 +0100 | [diff] [blame] | 8214 | Make use of non-standard Proxy-Connection header instead of Connection |
| 8215 | May be used in sections : defaults | frontend | listen | backend |
| 8216 | yes | yes | yes | no |
| 8217 | Arguments : none |
| 8218 | |
Lukas Tribus | 2395368 | 2017-04-28 13:24:30 +0000 | [diff] [blame] | 8219 | While RFC7230 explicitly states that HTTP/1.1 agents must use the |
Willy Tarreau | 88d349d | 2010-01-25 12:15:43 +0100 | [diff] [blame] | 8220 | Connection header to indicate their wish of persistent or non-persistent |
| 8221 | connections, both browsers and proxies ignore this header for proxied |
| 8222 | connections and make use of the undocumented, non-standard Proxy-Connection |
| 8223 | header instead. The issue begins when trying to put a load balancer between |
| 8224 | browsers and such proxies, because there will be a difference between what |
| 8225 | haproxy understands and what the client and the proxy agree on. |
| 8226 | |
| 8227 | By setting this option in a frontend, haproxy can automatically switch to use |
| 8228 | that non-standard header if it sees proxied requests. A proxied request is |
Lukas Tribus | f01a9cd | 2016-02-03 18:09:37 +0100 | [diff] [blame] | 8229 | defined here as one where the URI begins with neither a '/' nor a '*'. This |
| 8230 | is incompatible with the HTTP tunnel mode. Note that this option can only be |
| 8231 | specified in a frontend and will affect the request along its whole life. |
Willy Tarreau | 88d349d | 2010-01-25 12:15:43 +0100 | [diff] [blame] | 8232 | |
Willy Tarreau | 844a7e7 | 2010-01-31 21:46:18 +0100 | [diff] [blame] | 8233 | Also, when this option is set, a request which requires authentication will |
| 8234 | automatically switch to use proxy authentication headers if it is itself a |
| 8235 | proxied request. That makes it possible to check or enforce authentication in |
| 8236 | front of an existing proxy. |
| 8237 | |
Willy Tarreau | 88d349d | 2010-01-25 12:15:43 +0100 | [diff] [blame] | 8238 | This option should normally never be used, except in front of a proxy. |
| 8239 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8240 | See also : "option httpclose", and "option http-server-close". |
Willy Tarreau | 88d349d | 2010-01-25 12:15:43 +0100 | [diff] [blame] | 8241 | |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 8242 | option httpchk |
| 8243 | option httpchk <uri> |
| 8244 | option httpchk <method> <uri> |
| 8245 | option httpchk <method> <uri> <version> |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 8246 | Enables HTTP protocol to check on the servers health |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 8247 | May be used in sections : defaults | frontend | listen | backend |
| 8248 | yes | no | yes | yes |
| 8249 | Arguments : |
| 8250 | <method> is the optional HTTP method used with the requests. When not set, |
| 8251 | the "OPTIONS" method is used, as it generally requires low server |
| 8252 | processing and is easy to filter out from the logs. Any method |
| 8253 | may be used, though it is not recommended to invent non-standard |
| 8254 | ones. |
| 8255 | |
| 8256 | <uri> is the URI referenced in the HTTP requests. It defaults to " / " |
| 8257 | which is accessible by default on almost any server, but may be |
| 8258 | changed to any other URI. Query strings are permitted. |
| 8259 | |
| 8260 | <version> is the optional HTTP version string. It defaults to "HTTP/1.0" |
| 8261 | but some servers might behave incorrectly in HTTP 1.0, so turning |
| 8262 | it to HTTP/1.1 may sometimes help. Note that the Host field is |
Christopher Faulet | 8acb128 | 2020-04-09 08:44:06 +0200 | [diff] [blame] | 8263 | mandatory in HTTP/1.1, use "http-check send" directive to add it. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 8264 | |
| 8265 | By default, server health checks only consist in trying to establish a TCP |
| 8266 | connection. When "option httpchk" is specified, a complete HTTP request is |
| 8267 | sent once the TCP connection is established, and responses 2xx and 3xx are |
| 8268 | considered valid, while all other ones indicate a server failure, including |
| 8269 | the lack of any response. |
| 8270 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 8271 | Combined with "http-check" directives, it is possible to customize the |
| 8272 | request sent during the HTTP health checks or the matching rules on the |
| 8273 | response. It is also possible to configure a send/expect sequence, just like |
| 8274 | with the directive "tcp-check" for TCP health checks. |
| 8275 | |
| 8276 | The server configuration is used by default to open connections to perform |
| 8277 | HTTP health checks. By it is also possible to overwrite server parameters |
| 8278 | using "http-check connect" rules. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 8279 | |
Christopher Faulet | e5870d8 | 2020-04-15 11:32:03 +0200 | [diff] [blame] | 8280 | "httpchk" option does not necessarily require an HTTP backend, it also works |
| 8281 | with plain TCP backends. This is particularly useful to check simple scripts |
Christopher Faulet | 14cd316 | 2020-04-16 14:50:06 +0200 | [diff] [blame] | 8282 | bound to some dedicated ports using the inetd daemon. However, it will always |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 8283 | internally relies on an HTX multiplexer. Thus, it means the request |
Christopher Faulet | 14cd316 | 2020-04-16 14:50:06 +0200 | [diff] [blame] | 8284 | formatting and the response parsing will be strict. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 8285 | |
Christopher Faulet | 8acb128 | 2020-04-09 08:44:06 +0200 | [diff] [blame] | 8286 | Note : For a while, there was no way to add headers or body in the request |
| 8287 | used for HTTP health checks. So a workaround was to hide it at the end |
| 8288 | of the version string with a "\r\n" after the version. It is now |
| 8289 | deprecated. The directive "http-check send" must be used instead. |
| 8290 | |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 8291 | Examples : |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 8292 | # Relay HTTPS traffic to Apache instance and check service availability |
| 8293 | # using HTTP request "OPTIONS * HTTP/1.1" on port 80. |
| 8294 | backend https_relay |
| 8295 | mode tcp |
| 8296 | option httpchk OPTIONS * HTTP/1.1 |
| 8297 | http-check send hdr Host www |
| 8298 | server apache1 192.168.1.1:443 check port 80 |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 8299 | |
Simon Horman | afc47ee | 2013-11-25 10:46:35 +0900 | [diff] [blame] | 8300 | See also : "option ssl-hello-chk", "option smtpchk", "option mysql-check", |
| 8301 | "option pgsql-check", "http-check" and the "check", "port" and |
| 8302 | "inter" server options. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 8303 | |
| 8304 | |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8305 | option httpclose |
| 8306 | no option httpclose |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8307 | Enable or disable HTTP connection closing |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8308 | May be used in sections : defaults | frontend | listen | backend |
| 8309 | yes | yes | yes | yes |
| 8310 | Arguments : none |
| 8311 | |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 8312 | By default HAProxy operates in keep-alive mode with regards to persistent |
| 8313 | connections: for each connection it processes each request and response, and |
| 8314 | leaves the connection idle on both sides between the end of a response and |
| 8315 | the start of a new request. This mode may be changed by several options such |
Christopher Faulet | 159e667 | 2019-07-16 15:09:52 +0200 | [diff] [blame] | 8316 | as "option http-server-close" or "option httpclose". |
Willy Tarreau | 70dffda | 2014-01-30 03:07:23 +0100 | [diff] [blame] | 8317 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8318 | If "option httpclose" is set, HAProxy will close connections with the server |
| 8319 | and the client as soon as the request and the response are received. It will |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 8320 | also check if a "Connection: close" header is already set in each direction, |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8321 | and will add one if missing. Any "Connection" header different from "close" |
| 8322 | will also be removed. |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8323 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8324 | This option may also be combined with "option http-pretend-keepalive", which |
| 8325 | will disable sending of the "Connection: close" header, but will still cause |
| 8326 | the connection to be closed once the whole response is received. |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8327 | |
| 8328 | This option may be set both in a frontend and in a backend. It is enabled if |
| 8329 | at least one of the frontend or backend holding a connection has it enabled. |
Christopher Faulet | 159e667 | 2019-07-16 15:09:52 +0200 | [diff] [blame] | 8330 | It disables and replaces any previous "option http-server-close" or "option |
| 8331 | http-keep-alive". Please check section 4 ("Proxies") to see how this option |
| 8332 | combines with others when frontend and backend options differ. |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8333 | |
| 8334 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8335 | in a specific instance by prepending the "no" keyword before it. |
| 8336 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8337 | See also : "option http-server-close" and "1.1. The HTTP transaction model". |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8338 | |
| 8339 | |
Emeric Brun | 3a058f3 | 2009-06-30 18:26:00 +0200 | [diff] [blame] | 8340 | option httplog [ clf ] |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8341 | Enable logging of HTTP request, session state and timers |
| 8342 | May be used in sections : defaults | frontend | listen | backend |
Tim Duesterhus | 9ad9f35 | 2018-02-05 20:52:27 +0100 | [diff] [blame] | 8343 | yes | yes | yes | no |
Emeric Brun | 3a058f3 | 2009-06-30 18:26:00 +0200 | [diff] [blame] | 8344 | Arguments : |
| 8345 | clf if the "clf" argument is added, then the output format will be |
| 8346 | the CLF format instead of HAProxy's default HTTP format. You can |
| 8347 | use this when you need to feed HAProxy's logs through a specific |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8348 | log analyzer which only support the CLF format and which is not |
Emeric Brun | 3a058f3 | 2009-06-30 18:26:00 +0200 | [diff] [blame] | 8349 | extensible. |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8350 | |
| 8351 | By default, the log output format is very poor, as it only contains the |
| 8352 | source and destination addresses, and the instance name. By specifying |
| 8353 | "option httplog", each log line turns into a much richer format including, |
| 8354 | but not limited to, the HTTP request, the connection timers, the session |
| 8355 | status, the connections numbers, the captured headers and cookies, the |
| 8356 | frontend, backend and server name, and of course the source address and |
| 8357 | ports. |
| 8358 | |
PiBa-NL | bd556bf | 2014-12-11 21:31:54 +0100 | [diff] [blame] | 8359 | Specifying only "option httplog" will automatically clear the 'clf' mode |
| 8360 | if it was set by default. |
Emeric Brun | 3a058f3 | 2009-06-30 18:26:00 +0200 | [diff] [blame] | 8361 | |
Guillaume de Lafond | 29f4560 | 2017-03-31 19:52:15 +0200 | [diff] [blame] | 8362 | "option httplog" overrides any previous "log-format" directive. |
| 8363 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 8364 | See also : section 8 about logging. |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8365 | |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 8366 | |
| 8367 | option http_proxy |
| 8368 | no option http_proxy |
| 8369 | Enable or disable plain HTTP proxy mode |
| 8370 | May be used in sections : defaults | frontend | listen | backend |
| 8371 | yes | yes | yes | yes |
| 8372 | Arguments : none |
| 8373 | |
| 8374 | It sometimes happens that people need a pure HTTP proxy which understands |
| 8375 | basic proxy requests without caching nor any fancy feature. In this case, |
| 8376 | it may be worth setting up an HAProxy instance with the "option http_proxy" |
| 8377 | set. In this mode, no server is declared, and the connection is forwarded to |
| 8378 | the IP address and port found in the URL after the "http://" scheme. |
| 8379 | |
| 8380 | No host address resolution is performed, so this only works when pure IP |
| 8381 | addresses are passed. Since this option's usage perimeter is rather limited, |
Lukas Tribus | f01a9cd | 2016-02-03 18:09:37 +0100 | [diff] [blame] | 8382 | it will probably be used only by experts who know they need exactly it. This |
| 8383 | is incompatible with the HTTP tunnel mode. |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 8384 | |
| 8385 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8386 | in a specific instance by prepending the "no" keyword before it. |
| 8387 | |
| 8388 | Example : |
| 8389 | # this backend understands HTTP proxy requests and forwards them directly. |
| 8390 | backend direct_forward |
| 8391 | option httpclose |
| 8392 | option http_proxy |
| 8393 | |
| 8394 | See also : "option httpclose" |
| 8395 | |
Willy Tarreau | 211ad24 | 2009-10-03 21:45:07 +0200 | [diff] [blame] | 8396 | |
Jamie Gloudon | 801a0a3 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 8397 | option independent-streams |
| 8398 | no option independent-streams |
| 8399 | Enable or disable independent timeout processing for both directions |
Willy Tarreau | f27b5ea | 2009-10-03 22:01:18 +0200 | [diff] [blame] | 8400 | May be used in sections : defaults | frontend | listen | backend |
| 8401 | yes | yes | yes | yes |
| 8402 | Arguments : none |
| 8403 | |
| 8404 | By default, when data is sent over a socket, both the write timeout and the |
| 8405 | read timeout for that socket are refreshed, because we consider that there is |
| 8406 | activity on that socket, and we have no other means of guessing if we should |
| 8407 | receive data or not. |
| 8408 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8409 | While this default behavior is desirable for almost all applications, there |
Willy Tarreau | f27b5ea | 2009-10-03 22:01:18 +0200 | [diff] [blame] | 8410 | exists a situation where it is desirable to disable it, and only refresh the |
| 8411 | read timeout if there are incoming data. This happens on sessions with large |
| 8412 | timeouts and low amounts of exchanged data such as telnet session. If the |
| 8413 | server suddenly disappears, the output data accumulates in the system's |
| 8414 | socket buffers, both timeouts are correctly refreshed, and there is no way |
| 8415 | to know the server does not receive them, so we don't timeout. However, when |
| 8416 | the underlying protocol always echoes sent data, it would be enough by itself |
| 8417 | to detect the issue using the read timeout. Note that this problem does not |
| 8418 | happen with more verbose protocols because data won't accumulate long in the |
| 8419 | socket buffers. |
| 8420 | |
| 8421 | When this option is set on the frontend, it will disable read timeout updates |
| 8422 | on data sent to the client. There probably is little use of this case. When |
| 8423 | the option is set on the backend, it will disable read timeout updates on |
| 8424 | data sent to the server. Doing so will typically break large HTTP posts from |
| 8425 | slow lines, so use it with caution. |
| 8426 | |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 8427 | See also : "timeout client", "timeout server" and "timeout tunnel" |
Willy Tarreau | f27b5ea | 2009-10-03 22:01:18 +0200 | [diff] [blame] | 8428 | |
| 8429 | |
Gabor Lekeny | b4c81e4 | 2010-09-29 18:17:05 +0200 | [diff] [blame] | 8430 | option ldap-check |
| 8431 | Use LDAPv3 health checks for server testing |
| 8432 | May be used in sections : defaults | frontend | listen | backend |
| 8433 | yes | no | yes | yes |
| 8434 | Arguments : none |
| 8435 | |
| 8436 | It is possible to test that the server correctly talks LDAPv3 instead of just |
| 8437 | testing that it accepts the TCP connection. When this option is set, an |
| 8438 | LDAPv3 anonymous simple bind message is sent to the server, and the response |
| 8439 | is analyzed to find an LDAPv3 bind response message. |
| 8440 | |
| 8441 | The server is considered valid only when the LDAP response contains success |
| 8442 | resultCode (http://tools.ietf.org/html/rfc4511#section-4.1.9). |
| 8443 | |
| 8444 | Logging of bind requests is server dependent see your documentation how to |
| 8445 | configure it. |
| 8446 | |
| 8447 | Example : |
| 8448 | option ldap-check |
| 8449 | |
| 8450 | See also : "option httpchk" |
| 8451 | |
| 8452 | |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 8453 | option external-check |
| 8454 | Use external processes for server health checks |
| 8455 | May be used in sections : defaults | frontend | listen | backend |
| 8456 | yes | no | yes | yes |
| 8457 | |
| 8458 | It is possible to test the health of a server using an external command. |
| 8459 | This is achieved by running the executable set using "external-check |
| 8460 | command". |
| 8461 | |
| 8462 | Requires the "external-check" global to be set. |
| 8463 | |
| 8464 | See also : "external-check", "external-check command", "external-check path" |
| 8465 | |
| 8466 | |
Willy Tarreau | 211ad24 | 2009-10-03 21:45:07 +0200 | [diff] [blame] | 8467 | option log-health-checks |
| 8468 | no option log-health-checks |
Willy Tarreau | bef1b32 | 2014-05-13 21:01:39 +0200 | [diff] [blame] | 8469 | Enable or disable logging of health checks status updates |
Willy Tarreau | 211ad24 | 2009-10-03 21:45:07 +0200 | [diff] [blame] | 8470 | May be used in sections : defaults | frontend | listen | backend |
| 8471 | yes | no | yes | yes |
| 8472 | Arguments : none |
| 8473 | |
Willy Tarreau | bef1b32 | 2014-05-13 21:01:39 +0200 | [diff] [blame] | 8474 | By default, failed health check are logged if server is UP and successful |
| 8475 | health checks are logged if server is DOWN, so the amount of additional |
| 8476 | information is limited. |
Willy Tarreau | 211ad24 | 2009-10-03 21:45:07 +0200 | [diff] [blame] | 8477 | |
Willy Tarreau | bef1b32 | 2014-05-13 21:01:39 +0200 | [diff] [blame] | 8478 | When this option is enabled, any change of the health check status or to |
| 8479 | the server's health will be logged, so that it becomes possible to know |
| 8480 | that a server was failing occasional checks before crashing, or exactly when |
| 8481 | it failed to respond a valid HTTP status, then when the port started to |
| 8482 | reject connections, then when the server stopped responding at all. |
| 8483 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8484 | Note that status changes not caused by health checks (e.g. enable/disable on |
Willy Tarreau | bef1b32 | 2014-05-13 21:01:39 +0200 | [diff] [blame] | 8485 | the CLI) are intentionally not logged by this option. |
Willy Tarreau | 211ad24 | 2009-10-03 21:45:07 +0200 | [diff] [blame] | 8486 | |
Willy Tarreau | bef1b32 | 2014-05-13 21:01:39 +0200 | [diff] [blame] | 8487 | See also: "option httpchk", "option ldap-check", "option mysql-check", |
| 8488 | "option pgsql-check", "option redis-check", "option smtpchk", |
| 8489 | "option tcp-check", "log" and section 8 about logging. |
Willy Tarreau | 211ad24 | 2009-10-03 21:45:07 +0200 | [diff] [blame] | 8490 | |
Willy Tarreau | c9bd0cc | 2009-05-10 11:57:02 +0200 | [diff] [blame] | 8491 | |
| 8492 | option log-separate-errors |
| 8493 | no option log-separate-errors |
| 8494 | Change log level for non-completely successful connections |
| 8495 | May be used in sections : defaults | frontend | listen | backend |
| 8496 | yes | yes | yes | no |
| 8497 | Arguments : none |
| 8498 | |
| 8499 | Sometimes looking for errors in logs is not easy. This option makes haproxy |
| 8500 | raise the level of logs containing potentially interesting information such |
| 8501 | as errors, timeouts, retries, redispatches, or HTTP status codes 5xx. The |
| 8502 | level changes from "info" to "err". This makes it possible to log them |
| 8503 | separately to a different file with most syslog daemons. Be careful not to |
| 8504 | remove them from the original file, otherwise you would lose ordering which |
| 8505 | provides very important information. |
| 8506 | |
| 8507 | Using this option, large sites dealing with several thousand connections per |
| 8508 | second may log normal traffic to a rotating buffer and only archive smaller |
| 8509 | error logs. |
| 8510 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 8511 | See also : "log", "dontlognull", "dontlog-normal" and section 8 about |
Willy Tarreau | c9bd0cc | 2009-05-10 11:57:02 +0200 | [diff] [blame] | 8512 | logging. |
| 8513 | |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8514 | |
| 8515 | option logasap |
| 8516 | no option logasap |
Jerome Magnin | 95fb57b | 2020-04-23 19:01:17 +0200 | [diff] [blame] | 8517 | Enable or disable early logging. |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8518 | May be used in sections : defaults | frontend | listen | backend |
| 8519 | yes | yes | yes | no |
| 8520 | Arguments : none |
| 8521 | |
Jerome Magnin | 95fb57b | 2020-04-23 19:01:17 +0200 | [diff] [blame] | 8522 | By default, logs are emitted when all the log format variables and sample |
| 8523 | fetches used in the definition of the log-format string return a value, or |
| 8524 | when the session is terminated. This allows the built in log-format strings |
| 8525 | to account for the transfer time, or the number of bytes in log messages. |
| 8526 | |
| 8527 | When handling long lived connections such as large file transfers or RDP, |
| 8528 | it may take a while for the request or connection to appear in the logs. |
| 8529 | Using "option logasap", the log message is created as soon as the server |
| 8530 | connection is established in mode tcp, or as soon as the server sends the |
| 8531 | complete headers in mode http. Missing information in the logs will be the |
Ilya Shipitsin | 4329a9a | 2020-05-05 21:17:10 +0500 | [diff] [blame] | 8532 | total number of bytes which will only indicate the amount of data transferred |
Jerome Magnin | 95fb57b | 2020-04-23 19:01:17 +0200 | [diff] [blame] | 8533 | before the message was created and the total time which will not take the |
| 8534 | remainder of the connection life or transfer time into account. For the case |
| 8535 | of HTTP, it is good practice to capture the Content-Length response header |
| 8536 | so that the logs at least indicate how many bytes are expected to be |
Ilya Shipitsin | 4329a9a | 2020-05-05 21:17:10 +0500 | [diff] [blame] | 8537 | transferred. |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8538 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 8539 | Examples : |
| 8540 | listen http_proxy 0.0.0.0:80 |
| 8541 | mode http |
| 8542 | option httplog |
| 8543 | option logasap |
| 8544 | log 192.168.2.200 local3 |
| 8545 | |
| 8546 | >>> Feb 6 12:14:14 localhost \ |
| 8547 | haproxy[14389]: 10.0.1.2:33317 [06/Feb/2009:12:14:14.655] http-in \ |
| 8548 | static/srv1 9/10/7/14/+30 200 +243 - - ---- 3/1/1/1/0 1/0 \ |
| 8549 | "GET /image.iso HTTP/1.0" |
| 8550 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 8551 | See also : "option httplog", "capture response header", and section 8 about |
Willy Tarreau | c27debf | 2008-01-06 08:57:02 +0100 | [diff] [blame] | 8552 | logging. |
| 8553 | |
| 8554 | |
Christopher Faulet | 62f79fe | 2020-05-18 18:13:03 +0200 | [diff] [blame] | 8555 | option mysql-check [ user <username> [ { post-41 | pre-41 } ] ] |
Hervé COMMOWICK | 8776f1b | 2010-10-18 15:58:36 +0200 | [diff] [blame] | 8556 | Use MySQL health checks for server testing |
Hervé COMMOWICK | 698ae00 | 2010-01-12 09:25:13 +0100 | [diff] [blame] | 8557 | May be used in sections : defaults | frontend | listen | backend |
| 8558 | yes | no | yes | yes |
Hervé COMMOWICK | 8776f1b | 2010-10-18 15:58:36 +0200 | [diff] [blame] | 8559 | Arguments : |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 8560 | <username> This is the username which will be used when connecting to MySQL |
| 8561 | server. |
Christopher Faulet | 62f79fe | 2020-05-18 18:13:03 +0200 | [diff] [blame] | 8562 | post-41 Send post v4.1 client compatible checks (the default) |
| 8563 | pre-41 Send pre v4.1 client compatible checks |
Hervé COMMOWICK | 8776f1b | 2010-10-18 15:58:36 +0200 | [diff] [blame] | 8564 | |
| 8565 | If you specify a username, the check consists of sending two MySQL packet, |
| 8566 | one Client Authentication packet, and one QUIT packet, to correctly close |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8567 | MySQL session. We then parse the MySQL Handshake Initialization packet and/or |
Hervé COMMOWICK | 8776f1b | 2010-10-18 15:58:36 +0200 | [diff] [blame] | 8568 | Error packet. It is a basic but useful test which does not produce error nor |
| 8569 | aborted connect on the server. However, it requires adding an authorization |
| 8570 | in the MySQL table, like this : |
| 8571 | |
| 8572 | USE mysql; |
| 8573 | INSERT INTO user (Host,User) values ('<ip_of_haproxy>','<username>'); |
| 8574 | FLUSH PRIVILEGES; |
| 8575 | |
| 8576 | If you don't specify a username (it is deprecated and not recommended), the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8577 | check only consists in parsing the Mysql Handshake Initialization packet or |
Hervé COMMOWICK | 8776f1b | 2010-10-18 15:58:36 +0200 | [diff] [blame] | 8578 | Error packet, we don't send anything in this mode. It was reported that it |
| 8579 | can generate lockout if check is too frequent and/or if there is not enough |
| 8580 | traffic. In fact, you need in this case to check MySQL "max_connect_errors" |
| 8581 | value as if a connection is established successfully within fewer than MySQL |
| 8582 | "max_connect_errors" attempts after a previous connection was interrupted, |
| 8583 | the error count for the host is cleared to zero. If HAProxy's server get |
| 8584 | blocked, the "FLUSH HOSTS" statement is the only way to unblock it. |
| 8585 | |
| 8586 | Remember that this does not check database presence nor database consistency. |
| 8587 | To do this, you can use an external check with xinetd for example. |
Hervé COMMOWICK | 698ae00 | 2010-01-12 09:25:13 +0100 | [diff] [blame] | 8588 | |
Hervé COMMOWICK | 212f778 | 2011-06-10 14:05:59 +0200 | [diff] [blame] | 8589 | The check requires MySQL >=3.22, for older version, please use TCP check. |
Hervé COMMOWICK | 698ae00 | 2010-01-12 09:25:13 +0100 | [diff] [blame] | 8590 | |
| 8591 | Most often, an incoming MySQL server needs to see the client's IP address for |
| 8592 | various purposes, including IP privilege matching and connection logging. |
| 8593 | When possible, it is often wise to masquerade the client's IP address when |
| 8594 | connecting to the server using the "usesrc" argument of the "source" keyword, |
Willy Tarreau | 29fbe51 | 2015-08-20 19:35:14 +0200 | [diff] [blame] | 8595 | which requires the transparent proxy feature to be compiled in, and the MySQL |
| 8596 | server to route the client via the machine hosting haproxy. |
Hervé COMMOWICK | 698ae00 | 2010-01-12 09:25:13 +0100 | [diff] [blame] | 8597 | |
| 8598 | See also: "option httpchk" |
| 8599 | |
| 8600 | |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8601 | option nolinger |
| 8602 | no option nolinger |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 8603 | Enable or disable immediate session resource cleaning after close |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8604 | May be used in sections: defaults | frontend | listen | backend |
| 8605 | yes | yes | yes | yes |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 8606 | Arguments : none |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8607 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8608 | When clients or servers abort connections in a dirty way (e.g. they are |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8609 | physically disconnected), the session timeouts triggers and the session is |
| 8610 | closed. But it will remain in FIN_WAIT1 state for some time in the system, |
| 8611 | using some resources and possibly limiting the ability to establish newer |
| 8612 | connections. |
| 8613 | |
| 8614 | When this happens, it is possible to activate "option nolinger" which forces |
| 8615 | the system to immediately remove any socket's pending data on close. Thus, |
Willy Tarreau | 4a32103 | 2020-10-16 04:55:19 +0200 | [diff] [blame] | 8616 | a TCP RST is emitted, any pending data are truncated, and the session is |
| 8617 | instantly purged from the system's tables. The generally visible effect for |
| 8618 | a client is that responses are truncated if the close happens with a last |
| 8619 | block of data (e.g. on a redirect or error response). On the server side, |
| 8620 | it may help release the source ports immediately when forwarding a client |
| 8621 | aborts in tunnels. In both cases, TCP resets are emitted and given that |
| 8622 | the session is instantly destroyed, there will be no retransmit. On a lossy |
| 8623 | network this can increase problems, especially when there is a firewall on |
| 8624 | the lossy side, because the firewall might see and process the reset (hence |
| 8625 | purge its session) and block any further traffic for this session,, including |
| 8626 | retransmits from the other side. So if the other side doesn't receive it, |
| 8627 | it will never receive any RST again, and the firewall might log many blocked |
| 8628 | packets. |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8629 | |
Willy Tarreau | 4a32103 | 2020-10-16 04:55:19 +0200 | [diff] [blame] | 8630 | For all these reasons, it is strongly recommended NOT to use this option, |
| 8631 | unless absolutely needed as a last resort. In most situations, using the |
| 8632 | "client-fin" or "server-fin" timeouts achieves similar results with a more |
| 8633 | reliable behavior. On Linux it's also possible to use the "tcp-ut" bind or |
| 8634 | server setting. |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8635 | |
| 8636 | This option may be used both on frontends and backends, depending on the side |
| 8637 | where it is required. Use it on the frontend for clients, and on the backend |
Willy Tarreau | 4a32103 | 2020-10-16 04:55:19 +0200 | [diff] [blame] | 8638 | for servers. While this option is technically supported in "defaults" |
Ilya Shipitsin | 2272d8a | 2020-12-21 01:22:40 +0500 | [diff] [blame] | 8639 | sections, it must really not be used there as it risks to accidentally |
Willy Tarreau | 4a32103 | 2020-10-16 04:55:19 +0200 | [diff] [blame] | 8640 | propagate to sections that must no use it and to cause problems there. |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8641 | |
| 8642 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8643 | in a specific instance by prepending the "no" keyword before it. |
| 8644 | |
Willy Tarreau | 4a32103 | 2020-10-16 04:55:19 +0200 | [diff] [blame] | 8645 | See also: "timeout client-fin", "timeout server-fin", "tcp-ut" bind or server |
| 8646 | keywords. |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8647 | |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 8648 | option originalto [ except <network> ] [ header <name> ] |
| 8649 | Enable insertion of the X-Original-To header to requests sent to servers |
| 8650 | May be used in sections : defaults | frontend | listen | backend |
| 8651 | yes | yes | yes | yes |
| 8652 | Arguments : |
| 8653 | <network> is an optional argument used to disable this option for sources |
| 8654 | matching <network> |
| 8655 | <name> an optional argument to specify a different "X-Original-To" |
| 8656 | header name. |
| 8657 | |
| 8658 | Since HAProxy can work in transparent mode, every request from a client can |
| 8659 | be redirected to the proxy and HAProxy itself can proxy every request to a |
| 8660 | complex SQUID environment and the destination host from SO_ORIGINAL_DST will |
| 8661 | be lost. This is annoying when you want access rules based on destination ip |
| 8662 | addresses. To solve this problem, a new HTTP header "X-Original-To" may be |
| 8663 | added by HAProxy to all requests sent to the server. This header contains a |
| 8664 | value representing the original destination IP address. Since this must be |
| 8665 | configured to always use the last occurrence of this header only. Note that |
| 8666 | only the last occurrence of the header must be used, since it is really |
| 8667 | possible that the client has already brought one. |
| 8668 | |
| 8669 | The keyword "header" may be used to supply a different header name to replace |
| 8670 | the default "X-Original-To". This can be useful where you might already |
| 8671 | have a "X-Original-To" header from a different application, and you need |
| 8672 | preserve it. Also if your backend server doesn't use the "X-Original-To" |
| 8673 | header and requires different one. |
| 8674 | |
| 8675 | Sometimes, a same HAProxy instance may be shared between a direct client |
| 8676 | access and a reverse-proxy access (for instance when an SSL reverse-proxy is |
| 8677 | used to decrypt HTTPS traffic). It is possible to disable the addition of the |
| 8678 | header for a known source address or network by adding the "except" keyword |
| 8679 | followed by the network address. In this case, any source IP matching the |
| 8680 | network will not cause an addition of this header. Most common uses are with |
| 8681 | private networks or 127.0.0.1. |
| 8682 | |
| 8683 | This option may be specified either in the frontend or in the backend. If at |
| 8684 | least one of them uses it, the header will be added. Note that the backend's |
| 8685 | setting of the header subargument takes precedence over the frontend's if |
| 8686 | both are defined. |
| 8687 | |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 8688 | Examples : |
| 8689 | # Original Destination address |
| 8690 | frontend www |
| 8691 | mode http |
| 8692 | option originalto except 127.0.0.1 |
| 8693 | |
| 8694 | # Those servers want the IP Address in X-Client-Dst |
| 8695 | backend www |
| 8696 | mode http |
| 8697 | option originalto header X-Client-Dst |
| 8698 | |
Christopher Faulet | 315b39c | 2018-09-21 16:26:19 +0200 | [diff] [blame] | 8699 | See also : "option httpclose", "option http-server-close". |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 8700 | |
| 8701 | |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8702 | option persist |
| 8703 | no option persist |
| 8704 | Enable or disable forced persistence on down servers |
| 8705 | May be used in sections: defaults | frontend | listen | backend |
| 8706 | yes | no | yes | yes |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 8707 | Arguments : none |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8708 | |
| 8709 | When an HTTP request reaches a backend with a cookie which references a dead |
| 8710 | server, by default it is redispatched to another server. It is possible to |
| 8711 | force the request to be sent to the dead server first using "option persist" |
| 8712 | if absolutely needed. A common use case is when servers are under extreme |
| 8713 | load and spend their time flapping. In this case, the users would still be |
| 8714 | directed to the server they opened the session on, in the hope they would be |
| 8715 | correctly served. It is recommended to use "option redispatch" in conjunction |
| 8716 | with this option so that in the event it would not be possible to connect to |
| 8717 | the server at all (server definitely dead), the client would finally be |
| 8718 | redirected to another valid server. |
| 8719 | |
| 8720 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8721 | in a specific instance by prepending the "no" keyword before it. |
| 8722 | |
Willy Tarreau | 4de9149 | 2010-01-22 19:10:05 +0100 | [diff] [blame] | 8723 | See also : "option redispatch", "retries", "force-persist" |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8724 | |
| 8725 | |
Willy Tarreau | 0c12282 | 2013-12-15 18:49:01 +0100 | [diff] [blame] | 8726 | option pgsql-check [ user <username> ] |
| 8727 | Use PostgreSQL health checks for server testing |
| 8728 | May be used in sections : defaults | frontend | listen | backend |
| 8729 | yes | no | yes | yes |
| 8730 | Arguments : |
| 8731 | <username> This is the username which will be used when connecting to |
| 8732 | PostgreSQL server. |
| 8733 | |
| 8734 | The check sends a PostgreSQL StartupMessage and waits for either |
| 8735 | Authentication request or ErrorResponse message. It is a basic but useful |
| 8736 | test which does not produce error nor aborted connect on the server. |
| 8737 | This check is identical with the "mysql-check". |
| 8738 | |
| 8739 | See also: "option httpchk" |
| 8740 | |
| 8741 | |
Willy Tarreau | 9420b12 | 2013-12-15 18:58:25 +0100 | [diff] [blame] | 8742 | option prefer-last-server |
| 8743 | no option prefer-last-server |
| 8744 | Allow multiple load balanced requests to remain on the same server |
| 8745 | May be used in sections: defaults | frontend | listen | backend |
| 8746 | yes | no | yes | yes |
| 8747 | Arguments : none |
| 8748 | |
| 8749 | When the load balancing algorithm in use is not deterministic, and a previous |
| 8750 | request was sent to a server to which haproxy still holds a connection, it is |
| 8751 | sometimes desirable that subsequent requests on a same session go to the same |
| 8752 | server as much as possible. Note that this is different from persistence, as |
| 8753 | we only indicate a preference which haproxy tries to apply without any form |
| 8754 | of warranty. The real use is for keep-alive connections sent to servers. When |
| 8755 | this option is used, haproxy will try to reuse the same connection that is |
| 8756 | attached to the server instead of rebalancing to another server, causing a |
| 8757 | close of the connection. This can make sense for static file servers. It does |
Willy Tarreau | 068621e | 2013-12-23 15:11:25 +0100 | [diff] [blame] | 8758 | not make much sense to use this in combination with hashing algorithms. Note, |
| 8759 | haproxy already automatically tries to stick to a server which sends a 401 or |
Lukas Tribus | 80512b1 | 2018-10-27 20:07:40 +0200 | [diff] [blame] | 8760 | to a proxy which sends a 407 (authentication required), when the load |
| 8761 | balancing algorithm is not deterministic. This is mandatory for use with the |
| 8762 | broken NTLM authentication challenge, and significantly helps in |
Willy Tarreau | 068621e | 2013-12-23 15:11:25 +0100 | [diff] [blame] | 8763 | troubleshooting some faulty applications. Option prefer-last-server might be |
| 8764 | desirable in these environments as well, to avoid redistributing the traffic |
| 8765 | after every other response. |
Willy Tarreau | 9420b12 | 2013-12-15 18:58:25 +0100 | [diff] [blame] | 8766 | |
| 8767 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8768 | in a specific instance by prepending the "no" keyword before it. |
| 8769 | |
| 8770 | See also: "option http-keep-alive" |
| 8771 | |
| 8772 | |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 8773 | option redispatch |
Joseph Lynch | 726ab71 | 2015-05-11 23:25:34 -0700 | [diff] [blame] | 8774 | option redispatch <interval> |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 8775 | no option redispatch |
| 8776 | Enable or disable session redistribution in case of connection failure |
| 8777 | May be used in sections: defaults | frontend | listen | backend |
| 8778 | yes | no | yes | yes |
Joseph Lynch | 726ab71 | 2015-05-11 23:25:34 -0700 | [diff] [blame] | 8779 | Arguments : |
| 8780 | <interval> The optional integer value that controls how often redispatches |
| 8781 | occur when retrying connections. Positive value P indicates a |
| 8782 | redispatch is desired on every Pth retry, and negative value |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8783 | N indicate a redispatch is desired on the Nth retry prior to the |
Joseph Lynch | 726ab71 | 2015-05-11 23:25:34 -0700 | [diff] [blame] | 8784 | last retry. For example, the default of -1 preserves the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8785 | historical behavior of redispatching on the last retry, a |
Joseph Lynch | 726ab71 | 2015-05-11 23:25:34 -0700 | [diff] [blame] | 8786 | positive value of 1 would indicate a redispatch on every retry, |
| 8787 | and a positive value of 3 would indicate a redispatch on every |
| 8788 | third retry. You can disable redispatches with a value of 0. |
| 8789 | |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 8790 | |
| 8791 | In HTTP mode, if a server designated by a cookie is down, clients may |
| 8792 | definitely stick to it because they cannot flush the cookie, so they will not |
| 8793 | be able to access the service anymore. |
| 8794 | |
Willy Tarreau | 59884a6 | 2019-01-02 14:48:31 +0100 | [diff] [blame] | 8795 | Specifying "option redispatch" will allow the proxy to break cookie or |
| 8796 | consistent hash based persistence and redistribute them to a working server. |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 8797 | |
Olivier Carrère | 6e6f59b | 2020-04-15 11:30:18 +0200 | [diff] [blame] | 8798 | Active servers are selected from a subset of the list of available |
| 8799 | servers. Active servers that are not down or in maintenance (i.e., whose |
| 8800 | health is not checked or that have been checked as "up"), are selected in the |
| 8801 | following order: |
| 8802 | |
| 8803 | 1. Any active, non-backup server, if any, or, |
| 8804 | |
| 8805 | 2. If the "allbackups" option is not set, the first backup server in the |
| 8806 | list, or |
| 8807 | |
| 8808 | 3. If the "allbackups" option is set, any backup server. |
| 8809 | |
| 8810 | When a retry occurs, HAProxy tries to select another server than the last |
| 8811 | one. The new server is selected from the current list of servers. |
| 8812 | |
| 8813 | Sometimes, if the list is updated between retries (e.g., if numerous retries |
| 8814 | occur and last longer than the time needed to check that a server is down, |
| 8815 | remove it from the list and fall back on the list of backup servers), |
| 8816 | connections may be redirected to a backup server, though. |
| 8817 | |
Joseph Lynch | 726ab71 | 2015-05-11 23:25:34 -0700 | [diff] [blame] | 8818 | It also allows to retry connections to another server in case of multiple |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 8819 | connection failures. Of course, it requires having "retries" set to a nonzero |
| 8820 | value. |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 8821 | |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 8822 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8823 | in a specific instance by prepending the "no" keyword before it. |
| 8824 | |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 8825 | See also : "retries", "force-persist" |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 8826 | |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8827 | |
Hervé COMMOWICK | ec032d6 | 2011-08-05 16:23:48 +0200 | [diff] [blame] | 8828 | option redis-check |
| 8829 | Use redis health checks for server testing |
| 8830 | May be used in sections : defaults | frontend | listen | backend |
| 8831 | yes | no | yes | yes |
| 8832 | Arguments : none |
| 8833 | |
| 8834 | It is possible to test that the server correctly talks REDIS protocol instead |
| 8835 | of just testing that it accepts the TCP connection. When this option is set, |
| 8836 | a PING redis command is sent to the server, and the response is analyzed to |
| 8837 | find the "+PONG" response message. |
| 8838 | |
| 8839 | Example : |
| 8840 | option redis-check |
| 8841 | |
Jarno Huuskonen | e5ae702 | 2017-04-03 14:36:21 +0300 | [diff] [blame] | 8842 | See also : "option httpchk", "option tcp-check", "tcp-check expect" |
Hervé COMMOWICK | ec032d6 | 2011-08-05 16:23:48 +0200 | [diff] [blame] | 8843 | |
| 8844 | |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8845 | option smtpchk |
| 8846 | option smtpchk <hello> <domain> |
| 8847 | Use SMTP health checks for server testing |
| 8848 | May be used in sections : defaults | frontend | listen | backend |
| 8849 | yes | no | yes | yes |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 8850 | Arguments : |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8851 | <hello> is an optional argument. It is the "hello" command to use. It can |
Lukas Tribus | 2793578 | 2018-10-01 02:00:16 +0200 | [diff] [blame] | 8852 | be either "HELO" (for SMTP) or "EHLO" (for ESMTP). All other |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8853 | values will be turned into the default command ("HELO"). |
| 8854 | |
| 8855 | <domain> is the domain name to present to the server. It may only be |
| 8856 | specified (and is mandatory) if the hello command has been |
| 8857 | specified. By default, "localhost" is used. |
| 8858 | |
| 8859 | When "option smtpchk" is set, the health checks will consist in TCP |
| 8860 | connections followed by an SMTP command. By default, this command is |
| 8861 | "HELO localhost". The server's return code is analyzed and only return codes |
| 8862 | starting with a "2" will be considered as valid. All other responses, |
| 8863 | including a lack of response will constitute an error and will indicate a |
| 8864 | dead server. |
| 8865 | |
| 8866 | This test is meant to be used with SMTP servers or relays. Depending on the |
| 8867 | request, it is possible that some servers do not log each connection attempt, |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8868 | so you may want to experiment to improve the behavior. Using telnet on port |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8869 | 25 is often easier than adjusting the configuration. |
| 8870 | |
| 8871 | Most often, an incoming SMTP server needs to see the client's IP address for |
| 8872 | various purposes, including spam filtering, anti-spoofing and logging. When |
| 8873 | possible, it is often wise to masquerade the client's IP address when |
| 8874 | connecting to the server using the "usesrc" argument of the "source" keyword, |
Willy Tarreau | 29fbe51 | 2015-08-20 19:35:14 +0200 | [diff] [blame] | 8875 | which requires the transparent proxy feature to be compiled in. |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 8876 | |
| 8877 | Example : |
| 8878 | option smtpchk HELO mydomain.org |
| 8879 | |
| 8880 | See also : "option httpchk", "source" |
| 8881 | |
Krzysztof Piotr Oledzki | 25b501a | 2008-01-06 16:36:16 +0100 | [diff] [blame] | 8882 | |
Krzysztof Piotr Oledzki | aeebf9b | 2009-10-04 15:43:17 +0200 | [diff] [blame] | 8883 | option socket-stats |
| 8884 | no option socket-stats |
| 8885 | |
| 8886 | Enable or disable collecting & providing separate statistics for each socket. |
| 8887 | May be used in sections : defaults | frontend | listen | backend |
| 8888 | yes | yes | yes | no |
| 8889 | |
| 8890 | Arguments : none |
| 8891 | |
| 8892 | |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 8893 | option splice-auto |
| 8894 | no option splice-auto |
| 8895 | Enable or disable automatic kernel acceleration on sockets in both directions |
| 8896 | May be used in sections : defaults | frontend | listen | backend |
| 8897 | yes | yes | yes | yes |
| 8898 | Arguments : none |
| 8899 | |
| 8900 | When this option is enabled either on a frontend or on a backend, haproxy |
| 8901 | will automatically evaluate the opportunity to use kernel tcp splicing to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 8902 | forward data between the client and the server, in either direction. HAProxy |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 8903 | uses heuristics to estimate if kernel splicing might improve performance or |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 8904 | not. Both directions are handled independently. Note that the heuristics used |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 8905 | are not much aggressive in order to limit excessive use of splicing. This |
| 8906 | option requires splicing to be enabled at compile time, and may be globally |
| 8907 | disabled with the global option "nosplice". Since splice uses pipes, using it |
| 8908 | requires that there are enough spare pipes. |
| 8909 | |
| 8910 | Important note: kernel-based TCP splicing is a Linux-specific feature which |
| 8911 | first appeared in kernel 2.6.25. It offers kernel-based acceleration to |
| 8912 | transfer data between sockets without copying these data to user-space, thus |
| 8913 | providing noticeable performance gains and CPU cycles savings. Since many |
| 8914 | early implementations are buggy, corrupt data and/or are inefficient, this |
| 8915 | feature is not enabled by default, and it should be used with extreme care. |
| 8916 | While it is not possible to detect the correctness of an implementation, |
| 8917 | 2.6.29 is the first version offering a properly working implementation. In |
| 8918 | case of doubt, splicing may be globally disabled using the global "nosplice" |
| 8919 | keyword. |
| 8920 | |
| 8921 | Example : |
| 8922 | option splice-auto |
| 8923 | |
| 8924 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8925 | in a specific instance by prepending the "no" keyword before it. |
| 8926 | |
| 8927 | See also : "option splice-request", "option splice-response", and global |
| 8928 | options "nosplice" and "maxpipes" |
| 8929 | |
| 8930 | |
| 8931 | option splice-request |
| 8932 | no option splice-request |
| 8933 | Enable or disable automatic kernel acceleration on sockets for requests |
| 8934 | May be used in sections : defaults | frontend | listen | backend |
| 8935 | yes | yes | yes | yes |
| 8936 | Arguments : none |
| 8937 | |
| 8938 | When this option is enabled either on a frontend or on a backend, haproxy |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 8939 | will use kernel tcp splicing whenever possible to forward data going from |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 8940 | the client to the server. It might still use the recv/send scheme if there |
| 8941 | are no spare pipes left. This option requires splicing to be enabled at |
| 8942 | compile time, and may be globally disabled with the global option "nosplice". |
| 8943 | Since splice uses pipes, using it requires that there are enough spare pipes. |
| 8944 | |
| 8945 | Important note: see "option splice-auto" for usage limitations. |
| 8946 | |
| 8947 | Example : |
| 8948 | option splice-request |
| 8949 | |
| 8950 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8951 | in a specific instance by prepending the "no" keyword before it. |
| 8952 | |
| 8953 | See also : "option splice-auto", "option splice-response", and global options |
| 8954 | "nosplice" and "maxpipes" |
| 8955 | |
| 8956 | |
| 8957 | option splice-response |
| 8958 | no option splice-response |
| 8959 | Enable or disable automatic kernel acceleration on sockets for responses |
| 8960 | May be used in sections : defaults | frontend | listen | backend |
| 8961 | yes | yes | yes | yes |
| 8962 | Arguments : none |
| 8963 | |
| 8964 | When this option is enabled either on a frontend or on a backend, haproxy |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 8965 | will use kernel tcp splicing whenever possible to forward data going from |
Willy Tarreau | ff4f82d | 2009-02-06 11:28:13 +0100 | [diff] [blame] | 8966 | the server to the client. It might still use the recv/send scheme if there |
| 8967 | are no spare pipes left. This option requires splicing to be enabled at |
| 8968 | compile time, and may be globally disabled with the global option "nosplice". |
| 8969 | Since splice uses pipes, using it requires that there are enough spare pipes. |
| 8970 | |
| 8971 | Important note: see "option splice-auto" for usage limitations. |
| 8972 | |
| 8973 | Example : |
| 8974 | option splice-response |
| 8975 | |
| 8976 | If this option has been enabled in a "defaults" section, it can be disabled |
| 8977 | in a specific instance by prepending the "no" keyword before it. |
| 8978 | |
| 8979 | See also : "option splice-auto", "option splice-request", and global options |
| 8980 | "nosplice" and "maxpipes" |
| 8981 | |
| 8982 | |
Christopher Faulet | ba7bc16 | 2016-11-07 21:07:38 +0100 | [diff] [blame] | 8983 | option spop-check |
| 8984 | Use SPOP health checks for server testing |
| 8985 | May be used in sections : defaults | frontend | listen | backend |
| 8986 | no | no | no | yes |
| 8987 | Arguments : none |
| 8988 | |
| 8989 | It is possible to test that the server correctly talks SPOP protocol instead |
| 8990 | of just testing that it accepts the TCP connection. When this option is set, |
| 8991 | a HELLO handshake is performed between HAProxy and the server, and the |
| 8992 | response is analyzed to check no error is reported. |
| 8993 | |
| 8994 | Example : |
| 8995 | option spop-check |
| 8996 | |
| 8997 | See also : "option httpchk" |
| 8998 | |
| 8999 | |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 9000 | option srvtcpka |
| 9001 | no option srvtcpka |
| 9002 | Enable or disable the sending of TCP keepalive packets on the server side |
| 9003 | May be used in sections : defaults | frontend | listen | backend |
| 9004 | yes | no | yes | yes |
| 9005 | Arguments : none |
| 9006 | |
| 9007 | When there is a firewall or any session-aware component between a client and |
| 9008 | a server, and when the protocol involves very long sessions with long idle |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9009 | periods (e.g. remote desktops), there is a risk that one of the intermediate |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 9010 | components decides to expire a session which has remained idle for too long. |
| 9011 | |
| 9012 | Enabling socket-level TCP keep-alives makes the system regularly send packets |
| 9013 | to the other end of the connection, leaving it active. The delay between |
| 9014 | keep-alive probes is controlled by the system only and depends both on the |
| 9015 | operating system and its tuning parameters. |
| 9016 | |
| 9017 | It is important to understand that keep-alive packets are neither emitted nor |
| 9018 | received at the application level. It is only the network stacks which sees |
| 9019 | them. For this reason, even if one side of the proxy already uses keep-alives |
| 9020 | to maintain its connection alive, those keep-alive packets will not be |
| 9021 | forwarded to the other side of the proxy. |
| 9022 | |
| 9023 | Please note that this has nothing to do with HTTP keep-alive. |
| 9024 | |
| 9025 | Using option "srvtcpka" enables the emission of TCP keep-alive probes on the |
| 9026 | server side of a connection, which should help when session expirations are |
| 9027 | noticed between HAProxy and a server. |
| 9028 | |
| 9029 | If this option has been enabled in a "defaults" section, it can be disabled |
| 9030 | in a specific instance by prepending the "no" keyword before it. |
| 9031 | |
| 9032 | See also : "option clitcpka", "option tcpka" |
| 9033 | |
| 9034 | |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 9035 | option ssl-hello-chk |
| 9036 | Use SSLv3 client hello health checks for server testing |
| 9037 | May be used in sections : defaults | frontend | listen | backend |
| 9038 | yes | no | yes | yes |
| 9039 | Arguments : none |
| 9040 | |
| 9041 | When some SSL-based protocols are relayed in TCP mode through HAProxy, it is |
| 9042 | possible to test that the server correctly talks SSL instead of just testing |
| 9043 | that it accepts the TCP connection. When "option ssl-hello-chk" is set, pure |
| 9044 | SSLv3 client hello messages are sent once the connection is established to |
| 9045 | the server, and the response is analyzed to find an SSL server hello message. |
| 9046 | The server is considered valid only when the response contains this server |
| 9047 | hello message. |
| 9048 | |
| 9049 | All servers tested till there correctly reply to SSLv3 client hello messages, |
| 9050 | and most servers tested do not even log the requests containing only hello |
| 9051 | messages, which is appreciable. |
| 9052 | |
Willy Tarreau | 763a95b | 2012-10-04 23:15:39 +0200 | [diff] [blame] | 9053 | Note that this check works even when SSL support was not built into haproxy |
| 9054 | because it forges the SSL message. When SSL support is available, it is best |
| 9055 | to use native SSL health checks instead of this one. |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 9056 | |
Willy Tarreau | 763a95b | 2012-10-04 23:15:39 +0200 | [diff] [blame] | 9057 | See also: "option httpchk", "check-ssl" |
| 9058 | |
Willy Tarreau | a453bdd | 2008-01-08 19:50:52 +0100 | [diff] [blame] | 9059 | |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9060 | option tcp-check |
| 9061 | Perform health checks using tcp-check send/expect sequences |
| 9062 | May be used in sections: defaults | frontend | listen | backend |
| 9063 | yes | no | yes | yes |
| 9064 | |
| 9065 | This health check method is intended to be combined with "tcp-check" command |
| 9066 | lists in order to support send/expect types of health check sequences. |
| 9067 | |
| 9068 | TCP checks currently support 4 modes of operations : |
| 9069 | - no "tcp-check" directive : the health check only consists in a connection |
| 9070 | attempt, which remains the default mode. |
| 9071 | |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 9072 | - "tcp-check send" or "tcp-check send-binary" only is mentioned : this is |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9073 | used to send a string along with a connection opening. With some |
| 9074 | protocols, it helps sending a "QUIT" message for example that prevents |
| 9075 | the server from logging a connection error for each health check. The |
| 9076 | check result will still be based on the ability to open the connection |
| 9077 | only. |
| 9078 | |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 9079 | - "tcp-check expect" only is mentioned : this is used to test a banner. |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9080 | The connection is opened and haproxy waits for the server to present some |
| 9081 | contents which must validate some rules. The check result will be based |
| 9082 | on the matching between the contents and the rules. This is suited for |
| 9083 | POP, IMAP, SMTP, FTP, SSH, TELNET. |
| 9084 | |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 9085 | - both "tcp-check send" and "tcp-check expect" are mentioned : this is |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9086 | used to test a hello-type protocol. HAProxy sends a message, the server |
| 9087 | responds and its response is analyzed. the check result will be based on |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 9088 | the matching between the response contents and the rules. This is often |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9089 | suited for protocols which require a binding or a request/response model. |
| 9090 | LDAP, MySQL, Redis and SSL are example of such protocols, though they |
| 9091 | already all have their dedicated checks with a deeper understanding of |
| 9092 | the respective protocols. |
| 9093 | In this mode, many questions may be sent and many answers may be |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9094 | analyzed. |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9095 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 9096 | A fifth mode can be used to insert comments in different steps of the script. |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9097 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 9098 | For each tcp-check rule you create, you can add a "comment" directive, |
| 9099 | followed by a string. This string will be reported in the log and stderr in |
| 9100 | debug mode. It is useful to make user-friendly error reporting. The |
| 9101 | "comment" is of course optional. |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9102 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 9103 | During the execution of a health check, a variable scope is made available to |
| 9104 | store data samples, using the "tcp-check set-var" operation. Freeing those |
| 9105 | variable is possible using "tcp-check unset-var". |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 9106 | |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9107 | |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9108 | Examples : |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9109 | # perform a POP check (analyze only server's banner) |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9110 | option tcp-check |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9111 | tcp-check expect string +OK\ POP3\ ready comment POP\ protocol |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9112 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9113 | # perform an IMAP check (analyze only server's banner) |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9114 | option tcp-check |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9115 | tcp-check expect string *\ OK\ IMAP4\ ready comment IMAP\ protocol |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9116 | |
| 9117 | # look for the redis master server after ensuring it speaks well |
| 9118 | # redis protocol, then it exits properly. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9119 | # (send a command then analyze the response 3 times) |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9120 | option tcp-check |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9121 | tcp-check comment PING\ phase |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9122 | tcp-check send PING\r\n |
Baptiste Assmann | a332299 | 2015-08-04 10:12:18 +0200 | [diff] [blame] | 9123 | tcp-check expect string +PONG |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9124 | tcp-check comment role\ check |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9125 | tcp-check send info\ replication\r\n |
| 9126 | tcp-check expect string role:master |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9127 | tcp-check comment QUIT\ phase |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9128 | tcp-check send QUIT\r\n |
| 9129 | tcp-check expect string +OK |
| 9130 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9131 | forge a HTTP request, then analyze the response |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9132 | (send many headers before analyzing) |
| 9133 | option tcp-check |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9134 | tcp-check comment forge\ and\ send\ HTTP\ request |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9135 | tcp-check send HEAD\ /\ HTTP/1.1\r\n |
| 9136 | tcp-check send Host:\ www.mydomain.com\r\n |
| 9137 | tcp-check send User-Agent:\ HAProxy\ tcpcheck\r\n |
| 9138 | tcp-check send \r\n |
Baptiste Assmann | d60a9e5 | 2015-04-25 16:27:23 +0200 | [diff] [blame] | 9139 | tcp-check expect rstring HTTP/1\..\ (2..|3..) comment check\ HTTP\ response |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9140 | |
| 9141 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 9142 | See also : "tcp-check connect", "tcp-check expect" and "tcp-check send". |
Willy Tarreau | ed17985 | 2013-12-16 01:07:00 +0100 | [diff] [blame] | 9143 | |
| 9144 | |
Willy Tarreau | 9ea05a7 | 2009-06-14 12:07:01 +0200 | [diff] [blame] | 9145 | option tcp-smart-accept |
| 9146 | no option tcp-smart-accept |
| 9147 | Enable or disable the saving of one ACK packet during the accept sequence |
| 9148 | May be used in sections : defaults | frontend | listen | backend |
| 9149 | yes | yes | yes | no |
| 9150 | Arguments : none |
| 9151 | |
| 9152 | When an HTTP connection request comes in, the system acknowledges it on |
| 9153 | behalf of HAProxy, then the client immediately sends its request, and the |
| 9154 | system acknowledges it too while it is notifying HAProxy about the new |
| 9155 | connection. HAProxy then reads the request and responds. This means that we |
| 9156 | have one TCP ACK sent by the system for nothing, because the request could |
| 9157 | very well be acknowledged by HAProxy when it sends its response. |
| 9158 | |
| 9159 | For this reason, in HTTP mode, HAProxy automatically asks the system to avoid |
| 9160 | sending this useless ACK on platforms which support it (currently at least |
| 9161 | Linux). It must not cause any problem, because the system will send it anyway |
| 9162 | after 40 ms if the response takes more time than expected to come. |
| 9163 | |
| 9164 | During complex network debugging sessions, it may be desirable to disable |
| 9165 | this optimization because delayed ACKs can make troubleshooting more complex |
| 9166 | when trying to identify where packets are delayed. It is then possible to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9167 | fall back to normal behavior by specifying "no option tcp-smart-accept". |
Willy Tarreau | 9ea05a7 | 2009-06-14 12:07:01 +0200 | [diff] [blame] | 9168 | |
| 9169 | It is also possible to force it for non-HTTP proxies by simply specifying |
| 9170 | "option tcp-smart-accept". For instance, it can make sense with some services |
| 9171 | such as SMTP where the server speaks first. |
| 9172 | |
| 9173 | It is recommended to avoid forcing this option in a defaults section. In case |
| 9174 | of doubt, consider setting it back to automatic values by prepending the |
| 9175 | "default" keyword before it, or disabling it using the "no" keyword. |
| 9176 | |
Willy Tarreau | d88edf2 | 2009-06-14 15:48:17 +0200 | [diff] [blame] | 9177 | See also : "option tcp-smart-connect" |
| 9178 | |
| 9179 | |
| 9180 | option tcp-smart-connect |
| 9181 | no option tcp-smart-connect |
| 9182 | Enable or disable the saving of one ACK packet during the connect sequence |
| 9183 | May be used in sections : defaults | frontend | listen | backend |
| 9184 | yes | no | yes | yes |
| 9185 | Arguments : none |
| 9186 | |
| 9187 | On certain systems (at least Linux), HAProxy can ask the kernel not to |
| 9188 | immediately send an empty ACK upon a connection request, but to directly |
| 9189 | send the buffer request instead. This saves one packet on the network and |
| 9190 | thus boosts performance. It can also be useful for some servers, because they |
| 9191 | immediately get the request along with the incoming connection. |
| 9192 | |
| 9193 | This feature is enabled when "option tcp-smart-connect" is set in a backend. |
| 9194 | It is not enabled by default because it makes network troubleshooting more |
| 9195 | complex. |
| 9196 | |
| 9197 | It only makes sense to enable it with protocols where the client speaks first |
| 9198 | such as HTTP. In other situations, if there is no data to send in place of |
| 9199 | the ACK, a normal ACK is sent. |
| 9200 | |
| 9201 | If this option has been enabled in a "defaults" section, it can be disabled |
| 9202 | in a specific instance by prepending the "no" keyword before it. |
| 9203 | |
| 9204 | See also : "option tcp-smart-accept" |
| 9205 | |
Willy Tarreau | 9ea05a7 | 2009-06-14 12:07:01 +0200 | [diff] [blame] | 9206 | |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 9207 | option tcpka |
| 9208 | Enable or disable the sending of TCP keepalive packets on both sides |
| 9209 | May be used in sections : defaults | frontend | listen | backend |
| 9210 | yes | yes | yes | yes |
| 9211 | Arguments : none |
| 9212 | |
| 9213 | When there is a firewall or any session-aware component between a client and |
| 9214 | a server, and when the protocol involves very long sessions with long idle |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9215 | periods (e.g. remote desktops), there is a risk that one of the intermediate |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 9216 | components decides to expire a session which has remained idle for too long. |
| 9217 | |
| 9218 | Enabling socket-level TCP keep-alives makes the system regularly send packets |
| 9219 | to the other end of the connection, leaving it active. The delay between |
| 9220 | keep-alive probes is controlled by the system only and depends both on the |
| 9221 | operating system and its tuning parameters. |
| 9222 | |
| 9223 | It is important to understand that keep-alive packets are neither emitted nor |
| 9224 | received at the application level. It is only the network stacks which sees |
| 9225 | them. For this reason, even if one side of the proxy already uses keep-alives |
| 9226 | to maintain its connection alive, those keep-alive packets will not be |
| 9227 | forwarded to the other side of the proxy. |
| 9228 | |
| 9229 | Please note that this has nothing to do with HTTP keep-alive. |
| 9230 | |
| 9231 | Using option "tcpka" enables the emission of TCP keep-alive probes on both |
| 9232 | the client and server sides of a connection. Note that this is meaningful |
| 9233 | only in "defaults" or "listen" sections. If this option is used in a |
| 9234 | frontend, only the client side will get keep-alives, and if this option is |
| 9235 | used in a backend, only the server side will get keep-alives. For this |
| 9236 | reason, it is strongly recommended to explicitly use "option clitcpka" and |
| 9237 | "option srvtcpka" when the configuration is split between frontends and |
| 9238 | backends. |
| 9239 | |
| 9240 | See also : "option clitcpka", "option srvtcpka" |
| 9241 | |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 9242 | |
| 9243 | option tcplog |
| 9244 | Enable advanced logging of TCP connections with session state and timers |
| 9245 | May be used in sections : defaults | frontend | listen | backend |
Tim Duesterhus | 9ad9f35 | 2018-02-05 20:52:27 +0100 | [diff] [blame] | 9246 | yes | yes | yes | no |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 9247 | Arguments : none |
| 9248 | |
| 9249 | By default, the log output format is very poor, as it only contains the |
| 9250 | source and destination addresses, and the instance name. By specifying |
| 9251 | "option tcplog", each log line turns into a much richer format including, but |
| 9252 | not limited to, the connection timers, the session status, the connections |
| 9253 | numbers, the frontend, backend and server name, and of course the source |
| 9254 | address and ports. This option is useful for pure TCP proxies in order to |
| 9255 | find which of the client or server disconnects or times out. For normal HTTP |
| 9256 | proxies, it's better to use "option httplog" which is even more complete. |
| 9257 | |
Guillaume de Lafond | 29f4560 | 2017-03-31 19:52:15 +0200 | [diff] [blame] | 9258 | "option tcplog" overrides any previous "log-format" directive. |
| 9259 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 9260 | See also : "option httplog", and section 8 about logging. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 9261 | |
| 9262 | |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 9263 | option transparent |
| 9264 | no option transparent |
| 9265 | Enable client-side transparent proxying |
| 9266 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | 4b1f859 | 2008-12-23 23:13:55 +0100 | [diff] [blame] | 9267 | yes | no | yes | yes |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 9268 | Arguments : none |
| 9269 | |
| 9270 | This option was introduced in order to provide layer 7 persistence to layer 3 |
| 9271 | load balancers. The idea is to use the OS's ability to redirect an incoming |
| 9272 | connection for a remote address to a local process (here HAProxy), and let |
| 9273 | this process know what address was initially requested. When this option is |
| 9274 | used, sessions without cookies will be forwarded to the original destination |
| 9275 | IP address of the incoming request (which should match that of another |
| 9276 | equipment), while requests with cookies will still be forwarded to the |
| 9277 | appropriate server. |
| 9278 | |
| 9279 | Note that contrary to a common belief, this option does NOT make HAProxy |
| 9280 | present the client's IP to the server when establishing the connection. |
| 9281 | |
Willy Tarreau | a114605 | 2011-03-01 09:51:54 +0100 | [diff] [blame] | 9282 | See also: the "usesrc" argument of the "source" keyword, and the |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9283 | "transparent" option of the "bind" keyword. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 9284 | |
Willy Tarreau | bf1f816 | 2007-12-28 17:42:56 +0100 | [diff] [blame] | 9285 | |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 9286 | external-check command <command> |
| 9287 | Executable to run when performing an external-check |
| 9288 | May be used in sections : defaults | frontend | listen | backend |
| 9289 | yes | no | yes | yes |
| 9290 | |
| 9291 | Arguments : |
| 9292 | <command> is the external command to run |
| 9293 | |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 9294 | The arguments passed to the to the command are: |
| 9295 | |
Cyril Bonté | 777be86 | 2014-12-02 21:21:35 +0100 | [diff] [blame] | 9296 | <proxy_address> <proxy_port> <server_address> <server_port> |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 9297 | |
Cyril Bonté | 777be86 | 2014-12-02 21:21:35 +0100 | [diff] [blame] | 9298 | The <proxy_address> and <proxy_port> are derived from the first listener |
| 9299 | that is either IPv4, IPv6 or a UNIX socket. In the case of a UNIX socket |
| 9300 | listener the proxy_address will be the path of the socket and the |
| 9301 | <proxy_port> will be the string "NOT_USED". In a backend section, it's not |
| 9302 | possible to determine a listener, and both <proxy_address> and <proxy_port> |
| 9303 | will have the string value "NOT_USED". |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 9304 | |
Cyril Bonté | 72cda2a | 2014-12-27 22:28:39 +0100 | [diff] [blame] | 9305 | Some values are also provided through environment variables. |
| 9306 | |
| 9307 | Environment variables : |
| 9308 | HAPROXY_PROXY_ADDR The first bind address if available (or empty if not |
| 9309 | applicable, for example in a "backend" section). |
| 9310 | |
| 9311 | HAPROXY_PROXY_ID The backend id. |
| 9312 | |
| 9313 | HAPROXY_PROXY_NAME The backend name. |
| 9314 | |
| 9315 | HAPROXY_PROXY_PORT The first bind port if available (or empty if not |
| 9316 | applicable, for example in a "backend" section or |
| 9317 | for a UNIX socket). |
| 9318 | |
| 9319 | HAPROXY_SERVER_ADDR The server address. |
| 9320 | |
| 9321 | HAPROXY_SERVER_CURCONN The current number of connections on the server. |
| 9322 | |
| 9323 | HAPROXY_SERVER_ID The server id. |
| 9324 | |
| 9325 | HAPROXY_SERVER_MAXCONN The server max connections. |
| 9326 | |
| 9327 | HAPROXY_SERVER_NAME The server name. |
| 9328 | |
| 9329 | HAPROXY_SERVER_PORT The server port if available (or empty for a UNIX |
| 9330 | socket). |
| 9331 | |
| 9332 | PATH The PATH environment variable used when executing |
| 9333 | the command may be set using "external-check path". |
| 9334 | |
William Lallemand | 4d03e43 | 2019-06-14 15:35:37 +0200 | [diff] [blame] | 9335 | See also "2.3. Environment variables" for other variables. |
| 9336 | |
Simon Horman | 98637e5 | 2014-06-20 12:30:16 +0900 | [diff] [blame] | 9337 | If the command executed and exits with a zero status then the check is |
| 9338 | considered to have passed, otherwise the check is considered to have |
| 9339 | failed. |
| 9340 | |
| 9341 | Example : |
| 9342 | external-check command /bin/true |
| 9343 | |
| 9344 | See also : "external-check", "option external-check", "external-check path" |
| 9345 | |
| 9346 | |
| 9347 | external-check path <path> |
| 9348 | The value of the PATH environment variable used when running an external-check |
| 9349 | May be used in sections : defaults | frontend | listen | backend |
| 9350 | yes | no | yes | yes |
| 9351 | |
| 9352 | Arguments : |
| 9353 | <path> is the path used when executing external command to run |
| 9354 | |
| 9355 | The default path is "". |
| 9356 | |
| 9357 | Example : |
| 9358 | external-check path "/usr/bin:/bin" |
| 9359 | |
| 9360 | See also : "external-check", "option external-check", |
| 9361 | "external-check command" |
| 9362 | |
| 9363 | |
Emeric Brun | 647caf1 | 2009-06-30 17:57:00 +0200 | [diff] [blame] | 9364 | persist rdp-cookie |
Hervé COMMOWICK | a3eb39c | 2011-08-05 18:48:51 +0200 | [diff] [blame] | 9365 | persist rdp-cookie(<name>) |
Emeric Brun | 647caf1 | 2009-06-30 17:57:00 +0200 | [diff] [blame] | 9366 | Enable RDP cookie-based persistence |
| 9367 | May be used in sections : defaults | frontend | listen | backend |
| 9368 | yes | no | yes | yes |
| 9369 | Arguments : |
| 9370 | <name> is the optional name of the RDP cookie to check. If omitted, the |
Willy Tarreau | 61e28f2 | 2010-05-16 22:31:05 +0200 | [diff] [blame] | 9371 | default cookie name "msts" will be used. There currently is no |
| 9372 | valid reason to change this name. |
Emeric Brun | 647caf1 | 2009-06-30 17:57:00 +0200 | [diff] [blame] | 9373 | |
| 9374 | This statement enables persistence based on an RDP cookie. The RDP cookie |
| 9375 | contains all information required to find the server in the list of known |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9376 | servers. So when this option is set in the backend, the request is analyzed |
Emeric Brun | 647caf1 | 2009-06-30 17:57:00 +0200 | [diff] [blame] | 9377 | and if an RDP cookie is found, it is decoded. If it matches a known server |
| 9378 | which is still UP (or if "option persist" is set), then the connection is |
| 9379 | forwarded to this server. |
| 9380 | |
| 9381 | Note that this only makes sense in a TCP backend, but for this to work, the |
| 9382 | frontend must have waited long enough to ensure that an RDP cookie is present |
| 9383 | in the request buffer. This is the same requirement as with the "rdp-cookie" |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 9384 | load-balancing method. Thus it is highly recommended to put all statements in |
Emeric Brun | 647caf1 | 2009-06-30 17:57:00 +0200 | [diff] [blame] | 9385 | a single "listen" section. |
| 9386 | |
Willy Tarreau | 61e28f2 | 2010-05-16 22:31:05 +0200 | [diff] [blame] | 9387 | Also, it is important to understand that the terminal server will emit this |
| 9388 | RDP cookie only if it is configured for "token redirection mode", which means |
| 9389 | that the "IP address redirection" option is disabled. |
| 9390 | |
Emeric Brun | 647caf1 | 2009-06-30 17:57:00 +0200 | [diff] [blame] | 9391 | Example : |
| 9392 | listen tse-farm |
| 9393 | bind :3389 |
| 9394 | # wait up to 5s for an RDP cookie in the request |
| 9395 | tcp-request inspect-delay 5s |
| 9396 | tcp-request content accept if RDP_COOKIE |
| 9397 | # apply RDP cookie persistence |
| 9398 | persist rdp-cookie |
| 9399 | # if server is unknown, let's balance on the same cookie. |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 9400 | # alternatively, "balance leastconn" may be useful too. |
Emeric Brun | 647caf1 | 2009-06-30 17:57:00 +0200 | [diff] [blame] | 9401 | balance rdp-cookie |
| 9402 | server srv1 1.1.1.1:3389 |
| 9403 | server srv2 1.1.1.2:3389 |
| 9404 | |
Simon Horman | ab814e0 | 2011-06-24 14:50:20 +0900 | [diff] [blame] | 9405 | See also : "balance rdp-cookie", "tcp-request", the "req_rdp_cookie" ACL and |
| 9406 | the rdp_cookie pattern fetch function. |
Emeric Brun | 647caf1 | 2009-06-30 17:57:00 +0200 | [diff] [blame] | 9407 | |
| 9408 | |
Willy Tarreau | 3a7d207 | 2009-03-05 23:48:25 +0100 | [diff] [blame] | 9409 | rate-limit sessions <rate> |
| 9410 | Set a limit on the number of new sessions accepted per second on a frontend |
| 9411 | May be used in sections : defaults | frontend | listen | backend |
| 9412 | yes | yes | yes | no |
| 9413 | Arguments : |
| 9414 | <rate> The <rate> parameter is an integer designating the maximum number |
| 9415 | of new sessions per second to accept on the frontend. |
| 9416 | |
| 9417 | When the frontend reaches the specified number of new sessions per second, it |
| 9418 | stops accepting new connections until the rate drops below the limit again. |
| 9419 | During this time, the pending sessions will be kept in the socket's backlog |
| 9420 | (in system buffers) and haproxy will not even be aware that sessions are |
| 9421 | pending. When applying very low limit on a highly loaded service, it may make |
| 9422 | sense to increase the socket's backlog using the "backlog" keyword. |
| 9423 | |
| 9424 | This feature is particularly efficient at blocking connection-based attacks |
| 9425 | or service abuse on fragile servers. Since the session rate is measured every |
| 9426 | millisecond, it is extremely accurate. Also, the limit applies immediately, |
| 9427 | no delay is needed at all to detect the threshold. |
| 9428 | |
| 9429 | Example : limit the connection rate on SMTP to 10 per second max |
| 9430 | listen smtp |
| 9431 | mode tcp |
| 9432 | bind :25 |
| 9433 | rate-limit sessions 10 |
Panagiotis Panagiotopoulos | 7282d8e | 2016-02-11 16:37:15 +0200 | [diff] [blame] | 9434 | server smtp1 127.0.0.1:1025 |
Willy Tarreau | 3a7d207 | 2009-03-05 23:48:25 +0100 | [diff] [blame] | 9435 | |
Willy Tarreau | a17c2d9 | 2011-07-25 08:16:20 +0200 | [diff] [blame] | 9436 | Note : when the maximum rate is reached, the frontend's status is not changed |
| 9437 | but its sockets appear as "WAITING" in the statistics if the |
| 9438 | "socket-stats" option is enabled. |
Willy Tarreau | 3a7d207 | 2009-03-05 23:48:25 +0100 | [diff] [blame] | 9439 | |
| 9440 | See also : the "backlog" keyword and the "fe_sess_rate" ACL criterion. |
| 9441 | |
| 9442 | |
Willy Tarreau | 2e1dca8 | 2012-09-12 08:43:15 +0200 | [diff] [blame] | 9443 | redirect location <loc> [code <code>] <option> [{if | unless} <condition>] |
| 9444 | redirect prefix <pfx> [code <code>] <option> [{if | unless} <condition>] |
| 9445 | redirect scheme <sch> [code <code>] <option> [{if | unless} <condition>] |
Willy Tarreau | b463dfb | 2008-06-07 23:08:56 +0200 | [diff] [blame] | 9446 | Return an HTTP redirection if/unless a condition is matched |
| 9447 | May be used in sections : defaults | frontend | listen | backend |
| 9448 | no | yes | yes | yes |
| 9449 | |
| 9450 | If/unless the condition is matched, the HTTP request will lead to a redirect |
Willy Tarreau | f285f54 | 2010-01-03 20:03:03 +0100 | [diff] [blame] | 9451 | response. If no condition is specified, the redirect applies unconditionally. |
Willy Tarreau | b463dfb | 2008-06-07 23:08:56 +0200 | [diff] [blame] | 9452 | |
Willy Tarreau | 0140f25 | 2008-11-19 21:07:09 +0100 | [diff] [blame] | 9453 | Arguments : |
Willy Tarreau | 2e1dca8 | 2012-09-12 08:43:15 +0200 | [diff] [blame] | 9454 | <loc> With "redirect location", the exact value in <loc> is placed into |
Thierry FOURNIER | d18cd0f | 2013-11-29 12:15:45 +0100 | [diff] [blame] | 9455 | the HTTP "Location" header. When used in an "http-request" rule, |
| 9456 | <loc> value follows the log-format rules and can include some |
| 9457 | dynamic values (see Custom Log Format in section 8.2.4). |
Willy Tarreau | 2e1dca8 | 2012-09-12 08:43:15 +0200 | [diff] [blame] | 9458 | |
| 9459 | <pfx> With "redirect prefix", the "Location" header is built from the |
| 9460 | concatenation of <pfx> and the complete URI path, including the |
| 9461 | query string, unless the "drop-query" option is specified (see |
| 9462 | below). As a special case, if <pfx> equals exactly "/", then |
| 9463 | nothing is inserted before the original URI. It allows one to |
Thierry FOURNIER | d18cd0f | 2013-11-29 12:15:45 +0100 | [diff] [blame] | 9464 | redirect to the same URL (for instance, to insert a cookie). When |
| 9465 | used in an "http-request" rule, <pfx> value follows the log-format |
| 9466 | rules and can include some dynamic values (see Custom Log Format |
| 9467 | in section 8.2.4). |
Willy Tarreau | 2e1dca8 | 2012-09-12 08:43:15 +0200 | [diff] [blame] | 9468 | |
| 9469 | <sch> With "redirect scheme", then the "Location" header is built by |
| 9470 | concatenating <sch> with "://" then the first occurrence of the |
| 9471 | "Host" header, and then the URI path, including the query string |
| 9472 | unless the "drop-query" option is specified (see below). If no |
| 9473 | path is found or if the path is "*", then "/" is used instead. If |
| 9474 | no "Host" header is found, then an empty host component will be |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 9475 | returned, which most recent browsers interpret as redirecting to |
Willy Tarreau | 2e1dca8 | 2012-09-12 08:43:15 +0200 | [diff] [blame] | 9476 | the same host. This directive is mostly used to redirect HTTP to |
Thierry FOURNIER | d18cd0f | 2013-11-29 12:15:45 +0100 | [diff] [blame] | 9477 | HTTPS. When used in an "http-request" rule, <sch> value follows |
| 9478 | the log-format rules and can include some dynamic values (see |
| 9479 | Custom Log Format in section 8.2.4). |
Willy Tarreau | 0140f25 | 2008-11-19 21:07:09 +0100 | [diff] [blame] | 9480 | |
| 9481 | <code> The code is optional. It indicates which type of HTTP redirection |
Willy Tarreau | b67fdc4 | 2013-03-29 19:28:11 +0100 | [diff] [blame] | 9482 | is desired. Only codes 301, 302, 303, 307 and 308 are supported, |
| 9483 | with 302 used by default if no code is specified. 301 means |
| 9484 | "Moved permanently", and a browser may cache the Location. 302 |
Baptiste Assmann | ea849c0 | 2015-08-03 11:42:50 +0200 | [diff] [blame] | 9485 | means "Moved temporarily" and means that the browser should not |
Willy Tarreau | b67fdc4 | 2013-03-29 19:28:11 +0100 | [diff] [blame] | 9486 | cache the redirection. 303 is equivalent to 302 except that the |
| 9487 | browser will fetch the location with a GET method. 307 is just |
| 9488 | like 302 but makes it clear that the same method must be reused. |
| 9489 | Likewise, 308 replaces 301 if the same method must be used. |
Willy Tarreau | 0140f25 | 2008-11-19 21:07:09 +0100 | [diff] [blame] | 9490 | |
| 9491 | <option> There are several options which can be specified to adjust the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9492 | expected behavior of a redirection : |
Willy Tarreau | 0140f25 | 2008-11-19 21:07:09 +0100 | [diff] [blame] | 9493 | |
| 9494 | - "drop-query" |
| 9495 | When this keyword is used in a prefix-based redirection, then the |
| 9496 | location will be set without any possible query-string, which is useful |
| 9497 | for directing users to a non-secure page for instance. It has no effect |
| 9498 | with a location-type redirect. |
| 9499 | |
Willy Tarreau | 81e3b4f | 2010-01-10 00:42:19 +0100 | [diff] [blame] | 9500 | - "append-slash" |
| 9501 | This keyword may be used in conjunction with "drop-query" to redirect |
| 9502 | users who use a URL not ending with a '/' to the same one with the '/'. |
| 9503 | It can be useful to ensure that search engines will only see one URL. |
| 9504 | For this, a return code 301 is preferred. |
| 9505 | |
Willy Tarreau | 0140f25 | 2008-11-19 21:07:09 +0100 | [diff] [blame] | 9506 | - "set-cookie NAME[=value]" |
| 9507 | A "Set-Cookie" header will be added with NAME (and optionally "=value") |
| 9508 | to the response. This is sometimes used to indicate that a user has |
| 9509 | been seen, for instance to protect against some types of DoS. No other |
| 9510 | cookie option is added, so the cookie will be a session cookie. Note |
| 9511 | that for a browser, a sole cookie name without an equal sign is |
| 9512 | different from a cookie with an equal sign. |
| 9513 | |
| 9514 | - "clear-cookie NAME[=]" |
| 9515 | A "Set-Cookie" header will be added with NAME (and optionally "="), but |
| 9516 | with the "Max-Age" attribute set to zero. This will tell the browser to |
| 9517 | delete this cookie. It is useful for instance on logout pages. It is |
| 9518 | important to note that clearing the cookie "NAME" will not remove a |
| 9519 | cookie set with "NAME=value". You have to clear the cookie "NAME=" for |
| 9520 | that, because the browser makes the difference. |
Willy Tarreau | b463dfb | 2008-06-07 23:08:56 +0200 | [diff] [blame] | 9521 | |
| 9522 | Example: move the login URL only to HTTPS. |
| 9523 | acl clear dst_port 80 |
| 9524 | acl secure dst_port 8080 |
| 9525 | acl login_page url_beg /login |
Willy Tarreau | 0140f25 | 2008-11-19 21:07:09 +0100 | [diff] [blame] | 9526 | acl logout url_beg /logout |
Willy Tarreau | 79da469 | 2008-11-19 20:03:04 +0100 | [diff] [blame] | 9527 | acl uid_given url_reg /login?userid=[^&]+ |
Willy Tarreau | 0140f25 | 2008-11-19 21:07:09 +0100 | [diff] [blame] | 9528 | acl cookie_set hdr_sub(cookie) SEEN=1 |
| 9529 | |
| 9530 | redirect prefix https://mysite.com set-cookie SEEN=1 if !cookie_set |
Willy Tarreau | 79da469 | 2008-11-19 20:03:04 +0100 | [diff] [blame] | 9531 | redirect prefix https://mysite.com if login_page !secure |
| 9532 | redirect prefix http://mysite.com drop-query if login_page !uid_given |
| 9533 | redirect location http://mysite.com/ if !login_page secure |
Willy Tarreau | 0140f25 | 2008-11-19 21:07:09 +0100 | [diff] [blame] | 9534 | redirect location / clear-cookie USERID= if logout |
Willy Tarreau | b463dfb | 2008-06-07 23:08:56 +0200 | [diff] [blame] | 9535 | |
Willy Tarreau | 81e3b4f | 2010-01-10 00:42:19 +0100 | [diff] [blame] | 9536 | Example: send redirects for request for articles without a '/'. |
| 9537 | acl missing_slash path_reg ^/article/[^/]*$ |
| 9538 | redirect code 301 prefix / drop-query append-slash if missing_slash |
| 9539 | |
Willy Tarreau | 2e1dca8 | 2012-09-12 08:43:15 +0200 | [diff] [blame] | 9540 | Example: redirect all HTTP traffic to HTTPS when SSL is handled by haproxy. |
David BERARD | e715304 | 2012-11-03 00:11:31 +0100 | [diff] [blame] | 9541 | redirect scheme https if !{ ssl_fc } |
Willy Tarreau | 2e1dca8 | 2012-09-12 08:43:15 +0200 | [diff] [blame] | 9542 | |
Thierry FOURNIER | d18cd0f | 2013-11-29 12:15:45 +0100 | [diff] [blame] | 9543 | Example: append 'www.' prefix in front of all hosts not having it |
Coen Rosdorff | 596659b | 2016-04-11 11:33:49 +0200 | [diff] [blame] | 9544 | http-request redirect code 301 location \ |
| 9545 | http://www.%[hdr(host)]%[capture.req.uri] \ |
| 9546 | unless { hdr_beg(host) -i www } |
Thierry FOURNIER | d18cd0f | 2013-11-29 12:15:45 +0100 | [diff] [blame] | 9547 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 9548 | See section 7 about ACL usage. |
Willy Tarreau | b463dfb | 2008-06-07 23:08:56 +0200 | [diff] [blame] | 9549 | |
Willy Tarreau | 303c035 | 2008-01-17 19:01:39 +0100 | [diff] [blame] | 9550 | |
Willy Tarreau | e5c5ce9 | 2008-06-20 17:27:19 +0200 | [diff] [blame] | 9551 | retries <value> |
| 9552 | Set the number of retries to perform on a server after a connection failure |
| 9553 | May be used in sections: defaults | frontend | listen | backend |
| 9554 | yes | no | yes | yes |
| 9555 | Arguments : |
| 9556 | <value> is the number of times a connection attempt should be retried on |
| 9557 | a server when a connection either is refused or times out. The |
| 9558 | default value is 3. |
| 9559 | |
| 9560 | It is important to understand that this value applies to the number of |
| 9561 | connection attempts, not full requests. When a connection has effectively |
| 9562 | been established to a server, there will be no more retry. |
| 9563 | |
| 9564 | In order to avoid immediate reconnections to a server which is restarting, |
Joseph Lynch | 726ab71 | 2015-05-11 23:25:34 -0700 | [diff] [blame] | 9565 | a turn-around timer of min("timeout connect", one second) is applied before |
| 9566 | a retry occurs. |
Willy Tarreau | e5c5ce9 | 2008-06-20 17:27:19 +0200 | [diff] [blame] | 9567 | |
| 9568 | When "option redispatch" is set, the last retry may be performed on another |
| 9569 | server even if a cookie references a different server. |
| 9570 | |
| 9571 | See also : "option redispatch" |
| 9572 | |
| 9573 | |
Olivier Houchard | a254a37 | 2019-04-05 15:30:12 +0200 | [diff] [blame] | 9574 | retry-on [list of keywords] |
Jerome Magnin | 5ce3c14 | 2020-05-13 20:09:57 +0200 | [diff] [blame] | 9575 | Specify when to attempt to automatically retry a failed request. |
| 9576 | This setting is only valid when "mode" is set to http and is silently ignored |
| 9577 | otherwise. |
Olivier Houchard | a254a37 | 2019-04-05 15:30:12 +0200 | [diff] [blame] | 9578 | May be used in sections: defaults | frontend | listen | backend |
| 9579 | yes | no | yes | yes |
| 9580 | Arguments : |
| 9581 | <keywords> is a list of keywords or HTTP status codes, each representing a |
| 9582 | type of failure event on which an attempt to retry the request |
| 9583 | is desired. Please read the notes at the bottom before changing |
| 9584 | this setting. The following keywords are supported : |
| 9585 | |
| 9586 | none never retry |
| 9587 | |
| 9588 | conn-failure retry when the connection or the SSL handshake failed |
| 9589 | and the request could not be sent. This is the default. |
| 9590 | |
| 9591 | empty-response retry when the server connection was closed after part |
| 9592 | of the request was sent, and nothing was received from |
| 9593 | the server. This type of failure may be caused by the |
| 9594 | request timeout on the server side, poor network |
| 9595 | condition, or a server crash or restart while |
| 9596 | processing the request. |
| 9597 | |
Olivier Houchard | e3249a9 | 2019-05-03 23:01:47 +0200 | [diff] [blame] | 9598 | junk-response retry when the server returned something not looking |
| 9599 | like a complete HTTP response. This includes partial |
| 9600 | responses headers as well as non-HTTP contents. It |
| 9601 | usually is a bad idea to retry on such events, which |
| 9602 | may be caused a configuration issue (wrong server port) |
| 9603 | or by the request being harmful to the server (buffer |
| 9604 | overflow attack for example). |
| 9605 | |
Olivier Houchard | a254a37 | 2019-04-05 15:30:12 +0200 | [diff] [blame] | 9606 | response-timeout the server timeout stroke while waiting for the server |
| 9607 | to respond to the request. This may be caused by poor |
| 9608 | network condition, the reuse of an idle connection |
| 9609 | which has expired on the path, or by the request being |
| 9610 | extremely expensive to process. It generally is a bad |
| 9611 | idea to retry on such events on servers dealing with |
| 9612 | heavy database processing (full scans, etc) as it may |
| 9613 | amplify denial of service attacks. |
| 9614 | |
Olivier Houchard | 865d839 | 2019-05-03 22:46:27 +0200 | [diff] [blame] | 9615 | 0rtt-rejected retry requests which were sent over early data and were |
| 9616 | rejected by the server. These requests are generally |
| 9617 | considered to be safe to retry. |
| 9618 | |
Julien Pivotto | 2de240a | 2020-11-12 11:14:05 +0100 | [diff] [blame] | 9619 | <status> any HTTP status code among "401" (Unauthorized), "403" |
| 9620 | (Forbidden), "404" (Not Found), "408" (Request Timeout), |
| 9621 | "425" (Too Early), "500" (Server Error), "501" (Not |
| 9622 | Implemented), "502" (Bad Gateway), "503" (Service |
| 9623 | Unavailable), "504" (Gateway Timeout). |
Olivier Houchard | a254a37 | 2019-04-05 15:30:12 +0200 | [diff] [blame] | 9624 | |
Olivier Houchard | ddf0e03 | 2019-05-10 18:05:40 +0200 | [diff] [blame] | 9625 | all-retryable-errors |
| 9626 | retry request for any error that are considered |
| 9627 | retryable. This currently activates "conn-failure", |
| 9628 | "empty-response", "junk-response", "response-timeout", |
| 9629 | "0rtt-rejected", "500", "502", "503", and "504". |
| 9630 | |
Olivier Houchard | a254a37 | 2019-04-05 15:30:12 +0200 | [diff] [blame] | 9631 | Using this directive replaces any previous settings with the new ones; it is |
| 9632 | not cumulative. |
| 9633 | |
| 9634 | Please note that using anything other than "none" and "conn-failure" requires |
| 9635 | to allocate a buffer and copy the whole request into it, so it has memory and |
| 9636 | performance impacts. Requests not fitting in a single buffer will never be |
| 9637 | retried (see the global tune.bufsize setting). |
| 9638 | |
| 9639 | You have to make sure the application has a replay protection mechanism built |
| 9640 | in such as a unique transaction IDs passed in requests, or that replaying the |
| 9641 | same request has no consequence, or it is very dangerous to use any retry-on |
| 9642 | value beside "conn-failure" and "none". Static file servers and caches are |
| 9643 | generally considered safe against any type of retry. Using a status code can |
| 9644 | be useful to quickly leave a server showing an abnormal behavior (out of |
| 9645 | memory, file system issues, etc), but in this case it may be a good idea to |
| 9646 | immediately redispatch the connection to another server (please see "option |
| 9647 | redispatch" for this). Last, it is important to understand that most causes |
| 9648 | of failures are the requests themselves and that retrying a request causing a |
| 9649 | server to misbehave will often make the situation even worse for this server, |
| 9650 | or for the whole service in case of redispatch. |
| 9651 | |
| 9652 | Unless you know exactly how the application deals with replayed requests, you |
| 9653 | should not use this directive. |
| 9654 | |
| 9655 | The default is "conn-failure". |
| 9656 | |
| 9657 | See also: "retries", "option redispatch", "tune.bufsize" |
| 9658 | |
David du Colombier | 486df47 | 2011-03-17 10:40:26 +0100 | [diff] [blame] | 9659 | server <name> <address>[:[port]] [param*] |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9660 | Declare a server in a backend |
| 9661 | May be used in sections : defaults | frontend | listen | backend |
| 9662 | no | no | yes | yes |
| 9663 | Arguments : |
| 9664 | <name> is the internal name assigned to this server. This name will |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9665 | appear in logs and alerts. If "http-send-name-header" is |
Mark Lamourine | c2247f0 | 2012-01-04 13:02:01 -0500 | [diff] [blame] | 9666 | set, it will be added to the request header sent to the server. |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9667 | |
David du Colombier | 486df47 | 2011-03-17 10:40:26 +0100 | [diff] [blame] | 9668 | <address> is the IPv4 or IPv6 address of the server. Alternatively, a |
| 9669 | resolvable hostname is supported, but this name will be resolved |
| 9670 | during start-up. Address "0.0.0.0" or "*" has a special meaning. |
| 9671 | It indicates that the connection will be forwarded to the same IP |
Willy Tarreau | d669a4f | 2010-07-13 14:49:50 +0200 | [diff] [blame] | 9672 | address as the one from the client connection. This is useful in |
| 9673 | transparent proxy architectures where the client's connection is |
| 9674 | intercepted and haproxy must forward to the original destination |
| 9675 | address. This is more or less what the "transparent" keyword does |
| 9676 | except that with a server it's possible to limit concurrency and |
Willy Tarreau | 2470928 | 2013-03-10 21:32:12 +0100 | [diff] [blame] | 9677 | to report statistics. Optionally, an address family prefix may be |
| 9678 | used before the address to force the family regardless of the |
| 9679 | address format, which can be useful to specify a path to a unix |
| 9680 | socket with no slash ('/'). Currently supported prefixes are : |
| 9681 | - 'ipv4@' -> address is always IPv4 |
| 9682 | - 'ipv6@' -> address is always IPv6 |
| 9683 | - 'unix@' -> address is a path to a local unix socket |
Willy Tarreau | ccfccef | 2014-05-10 01:49:15 +0200 | [diff] [blame] | 9684 | - 'abns@' -> address is in abstract namespace (Linux only) |
William Lallemand | 2fe7dd0 | 2018-09-11 16:51:29 +0200 | [diff] [blame] | 9685 | - 'sockpair@' -> address is the FD of a connected unix |
| 9686 | socket or of a socketpair. During a connection, the |
| 9687 | backend creates a pair of connected sockets, and passes |
| 9688 | one of them over the FD. The bind part will use the |
| 9689 | received socket as the client FD. Should be used |
| 9690 | carefully. |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 9691 | You may want to reference some environment variables in the |
| 9692 | address parameter, see section 2.3 about environment |
Willy Tarreau | 6a031d1 | 2016-11-07 19:42:35 +0100 | [diff] [blame] | 9693 | variables. The "init-addr" setting can be used to modify the way |
| 9694 | IP addresses should be resolved upon startup. |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9695 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 9696 | <port> is an optional port specification. If set, all connections will |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9697 | be sent to this port. If unset, the same port the client |
| 9698 | connected to will be used. The port may also be prefixed by a "+" |
| 9699 | or a "-". In this case, the server's port will be determined by |
| 9700 | adding this value to the client's port. |
| 9701 | |
| 9702 | <param*> is a list of parameters for this server. The "server" keywords |
| 9703 | accepts an important number of options and has a complete section |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 9704 | dedicated to it. Please refer to section 5 for more details. |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9705 | |
| 9706 | Examples : |
| 9707 | server first 10.1.1.1:1080 cookie first check inter 1000 |
| 9708 | server second 10.1.1.2:1080 cookie second check inter 1000 |
Willy Tarreau | 2470928 | 2013-03-10 21:32:12 +0100 | [diff] [blame] | 9709 | server transp ipv4@ |
William Lallemand | b2f0745 | 2015-05-12 14:27:13 +0200 | [diff] [blame] | 9710 | server backup "${SRV_BACKUP}:1080" backup |
| 9711 | server www1_dc1 "${LAN_DC1}.101:80" |
| 9712 | server www1_dc2 "${LAN_DC2}.101:80" |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9713 | |
Willy Tarreau | 55dcaf6 | 2015-09-27 15:03:15 +0200 | [diff] [blame] | 9714 | Note: regarding Linux's abstract namespace sockets, HAProxy uses the whole |
| 9715 | sun_path length is used for the address length. Some other programs |
| 9716 | such as socat use the string length only by default. Pass the option |
| 9717 | ",unix-tightsocklen=0" to any abstract socket definition in socat to |
| 9718 | make it compatible with HAProxy's. |
| 9719 | |
Mark Lamourine | c2247f0 | 2012-01-04 13:02:01 -0500 | [diff] [blame] | 9720 | See also: "default-server", "http-send-name-header" and section 5 about |
| 9721 | server options |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9722 | |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 9723 | server-state-file-name [<file>] |
| 9724 | Set the server state file to read, load and apply to servers available in |
| 9725 | this backend. It only applies when the directive "load-server-state-from-file" |
| 9726 | is set to "local". When <file> is not provided or if this directive is not |
| 9727 | set, then backend name is used. If <file> starts with a slash '/', then it is |
| 9728 | considered as an absolute path. Otherwise, <file> is concatenated to the |
| 9729 | global directive "server-state-file-base". |
| 9730 | |
| 9731 | Example: the minimal configuration below would make HAProxy look for the |
| 9732 | state server file '/etc/haproxy/states/bk': |
| 9733 | |
| 9734 | global |
| 9735 | server-state-file-base /etc/haproxy/states |
| 9736 | |
Willy Tarreau | c9c6cdb | 2020-03-05 16:03:58 +0100 | [diff] [blame] | 9737 | backend bk |
Baptiste Assmann | 01c6cc3 | 2015-08-23 11:45:29 +0200 | [diff] [blame] | 9738 | load-server-state-from-file |
| 9739 | |
| 9740 | See also: "server-state-file-base", "load-server-state-from-file", and |
| 9741 | "show servers state" |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9742 | |
Frédéric Lécaille | cb4502e | 2017-04-20 13:36:25 +0200 | [diff] [blame] | 9743 | server-template <prefix> <num | range> <fqdn>[:<port>] [params*] |
| 9744 | Set a template to initialize servers with shared parameters. |
| 9745 | The names of these servers are built from <prefix> and <num | range> parameters. |
| 9746 | May be used in sections : defaults | frontend | listen | backend |
| 9747 | no | no | yes | yes |
| 9748 | |
| 9749 | Arguments: |
| 9750 | <prefix> A prefix for the server names to be built. |
| 9751 | |
| 9752 | <num | range> |
| 9753 | If <num> is provided, this template initializes <num> servers |
| 9754 | with 1 up to <num> as server name suffixes. A range of numbers |
| 9755 | <num_low>-<num_high> may also be used to use <num_low> up to |
| 9756 | <num_high> as server name suffixes. |
| 9757 | |
| 9758 | <fqdn> A FQDN for all the servers this template initializes. |
| 9759 | |
| 9760 | <port> Same meaning as "server" <port> argument (see "server" keyword). |
| 9761 | |
| 9762 | <params*> |
| 9763 | Remaining server parameters among all those supported by "server" |
| 9764 | keyword. |
| 9765 | |
| 9766 | Examples: |
| 9767 | # Initializes 3 servers with srv1, srv2 and srv3 as names, |
| 9768 | # google.com as FQDN, and health-check enabled. |
| 9769 | server-template srv 1-3 google.com:80 check |
| 9770 | |
| 9771 | # or |
| 9772 | server-template srv 3 google.com:80 check |
| 9773 | |
| 9774 | # would be equivalent to: |
| 9775 | server srv1 google.com:80 check |
| 9776 | server srv2 google.com:80 check |
| 9777 | server srv3 google.com:80 check |
| 9778 | |
| 9779 | |
| 9780 | |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9781 | source <addr>[:<port>] [usesrc { <addr2>[:<port2>] | client | clientip } ] |
Willy Tarreau | bce7088 | 2009-09-07 11:51:47 +0200 | [diff] [blame] | 9782 | source <addr>[:<port>] [usesrc { <addr2>[:<port2>] | hdr_ip(<hdr>[,<occ>]) } ] |
Willy Tarreau | d53f96b | 2009-02-04 18:46:54 +0100 | [diff] [blame] | 9783 | source <addr>[:<port>] [interface <name>] |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9784 | Set the source address for outgoing connections |
| 9785 | May be used in sections : defaults | frontend | listen | backend |
| 9786 | yes | no | yes | yes |
| 9787 | Arguments : |
| 9788 | <addr> is the IPv4 address HAProxy will bind to before connecting to a |
| 9789 | server. This address is also used as a source for health checks. |
Willy Tarreau | 2470928 | 2013-03-10 21:32:12 +0100 | [diff] [blame] | 9790 | |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9791 | The default value of 0.0.0.0 means that the system will select |
Willy Tarreau | 2470928 | 2013-03-10 21:32:12 +0100 | [diff] [blame] | 9792 | the most appropriate address to reach its destination. Optionally |
| 9793 | an address family prefix may be used before the address to force |
| 9794 | the family regardless of the address format, which can be useful |
| 9795 | to specify a path to a unix socket with no slash ('/'). Currently |
| 9796 | supported prefixes are : |
| 9797 | - 'ipv4@' -> address is always IPv4 |
| 9798 | - 'ipv6@' -> address is always IPv6 |
| 9799 | - 'unix@' -> address is a path to a local unix socket |
Willy Tarreau | ccfccef | 2014-05-10 01:49:15 +0200 | [diff] [blame] | 9800 | - 'abns@' -> address is in abstract namespace (Linux only) |
Cyril Bonté | 307ee1e | 2015-09-28 23:16:06 +0200 | [diff] [blame] | 9801 | You may want to reference some environment variables in the |
| 9802 | address parameter, see section 2.3 about environment variables. |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9803 | |
| 9804 | <port> is an optional port. It is normally not needed but may be useful |
| 9805 | in some very specific contexts. The default value of zero means |
Willy Tarreau | c6f4ce8 | 2009-06-10 11:09:37 +0200 | [diff] [blame] | 9806 | the system will select a free port. Note that port ranges are not |
| 9807 | supported in the backend. If you want to force port ranges, you |
| 9808 | have to specify them on each "server" line. |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9809 | |
| 9810 | <addr2> is the IP address to present to the server when connections are |
| 9811 | forwarded in full transparent proxy mode. This is currently only |
| 9812 | supported on some patched Linux kernels. When this address is |
| 9813 | specified, clients connecting to the server will be presented |
| 9814 | with this address, while health checks will still use the address |
| 9815 | <addr>. |
| 9816 | |
| 9817 | <port2> is the optional port to present to the server when connections |
| 9818 | are forwarded in full transparent proxy mode (see <addr2> above). |
| 9819 | The default value of zero means the system will select a free |
| 9820 | port. |
| 9821 | |
Willy Tarreau | bce7088 | 2009-09-07 11:51:47 +0200 | [diff] [blame] | 9822 | <hdr> is the name of a HTTP header in which to fetch the IP to bind to. |
| 9823 | This is the name of a comma-separated header list which can |
| 9824 | contain multiple IP addresses. By default, the last occurrence is |
| 9825 | used. This is designed to work with the X-Forwarded-For header |
Baptiste Assmann | ea3e73b | 2013-02-02 23:47:49 +0100 | [diff] [blame] | 9826 | and to automatically bind to the client's IP address as seen |
Willy Tarreau | bce7088 | 2009-09-07 11:51:47 +0200 | [diff] [blame] | 9827 | by previous proxy, typically Stunnel. In order to use another |
| 9828 | occurrence from the last one, please see the <occ> parameter |
| 9829 | below. When the header (or occurrence) is not found, no binding |
| 9830 | is performed so that the proxy's default IP address is used. Also |
| 9831 | keep in mind that the header name is case insensitive, as for any |
| 9832 | HTTP header. |
| 9833 | |
| 9834 | <occ> is the occurrence number of a value to be used in a multi-value |
| 9835 | header. This is to be used in conjunction with "hdr_ip(<hdr>)", |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 9836 | in order to specify which occurrence to use for the source IP |
Willy Tarreau | bce7088 | 2009-09-07 11:51:47 +0200 | [diff] [blame] | 9837 | address. Positive values indicate a position from the first |
| 9838 | occurrence, 1 being the first one. Negative values indicate |
| 9839 | positions relative to the last one, -1 being the last one. This |
| 9840 | is helpful for situations where an X-Forwarded-For header is set |
| 9841 | at the entry point of an infrastructure and must be used several |
| 9842 | proxy layers away. When this value is not specified, -1 is |
| 9843 | assumed. Passing a zero here disables the feature. |
| 9844 | |
Willy Tarreau | d53f96b | 2009-02-04 18:46:54 +0100 | [diff] [blame] | 9845 | <name> is an optional interface name to which to bind to for outgoing |
| 9846 | traffic. On systems supporting this features (currently, only |
| 9847 | Linux), this allows one to bind all traffic to the server to |
| 9848 | this interface even if it is not the one the system would select |
| 9849 | based on routing tables. This should be used with extreme care. |
| 9850 | Note that using this option requires root privileges. |
| 9851 | |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9852 | The "source" keyword is useful in complex environments where a specific |
| 9853 | address only is allowed to connect to the servers. It may be needed when a |
| 9854 | private address must be used through a public gateway for instance, and it is |
| 9855 | known that the system cannot determine the adequate source address by itself. |
| 9856 | |
| 9857 | An extension which is available on certain patched Linux kernels may be used |
| 9858 | through the "usesrc" optional keyword. It makes it possible to connect to the |
| 9859 | servers with an IP address which does not belong to the system itself. This |
| 9860 | is called "full transparent proxy mode". For this to work, the destination |
| 9861 | servers have to route their traffic back to this address through the machine |
| 9862 | running HAProxy, and IP forwarding must generally be enabled on this machine. |
| 9863 | |
| 9864 | In this "full transparent proxy" mode, it is possible to force a specific IP |
| 9865 | address to be presented to the servers. This is not much used in fact. A more |
| 9866 | common use is to tell HAProxy to present the client's IP address. For this, |
| 9867 | there are two methods : |
| 9868 | |
| 9869 | - present the client's IP and port addresses. This is the most transparent |
| 9870 | mode, but it can cause problems when IP connection tracking is enabled on |
| 9871 | the machine, because a same connection may be seen twice with different |
| 9872 | states. However, this solution presents the huge advantage of not |
| 9873 | limiting the system to the 64k outgoing address+port couples, because all |
| 9874 | of the client ranges may be used. |
| 9875 | |
| 9876 | - present only the client's IP address and select a spare port. This |
| 9877 | solution is still quite elegant but slightly less transparent (downstream |
| 9878 | firewalls logs will not match upstream's). It also presents the downside |
| 9879 | of limiting the number of concurrent connections to the usual 64k ports. |
| 9880 | However, since the upstream and downstream ports are different, local IP |
| 9881 | connection tracking on the machine will not be upset by the reuse of the |
| 9882 | same session. |
| 9883 | |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9884 | This option sets the default source for all servers in the backend. It may |
| 9885 | also be specified in a "defaults" section. Finer source address specification |
| 9886 | is possible at the server level using the "source" server option. Refer to |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 9887 | section 5 for more information. |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9888 | |
Baptiste Assmann | 91bd337 | 2015-07-17 21:59:42 +0200 | [diff] [blame] | 9889 | In order to work, "usesrc" requires root privileges. |
| 9890 | |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9891 | Examples : |
| 9892 | backend private |
| 9893 | # Connect to the servers using our 192.168.1.200 source address |
| 9894 | source 192.168.1.200 |
| 9895 | |
| 9896 | backend transparent_ssl1 |
| 9897 | # Connect to the SSL farm from the client's source address |
| 9898 | source 192.168.1.200 usesrc clientip |
| 9899 | |
| 9900 | backend transparent_ssl2 |
| 9901 | # Connect to the SSL farm from the client's source address and port |
| 9902 | # not recommended if IP conntrack is present on the local machine. |
| 9903 | source 192.168.1.200 usesrc client |
| 9904 | |
| 9905 | backend transparent_ssl3 |
| 9906 | # Connect to the SSL farm from the client's source address. It |
| 9907 | # is more conntrack-friendly. |
| 9908 | source 192.168.1.200 usesrc clientip |
| 9909 | |
| 9910 | backend transparent_smtp |
| 9911 | # Connect to the SMTP farm from the client's source address/port |
| 9912 | # with Tproxy version 4. |
| 9913 | source 0.0.0.0 usesrc clientip |
| 9914 | |
Willy Tarreau | bce7088 | 2009-09-07 11:51:47 +0200 | [diff] [blame] | 9915 | backend transparent_http |
| 9916 | # Connect to the servers using the client's IP as seen by previous |
| 9917 | # proxy. |
| 9918 | source 0.0.0.0 usesrc hdr_ip(x-forwarded-for,-1) |
| 9919 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 9920 | See also : the "source" server option in section 5, the Tproxy patches for |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 9921 | the Linux kernel on www.balabit.com, the "bind" keyword. |
| 9922 | |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 9923 | |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 9924 | srvtcpka-cnt <count> |
| 9925 | Sets the maximum number of keepalive probes TCP should send before dropping |
| 9926 | the connection on the server side. |
| 9927 | May be used in sections : defaults | frontend | listen | backend |
| 9928 | yes | no | yes | yes |
| 9929 | Arguments : |
| 9930 | <count> is the maximum number of keepalive probes. |
| 9931 | |
| 9932 | This keyword corresponds to the socket option TCP_KEEPCNT. If this keyword |
| 9933 | is not specified, system-wide TCP parameter (tcp_keepalive_probes) is used. |
Willy Tarreau | 5254321 | 2020-07-09 05:58:51 +0200 | [diff] [blame] | 9934 | The availability of this setting depends on the operating system. It is |
| 9935 | known to work on Linux. |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 9936 | |
| 9937 | See also : "option srvtcpka", "srvtcpka-idle", "srvtcpka-intvl". |
| 9938 | |
| 9939 | |
| 9940 | srvtcpka-idle <timeout> |
| 9941 | Sets the time the connection needs to remain idle before TCP starts sending |
| 9942 | keepalive probes, if enabled the sending of TCP keepalive packets on the |
| 9943 | server side. |
| 9944 | May be used in sections : defaults | frontend | listen | backend |
| 9945 | yes | no | yes | yes |
| 9946 | Arguments : |
| 9947 | <timeout> is the time the connection needs to remain idle before TCP starts |
| 9948 | sending keepalive probes. It is specified in seconds by default, |
| 9949 | but can be in any other unit if the number is suffixed by the |
| 9950 | unit, as explained at the top of this document. |
| 9951 | |
| 9952 | This keyword corresponds to the socket option TCP_KEEPIDLE. If this keyword |
| 9953 | is not specified, system-wide TCP parameter (tcp_keepalive_time) is used. |
Willy Tarreau | 5254321 | 2020-07-09 05:58:51 +0200 | [diff] [blame] | 9954 | The availability of this setting depends on the operating system. It is |
| 9955 | known to work on Linux. |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 9956 | |
| 9957 | See also : "option srvtcpka", "srvtcpka-cnt", "srvtcpka-intvl". |
| 9958 | |
| 9959 | |
| 9960 | srvtcpka-intvl <timeout> |
| 9961 | Sets the time between individual keepalive probes on the server side. |
| 9962 | May be used in sections : defaults | frontend | listen | backend |
| 9963 | yes | no | yes | yes |
| 9964 | Arguments : |
| 9965 | <timeout> is the time between individual keepalive probes. It is specified |
| 9966 | in seconds by default, but can be in any other unit if the number |
| 9967 | is suffixed by the unit, as explained at the top of this |
| 9968 | document. |
| 9969 | |
| 9970 | This keyword corresponds to the socket option TCP_KEEPINTVL. If this keyword |
| 9971 | is not specified, system-wide TCP parameter (tcp_keepalive_intvl) is used. |
Willy Tarreau | 5254321 | 2020-07-09 05:58:51 +0200 | [diff] [blame] | 9972 | The availability of this setting depends on the operating system. It is |
| 9973 | known to work on Linux. |
MIZUTA Takeshi | b24bc0d | 2020-07-09 11:13:20 +0900 | [diff] [blame] | 9974 | |
| 9975 | See also : "option srvtcpka", "srvtcpka-cnt", "srvtcpka-idle". |
| 9976 | |
| 9977 | |
Cyril Bonté | 66c327d | 2010-10-12 00:14:37 +0200 | [diff] [blame] | 9978 | stats admin { if | unless } <cond> |
| 9979 | Enable statistics admin level if/unless a condition is matched |
| 9980 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 9981 | no | yes | yes | yes |
Cyril Bonté | 66c327d | 2010-10-12 00:14:37 +0200 | [diff] [blame] | 9982 | |
| 9983 | This statement enables the statistics admin level if/unless a condition is |
| 9984 | matched. |
| 9985 | |
| 9986 | The admin level allows to enable/disable servers from the web interface. By |
| 9987 | default, statistics page is read-only for security reasons. |
| 9988 | |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 9989 | Note : Consider not using this feature in multi-process mode (nbproc > 1) |
| 9990 | unless you know what you do : memory is not shared between the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 9991 | processes, which can result in random behaviors. |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 9992 | |
Cyril Bonté | 23b39d9 | 2011-02-10 22:54:44 +0100 | [diff] [blame] | 9993 | Currently, the POST request is limited to the buffer size minus the reserved |
| 9994 | buffer space, which means that if the list of servers is too long, the |
| 9995 | request won't be processed. It is recommended to alter few servers at a |
| 9996 | time. |
Cyril Bonté | 66c327d | 2010-10-12 00:14:37 +0200 | [diff] [blame] | 9997 | |
| 9998 | Example : |
| 9999 | # statistics admin level only for localhost |
| 10000 | backend stats_localhost |
| 10001 | stats enable |
| 10002 | stats admin if LOCALHOST |
| 10003 | |
| 10004 | Example : |
| 10005 | # statistics admin level always enabled because of the authentication |
| 10006 | backend stats_auth |
| 10007 | stats enable |
| 10008 | stats auth admin:AdMiN123 |
| 10009 | stats admin if TRUE |
| 10010 | |
| 10011 | Example : |
| 10012 | # statistics admin level depends on the authenticated user |
| 10013 | userlist stats-auth |
| 10014 | group admin users admin |
| 10015 | user admin insecure-password AdMiN123 |
| 10016 | group readonly users haproxy |
| 10017 | user haproxy insecure-password haproxy |
| 10018 | |
| 10019 | backend stats_auth |
| 10020 | stats enable |
| 10021 | acl AUTH http_auth(stats-auth) |
| 10022 | acl AUTH_ADMIN http_auth_group(stats-auth) admin |
| 10023 | stats http-request auth unless AUTH |
| 10024 | stats admin if AUTH_ADMIN |
| 10025 | |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10026 | See also : "stats enable", "stats auth", "stats http-request", "nbproc", |
| 10027 | "bind-process", section 3.4 about userlists and section 7 about |
| 10028 | ACL usage. |
Cyril Bonté | 66c327d | 2010-10-12 00:14:37 +0200 | [diff] [blame] | 10029 | |
| 10030 | |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10031 | stats auth <user>:<passwd> |
| 10032 | Enable statistics with authentication and grant access to an account |
| 10033 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10034 | yes | yes | yes | yes |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10035 | Arguments : |
| 10036 | <user> is a user name to grant access to |
| 10037 | |
| 10038 | <passwd> is the cleartext password associated to this user |
| 10039 | |
| 10040 | This statement enables statistics with default settings, and restricts access |
| 10041 | to declared users only. It may be repeated as many times as necessary to |
| 10042 | allow as many users as desired. When a user tries to access the statistics |
| 10043 | without a valid account, a "401 Forbidden" response will be returned so that |
| 10044 | the browser asks the user to provide a valid user and password. The real |
| 10045 | which will be returned to the browser is configurable using "stats realm". |
| 10046 | |
| 10047 | Since the authentication method is HTTP Basic Authentication, the passwords |
| 10048 | circulate in cleartext on the network. Thus, it was decided that the |
| 10049 | configuration file would also use cleartext passwords to remind the users |
Willy Tarreau | 3c92c5f | 2011-08-28 09:45:47 +0200 | [diff] [blame] | 10050 | that those ones should not be sensitive and not shared with any other account. |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10051 | |
| 10052 | It is also possible to reduce the scope of the proxies which appear in the |
| 10053 | report using "stats scope". |
| 10054 | |
| 10055 | Though this statement alone is enough to enable statistics reporting, it is |
| 10056 | recommended to set all other settings in order to avoid relying on default |
| 10057 | unobvious parameters. |
| 10058 | |
| 10059 | Example : |
| 10060 | # public access (limited to this backend only) |
| 10061 | backend public_www |
| 10062 | server srv1 192.168.0.1:80 |
| 10063 | stats enable |
| 10064 | stats hide-version |
| 10065 | stats scope . |
| 10066 | stats uri /admin?stats |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10067 | stats realm HAProxy\ Statistics |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10068 | stats auth admin1:AdMiN123 |
| 10069 | stats auth admin2:AdMiN321 |
| 10070 | |
| 10071 | # internal monitoring access (unlimited) |
| 10072 | backend private_monitoring |
| 10073 | stats enable |
| 10074 | stats uri /admin?stats |
| 10075 | stats refresh 5s |
| 10076 | |
| 10077 | See also : "stats enable", "stats realm", "stats scope", "stats uri" |
| 10078 | |
| 10079 | |
| 10080 | stats enable |
| 10081 | Enable statistics reporting with default settings |
| 10082 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10083 | yes | yes | yes | yes |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10084 | Arguments : none |
| 10085 | |
| 10086 | This statement enables statistics reporting with default settings defined |
| 10087 | at build time. Unless stated otherwise, these settings are used : |
| 10088 | - stats uri : /haproxy?stats |
| 10089 | - stats realm : "HAProxy Statistics" |
| 10090 | - stats auth : no authentication |
| 10091 | - stats scope : no restriction |
| 10092 | |
| 10093 | Though this statement alone is enough to enable statistics reporting, it is |
| 10094 | recommended to set all other settings in order to avoid relying on default |
| 10095 | unobvious parameters. |
| 10096 | |
| 10097 | Example : |
| 10098 | # public access (limited to this backend only) |
| 10099 | backend public_www |
| 10100 | server srv1 192.168.0.1:80 |
| 10101 | stats enable |
| 10102 | stats hide-version |
| 10103 | stats scope . |
| 10104 | stats uri /admin?stats |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10105 | stats realm HAProxy\ Statistics |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10106 | stats auth admin1:AdMiN123 |
| 10107 | stats auth admin2:AdMiN321 |
| 10108 | |
| 10109 | # internal monitoring access (unlimited) |
| 10110 | backend private_monitoring |
| 10111 | stats enable |
| 10112 | stats uri /admin?stats |
| 10113 | stats refresh 5s |
| 10114 | |
| 10115 | See also : "stats auth", "stats realm", "stats uri" |
| 10116 | |
| 10117 | |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10118 | stats hide-version |
| 10119 | Enable statistics and hide HAProxy version reporting |
Willy Tarreau | 1d45b7c | 2009-08-16 10:29:18 +0200 | [diff] [blame] | 10120 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10121 | yes | yes | yes | yes |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10122 | Arguments : none |
Willy Tarreau | 1d45b7c | 2009-08-16 10:29:18 +0200 | [diff] [blame] | 10123 | |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10124 | By default, the stats page reports some useful status information along with |
| 10125 | the statistics. Among them is HAProxy's version. However, it is generally |
| 10126 | considered dangerous to report precise version to anyone, as it can help them |
| 10127 | target known weaknesses with specific attacks. The "stats hide-version" |
| 10128 | statement removes the version from the statistics report. This is recommended |
| 10129 | for public sites or any site with a weak login/password. |
Willy Tarreau | 1d45b7c | 2009-08-16 10:29:18 +0200 | [diff] [blame] | 10130 | |
Krzysztof Piotr Oledzki | 48cb2ae | 2009-10-02 22:51:14 +0200 | [diff] [blame] | 10131 | Though this statement alone is enough to enable statistics reporting, it is |
| 10132 | recommended to set all other settings in order to avoid relying on default |
| 10133 | unobvious parameters. |
| 10134 | |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10135 | Example : |
| 10136 | # public access (limited to this backend only) |
| 10137 | backend public_www |
| 10138 | server srv1 192.168.0.1:80 |
Krzysztof Piotr Oledzki | 48cb2ae | 2009-10-02 22:51:14 +0200 | [diff] [blame] | 10139 | stats enable |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10140 | stats hide-version |
| 10141 | stats scope . |
| 10142 | stats uri /admin?stats |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10143 | stats realm HAProxy\ Statistics |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10144 | stats auth admin1:AdMiN123 |
| 10145 | stats auth admin2:AdMiN321 |
Willy Tarreau | 1d45b7c | 2009-08-16 10:29:18 +0200 | [diff] [blame] | 10146 | |
Willy Tarreau | 1d45b7c | 2009-08-16 10:29:18 +0200 | [diff] [blame] | 10147 | # internal monitoring access (unlimited) |
| 10148 | backend private_monitoring |
| 10149 | stats enable |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10150 | stats uri /admin?stats |
| 10151 | stats refresh 5s |
Krzysztof Piotr Oledzki | 15514c2 | 2010-01-04 16:03:09 +0100 | [diff] [blame] | 10152 | |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10153 | See also : "stats auth", "stats enable", "stats realm", "stats uri" |
Willy Tarreau | 1d45b7c | 2009-08-16 10:29:18 +0200 | [diff] [blame] | 10154 | |
Willy Tarreau | 983e01e | 2010-01-11 18:42:06 +0100 | [diff] [blame] | 10155 | |
Cyril Bonté | 2be1b3f | 2010-09-30 23:46:30 +0200 | [diff] [blame] | 10156 | stats http-request { allow | deny | auth [realm <realm>] } |
| 10157 | [ { if | unless } <condition> ] |
| 10158 | Access control for statistics |
| 10159 | |
| 10160 | May be used in sections: defaults | frontend | listen | backend |
| 10161 | no | no | yes | yes |
| 10162 | |
| 10163 | As "http-request", these set of options allow to fine control access to |
| 10164 | statistics. Each option may be followed by if/unless and acl. |
| 10165 | First option with matched condition (or option without condition) is final. |
| 10166 | For "deny" a 403 error will be returned, for "allow" normal processing is |
| 10167 | performed, for "auth" a 401/407 error code is returned so the client |
| 10168 | should be asked to enter a username and password. |
| 10169 | |
| 10170 | There is no fixed limit to the number of http-request statements per |
| 10171 | instance. |
| 10172 | |
| 10173 | See also : "http-request", section 3.4 about userlists and section 7 |
| 10174 | about ACL usage. |
| 10175 | |
| 10176 | |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10177 | stats realm <realm> |
| 10178 | Enable statistics and set authentication realm |
| 10179 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10180 | yes | yes | yes | yes |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10181 | Arguments : |
| 10182 | <realm> is the name of the HTTP Basic Authentication realm reported to |
| 10183 | the browser. The browser uses it to display it in the pop-up |
| 10184 | inviting the user to enter a valid username and password. |
| 10185 | |
| 10186 | The realm is read as a single word, so any spaces in it should be escaped |
| 10187 | using a backslash ('\'). |
| 10188 | |
| 10189 | This statement is useful only in conjunction with "stats auth" since it is |
| 10190 | only related to authentication. |
| 10191 | |
| 10192 | Though this statement alone is enough to enable statistics reporting, it is |
| 10193 | recommended to set all other settings in order to avoid relying on default |
| 10194 | unobvious parameters. |
| 10195 | |
| 10196 | Example : |
| 10197 | # public access (limited to this backend only) |
| 10198 | backend public_www |
| 10199 | server srv1 192.168.0.1:80 |
| 10200 | stats enable |
| 10201 | stats hide-version |
| 10202 | stats scope . |
| 10203 | stats uri /admin?stats |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10204 | stats realm HAProxy\ Statistics |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10205 | stats auth admin1:AdMiN123 |
| 10206 | stats auth admin2:AdMiN321 |
| 10207 | |
| 10208 | # internal monitoring access (unlimited) |
| 10209 | backend private_monitoring |
| 10210 | stats enable |
| 10211 | stats uri /admin?stats |
| 10212 | stats refresh 5s |
| 10213 | |
| 10214 | See also : "stats auth", "stats enable", "stats uri" |
| 10215 | |
| 10216 | |
| 10217 | stats refresh <delay> |
| 10218 | Enable statistics with automatic refresh |
| 10219 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10220 | yes | yes | yes | yes |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10221 | Arguments : |
| 10222 | <delay> is the suggested refresh delay, specified in seconds, which will |
| 10223 | be returned to the browser consulting the report page. While the |
| 10224 | browser is free to apply any delay, it will generally respect it |
| 10225 | and refresh the page this every seconds. The refresh interval may |
| 10226 | be specified in any other non-default time unit, by suffixing the |
| 10227 | unit after the value, as explained at the top of this document. |
| 10228 | |
| 10229 | This statement is useful on monitoring displays with a permanent page |
| 10230 | reporting the load balancer's activity. When set, the HTML report page will |
| 10231 | include a link "refresh"/"stop refresh" so that the user can select whether |
Jackie Tapia | 749f74c | 2020-07-22 18:59:40 -0500 | [diff] [blame] | 10232 | they want automatic refresh of the page or not. |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10233 | |
| 10234 | Though this statement alone is enough to enable statistics reporting, it is |
| 10235 | recommended to set all other settings in order to avoid relying on default |
| 10236 | unobvious parameters. |
| 10237 | |
| 10238 | Example : |
| 10239 | # public access (limited to this backend only) |
| 10240 | backend public_www |
| 10241 | server srv1 192.168.0.1:80 |
| 10242 | stats enable |
| 10243 | stats hide-version |
| 10244 | stats scope . |
| 10245 | stats uri /admin?stats |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10246 | stats realm HAProxy\ Statistics |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10247 | stats auth admin1:AdMiN123 |
| 10248 | stats auth admin2:AdMiN321 |
| 10249 | |
| 10250 | # internal monitoring access (unlimited) |
| 10251 | backend private_monitoring |
| 10252 | stats enable |
| 10253 | stats uri /admin?stats |
| 10254 | stats refresh 5s |
| 10255 | |
| 10256 | See also : "stats auth", "stats enable", "stats realm", "stats uri" |
| 10257 | |
| 10258 | |
| 10259 | stats scope { <name> | "." } |
| 10260 | Enable statistics and limit access scope |
| 10261 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10262 | yes | yes | yes | yes |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10263 | Arguments : |
| 10264 | <name> is the name of a listen, frontend or backend section to be |
| 10265 | reported. The special name "." (a single dot) designates the |
| 10266 | section in which the statement appears. |
| 10267 | |
| 10268 | When this statement is specified, only the sections enumerated with this |
| 10269 | statement will appear in the report. All other ones will be hidden. This |
| 10270 | statement may appear as many times as needed if multiple sections need to be |
| 10271 | reported. Please note that the name checking is performed as simple string |
| 10272 | comparisons, and that it is never checked that a give section name really |
| 10273 | exists. |
| 10274 | |
| 10275 | Though this statement alone is enough to enable statistics reporting, it is |
| 10276 | recommended to set all other settings in order to avoid relying on default |
| 10277 | unobvious parameters. |
| 10278 | |
| 10279 | Example : |
| 10280 | # public access (limited to this backend only) |
| 10281 | backend public_www |
| 10282 | server srv1 192.168.0.1:80 |
| 10283 | stats enable |
| 10284 | stats hide-version |
| 10285 | stats scope . |
| 10286 | stats uri /admin?stats |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10287 | stats realm HAProxy\ Statistics |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10288 | stats auth admin1:AdMiN123 |
| 10289 | stats auth admin2:AdMiN321 |
| 10290 | |
| 10291 | # internal monitoring access (unlimited) |
| 10292 | backend private_monitoring |
| 10293 | stats enable |
| 10294 | stats uri /admin?stats |
| 10295 | stats refresh 5s |
| 10296 | |
| 10297 | See also : "stats auth", "stats enable", "stats realm", "stats uri" |
| 10298 | |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10299 | |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 10300 | stats show-desc [ <desc> ] |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10301 | Enable reporting of a description on the statistics page. |
| 10302 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10303 | yes | yes | yes | yes |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10304 | |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 10305 | <desc> is an optional description to be reported. If unspecified, the |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10306 | description from global section is automatically used instead. |
| 10307 | |
| 10308 | This statement is useful for users that offer shared services to their |
| 10309 | customers, where node or description should be different for each customer. |
| 10310 | |
| 10311 | Though this statement alone is enough to enable statistics reporting, it is |
| 10312 | recommended to set all other settings in order to avoid relying on default |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10313 | unobvious parameters. By default description is not shown. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10314 | |
| 10315 | Example : |
| 10316 | # internal monitoring access (unlimited) |
| 10317 | backend private_monitoring |
| 10318 | stats enable |
| 10319 | stats show-desc Master node for Europe, Asia, Africa |
| 10320 | stats uri /admin?stats |
| 10321 | stats refresh 5s |
| 10322 | |
| 10323 | See also: "show-node", "stats enable", "stats uri" and "description" in |
| 10324 | global section. |
| 10325 | |
| 10326 | |
| 10327 | stats show-legends |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10328 | Enable reporting additional information on the statistics page |
| 10329 | May be used in sections : defaults | frontend | listen | backend |
| 10330 | yes | yes | yes | yes |
| 10331 | Arguments : none |
| 10332 | |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 10333 | Enable reporting additional information on the statistics page : |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10334 | - cap: capabilities (proxy) |
| 10335 | - mode: one of tcp, http or health (proxy) |
| 10336 | - id: SNMP ID (proxy, socket, server) |
| 10337 | - IP (socket, server) |
| 10338 | - cookie (backend, server) |
| 10339 | |
| 10340 | Though this statement alone is enough to enable statistics reporting, it is |
| 10341 | recommended to set all other settings in order to avoid relying on default |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10342 | unobvious parameters. Default behavior is not to show this information. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10343 | |
| 10344 | See also: "stats enable", "stats uri". |
| 10345 | |
| 10346 | |
Amaury Denoyelle | 0b70a8a | 2020-10-05 11:49:45 +0200 | [diff] [blame] | 10347 | stats show-modules |
| 10348 | Enable display of extra statistics module on the statistics page |
| 10349 | May be used in sections : defaults | frontend | listen | backend |
| 10350 | yes | yes | yes | yes |
| 10351 | Arguments : none |
| 10352 | |
| 10353 | New columns are added at the end of the line containing the extra statistics |
| 10354 | values as a tooltip. |
| 10355 | |
| 10356 | Though this statement alone is enough to enable statistics reporting, it is |
| 10357 | recommended to set all other settings in order to avoid relying on default |
| 10358 | unobvious parameters. Default behavior is not to show this information. |
| 10359 | |
| 10360 | See also: "stats enable", "stats uri". |
| 10361 | |
| 10362 | |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10363 | stats show-node [ <name> ] |
| 10364 | Enable reporting of a host name on the statistics page. |
| 10365 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10366 | yes | yes | yes | yes |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10367 | Arguments: |
| 10368 | <name> is an optional name to be reported. If unspecified, the |
| 10369 | node name from global section is automatically used instead. |
| 10370 | |
| 10371 | This statement is useful for users that offer shared services to their |
| 10372 | customers, where node or description might be different on a stats page |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10373 | provided for each customer. Default behavior is not to show host name. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10374 | |
| 10375 | Though this statement alone is enough to enable statistics reporting, it is |
| 10376 | recommended to set all other settings in order to avoid relying on default |
| 10377 | unobvious parameters. |
| 10378 | |
| 10379 | Example: |
| 10380 | # internal monitoring access (unlimited) |
| 10381 | backend private_monitoring |
| 10382 | stats enable |
| 10383 | stats show-node Europe-1 |
| 10384 | stats uri /admin?stats |
| 10385 | stats refresh 5s |
| 10386 | |
| 10387 | See also: "show-desc", "stats enable", "stats uri", and "node" in global |
| 10388 | section. |
| 10389 | |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10390 | |
| 10391 | stats uri <prefix> |
| 10392 | Enable statistics and define the URI prefix to access them |
| 10393 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | ed2119c | 2014-04-24 22:10:39 +0200 | [diff] [blame] | 10394 | yes | yes | yes | yes |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10395 | Arguments : |
| 10396 | <prefix> is the prefix of any URI which will be redirected to stats. This |
| 10397 | prefix may contain a question mark ('?') to indicate part of a |
| 10398 | query string. |
| 10399 | |
| 10400 | The statistics URI is intercepted on the relayed traffic, so it appears as a |
| 10401 | page within the normal application. It is strongly advised to ensure that the |
| 10402 | selected URI will never appear in the application, otherwise it will never be |
| 10403 | possible to reach it in the application. |
| 10404 | |
| 10405 | The default URI compiled in haproxy is "/haproxy?stats", but this may be |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 10406 | changed at build time, so it's better to always explicitly specify it here. |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10407 | It is generally a good idea to include a question mark in the URI so that |
| 10408 | intermediate proxies refrain from caching the results. Also, since any string |
| 10409 | beginning with the prefix will be accepted as a stats request, the question |
| 10410 | mark helps ensuring that no valid URI will begin with the same words. |
| 10411 | |
| 10412 | It is sometimes very convenient to use "/" as the URI prefix, and put that |
| 10413 | statement in a "listen" instance of its own. That makes it easy to dedicate |
| 10414 | an address or a port to statistics only. |
| 10415 | |
| 10416 | Though this statement alone is enough to enable statistics reporting, it is |
| 10417 | recommended to set all other settings in order to avoid relying on default |
| 10418 | unobvious parameters. |
| 10419 | |
| 10420 | Example : |
| 10421 | # public access (limited to this backend only) |
| 10422 | backend public_www |
| 10423 | server srv1 192.168.0.1:80 |
| 10424 | stats enable |
| 10425 | stats hide-version |
| 10426 | stats scope . |
| 10427 | stats uri /admin?stats |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10428 | stats realm HAProxy\ Statistics |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10429 | stats auth admin1:AdMiN123 |
| 10430 | stats auth admin2:AdMiN321 |
| 10431 | |
| 10432 | # internal monitoring access (unlimited) |
| 10433 | backend private_monitoring |
| 10434 | stats enable |
| 10435 | stats uri /admin?stats |
| 10436 | stats refresh 5s |
| 10437 | |
| 10438 | See also : "stats auth", "stats enable", "stats realm" |
| 10439 | |
| 10440 | |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10441 | stick match <pattern> [table <table>] [{if | unless} <cond>] |
| 10442 | Define a request pattern matching condition to stick a user to a server |
Willy Tarreau | eabeafa | 2008-01-16 16:17:06 +0100 | [diff] [blame] | 10443 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 10444 | no | no | yes | yes |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10445 | |
| 10446 | Arguments : |
Willy Tarreau | be722a2 | 2014-06-13 16:31:59 +0200 | [diff] [blame] | 10447 | <pattern> is a sample expression rule as described in section 7.3. It |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10448 | describes what elements of the incoming request or connection |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10449 | will be analyzed in the hope to find a matching entry in a |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10450 | stickiness table. This rule is mandatory. |
| 10451 | |
| 10452 | <table> is an optional stickiness table name. If unspecified, the same |
| 10453 | backend's table is used. A stickiness table is declared using |
| 10454 | the "stick-table" statement. |
| 10455 | |
| 10456 | <cond> is an optional matching condition. It makes it possible to match |
| 10457 | on a certain criterion only when other conditions are met (or |
| 10458 | not met). For instance, it could be used to match on a source IP |
| 10459 | address except when a request passes through a known proxy, in |
| 10460 | which case we'd match on a header containing that IP address. |
| 10461 | |
| 10462 | Some protocols or applications require complex stickiness rules and cannot |
| 10463 | always simply rely on cookies nor hashing. The "stick match" statement |
| 10464 | describes a rule to extract the stickiness criterion from an incoming request |
| 10465 | or connection. See section 7 for a complete list of possible patterns and |
| 10466 | transformation rules. |
| 10467 | |
| 10468 | The table has to be declared using the "stick-table" statement. It must be of |
| 10469 | a type compatible with the pattern. By default it is the one which is present |
| 10470 | in the same backend. It is possible to share a table with other backends by |
| 10471 | referencing it using the "table" keyword. If another table is referenced, |
| 10472 | the server's ID inside the backends are used. By default, all server IDs |
| 10473 | start at 1 in each backend, so the server ordering is enough. But in case of |
| 10474 | doubt, it is highly recommended to force server IDs using their "id" setting. |
| 10475 | |
| 10476 | It is possible to restrict the conditions where a "stick match" statement |
| 10477 | will apply, using "if" or "unless" followed by a condition. See section 7 for |
| 10478 | ACL based conditions. |
| 10479 | |
| 10480 | There is no limit on the number of "stick match" statements. The first that |
| 10481 | applies and matches will cause the request to be directed to the same server |
| 10482 | as was used for the request which created the entry. That way, multiple |
| 10483 | matches can be used as fallbacks. |
| 10484 | |
| 10485 | The stick rules are checked after the persistence cookies, so they will not |
| 10486 | affect stickiness if a cookie has already been used to select a server. That |
| 10487 | way, it becomes very easy to insert cookies and match on IP addresses in |
| 10488 | order to maintain stickiness between HTTP and HTTPS. |
| 10489 | |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10490 | Note : Consider not using this feature in multi-process mode (nbproc > 1) |
| 10491 | unless you know what you do : memory is not shared between the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10492 | processes, which can result in random behaviors. |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10493 | |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10494 | Example : |
| 10495 | # forward SMTP users to the same server they just used for POP in the |
| 10496 | # last 30 minutes |
| 10497 | backend pop |
| 10498 | mode tcp |
| 10499 | balance roundrobin |
| 10500 | stick store-request src |
| 10501 | stick-table type ip size 200k expire 30m |
| 10502 | server s1 192.168.1.1:110 |
| 10503 | server s2 192.168.1.1:110 |
| 10504 | |
| 10505 | backend smtp |
| 10506 | mode tcp |
| 10507 | balance roundrobin |
| 10508 | stick match src table pop |
| 10509 | server s1 192.168.1.1:25 |
| 10510 | server s2 192.168.1.1:25 |
| 10511 | |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10512 | See also : "stick-table", "stick on", "nbproc", "bind-process" and section 7 |
Willy Tarreau | be722a2 | 2014-06-13 16:31:59 +0200 | [diff] [blame] | 10513 | about ACLs and samples fetching. |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10514 | |
| 10515 | |
| 10516 | stick on <pattern> [table <table>] [{if | unless} <condition>] |
| 10517 | Define a request pattern to associate a user to a server |
| 10518 | May be used in sections : defaults | frontend | listen | backend |
| 10519 | no | no | yes | yes |
| 10520 | |
| 10521 | Note : This form is exactly equivalent to "stick match" followed by |
| 10522 | "stick store-request", all with the same arguments. Please refer |
| 10523 | to both keywords for details. It is only provided as a convenience |
| 10524 | for writing more maintainable configurations. |
| 10525 | |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10526 | Note : Consider not using this feature in multi-process mode (nbproc > 1) |
| 10527 | unless you know what you do : memory is not shared between the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10528 | processes, which can result in random behaviors. |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10529 | |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10530 | Examples : |
| 10531 | # The following form ... |
Willy Tarreau | ec579d8 | 2010-02-26 19:15:04 +0100 | [diff] [blame] | 10532 | stick on src table pop if !localhost |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10533 | |
| 10534 | # ...is strictly equivalent to this one : |
| 10535 | stick match src table pop if !localhost |
| 10536 | stick store-request src table pop if !localhost |
| 10537 | |
| 10538 | |
| 10539 | # Use cookie persistence for HTTP, and stick on source address for HTTPS as |
| 10540 | # well as HTTP without cookie. Share the same table between both accesses. |
| 10541 | backend http |
| 10542 | mode http |
| 10543 | balance roundrobin |
| 10544 | stick on src table https |
| 10545 | cookie SRV insert indirect nocache |
| 10546 | server s1 192.168.1.1:80 cookie s1 |
| 10547 | server s2 192.168.1.1:80 cookie s2 |
| 10548 | |
| 10549 | backend https |
| 10550 | mode tcp |
| 10551 | balance roundrobin |
| 10552 | stick-table type ip size 200k expire 30m |
| 10553 | stick on src |
| 10554 | server s1 192.168.1.1:443 |
| 10555 | server s2 192.168.1.1:443 |
| 10556 | |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10557 | See also : "stick match", "stick store-request", "nbproc" and "bind-process". |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10558 | |
| 10559 | |
| 10560 | stick store-request <pattern> [table <table>] [{if | unless} <condition>] |
| 10561 | Define a request pattern used to create an entry in a stickiness table |
| 10562 | May be used in sections : defaults | frontend | listen | backend |
| 10563 | no | no | yes | yes |
| 10564 | |
| 10565 | Arguments : |
Willy Tarreau | be722a2 | 2014-06-13 16:31:59 +0200 | [diff] [blame] | 10566 | <pattern> is a sample expression rule as described in section 7.3. It |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10567 | describes what elements of the incoming request or connection |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10568 | will be analyzed, extracted and stored in the table once a |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10569 | server is selected. |
| 10570 | |
| 10571 | <table> is an optional stickiness table name. If unspecified, the same |
| 10572 | backend's table is used. A stickiness table is declared using |
| 10573 | the "stick-table" statement. |
| 10574 | |
| 10575 | <cond> is an optional storage condition. It makes it possible to store |
| 10576 | certain criteria only when some conditions are met (or not met). |
| 10577 | For instance, it could be used to store the source IP address |
| 10578 | except when the request passes through a known proxy, in which |
| 10579 | case we'd store a converted form of a header containing that IP |
| 10580 | address. |
| 10581 | |
| 10582 | Some protocols or applications require complex stickiness rules and cannot |
| 10583 | always simply rely on cookies nor hashing. The "stick store-request" statement |
| 10584 | describes a rule to decide what to extract from the request and when to do |
| 10585 | it, in order to store it into a stickiness table for further requests to |
| 10586 | match it using the "stick match" statement. Obviously the extracted part must |
| 10587 | make sense and have a chance to be matched in a further request. Storing a |
| 10588 | client's IP address for instance often makes sense. Storing an ID found in a |
| 10589 | URL parameter also makes sense. Storing a source port will almost never make |
| 10590 | any sense because it will be randomly matched. See section 7 for a complete |
| 10591 | list of possible patterns and transformation rules. |
| 10592 | |
| 10593 | The table has to be declared using the "stick-table" statement. It must be of |
| 10594 | a type compatible with the pattern. By default it is the one which is present |
| 10595 | in the same backend. It is possible to share a table with other backends by |
| 10596 | referencing it using the "table" keyword. If another table is referenced, |
| 10597 | the server's ID inside the backends are used. By default, all server IDs |
| 10598 | start at 1 in each backend, so the server ordering is enough. But in case of |
| 10599 | doubt, it is highly recommended to force server IDs using their "id" setting. |
| 10600 | |
| 10601 | It is possible to restrict the conditions where a "stick store-request" |
| 10602 | statement will apply, using "if" or "unless" followed by a condition. This |
| 10603 | condition will be evaluated while parsing the request, so any criteria can be |
| 10604 | used. See section 7 for ACL based conditions. |
| 10605 | |
| 10606 | There is no limit on the number of "stick store-request" statements, but |
| 10607 | there is a limit of 8 simultaneous stores per request or response. This |
| 10608 | makes it possible to store up to 8 criteria, all extracted from either the |
| 10609 | request or the response, regardless of the number of rules. Only the 8 first |
| 10610 | ones which match will be kept. Using this, it is possible to feed multiple |
| 10611 | tables at once in the hope to increase the chance to recognize a user on |
Willy Tarreau | 9667a80 | 2013-12-09 12:52:13 +0100 | [diff] [blame] | 10612 | another protocol or access method. Using multiple store-request rules with |
| 10613 | the same table is possible and may be used to find the best criterion to rely |
| 10614 | on, by arranging the rules by decreasing preference order. Only the first |
| 10615 | extracted criterion for a given table will be stored. All subsequent store- |
| 10616 | request rules referencing the same table will be skipped and their ACLs will |
| 10617 | not be evaluated. |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10618 | |
| 10619 | The "store-request" rules are evaluated once the server connection has been |
| 10620 | established, so that the table will contain the real server that processed |
| 10621 | the request. |
| 10622 | |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10623 | Note : Consider not using this feature in multi-process mode (nbproc > 1) |
| 10624 | unless you know what you do : memory is not shared between the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10625 | processes, which can result in random behaviors. |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10626 | |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10627 | Example : |
| 10628 | # forward SMTP users to the same server they just used for POP in the |
| 10629 | # last 30 minutes |
| 10630 | backend pop |
| 10631 | mode tcp |
| 10632 | balance roundrobin |
| 10633 | stick store-request src |
| 10634 | stick-table type ip size 200k expire 30m |
| 10635 | server s1 192.168.1.1:110 |
| 10636 | server s2 192.168.1.1:110 |
| 10637 | |
| 10638 | backend smtp |
| 10639 | mode tcp |
| 10640 | balance roundrobin |
| 10641 | stick match src table pop |
| 10642 | server s1 192.168.1.1:25 |
| 10643 | server s2 192.168.1.1:25 |
| 10644 | |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10645 | See also : "stick-table", "stick on", "nbproc", "bind-process" and section 7 |
Willy Tarreau | be722a2 | 2014-06-13 16:31:59 +0200 | [diff] [blame] | 10646 | about ACLs and sample fetching. |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10647 | |
| 10648 | |
Emeric Brun | 7c6b82e | 2010-09-24 16:34:28 +0200 | [diff] [blame] | 10649 | stick-table type {ip | integer | string [len <length>] | binary [len <length>]} |
Thayne McCombs | 92149f9 | 2020-11-20 01:28:26 -0700 | [diff] [blame] | 10650 | size <size> [expire <expire>] [nopurge] [peers <peersect>] [srvkey <srvkey>] |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 10651 | [store <data_type>]* |
Godbach | 64cef79 | 2013-12-04 16:08:22 +0800 | [diff] [blame] | 10652 | Configure the stickiness table for the current section |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10653 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | c00cdc2 | 2010-06-06 16:48:26 +0200 | [diff] [blame] | 10654 | no | yes | yes | yes |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10655 | |
| 10656 | Arguments : |
| 10657 | ip a table declared with "type ip" will only store IPv4 addresses. |
| 10658 | This form is very compact (about 50 bytes per entry) and allows |
| 10659 | very fast entry lookup and stores with almost no overhead. This |
| 10660 | is mainly used to store client source IP addresses. |
| 10661 | |
David du Colombier | 9a6d3c9 | 2011-03-17 10:40:24 +0100 | [diff] [blame] | 10662 | ipv6 a table declared with "type ipv6" will only store IPv6 addresses. |
| 10663 | This form is very compact (about 60 bytes per entry) and allows |
| 10664 | very fast entry lookup and stores with almost no overhead. This |
| 10665 | is mainly used to store client source IP addresses. |
| 10666 | |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10667 | integer a table declared with "type integer" will store 32bit integers |
| 10668 | which can represent a client identifier found in a request for |
| 10669 | instance. |
| 10670 | |
| 10671 | string a table declared with "type string" will store substrings of up |
| 10672 | to <len> characters. If the string provided by the pattern |
| 10673 | extractor is larger than <len>, it will be truncated before |
| 10674 | being stored. During matching, at most <len> characters will be |
| 10675 | compared between the string in the table and the extracted |
| 10676 | pattern. When not specified, the string is automatically limited |
Emeric Brun | 7c6b82e | 2010-09-24 16:34:28 +0200 | [diff] [blame] | 10677 | to 32 characters. |
| 10678 | |
| 10679 | binary a table declared with "type binary" will store binary blocks |
| 10680 | of <len> bytes. If the block provided by the pattern |
| 10681 | extractor is larger than <len>, it will be truncated before |
Willy Tarreau | be722a2 | 2014-06-13 16:31:59 +0200 | [diff] [blame] | 10682 | being stored. If the block provided by the sample expression |
Emeric Brun | 7c6b82e | 2010-09-24 16:34:28 +0200 | [diff] [blame] | 10683 | is shorter than <len>, it will be padded by 0. When not |
| 10684 | specified, the block is automatically limited to 32 bytes. |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10685 | |
| 10686 | <length> is the maximum number of characters that will be stored in a |
Emeric Brun | 7c6b82e | 2010-09-24 16:34:28 +0200 | [diff] [blame] | 10687 | "string" type table (See type "string" above). Or the number |
| 10688 | of bytes of the block in "binary" type table. Be careful when |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10689 | changing this parameter as memory usage will proportionally |
| 10690 | increase. |
| 10691 | |
| 10692 | <size> is the maximum number of entries that can fit in the table. This |
Cyril Bonté | 78caf84 | 2010-03-10 22:41:43 +0100 | [diff] [blame] | 10693 | value directly impacts memory usage. Count approximately |
| 10694 | 50 bytes per entry, plus the size of a string if any. The size |
| 10695 | supports suffixes "k", "m", "g" for 2^10, 2^20 and 2^30 factors. |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10696 | |
| 10697 | [nopurge] indicates that we refuse to purge older entries when the table |
| 10698 | is full. When not specified and the table is full when haproxy |
| 10699 | wants to store an entry in it, it will flush a few of the oldest |
| 10700 | entries in order to release some space for the new ones. This is |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10701 | most often the desired behavior. In some specific cases, it |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10702 | be desirable to refuse new entries instead of purging the older |
| 10703 | ones. That may be the case when the amount of data to store is |
| 10704 | far above the hardware limits and we prefer not to offer access |
| 10705 | to new clients than to reject the ones already connected. When |
| 10706 | using this parameter, be sure to properly set the "expire" |
| 10707 | parameter (see below). |
| 10708 | |
Emeric Brun | f099e79 | 2010-09-27 12:05:28 +0200 | [diff] [blame] | 10709 | <peersect> is the name of the peers section to use for replication. Entries |
| 10710 | which associate keys to server IDs are kept synchronized with |
| 10711 | the remote peers declared in this section. All entries are also |
| 10712 | automatically learned from the local peer (old process) during a |
| 10713 | soft restart. |
| 10714 | |
Willy Tarreau | 1abc673 | 2015-05-01 19:21:02 +0200 | [diff] [blame] | 10715 | NOTE : each peers section may be referenced only by tables |
| 10716 | belonging to the same unique process. |
Cyril Bonté | 02ff8ef | 2010-12-14 22:48:49 +0100 | [diff] [blame] | 10717 | |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10718 | <expire> defines the maximum duration of an entry in the table since it |
| 10719 | was last created, refreshed or matched. The expiration delay is |
| 10720 | defined using the standard time format, similarly as the various |
| 10721 | timeouts. The maximum duration is slightly above 24 days. See |
Jarno Huuskonen | e0ee0be | 2017-07-04 10:35:12 +0300 | [diff] [blame] | 10722 | section 2.4 for more information. If this delay is not specified, |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 10723 | the session won't automatically expire, but older entries will |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10724 | be removed once full. Be sure not to use the "nopurge" parameter |
| 10725 | if not expiration delay is specified. |
| 10726 | |
Thayne McCombs | 92149f9 | 2020-11-20 01:28:26 -0700 | [diff] [blame] | 10727 | <srvkey> specifies how each server is identified for the purposes of the |
| 10728 | stick table. The valid values are "name" and "addr". If "name" is |
| 10729 | given, then <name> argument for the server (may be generated by |
| 10730 | a template). If "addr" is given, then the server is identified |
| 10731 | by its current network address, including the port. "addr" is |
| 10732 | especially useful if you are using service discovery to generate |
| 10733 | the addresses for servers with peered stick-tables and want |
| 10734 | to consistently use the same host across peers for a stickiness |
| 10735 | token. |
| 10736 | |
Willy Tarreau | 08d5f98 | 2010-06-06 13:34:54 +0200 | [diff] [blame] | 10737 | <data_type> is used to store additional information in the stick-table. This |
| 10738 | may be used by ACLs in order to control various criteria related |
| 10739 | to the activity of the client matching the stick-table. For each |
| 10740 | item specified here, the size of each entry will be inflated so |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 10741 | that the additional data can fit. Several data types may be |
| 10742 | stored with an entry. Multiple data types may be specified after |
| 10743 | the "store" keyword, as a comma-separated list. Alternatively, |
| 10744 | it is possible to repeat the "store" keyword followed by one or |
| 10745 | several data types. Except for the "server_id" type which is |
| 10746 | automatically detected and enabled, all data types must be |
| 10747 | explicitly declared to be stored. If an ACL references a data |
| 10748 | type which is not stored, the ACL will simply not match. Some |
| 10749 | data types require an argument which must be passed just after |
| 10750 | the type between parenthesis. See below for the supported data |
| 10751 | types and their arguments. |
| 10752 | |
| 10753 | The data types that can be stored with an entry are the following : |
| 10754 | - server_id : this is an integer which holds the numeric ID of the server a |
| 10755 | request was assigned to. It is used by the "stick match", "stick store", |
| 10756 | and "stick on" rules. It is automatically enabled when referenced. |
| 10757 | |
| 10758 | - gpc0 : first General Purpose Counter. It is a positive 32-bit integer |
| 10759 | integer which may be used for anything. Most of the time it will be used |
| 10760 | to put a special tag on some entries, for instance to note that a |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10761 | specific behavior was detected and must be known for future matches. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 10762 | |
Willy Tarreau | ba2ffd1 | 2013-05-29 15:54:14 +0200 | [diff] [blame] | 10763 | - gpc0_rate(<period>) : increment rate of the first General Purpose Counter |
| 10764 | over a period. It is a positive 32-bit integer integer which may be used |
| 10765 | for anything. Just like <gpc0>, it counts events, but instead of keeping |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10766 | a cumulative number, it maintains the rate at which the counter is |
Willy Tarreau | ba2ffd1 | 2013-05-29 15:54:14 +0200 | [diff] [blame] | 10767 | incremented. Most of the time it will be used to measure the frequency of |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10768 | occurrence of certain events (e.g. requests to a specific URL). |
Willy Tarreau | ba2ffd1 | 2013-05-29 15:54:14 +0200 | [diff] [blame] | 10769 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 10770 | - gpc1 : second General Purpose Counter. It is a positive 32-bit integer |
| 10771 | integer which may be used for anything. Most of the time it will be used |
| 10772 | to put a special tag on some entries, for instance to note that a |
| 10773 | specific behavior was detected and must be known for future matches. |
| 10774 | |
| 10775 | - gpc1_rate(<period>) : increment rate of the second General Purpose Counter |
| 10776 | over a period. It is a positive 32-bit integer integer which may be used |
| 10777 | for anything. Just like <gpc1>, it counts events, but instead of keeping |
| 10778 | a cumulative number, it maintains the rate at which the counter is |
| 10779 | incremented. Most of the time it will be used to measure the frequency of |
| 10780 | occurrence of certain events (e.g. requests to a specific URL). |
| 10781 | |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 10782 | - conn_cnt : Connection Count. It is a positive 32-bit integer which counts |
| 10783 | the absolute number of connections received from clients which matched |
| 10784 | this entry. It does not mean the connections were accepted, just that |
| 10785 | they were received. |
| 10786 | |
| 10787 | - conn_cur : Current Connections. It is a positive 32-bit integer which |
| 10788 | stores the concurrent connection counts for the entry. It is incremented |
| 10789 | once an incoming connection matches the entry, and decremented once the |
| 10790 | connection leaves. That way it is possible to know at any time the exact |
| 10791 | number of concurrent connections for an entry. |
| 10792 | |
| 10793 | - conn_rate(<period>) : frequency counter (takes 12 bytes). It takes an |
| 10794 | integer parameter <period> which indicates in milliseconds the length |
| 10795 | of the period over which the average is measured. It reports the average |
| 10796 | incoming connection rate over that period, in connections per period. The |
| 10797 | result is an integer which can be matched using ACLs. |
| 10798 | |
| 10799 | - sess_cnt : Session Count. It is a positive 32-bit integer which counts |
| 10800 | the absolute number of sessions received from clients which matched this |
| 10801 | entry. A session is a connection that was accepted by the layer 4 rules. |
| 10802 | |
| 10803 | - sess_rate(<period>) : frequency counter (takes 12 bytes). It takes an |
| 10804 | integer parameter <period> which indicates in milliseconds the length |
| 10805 | of the period over which the average is measured. It reports the average |
| 10806 | incoming session rate over that period, in sessions per period. The |
| 10807 | result is an integer which can be matched using ACLs. |
| 10808 | |
| 10809 | - http_req_cnt : HTTP request Count. It is a positive 32-bit integer which |
| 10810 | counts the absolute number of HTTP requests received from clients which |
| 10811 | matched this entry. It does not matter whether they are valid requests or |
| 10812 | not. Note that this is different from sessions when keep-alive is used on |
| 10813 | the client side. |
| 10814 | |
| 10815 | - http_req_rate(<period>) : frequency counter (takes 12 bytes). It takes an |
| 10816 | integer parameter <period> which indicates in milliseconds the length |
| 10817 | of the period over which the average is measured. It reports the average |
| 10818 | HTTP request rate over that period, in requests per period. The result is |
| 10819 | an integer which can be matched using ACLs. It does not matter whether |
| 10820 | they are valid requests or not. Note that this is different from sessions |
| 10821 | when keep-alive is used on the client side. |
| 10822 | |
| 10823 | - http_err_cnt : HTTP Error Count. It is a positive 32-bit integer which |
| 10824 | counts the absolute number of HTTP requests errors induced by clients |
| 10825 | which matched this entry. Errors are counted on invalid and truncated |
| 10826 | requests, as well as on denied or tarpitted requests, and on failed |
| 10827 | authentications. If the server responds with 4xx, then the request is |
| 10828 | also counted as an error since it's an error triggered by the client |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10829 | (e.g. vulnerability scan). |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 10830 | |
| 10831 | - http_err_rate(<period>) : frequency counter (takes 12 bytes). It takes an |
| 10832 | integer parameter <period> which indicates in milliseconds the length |
| 10833 | of the period over which the average is measured. It reports the average |
| 10834 | HTTP request error rate over that period, in requests per period (see |
| 10835 | http_err_cnt above for what is accounted as an error). The result is an |
| 10836 | integer which can be matched using ACLs. |
| 10837 | |
| 10838 | - bytes_in_cnt : client to server byte count. It is a positive 64-bit |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10839 | integer which counts the cumulative number of bytes received from clients |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 10840 | which matched this entry. Headers are included in the count. This may be |
| 10841 | used to limit abuse of upload features on photo or video servers. |
| 10842 | |
| 10843 | - bytes_in_rate(<period>) : frequency counter (takes 12 bytes). It takes an |
| 10844 | integer parameter <period> which indicates in milliseconds the length |
| 10845 | of the period over which the average is measured. It reports the average |
| 10846 | incoming bytes rate over that period, in bytes per period. It may be used |
| 10847 | to detect users which upload too much and too fast. Warning: with large |
| 10848 | uploads, it is possible that the amount of uploaded data will be counted |
| 10849 | once upon termination, thus causing spikes in the average transfer speed |
| 10850 | instead of having a smooth one. This may partially be smoothed with |
| 10851 | "option contstats" though this is not perfect yet. Use of byte_in_cnt is |
| 10852 | recommended for better fairness. |
| 10853 | |
| 10854 | - bytes_out_cnt : server to client byte count. It is a positive 64-bit |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10855 | integer which counts the cumulative number of bytes sent to clients which |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 10856 | matched this entry. Headers are included in the count. This may be used |
| 10857 | to limit abuse of bots sucking the whole site. |
| 10858 | |
| 10859 | - bytes_out_rate(<period>) : frequency counter (takes 12 bytes). It takes |
| 10860 | an integer parameter <period> which indicates in milliseconds the length |
| 10861 | of the period over which the average is measured. It reports the average |
| 10862 | outgoing bytes rate over that period, in bytes per period. It may be used |
| 10863 | to detect users which download too much and too fast. Warning: with large |
| 10864 | transfers, it is possible that the amount of transferred data will be |
| 10865 | counted once upon termination, thus causing spikes in the average |
| 10866 | transfer speed instead of having a smooth one. This may partially be |
| 10867 | smoothed with "option contstats" though this is not perfect yet. Use of |
| 10868 | byte_out_cnt is recommended for better fairness. |
Willy Tarreau | 08d5f98 | 2010-06-06 13:34:54 +0200 | [diff] [blame] | 10869 | |
Willy Tarreau | c00cdc2 | 2010-06-06 16:48:26 +0200 | [diff] [blame] | 10870 | There is only one stick-table per proxy. At the moment of writing this doc, |
| 10871 | it does not seem useful to have multiple tables per proxy. If this happens |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10872 | to be required, simply create a dummy backend with a stick-table in it and |
| 10873 | reference it. |
| 10874 | |
| 10875 | It is important to understand that stickiness based on learning information |
| 10876 | has some limitations, including the fact that all learned associations are |
Baptiste Assmann | 123ff04 | 2016-03-06 23:29:28 +0100 | [diff] [blame] | 10877 | lost upon restart unless peers are properly configured to transfer such |
| 10878 | information upon restart (recommended). In general it can be good as a |
| 10879 | complement but not always as an exclusive stickiness. |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10880 | |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 10881 | Last, memory requirements may be important when storing many data types. |
| 10882 | Indeed, storing all indicators above at once in each entry requires 116 bytes |
| 10883 | per entry, or 116 MB for a 1-million entries table. This is definitely not |
| 10884 | something that can be ignored. |
| 10885 | |
| 10886 | Example: |
| 10887 | # Keep track of counters of up to 1 million IP addresses over 5 minutes |
| 10888 | # and store a general purpose counter and the average connection rate |
| 10889 | # computed over a sliding window of 30 seconds. |
| 10890 | stick-table type ip size 1m expire 5m store gpc0,conn_rate(30s) |
| 10891 | |
Jarno Huuskonen | e0ee0be | 2017-07-04 10:35:12 +0300 | [diff] [blame] | 10892 | See also : "stick match", "stick on", "stick store-request", section 2.4 |
David du Colombier | a13d1b9 | 2011-03-17 10:40:22 +0100 | [diff] [blame] | 10893 | about time format and section 7 about ACLs. |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 10894 | |
| 10895 | |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10896 | stick store-response <pattern> [table <table>] [{if | unless} <condition>] |
Baptiste Assmann | 2f2d2ec | 2016-03-06 23:27:24 +0100 | [diff] [blame] | 10897 | Define a response pattern used to create an entry in a stickiness table |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10898 | May be used in sections : defaults | frontend | listen | backend |
| 10899 | no | no | yes | yes |
| 10900 | |
| 10901 | Arguments : |
Willy Tarreau | be722a2 | 2014-06-13 16:31:59 +0200 | [diff] [blame] | 10902 | <pattern> is a sample expression rule as described in section 7.3. It |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10903 | describes what elements of the response or connection will |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 10904 | be analyzed, extracted and stored in the table once a |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10905 | server is selected. |
| 10906 | |
| 10907 | <table> is an optional stickiness table name. If unspecified, the same |
| 10908 | backend's table is used. A stickiness table is declared using |
| 10909 | the "stick-table" statement. |
| 10910 | |
| 10911 | <cond> is an optional storage condition. It makes it possible to store |
| 10912 | certain criteria only when some conditions are met (or not met). |
| 10913 | For instance, it could be used to store the SSL session ID only |
| 10914 | when the response is a SSL server hello. |
| 10915 | |
| 10916 | Some protocols or applications require complex stickiness rules and cannot |
| 10917 | always simply rely on cookies nor hashing. The "stick store-response" |
| 10918 | statement describes a rule to decide what to extract from the response and |
| 10919 | when to do it, in order to store it into a stickiness table for further |
| 10920 | requests to match it using the "stick match" statement. Obviously the |
| 10921 | extracted part must make sense and have a chance to be matched in a further |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 10922 | request. Storing an ID found in a header of a response makes sense. |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10923 | See section 7 for a complete list of possible patterns and transformation |
| 10924 | rules. |
| 10925 | |
| 10926 | The table has to be declared using the "stick-table" statement. It must be of |
| 10927 | a type compatible with the pattern. By default it is the one which is present |
| 10928 | in the same backend. It is possible to share a table with other backends by |
| 10929 | referencing it using the "table" keyword. If another table is referenced, |
| 10930 | the server's ID inside the backends are used. By default, all server IDs |
| 10931 | start at 1 in each backend, so the server ordering is enough. But in case of |
| 10932 | doubt, it is highly recommended to force server IDs using their "id" setting. |
| 10933 | |
| 10934 | It is possible to restrict the conditions where a "stick store-response" |
| 10935 | statement will apply, using "if" or "unless" followed by a condition. This |
| 10936 | condition will be evaluated while parsing the response, so any criteria can |
| 10937 | be used. See section 7 for ACL based conditions. |
| 10938 | |
| 10939 | There is no limit on the number of "stick store-response" statements, but |
| 10940 | there is a limit of 8 simultaneous stores per request or response. This |
| 10941 | makes it possible to store up to 8 criteria, all extracted from either the |
| 10942 | request or the response, regardless of the number of rules. Only the 8 first |
| 10943 | ones which match will be kept. Using this, it is possible to feed multiple |
| 10944 | tables at once in the hope to increase the chance to recognize a user on |
Willy Tarreau | 9667a80 | 2013-12-09 12:52:13 +0100 | [diff] [blame] | 10945 | another protocol or access method. Using multiple store-response rules with |
| 10946 | the same table is possible and may be used to find the best criterion to rely |
| 10947 | on, by arranging the rules by decreasing preference order. Only the first |
| 10948 | extracted criterion for a given table will be stored. All subsequent store- |
| 10949 | response rules referencing the same table will be skipped and their ACLs will |
| 10950 | not be evaluated. However, even if a store-request rule references a table, a |
| 10951 | store-response rule may also use the same table. This means that each table |
| 10952 | may learn exactly one element from the request and one element from the |
| 10953 | response at once. |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10954 | |
| 10955 | The table will contain the real server that processed the request. |
| 10956 | |
| 10957 | Example : |
| 10958 | # Learn SSL session ID from both request and response and create affinity. |
| 10959 | backend https |
| 10960 | mode tcp |
| 10961 | balance roundrobin |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 10962 | # maximum SSL session ID length is 32 bytes. |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10963 | stick-table type binary len 32 size 30k expire 30m |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 10964 | |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10965 | acl clienthello req_ssl_hello_type 1 |
| 10966 | acl serverhello rep_ssl_hello_type 2 |
| 10967 | |
| 10968 | # use tcp content accepts to detects ssl client and server hello. |
| 10969 | tcp-request inspect-delay 5s |
| 10970 | tcp-request content accept if clienthello |
| 10971 | |
| 10972 | # no timeout on response inspect delay by default. |
| 10973 | tcp-response content accept if serverhello |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 10974 | |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10975 | # SSL session ID (SSLID) may be present on a client or server hello. |
| 10976 | # Its length is coded on 1 byte at offset 43 and its value starts |
| 10977 | # at offset 44. |
| 10978 | |
| 10979 | # Match and learn on request if client hello. |
| 10980 | stick on payload_lv(43,1) if clienthello |
| 10981 | |
| 10982 | # Learn on response if server hello. |
| 10983 | stick store-response payload_lv(43,1) if serverhello |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 10984 | |
Emeric Brun | 6a1cefa | 2010-09-24 18:15:17 +0200 | [diff] [blame] | 10985 | server s1 192.168.1.1:443 |
| 10986 | server s2 192.168.1.1:443 |
| 10987 | |
| 10988 | See also : "stick-table", "stick on", and section 7 about ACLs and pattern |
| 10989 | extraction. |
| 10990 | |
| 10991 | |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 10992 | tcp-check comment <string> |
| 10993 | Defines a comment for the following the tcp-check rule, reported in logs if |
| 10994 | it fails. |
| 10995 | May be used in sections : defaults | frontend | listen | backend |
| 10996 | yes | no | yes | yes |
| 10997 | |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 10998 | Arguments : |
| 10999 | <string> is the comment message to add in logs if the following tcp-check |
| 11000 | rule fails. |
| 11001 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 11002 | It only works for connect, send and expect rules. It is useful to make |
| 11003 | user-friendly error reporting. |
| 11004 | |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 11005 | See also : "option tcp-check", "tcp-check connect", "tcp-check send" and |
| 11006 | "tcp-check expect". |
| 11007 | |
| 11008 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 11009 | tcp-check connect [default] [port <expr>] [addr <ip>] [send-proxy] [via-socks4] |
| 11010 | [ssl] [sni <sni>] [alpn <alpn>] [linger] |
Christopher Faulet | edc6ed9 | 2020-04-23 16:27:59 +0200 | [diff] [blame] | 11011 | [proto <name>] [comment <msg>] |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11012 | Opens a new connection |
| 11013 | May be used in sections: defaults | frontend | listen | backend |
Christopher Faulet | 404f919 | 2020-04-09 23:13:54 +0200 | [diff] [blame] | 11014 | yes | no | yes | yes |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11015 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 11016 | Arguments : |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 11017 | comment <msg> defines a message to report if the rule evaluation fails. |
| 11018 | |
Christopher Faulet | 4dce592 | 2020-03-30 13:54:42 +0200 | [diff] [blame] | 11019 | default Use default options of the server line to do the health |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 11020 | checks. The server options are used only if not redefined. |
Christopher Faulet | 4dce592 | 2020-03-30 13:54:42 +0200 | [diff] [blame] | 11021 | |
Christopher Faulet | b7d3009 | 2020-03-30 15:19:03 +0200 | [diff] [blame] | 11022 | port <expr> if not set, check port or server port is used. |
Christopher Faulet | 5c28874 | 2020-03-31 08:15:58 +0200 | [diff] [blame] | 11023 | It tells HAProxy where to open the connection to. |
| 11024 | <port> must be a valid TCP port source integer, from 1 to |
Christopher Faulet | b7d3009 | 2020-03-30 15:19:03 +0200 | [diff] [blame] | 11025 | 65535 or an sample-fetch expression. |
Christopher Faulet | 5c28874 | 2020-03-31 08:15:58 +0200 | [diff] [blame] | 11026 | |
| 11027 | addr <ip> defines the IP address to do the health check. |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11028 | |
| 11029 | send-proxy send a PROXY protocol string |
| 11030 | |
Christopher Faulet | 085426a | 2020-03-30 13:07:02 +0200 | [diff] [blame] | 11031 | via-socks4 enables outgoing health checks using upstream socks4 proxy. |
| 11032 | |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11033 | ssl opens a ciphered connection |
| 11034 | |
Christopher Faulet | 79b31d4 | 2020-03-30 13:00:05 +0200 | [diff] [blame] | 11035 | sni <sni> specifies the SNI to use to do health checks over SSL. |
| 11036 | |
Christopher Faulet | 9857232 | 2020-03-30 13:16:44 +0200 | [diff] [blame] | 11037 | alpn <alpn> defines which protocols to advertise with ALPN. The protocol |
| 11038 | list consists in a comma-delimited list of protocol names, |
| 11039 | for instance: "http/1.1,http/1.0" (without quotes). |
| 11040 | If it is not set, the server ALPN is used. |
| 11041 | |
Christopher Faulet | edc6ed9 | 2020-04-23 16:27:59 +0200 | [diff] [blame] | 11042 | proto <name> forces the multiplexer's protocol to use for this connection. |
| 11043 | It must be a TCP mux protocol and it must be usable on the |
| 11044 | backend side. The list of available protocols is reported in |
| 11045 | haproxy -vv. |
| 11046 | |
Christopher Faulet | 5c28874 | 2020-03-31 08:15:58 +0200 | [diff] [blame] | 11047 | linger cleanly close the connection instead of using a single RST. |
Gaetan Rivet | f8ba677 | 2020-02-07 15:37:17 +0100 | [diff] [blame] | 11048 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 11049 | When an application lies on more than a single TCP port or when HAProxy |
| 11050 | load-balance many services in a single backend, it makes sense to probe all |
| 11051 | the services individually before considering a server as operational. |
| 11052 | |
| 11053 | When there are no TCP port configured on the server line neither server port |
| 11054 | directive, then the 'tcp-check connect port <port>' must be the first step |
| 11055 | of the sequence. |
| 11056 | |
| 11057 | In a tcp-check ruleset a 'connect' is required, it is also mandatory to start |
| 11058 | the ruleset with a 'connect' rule. Purpose is to ensure admin know what they |
| 11059 | do. |
| 11060 | |
| 11061 | When a connect must start the ruleset, if may still be preceded by set-var, |
| 11062 | unset-var or comment rules. |
| 11063 | |
| 11064 | Examples : |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11065 | # check HTTP and HTTPs services on a server. |
| 11066 | # first open port 80 thanks to server line port directive, then |
| 11067 | # tcp-check opens port 443, ciphered and run a request on it: |
| 11068 | option tcp-check |
| 11069 | tcp-check connect |
| 11070 | tcp-check send GET\ /\ HTTP/1.0\r\n |
| 11071 | tcp-check send Host:\ haproxy.1wt.eu\r\n |
| 11072 | tcp-check send \r\n |
| 11073 | tcp-check expect rstring (2..|3..) |
| 11074 | tcp-check connect port 443 ssl |
| 11075 | tcp-check send GET\ /\ HTTP/1.0\r\n |
| 11076 | tcp-check send Host:\ haproxy.1wt.eu\r\n |
| 11077 | tcp-check send \r\n |
| 11078 | tcp-check expect rstring (2..|3..) |
| 11079 | server www 10.0.0.1 check port 80 |
| 11080 | |
| 11081 | # check both POP and IMAP from a single server: |
| 11082 | option tcp-check |
Gaetan Rivet | f8ba677 | 2020-02-07 15:37:17 +0100 | [diff] [blame] | 11083 | tcp-check connect port 110 linger |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11084 | tcp-check expect string +OK\ POP3\ ready |
| 11085 | tcp-check connect port 143 |
| 11086 | tcp-check expect string *\ OK\ IMAP4\ ready |
| 11087 | server mail 10.0.0.1 check |
| 11088 | |
| 11089 | See also : "option tcp-check", "tcp-check send", "tcp-check expect" |
| 11090 | |
| 11091 | |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 11092 | tcp-check expect [min-recv <int>] [comment <msg>] |
Christopher Faulet | ec07e38 | 2020-04-07 14:56:26 +0200 | [diff] [blame] | 11093 | [ok-status <st>] [error-status <st>] [tout-status <st>] |
Christopher Faulet | 98cc57c | 2020-04-01 20:52:31 +0200 | [diff] [blame] | 11094 | [on-success <fmt>] [on-error <fmt>] [status-code <expr>] |
Christopher Faulet | cf80f2f | 2020-04-01 11:04:52 +0200 | [diff] [blame] | 11095 | [!] <match> <pattern> |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11096 | Specify data to be collected and analyzed during a generic health check |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11097 | May be used in sections: defaults | frontend | listen | backend |
Christopher Faulet | 404f919 | 2020-04-09 23:13:54 +0200 | [diff] [blame] | 11098 | yes | no | yes | yes |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11099 | |
| 11100 | Arguments : |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 11101 | comment <msg> defines a message to report if the rule evaluation fails. |
| 11102 | |
Gaetan Rivet | 1afd826 | 2020-02-07 15:37:17 +0100 | [diff] [blame] | 11103 | min-recv is optional and can define the minimum amount of data required to |
| 11104 | evaluate the current expect rule. If the number of received bytes |
| 11105 | is under this limit, the check will wait for more data. This |
| 11106 | option can be used to resolve some ambiguous matching rules or to |
| 11107 | avoid executing costly regex matches on content known to be still |
| 11108 | incomplete. If an exact string (string or binary) is used, the |
| 11109 | minimum between the string length and this parameter is used. |
| 11110 | This parameter is ignored if it is set to -1. If the expect rule |
| 11111 | does not match, the check will wait for more data. If set to 0, |
| 11112 | the evaluation result is always conclusive. |
| 11113 | |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11114 | <match> is a keyword indicating how to look for a specific pattern in the |
Gaetan Rivet | efab6c6 | 2020-02-07 15:37:17 +0100 | [diff] [blame] | 11115 | response. The keyword may be one of "string", "rstring", "binary" or |
| 11116 | "rbinary". |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11117 | The keyword may be preceded by an exclamation mark ("!") to negate |
| 11118 | the match. Spaces are allowed between the exclamation mark and the |
| 11119 | keyword. See below for more details on the supported keywords. |
| 11120 | |
Christopher Faulet | ec07e38 | 2020-04-07 14:56:26 +0200 | [diff] [blame] | 11121 | ok-status <st> is optional and can be used to set the check status if |
| 11122 | the expect rule is successfully evaluated and if it is |
| 11123 | the last rule in the tcp-check ruleset. "L7OK", "L7OKC", |
Christopher Faulet | d888f0f | 2020-05-07 07:40:17 +0200 | [diff] [blame] | 11124 | "L6OK" and "L4OK" are supported : |
| 11125 | - L7OK : check passed on layer 7 |
Christopher Faulet | 83662b5 | 2020-11-20 17:47:47 +0100 | [diff] [blame] | 11126 | - L7OKC : check conditionally passed on layer 7, set |
| 11127 | server to NOLB state. |
Christopher Faulet | d888f0f | 2020-05-07 07:40:17 +0200 | [diff] [blame] | 11128 | - L6OK : check passed on layer 6 |
| 11129 | - L4OK : check passed on layer 4 |
Christopher Faulet | ec07e38 | 2020-04-07 14:56:26 +0200 | [diff] [blame] | 11130 | By default "L7OK" is used. |
| 11131 | |
Christopher Faulet | cf80f2f | 2020-04-01 11:04:52 +0200 | [diff] [blame] | 11132 | error-status <st> is optional and can be used to set the check status if |
| 11133 | an error occurred during the expect rule evaluation. |
Christopher Faulet | 83662b5 | 2020-11-20 17:47:47 +0100 | [diff] [blame] | 11134 | "L7OKC", "L7RSP", "L7STS", "L6RSP" and "L4CON" are |
| 11135 | supported : |
| 11136 | - L7OKC : check conditionally passed on layer 7, set |
| 11137 | server to NOLB state. |
Christopher Faulet | d888f0f | 2020-05-07 07:40:17 +0200 | [diff] [blame] | 11138 | - L7RSP : layer 7 invalid response - protocol error |
| 11139 | - L7STS : layer 7 response error, for example HTTP 5xx |
| 11140 | - L6RSP : layer 6 invalid response - protocol error |
| 11141 | - L4CON : layer 1-4 connection problem |
| 11142 | By default "L7RSP" is used. |
Christopher Faulet | cf80f2f | 2020-04-01 11:04:52 +0200 | [diff] [blame] | 11143 | |
Christopher Faulet | ec07e38 | 2020-04-07 14:56:26 +0200 | [diff] [blame] | 11144 | tout-status <st> is optional and can be used to set the check status if |
Christopher Faulet | cf80f2f | 2020-04-01 11:04:52 +0200 | [diff] [blame] | 11145 | a timeout occurred during the expect rule evaluation. |
Christopher Faulet | d888f0f | 2020-05-07 07:40:17 +0200 | [diff] [blame] | 11146 | "L7TOUT", "L6TOUT", and "L4TOUT" are supported : |
| 11147 | - L7TOUT : layer 7 (HTTP/SMTP) timeout |
| 11148 | - L6TOUT : layer 6 (SSL) timeout |
| 11149 | - L4TOUT : layer 1-4 timeout |
Christopher Faulet | cf80f2f | 2020-04-01 11:04:52 +0200 | [diff] [blame] | 11150 | By default "L7TOUT" is used. |
| 11151 | |
Christopher Faulet | be52b4d | 2020-04-01 16:30:22 +0200 | [diff] [blame] | 11152 | on-success <fmt> is optional and can be used to customize the |
| 11153 | informational message reported in logs if the expect |
| 11154 | rule is successfully evaluated and if it is the last rule |
| 11155 | in the tcp-check ruleset. <fmt> is a log-format string. |
| 11156 | |
| 11157 | on-error <fmt> is optional and can be used to customize the |
| 11158 | informational message reported in logs if an error |
| 11159 | occurred during the expect rule evaluation. <fmt> is a |
| 11160 | log-format string. |
| 11161 | |
Christopher Faulet | 98cc57c | 2020-04-01 20:52:31 +0200 | [diff] [blame] | 11162 | status-code <expr> is optional and can be used to set the check status code |
| 11163 | reported in logs, on success or on error. <expr> is a |
| 11164 | standard HAProxy expression formed by a sample-fetch |
| 11165 | followed by some converters. |
| 11166 | |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11167 | <pattern> is the pattern to look for. It may be a string or a regular |
| 11168 | expression. If the pattern contains spaces, they must be escaped |
| 11169 | with the usual backslash ('\'). |
| 11170 | If the match is set to binary, then the pattern must be passed as |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11171 | a series of hexadecimal digits in an even number. Each sequence of |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11172 | two digits will represent a byte. The hexadecimal digits may be |
| 11173 | used upper or lower case. |
| 11174 | |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11175 | The available matches are intentionally similar to their http-check cousins : |
| 11176 | |
| 11177 | string <string> : test the exact string matches in the response buffer. |
| 11178 | A health check response will be considered valid if the |
| 11179 | response's buffer contains this exact string. If the |
| 11180 | "string" keyword is prefixed with "!", then the response |
| 11181 | will be considered invalid if the body contains this |
| 11182 | string. This can be used to look for a mandatory pattern |
| 11183 | in a protocol response, or to detect a failure when a |
| 11184 | specific error appears in a protocol banner. |
| 11185 | |
| 11186 | rstring <regex> : test a regular expression on the response buffer. |
| 11187 | A health check response will be considered valid if the |
| 11188 | response's buffer matches this expression. If the |
| 11189 | "rstring" keyword is prefixed with "!", then the response |
| 11190 | will be considered invalid if the body matches the |
| 11191 | expression. |
| 11192 | |
Christopher Faulet | aaab083 | 2020-05-05 15:54:22 +0200 | [diff] [blame] | 11193 | string-lf <fmt> : test a log-format string match in the response's buffer. |
| 11194 | A health check response will be considered valid if the |
| 11195 | response's buffer contains the string resulting of the |
| 11196 | evaluation of <fmt>, which follows the log-format rules. |
| 11197 | If prefixed with "!", then the response will be |
| 11198 | considered invalid if the buffer contains the string. |
| 11199 | |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11200 | binary <hexstring> : test the exact string in its hexadecimal form matches |
| 11201 | in the response buffer. A health check response will |
| 11202 | be considered valid if the response's buffer contains |
| 11203 | this exact hexadecimal string. |
| 11204 | Purpose is to match data on binary protocols. |
| 11205 | |
Gaetan Rivet | efab6c6 | 2020-02-07 15:37:17 +0100 | [diff] [blame] | 11206 | rbinary <regex> : test a regular expression on the response buffer, like |
| 11207 | "rstring". However, the response buffer is transformed |
| 11208 | into its hexadecimal form, including NUL-bytes. This |
| 11209 | allows using all regex engines to match any binary |
| 11210 | content. The hexadecimal transformation takes twice the |
| 11211 | size of the original response. As such, the expected |
| 11212 | pattern should work on at-most half the response buffer |
| 11213 | size. |
| 11214 | |
Christopher Faulet | aaab083 | 2020-05-05 15:54:22 +0200 | [diff] [blame] | 11215 | binary-lf <hexfmt> : test a log-format string in its hexadecimal form |
| 11216 | match in the response's buffer. A health check response |
| 11217 | will be considered valid if the response's buffer |
| 11218 | contains the hexadecimal string resulting of the |
| 11219 | evaluation of <fmt>, which follows the log-format |
| 11220 | rules. If prefixed with "!", then the response will be |
| 11221 | considered invalid if the buffer contains the |
| 11222 | hexadecimal string. The hexadecimal string is converted |
| 11223 | in a binary string before matching the response's |
| 11224 | buffer. |
| 11225 | |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11226 | It is important to note that the responses will be limited to a certain size |
Christopher Faulet | bb9fb8b | 2020-11-25 17:20:57 +0100 | [diff] [blame] | 11227 | defined by the global "tune.bufsize" option, which defaults to 16384 bytes. |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11228 | Thus, too large responses may not contain the mandatory pattern when using |
| 11229 | "string", "rstring" or binary. If a large response is absolutely required, it |
| 11230 | is possible to change the default max size by setting the global variable. |
| 11231 | However, it is worth keeping in mind that parsing very large responses can |
| 11232 | waste some CPU cycles, especially when regular expressions are used, and that |
| 11233 | it is always better to focus the checks on smaller resources. Also, in its |
| 11234 | current state, the check will not find any string nor regex past a null |
| 11235 | character in the response. Similarly it is not possible to request matching |
| 11236 | the null character. |
| 11237 | |
| 11238 | Examples : |
| 11239 | # perform a POP check |
| 11240 | option tcp-check |
| 11241 | tcp-check expect string +OK\ POP3\ ready |
| 11242 | |
| 11243 | # perform an IMAP check |
| 11244 | option tcp-check |
| 11245 | tcp-check expect string *\ OK\ IMAP4\ ready |
| 11246 | |
| 11247 | # look for the redis master server |
| 11248 | option tcp-check |
| 11249 | tcp-check send PING\r\n |
Baptiste Assmann | a332299 | 2015-08-04 10:12:18 +0200 | [diff] [blame] | 11250 | tcp-check expect string +PONG |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11251 | tcp-check send info\ replication\r\n |
| 11252 | tcp-check expect string role:master |
| 11253 | tcp-check send QUIT\r\n |
| 11254 | tcp-check expect string +OK |
| 11255 | |
| 11256 | |
| 11257 | See also : "option tcp-check", "tcp-check connect", "tcp-check send", |
Christopher Faulet | bb9fb8b | 2020-11-25 17:20:57 +0100 | [diff] [blame] | 11258 | "tcp-check send-binary", "http-check expect", tune.bufsize |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11259 | |
| 11260 | |
Christopher Faulet | b50b3e6 | 2020-05-05 18:43:43 +0200 | [diff] [blame] | 11261 | tcp-check send <data> [comment <msg>] |
| 11262 | tcp-check send-lf <fmt> [comment <msg>] |
| 11263 | Specify a string or a log-format string to be sent as a question during a |
| 11264 | generic health check |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11265 | May be used in sections: defaults | frontend | listen | backend |
Christopher Faulet | 404f919 | 2020-04-09 23:13:54 +0200 | [diff] [blame] | 11266 | yes | no | yes | yes |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11267 | |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 11268 | Arguments : |
| 11269 | comment <msg> defines a message to report if the rule evaluation fails. |
| 11270 | |
Christopher Faulet | b50b3e6 | 2020-05-05 18:43:43 +0200 | [diff] [blame] | 11271 | <data> is the string that will be sent during a generic health |
| 11272 | check session. |
Christopher Faulet | 16fff67 | 2020-04-30 07:50:54 +0200 | [diff] [blame] | 11273 | |
Christopher Faulet | b50b3e6 | 2020-05-05 18:43:43 +0200 | [diff] [blame] | 11274 | <fmt> is the log-format string that will be sent, once evaluated, |
| 11275 | during a generic health check session. |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11276 | |
| 11277 | Examples : |
| 11278 | # look for the redis master server |
| 11279 | option tcp-check |
| 11280 | tcp-check send info\ replication\r\n |
| 11281 | tcp-check expect string role:master |
| 11282 | |
| 11283 | See also : "option tcp-check", "tcp-check connect", "tcp-check expect", |
Christopher Faulet | bb9fb8b | 2020-11-25 17:20:57 +0100 | [diff] [blame] | 11284 | "tcp-check send-binary", tune.bufsize |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11285 | |
| 11286 | |
Christopher Faulet | b50b3e6 | 2020-05-05 18:43:43 +0200 | [diff] [blame] | 11287 | tcp-check send-binary <hexstring> [comment <msg>] |
| 11288 | tcp-check send-binary-lf <hexfmt> [comment <msg>] |
| 11289 | Specify an hex digits string or an hex digits log-format string to be sent as |
| 11290 | a binary question during a raw tcp health check |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11291 | May be used in sections: defaults | frontend | listen | backend |
Christopher Faulet | 404f919 | 2020-04-09 23:13:54 +0200 | [diff] [blame] | 11292 | yes | no | yes | yes |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11293 | |
Christopher Faulet | 4f5c2e2 | 2020-04-23 15:22:33 +0200 | [diff] [blame] | 11294 | Arguments : |
| 11295 | comment <msg> defines a message to report if the rule evaluation fails. |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 11296 | |
Christopher Faulet | b50b3e6 | 2020-05-05 18:43:43 +0200 | [diff] [blame] | 11297 | <hexstring> is the hexadecimal string that will be send, once converted |
| 11298 | to binary, during a generic health check session. |
Christopher Faulet | 16fff67 | 2020-04-30 07:50:54 +0200 | [diff] [blame] | 11299 | |
Christopher Faulet | b50b3e6 | 2020-05-05 18:43:43 +0200 | [diff] [blame] | 11300 | <hexfmt> is the hexadecimal log-format string that will be send, once |
| 11301 | evaluated and converted to binary, during a generic health |
| 11302 | check session. |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11303 | |
| 11304 | Examples : |
| 11305 | # redis check in binary |
| 11306 | option tcp-check |
| 11307 | tcp-check send-binary 50494e470d0a # PING\r\n |
| 11308 | tcp-check expect binary 2b504F4e47 # +PONG |
| 11309 | |
| 11310 | |
| 11311 | See also : "option tcp-check", "tcp-check connect", "tcp-check expect", |
Christopher Faulet | bb9fb8b | 2020-11-25 17:20:57 +0100 | [diff] [blame] | 11312 | "tcp-check send", tune.bufsize |
Willy Tarreau | 938c7fe | 2014-04-25 14:21:39 +0200 | [diff] [blame] | 11313 | |
| 11314 | |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11315 | tcp-check set-var(<var-name>) <expr> |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11316 | This operation sets the content of a variable. The variable is declared inline. |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11317 | May be used in sections: defaults | frontend | listen | backend |
Christopher Faulet | 404f919 | 2020-04-09 23:13:54 +0200 | [diff] [blame] | 11318 | yes | no | yes | yes |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11319 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 11320 | Arguments : |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11321 | <var-name> The name of the variable starts with an indication about its |
| 11322 | scope. The scopes allowed for tcp-check are: |
| 11323 | "proc" : the variable is shared with the whole process. |
| 11324 | "sess" : the variable is shared with the tcp-check session. |
| 11325 | "check": the variable is declared for the lifetime of the tcp-check. |
| 11326 | This prefix is followed by a name. The separator is a '.'. |
| 11327 | The name may only contain characters 'a-z', 'A-Z', '0-9', '.', |
| 11328 | and '-'. |
| 11329 | |
| 11330 | <expr> Is a sample-fetch expression potentially followed by converters. |
| 11331 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 11332 | Examples : |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11333 | tcp-check set-var(check.port) int(1234) |
| 11334 | |
| 11335 | |
| 11336 | tcp-check unset-var(<var-name>) |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11337 | Free a reference to a variable within its scope. |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11338 | May be used in sections: defaults | frontend | listen | backend |
Christopher Faulet | 404f919 | 2020-04-09 23:13:54 +0200 | [diff] [blame] | 11339 | yes | no | yes | yes |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11340 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 11341 | Arguments : |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11342 | <var-name> The name of the variable starts with an indication about its |
| 11343 | scope. The scopes allowed for tcp-check are: |
| 11344 | "proc" : the variable is shared with the whole process. |
| 11345 | "sess" : the variable is shared with the tcp-check session. |
| 11346 | "check": the variable is declared for the lifetime of the tcp-check. |
| 11347 | This prefix is followed by a name. The separator is a '.'. |
| 11348 | The name may only contain characters 'a-z', 'A-Z', '0-9', '.', |
| 11349 | and '-'. |
| 11350 | |
Christopher Faulet | c52ea4d | 2020-04-23 15:43:35 +0200 | [diff] [blame] | 11351 | Examples : |
Gaetan Rivet | 0c39ecc | 2020-02-24 17:34:11 +0100 | [diff] [blame] | 11352 | tcp-check unset-var(check.port) |
| 11353 | |
| 11354 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11355 | tcp-request connection <action> [{if | unless} <condition>] |
| 11356 | Perform an action on an incoming connection depending on a layer 4 condition |
Willy Tarreau | 1a68794 | 2010-05-23 22:40:30 +0200 | [diff] [blame] | 11357 | May be used in sections : defaults | frontend | listen | backend |
| 11358 | no | yes | yes | no |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11359 | Arguments : |
Willy Tarreau | c870bfd | 2015-09-28 18:47:38 +0200 | [diff] [blame] | 11360 | <action> defines the action to perform if the condition applies. See |
| 11361 | below. |
Willy Tarreau | 1a68794 | 2010-05-23 22:40:30 +0200 | [diff] [blame] | 11362 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11363 | <condition> is a standard layer4-only ACL-based condition (see section 7). |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11364 | |
| 11365 | Immediately after acceptance of a new incoming connection, it is possible to |
| 11366 | evaluate some conditions to decide whether this connection must be accepted |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11367 | or dropped or have its counters tracked. Those conditions cannot make use of |
| 11368 | any data contents because the connection has not been read from yet, and the |
| 11369 | buffers are not yet allocated. This is used to selectively and very quickly |
| 11370 | accept or drop connections from various sources with a very low overhead. If |
| 11371 | some contents need to be inspected in order to take the decision, the |
| 11372 | "tcp-request content" statements must be used instead. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11373 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11374 | The "tcp-request connection" rules are evaluated in their exact declaration |
| 11375 | order. If no rule matches or if there is no rule, the default action is to |
| 11376 | accept the incoming connection. There is no specific limit to the number of |
| 11377 | rules which may be inserted. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11378 | |
Willy Tarreau | a9083d0 | 2015-05-08 15:27:59 +0200 | [diff] [blame] | 11379 | Four types of actions are supported : |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11380 | - accept : |
| 11381 | accepts the connection if the condition is true (when used with "if") |
| 11382 | or false (when used with "unless"). The first such rule executed ends |
| 11383 | the rules evaluation. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11384 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11385 | - reject : |
| 11386 | rejects the connection if the condition is true (when used with "if") |
| 11387 | or false (when used with "unless"). The first such rule executed ends |
| 11388 | the rules evaluation. Rejected connections do not even become a |
| 11389 | session, which is why they are accounted separately for in the stats, |
| 11390 | as "denied connections". They are not considered for the session |
| 11391 | rate-limit and are not logged either. The reason is that these rules |
| 11392 | should only be used to filter extremely high connection rates such as |
| 11393 | the ones encountered during a massive DDoS attack. Under these extreme |
| 11394 | conditions, the simple action of logging each event would make the |
| 11395 | system collapse and would considerably lower the filtering capacity. If |
| 11396 | logging is absolutely desired, then "tcp-request content" rules should |
Willy Tarreau | 4f61429 | 2016-10-21 17:49:36 +0200 | [diff] [blame] | 11397 | be used instead, as "tcp-request session" rules will not log either. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11398 | |
Willy Tarreau | 4f0d919 | 2013-06-11 20:40:55 +0200 | [diff] [blame] | 11399 | - expect-proxy layer4 : |
| 11400 | configures the client-facing connection to receive a PROXY protocol |
| 11401 | header before any byte is read from the socket. This is equivalent to |
| 11402 | having the "accept-proxy" keyword on the "bind" line, except that using |
| 11403 | the TCP rule allows the PROXY protocol to be accepted only for certain |
| 11404 | IP address ranges using an ACL. This is convenient when multiple layers |
| 11405 | of load balancers are passed through by traffic coming from public |
| 11406 | hosts. |
| 11407 | |
Bertrand Jacquin | 9075968 | 2016-06-06 15:35:39 +0100 | [diff] [blame] | 11408 | - expect-netscaler-cip layer4 : |
| 11409 | configures the client-facing connection to receive a NetScaler Client |
| 11410 | IP insertion protocol header before any byte is read from the socket. |
| 11411 | This is equivalent to having the "accept-netscaler-cip" keyword on the |
| 11412 | "bind" line, except that using the TCP rule allows the PROXY protocol |
| 11413 | to be accepted only for certain IP address ranges using an ACL. This |
| 11414 | is convenient when multiple layers of load balancers are passed |
| 11415 | through by traffic coming from public hosts. |
| 11416 | |
Willy Tarreau | 18bf01e | 2014-06-13 16:18:52 +0200 | [diff] [blame] | 11417 | - capture <sample> len <length> : |
| 11418 | This only applies to "tcp-request content" rules. It captures sample |
| 11419 | expression <sample> from the request buffer, and converts it to a |
| 11420 | string of at most <len> characters. The resulting string is stored into |
| 11421 | the next request "capture" slot, so it will possibly appear next to |
| 11422 | some captured HTTP headers. It will then automatically appear in the |
| 11423 | logs, and it will be possible to extract it using sample fetch rules to |
| 11424 | feed it into headers or anything. The length should be limited given |
| 11425 | that this size will be allocated for each capture during the whole |
Willy Tarreau | a9083d0 | 2015-05-08 15:27:59 +0200 | [diff] [blame] | 11426 | session life. Please check section 7.3 (Fetching samples) and "capture |
| 11427 | request header" for more information. |
Willy Tarreau | 18bf01e | 2014-06-13 16:18:52 +0200 | [diff] [blame] | 11428 | |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 11429 | - { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>] : |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11430 | enables tracking of sticky counters from current connection. These |
Moemen MHEDHBI | 9cf4634 | 2018-09-25 17:50:53 +0200 | [diff] [blame] | 11431 | rules do not stop evaluation and do not change default action. The |
| 11432 | number of counters that may be simultaneously tracked by the same |
| 11433 | connection is set in MAX_SESS_STKCTR at build time (reported in |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 11434 | haproxy -vv) which defaults to 3, so the track-sc number is between 0 |
Matteo Contrini | 1857b8c | 2020-10-16 17:35:54 +0200 | [diff] [blame] | 11435 | and (MAX_SESS_STKCTR-1). The first "track-sc0" rule executed enables |
Moemen MHEDHBI | 9cf4634 | 2018-09-25 17:50:53 +0200 | [diff] [blame] | 11436 | tracking of the counters of the specified table as the first set. The |
| 11437 | first "track-sc1" rule executed enables tracking of the counters of the |
| 11438 | specified table as the second set. The first "track-sc2" rule executed |
| 11439 | enables tracking of the counters of the specified table as the third |
| 11440 | set. It is a recommended practice to use the first set of counters for |
| 11441 | the per-frontend counters and the second set for the per-backend ones. |
| 11442 | But this is just a guideline, all may be used everywhere. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11443 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11444 | These actions take one or two arguments : |
Willy Tarreau | be722a2 | 2014-06-13 16:31:59 +0200 | [diff] [blame] | 11445 | <key> is mandatory, and is a sample expression rule as described |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 11446 | in section 7.3. It describes what elements of the incoming |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11447 | request or connection will be analyzed, extracted, combined, |
Willy Tarreau | 5d5b5d8 | 2012-12-09 12:00:04 +0100 | [diff] [blame] | 11448 | and used to select which table entry to update the counters. |
| 11449 | Note that "tcp-request connection" cannot use content-based |
| 11450 | fetches. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11451 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11452 | <table> is an optional table to be used instead of the default one, |
| 11453 | which is the stick-table declared in the current proxy. All |
| 11454 | the counters for the matches and updates for the key will |
| 11455 | then be performed in that table until the session ends. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11456 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11457 | Once a "track-sc*" rule is executed, the key is looked up in the table |
| 11458 | and if it is not found, an entry is allocated for it. Then a pointer to |
| 11459 | that entry is kept during all the session's life, and this entry's |
| 11460 | counters are updated as often as possible, every time the session's |
| 11461 | counters are updated, and also systematically when the session ends. |
Willy Tarreau | 5d5b5d8 | 2012-12-09 12:00:04 +0100 | [diff] [blame] | 11462 | Counters are only updated for events that happen after the tracking has |
| 11463 | been started. For example, connection counters will not be updated when |
| 11464 | tracking layer 7 information, since the connection event happens before |
| 11465 | layer7 information is extracted. |
| 11466 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11467 | If the entry tracks concurrent connection counters, one connection is |
| 11468 | counted for as long as the entry is tracked, and the entry will not |
| 11469 | expire during that time. Tracking counters also provides a performance |
| 11470 | advantage over just checking the keys, because only one table lookup is |
| 11471 | performed for all ACL checks that make use of it. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11472 | |
Thierry FOURNIER | e0627bd | 2015-08-04 08:20:33 +0200 | [diff] [blame] | 11473 | - sc-inc-gpc0(<sc-id>): |
| 11474 | The "sc-inc-gpc0" increments the GPC0 counter according to the sticky |
| 11475 | counter designated by <sc-id>. If an error occurs, this action silently |
| 11476 | fails and the actions evaluation continues. |
| 11477 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 11478 | - sc-inc-gpc1(<sc-id>): |
| 11479 | The "sc-inc-gpc1" increments the GPC1 counter according to the sticky |
| 11480 | counter designated by <sc-id>. If an error occurs, this action silently |
| 11481 | fails and the actions evaluation continues. |
| 11482 | |
Cédric Dufour | 0d7712d | 2019-11-06 18:38:53 +0100 | [diff] [blame] | 11483 | - sc-set-gpt0(<sc-id>) { <int> | <expr> }: |
| 11484 | This action sets the 32-bit unsigned GPT0 tag according to the sticky |
| 11485 | counter designated by <sc-id> and the value of <int>/<expr>. The |
| 11486 | expected result is a boolean. If an error occurs, this action silently |
| 11487 | fails and the actions evaluation continues. |
Thierry FOURNIER | 236657b | 2015-08-19 08:25:14 +0200 | [diff] [blame] | 11488 | |
William Lallemand | 2e785f2 | 2016-05-25 01:48:42 +0200 | [diff] [blame] | 11489 | - set-src <expr> : |
| 11490 | Is used to set the source IP address to the value of specified |
| 11491 | expression. Useful if you want to mask source IP for privacy. |
| 11492 | If you want to provide an IP from a HTTP header use "http-request |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 11493 | set-src". |
William Lallemand | 2e785f2 | 2016-05-25 01:48:42 +0200 | [diff] [blame] | 11494 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 11495 | Arguments: |
| 11496 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 11497 | followed by some converters. |
William Lallemand | 2e785f2 | 2016-05-25 01:48:42 +0200 | [diff] [blame] | 11498 | |
| 11499 | Example: |
William Lallemand | 2e785f2 | 2016-05-25 01:48:42 +0200 | [diff] [blame] | 11500 | tcp-request connection set-src src,ipmask(24) |
| 11501 | |
Willy Tarreau | 0c63053 | 2016-10-21 17:52:58 +0200 | [diff] [blame] | 11502 | When possible, set-src preserves the original source port as long as the |
| 11503 | address family allows it, otherwise the source port is set to 0. |
William Lallemand | 2e785f2 | 2016-05-25 01:48:42 +0200 | [diff] [blame] | 11504 | |
William Lallemand | 44be640 | 2016-05-25 01:51:35 +0200 | [diff] [blame] | 11505 | - set-src-port <expr> : |
| 11506 | Is used to set the source port address to the value of specified |
| 11507 | expression. |
| 11508 | |
Cyril Bonté | 6c81d5f | 2018-10-17 00:14:51 +0200 | [diff] [blame] | 11509 | Arguments: |
| 11510 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 11511 | followed by some converters. |
William Lallemand | 44be640 | 2016-05-25 01:51:35 +0200 | [diff] [blame] | 11512 | |
| 11513 | Example: |
William Lallemand | 44be640 | 2016-05-25 01:51:35 +0200 | [diff] [blame] | 11514 | tcp-request connection set-src-port int(4000) |
| 11515 | |
Willy Tarreau | 0c63053 | 2016-10-21 17:52:58 +0200 | [diff] [blame] | 11516 | When possible, set-src-port preserves the original source address as long |
| 11517 | as the address family supports a port, otherwise it forces the source |
| 11518 | address to IPv4 "0.0.0.0" before rewriting the port. |
William Lallemand | 44be640 | 2016-05-25 01:51:35 +0200 | [diff] [blame] | 11519 | |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 11520 | - set-dst <expr> : |
| 11521 | Is used to set the destination IP address to the value of specified |
| 11522 | expression. Useful if you want to mask IP for privacy in log. |
| 11523 | If you want to provide an IP from a HTTP header use "http-request |
| 11524 | set-dst". If you want to connect to the new address/port, use |
| 11525 | '0.0.0.0:0' as a server address in the backend. |
| 11526 | |
| 11527 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 11528 | followed by some converters. |
| 11529 | |
| 11530 | Example: |
| 11531 | |
| 11532 | tcp-request connection set-dst dst,ipmask(24) |
| 11533 | tcp-request connection set-dst ipv4(10.0.0.1) |
| 11534 | |
Willy Tarreau | 0c63053 | 2016-10-21 17:52:58 +0200 | [diff] [blame] | 11535 | When possible, set-dst preserves the original destination port as long as |
| 11536 | the address family allows it, otherwise the destination port is set to 0. |
| 11537 | |
William Lallemand | 13e9b0c | 2016-05-25 02:34:07 +0200 | [diff] [blame] | 11538 | - set-dst-port <expr> : |
| 11539 | Is used to set the destination port address to the value of specified |
| 11540 | expression. If you want to connect to the new address/port, use |
| 11541 | '0.0.0.0:0' as a server address in the backend. |
| 11542 | |
| 11543 | |
| 11544 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 11545 | followed by some converters. |
| 11546 | |
| 11547 | Example: |
| 11548 | |
| 11549 | tcp-request connection set-dst-port int(4000) |
| 11550 | |
Willy Tarreau | 0c63053 | 2016-10-21 17:52:58 +0200 | [diff] [blame] | 11551 | When possible, set-dst-port preserves the original destination address as |
| 11552 | long as the address family supports a port, otherwise it forces the |
| 11553 | destination address to IPv4 "0.0.0.0" before rewriting the port. |
| 11554 | |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 11555 | - "silent-drop" : |
| 11556 | This stops the evaluation of the rules and makes the client-facing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11557 | connection suddenly disappear using a system-dependent way that tries |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 11558 | to prevent the client from being notified. The effect it then that the |
| 11559 | client still sees an established connection while there's none on |
| 11560 | HAProxy. The purpose is to achieve a comparable effect to "tarpit" |
| 11561 | except that it doesn't use any local resource at all on the machine |
| 11562 | running HAProxy. It can resist much higher loads than "tarpit", and |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11563 | slow down stronger attackers. It is important to understand the impact |
| 11564 | of using this mechanism. All stateful equipment placed between the |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 11565 | client and HAProxy (firewalls, proxies, load balancers) will also keep |
| 11566 | the established connection for a long time and may suffer from this |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11567 | action. On modern Linux systems running with enough privileges, the |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 11568 | TCP_REPAIR socket option is used to block the emission of a TCP |
| 11569 | reset. On other systems, the socket's TTL is reduced to 1 so that the |
| 11570 | TCP reset doesn't pass the first router, though it's still delivered to |
| 11571 | local networks. Do not use it unless you fully understand how it works. |
| 11572 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11573 | Note that the "if/unless" condition is optional. If no condition is set on |
| 11574 | the action, it is simply performed unconditionally. That can be useful for |
| 11575 | "track-sc*" actions as well as for changing the default action to a reject. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11576 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11577 | Example: accept all connections from white-listed hosts, reject too fast |
| 11578 | connection without counting them, and track accepted connections. |
| 11579 | This results in connection rate being capped from abusive sources. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11580 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11581 | tcp-request connection accept if { src -f /etc/haproxy/whitelist.lst } |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11582 | tcp-request connection reject if { src_conn_rate gt 10 } |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 11583 | tcp-request connection track-sc0 src |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11584 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11585 | Example: accept all connections from white-listed hosts, count all other |
| 11586 | connections and reject too fast ones. This results in abusive ones |
| 11587 | being blocked as long as they don't slow down. |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11588 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11589 | tcp-request connection accept if { src -f /etc/haproxy/whitelist.lst } |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 11590 | tcp-request connection track-sc0 src |
| 11591 | tcp-request connection reject if { sc0_conn_rate gt 10 } |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11592 | |
Willy Tarreau | 4f0d919 | 2013-06-11 20:40:55 +0200 | [diff] [blame] | 11593 | Example: enable the PROXY protocol for traffic coming from all known proxies. |
| 11594 | |
| 11595 | tcp-request connection expect-proxy layer4 if { src -f proxies.lst } |
| 11596 | |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11597 | See section 7 about ACL usage. |
| 11598 | |
Willy Tarreau | 4f61429 | 2016-10-21 17:49:36 +0200 | [diff] [blame] | 11599 | See also : "tcp-request session", "tcp-request content", "stick-table" |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11600 | |
| 11601 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11602 | tcp-request content <action> [{if | unless} <condition>] |
| 11603 | Perform an action on a new session depending on a layer 4-7 condition |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11604 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | fb35620 | 2010-08-03 14:02:05 +0200 | [diff] [blame] | 11605 | no | yes | yes | yes |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11606 | Arguments : |
Willy Tarreau | c870bfd | 2015-09-28 18:47:38 +0200 | [diff] [blame] | 11607 | <action> defines the action to perform if the condition applies. See |
| 11608 | below. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11609 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11610 | <condition> is a standard layer 4-7 ACL-based condition (see section 7). |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11611 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11612 | A request's contents can be analyzed at an early stage of request processing |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11613 | called "TCP content inspection". During this stage, ACL-based rules are |
| 11614 | evaluated every time the request contents are updated, until either an |
| 11615 | "accept" or a "reject" rule matches, or the TCP request inspection delay |
| 11616 | expires with no matching rule. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11617 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11618 | The first difference between these rules and "tcp-request connection" rules |
| 11619 | is that "tcp-request content" rules can make use of contents to take a |
| 11620 | decision. Most often, these decisions will consider a protocol recognition or |
| 11621 | validity. The second difference is that content-based rules can be used in |
Willy Tarreau | f333834 | 2014-01-28 21:40:28 +0100 | [diff] [blame] | 11622 | both frontends and backends. In case of HTTP keep-alive with the client, all |
| 11623 | tcp-request content rules are evaluated again, so haproxy keeps a record of |
| 11624 | what sticky counters were assigned by a "tcp-request connection" versus a |
| 11625 | "tcp-request content" rule, and flushes all the content-related ones after |
| 11626 | processing an HTTP request, so that they may be evaluated again by the rules |
| 11627 | being evaluated again for the next request. This is of particular importance |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 11628 | when the rule tracks some L7 information or when it is conditioned by an |
Willy Tarreau | f333834 | 2014-01-28 21:40:28 +0100 | [diff] [blame] | 11629 | L7-based ACL, since tracking may change between requests. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11630 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11631 | Content-based rules are evaluated in their exact declaration order. If no |
| 11632 | rule matches or if there is no rule, the default action is to accept the |
| 11633 | contents. There is no specific limit to the number of rules which may be |
| 11634 | inserted. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11635 | |
Thierry FOURNIER | 236657b | 2015-08-19 08:25:14 +0200 | [diff] [blame] | 11636 | Several types of actions are supported : |
Willy Tarreau | 18bf01e | 2014-06-13 16:18:52 +0200 | [diff] [blame] | 11637 | - accept : the request is accepted |
Baptiste Assmann | 333939c | 2019-01-21 08:34:50 +0100 | [diff] [blame] | 11638 | - do-resolve: perform a DNS resolution |
Willy Tarreau | 18bf01e | 2014-06-13 16:18:52 +0200 | [diff] [blame] | 11639 | - reject : the request is rejected and the connection is closed |
| 11640 | - capture : the specified sample expression is captured |
Patrick Hemmer | 268a707 | 2018-05-11 12:52:31 -0400 | [diff] [blame] | 11641 | - set-priority-class <expr> | set-priority-offset <expr> |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 11642 | - { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>] |
Thierry FOURNIER | e0627bd | 2015-08-04 08:20:33 +0200 | [diff] [blame] | 11643 | - sc-inc-gpc0(<sc-id>) |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 11644 | - sc-inc-gpc1(<sc-id>) |
Cédric Dufour | 0d7712d | 2019-11-06 18:38:53 +0100 | [diff] [blame] | 11645 | - sc-set-gpt0(<sc-id>) { <int> | <expr> } |
Baptiste Assmann | e1afd4f | 2019-04-18 16:21:13 +0200 | [diff] [blame] | 11646 | - set-dst <expr> |
| 11647 | - set-dst-port <expr> |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11648 | - set-var(<var-name>) <expr> |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 11649 | - unset-var(<var-name>) |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 11650 | - silent-drop |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11651 | - send-spoe-group <engine-name> <group-name> |
Christopher Faulet | 579d83b | 2019-11-22 15:34:17 +0100 | [diff] [blame] | 11652 | - use-service <service-name> |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11653 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11654 | They have the same meaning as their counter-parts in "tcp-request connection" |
| 11655 | so please refer to that section for a complete description. |
Baptiste Assmann | 333939c | 2019-01-21 08:34:50 +0100 | [diff] [blame] | 11656 | For "do-resolve" action, please check the "http-request do-resolve" |
| 11657 | configuration section. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11658 | |
Willy Tarreau | f333834 | 2014-01-28 21:40:28 +0100 | [diff] [blame] | 11659 | While there is nothing mandatory about it, it is recommended to use the |
| 11660 | track-sc0 in "tcp-request connection" rules, track-sc1 for "tcp-request |
| 11661 | content" rules in the frontend, and track-sc2 for "tcp-request content" |
| 11662 | rules in the backend, because that makes the configuration more readable |
| 11663 | and easier to troubleshoot, but this is just a guideline and all counters |
| 11664 | may be used everywhere. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11665 | |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 11666 | Note that the "if/unless" condition is optional. If no condition is set on |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11667 | the action, it is simply performed unconditionally. That can be useful for |
| 11668 | "track-sc*" actions as well as for changing the default action to a reject. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11669 | |
Christopher Faulet | 2079a4a | 2020-10-02 11:48:57 +0200 | [diff] [blame] | 11670 | Note also that it is recommended to use a "tcp-request session" rule to track |
| 11671 | information that does *not* depend on Layer 7 contents, especially for HTTP |
| 11672 | frontends. Some HTTP processing are performed at the session level and may |
| 11673 | lead to an early rejection of the requests. Thus, the tracking at the content |
| 11674 | level may be disturbed in such case. A warning is emitted during startup to |
| 11675 | prevent, as far as possible, such unreliable usage. |
| 11676 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11677 | It is perfectly possible to match layer 7 contents with "tcp-request content" |
Christopher Faulet | 7ea509e | 2020-10-02 11:38:46 +0200 | [diff] [blame] | 11678 | rules from a TCP proxy, since HTTP-specific ACL matches are able to |
| 11679 | preliminarily parse the contents of a buffer before extracting the required |
| 11680 | data. If the buffered contents do not parse as a valid HTTP message, then the |
| 11681 | ACL does not match. The parser which is involved there is exactly the same |
| 11682 | as for all other HTTP processing, so there is no risk of parsing something |
| 11683 | differently. In an HTTP frontend or an HTTP backend, it is guaranteed that |
| 11684 | HTTP contents will always be immediately present when the rule is evaluated |
| 11685 | first because the HTTP parsing is performed in the early stages of the |
| 11686 | connection processing, at the session level. But for such proxies, using |
| 11687 | "http-request" rules is much more natural and recommended. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11688 | |
Willy Tarreau | 5d5b5d8 | 2012-12-09 12:00:04 +0100 | [diff] [blame] | 11689 | Tracking layer7 information is also possible provided that the information |
Willy Tarreau | 4d54c7c | 2014-09-16 15:48:15 +0200 | [diff] [blame] | 11690 | are present when the rule is processed. The rule processing engine is able to |
| 11691 | wait until the inspect delay expires when the data to be tracked is not yet |
| 11692 | available. |
Willy Tarreau | 5d5b5d8 | 2012-12-09 12:00:04 +0100 | [diff] [blame] | 11693 | |
Baptiste Assmann | e1afd4f | 2019-04-18 16:21:13 +0200 | [diff] [blame] | 11694 | The "set-dst" and "set-dst-port" are used to set respectively the destination |
| 11695 | IP and port. More information on how to use it at "http-request set-dst". |
| 11696 | |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11697 | The "set-var" is used to set the content of a variable. The variable is |
Willy Tarreau | 4f61429 | 2016-10-21 17:49:36 +0200 | [diff] [blame] | 11698 | declared inline. For "tcp-request session" rules, only session-level |
| 11699 | variables can be used, without any layer7 contents. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11700 | |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 11701 | <var-name> The name of the variable starts with an indication about |
| 11702 | its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 11703 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 11704 | "sess" : the variable is shared with the whole session |
| 11705 | "txn" : the variable is shared with the transaction |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11706 | (request and response) |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 11707 | "req" : the variable is shared only during request |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11708 | processing |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 11709 | "res" : the variable is shared only during response |
| 11710 | processing |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11711 | This prefix is followed by a name. The separator is a '.'. |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 11712 | The name may only contain characters 'a-z', 'A-Z', '0-9', |
| 11713 | '.' and '_'. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11714 | |
| 11715 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 11716 | followed by some converters. |
| 11717 | |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 11718 | The "unset-var" is used to unset a variable. See above for details about |
| 11719 | <var-name>. |
| 11720 | |
Patrick Hemmer | 268a707 | 2018-05-11 12:52:31 -0400 | [diff] [blame] | 11721 | The "set-priority-class" is used to set the queue priority class of the |
| 11722 | current request. The value must be a sample expression which converts to an |
| 11723 | integer in the range -2047..2047. Results outside this range will be |
| 11724 | truncated. The priority class determines the order in which queued requests |
| 11725 | are processed. Lower values have higher priority. |
| 11726 | |
| 11727 | The "set-priority-offset" is used to set the queue priority timestamp offset |
| 11728 | of the current request. The value must be a sample expression which converts |
| 11729 | to an integer in the range -524287..524287. Results outside this range will be |
| 11730 | truncated. When a request is queued, it is ordered first by the priority |
| 11731 | class, then by the current timestamp adjusted by the given offset in |
| 11732 | milliseconds. Lower values have higher priority. |
| 11733 | Note that the resulting timestamp is is only tracked with enough precision for |
| 11734 | 524,287ms (8m44s287ms). If the request is queued long enough to where the |
| 11735 | adjusted timestamp exceeds this value, it will be misidentified as highest |
| 11736 | priority. Thus it is important to set "timeout queue" to a value, where when |
| 11737 | combined with the offset, does not exceed this limit. |
| 11738 | |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 11739 | The "send-spoe-group" is used to trigger sending of a group of SPOE |
| 11740 | messages. To do so, the SPOE engine used to send messages must be defined, as |
| 11741 | well as the SPOE group to send. Of course, the SPOE engine must refer to an |
| 11742 | existing SPOE filter. If not engine name is provided on the SPOE filter line, |
| 11743 | the SPOE agent name must be used. |
| 11744 | |
| 11745 | <engine-name> The SPOE engine name. |
| 11746 | |
| 11747 | <group-name> The SPOE group name as specified in the engine configuration. |
| 11748 | |
Christopher Faulet | 579d83b | 2019-11-22 15:34:17 +0100 | [diff] [blame] | 11749 | The "use-service" is used to executes a TCP service which will reply to the |
| 11750 | request and stop the evaluation of the rules. This service may choose to |
| 11751 | reply by sending any valid response or it may immediately close the |
| 11752 | connection without sending anything. Outside natives services, it is possible |
| 11753 | to write your own services in Lua. No further "tcp-request" rules are |
| 11754 | evaluated. |
| 11755 | |
| 11756 | Example: |
| 11757 | tcp-request content use-service lua.deny { src -f /etc/haproxy/blacklist.lst } |
| 11758 | |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11759 | Example: |
| 11760 | |
| 11761 | tcp-request content set-var(sess.my_var) src |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 11762 | tcp-request content unset-var(sess.my_var2) |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11763 | |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11764 | Example: |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11765 | # Accept HTTP requests containing a Host header saying "example.com" |
| 11766 | # and reject everything else. |
| 11767 | acl is_host_com hdr(Host) -i example.com |
| 11768 | tcp-request inspect-delay 30s |
Willy Tarreau | c0239e0 | 2012-04-16 14:42:55 +0200 | [diff] [blame] | 11769 | tcp-request content accept if is_host_com |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11770 | tcp-request content reject |
| 11771 | |
| 11772 | Example: |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11773 | # reject SMTP connection if client speaks first |
| 11774 | tcp-request inspect-delay 30s |
| 11775 | acl content_present req_len gt 0 |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11776 | tcp-request content reject if content_present |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11777 | |
| 11778 | # Forward HTTPS connection only if client speaks |
| 11779 | tcp-request inspect-delay 30s |
| 11780 | acl content_present req_len gt 0 |
Willy Tarreau | 68c03ab | 2010-08-06 15:08:45 +0200 | [diff] [blame] | 11781 | tcp-request content accept if content_present |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11782 | tcp-request content reject |
| 11783 | |
Willy Tarreau | 5d5b5d8 | 2012-12-09 12:00:04 +0100 | [diff] [blame] | 11784 | Example: |
Jarno Huuskonen | e5ae702 | 2017-04-03 14:36:21 +0300 | [diff] [blame] | 11785 | # Track the last IP(stick-table type string) from X-Forwarded-For |
Willy Tarreau | 5d5b5d8 | 2012-12-09 12:00:04 +0100 | [diff] [blame] | 11786 | tcp-request inspect-delay 10s |
Willy Tarreau | 4d54c7c | 2014-09-16 15:48:15 +0200 | [diff] [blame] | 11787 | tcp-request content track-sc0 hdr(x-forwarded-for,-1) |
Jarno Huuskonen | e5ae702 | 2017-04-03 14:36:21 +0300 | [diff] [blame] | 11788 | # Or track the last IP(stick-table type ip|ipv6) from X-Forwarded-For |
| 11789 | tcp-request content track-sc0 req.hdr_ip(x-forwarded-for,-1) |
Willy Tarreau | 5d5b5d8 | 2012-12-09 12:00:04 +0100 | [diff] [blame] | 11790 | |
| 11791 | Example: |
| 11792 | # track request counts per "base" (concatenation of Host+URL) |
| 11793 | tcp-request inspect-delay 10s |
Willy Tarreau | 4d54c7c | 2014-09-16 15:48:15 +0200 | [diff] [blame] | 11794 | tcp-request content track-sc0 base table req-rate |
Willy Tarreau | 5d5b5d8 | 2012-12-09 12:00:04 +0100 | [diff] [blame] | 11795 | |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11796 | Example: track per-frontend and per-backend counters, block abusers at the |
Jarno Huuskonen | e5ae702 | 2017-04-03 14:36:21 +0300 | [diff] [blame] | 11797 | frontend when the backend detects abuse(and marks gpc0). |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11798 | |
| 11799 | frontend http |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11800 | # Use General Purpose Counter 0 in SC0 as a global abuse counter |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11801 | # protecting all our sites |
| 11802 | stick-table type ip size 1m expire 5m store gpc0 |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 11803 | tcp-request connection track-sc0 src |
| 11804 | tcp-request connection reject if { sc0_get_gpc0 gt 0 } |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11805 | ... |
| 11806 | use_backend http_dynamic if { path_end .php } |
| 11807 | |
| 11808 | backend http_dynamic |
| 11809 | # if a source makes too fast requests to this dynamic site (tracked |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 11810 | # by SC1), block it globally in the frontend. |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11811 | stick-table type ip size 1m expire 5m store http_req_rate(10s) |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 11812 | acl click_too_fast sc1_http_req_rate gt 10 |
Jarno Huuskonen | e5ae702 | 2017-04-03 14:36:21 +0300 | [diff] [blame] | 11813 | acl mark_as_abuser sc0_inc_gpc0(http) gt 0 |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 11814 | tcp-request content track-sc1 src |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 11815 | tcp-request content reject if click_too_fast mark_as_abuser |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11816 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 11817 | See section 7 about ACL usage. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11818 | |
Jarno Huuskonen | 95b012b | 2017-04-06 13:59:14 +0300 | [diff] [blame] | 11819 | See also : "tcp-request connection", "tcp-request session", |
| 11820 | "tcp-request inspect-delay", and "http-request". |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11821 | |
| 11822 | |
| 11823 | tcp-request inspect-delay <timeout> |
| 11824 | Set the maximum allowed time to wait for data during content inspection |
| 11825 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | fb35620 | 2010-08-03 14:02:05 +0200 | [diff] [blame] | 11826 | no | yes | yes | yes |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11827 | Arguments : |
| 11828 | <timeout> is the timeout value specified in milliseconds by default, but |
| 11829 | can be in any other unit if the number is suffixed by the unit, |
| 11830 | as explained at the top of this document. |
| 11831 | |
| 11832 | People using haproxy primarily as a TCP relay are often worried about the |
| 11833 | risk of passing any type of protocol to a server without any analysis. In |
| 11834 | order to be able to analyze the request contents, we must first withhold |
| 11835 | the data then analyze them. This statement simply enables withholding of |
| 11836 | data for at most the specified amount of time. |
| 11837 | |
Willy Tarreau | fb35620 | 2010-08-03 14:02:05 +0200 | [diff] [blame] | 11838 | TCP content inspection applies very early when a connection reaches a |
| 11839 | frontend, then very early when the connection is forwarded to a backend. This |
| 11840 | means that a connection may experience a first delay in the frontend and a |
| 11841 | second delay in the backend if both have tcp-request rules. |
| 11842 | |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11843 | Note that when performing content inspection, haproxy will evaluate the whole |
| 11844 | rules for every new chunk which gets in, taking into account the fact that |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 11845 | those data are partial. If no rule matches before the aforementioned delay, |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11846 | a last check is performed upon expiration, this time considering that the |
Willy Tarreau | d869b24 | 2009-03-15 14:43:58 +0100 | [diff] [blame] | 11847 | contents are definitive. If no delay is set, haproxy will not wait at all |
| 11848 | and will immediately apply a verdict based on the available information. |
| 11849 | Obviously this is unlikely to be very useful and might even be racy, so such |
| 11850 | setups are not recommended. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11851 | |
| 11852 | As soon as a rule matches, the request is released and continues as usual. If |
| 11853 | the timeout is reached and no rule matches, the default policy will be to let |
| 11854 | it pass through unaffected. |
| 11855 | |
| 11856 | For most protocols, it is enough to set it to a few seconds, as most clients |
| 11857 | send the full request immediately upon connection. Add 3 or more seconds to |
| 11858 | cover TCP retransmits but that's all. For some protocols, it may make sense |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 11859 | to use large values, for instance to ensure that the client never talks |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11860 | before the server (e.g. SMTP), or to wait for a client to talk before passing |
| 11861 | data to the server (e.g. SSL). Note that the client timeout must cover at |
Willy Tarreau | b824b00 | 2010-09-29 16:36:16 +0200 | [diff] [blame] | 11862 | least the inspection delay, otherwise it will expire first. If the client |
| 11863 | closes the connection or if the buffer is full, the delay immediately expires |
| 11864 | since the contents will not be able to change anymore. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11865 | |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 11866 | See also : "tcp-request content accept", "tcp-request content reject", |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 11867 | "timeout client". |
| 11868 | |
| 11869 | |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 11870 | tcp-response content <action> [{if | unless} <condition>] |
| 11871 | Perform an action on a session response depending on a layer 4-7 condition |
| 11872 | May be used in sections : defaults | frontend | listen | backend |
| 11873 | no | no | yes | yes |
| 11874 | Arguments : |
Willy Tarreau | c870bfd | 2015-09-28 18:47:38 +0200 | [diff] [blame] | 11875 | <action> defines the action to perform if the condition applies. See |
| 11876 | below. |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 11877 | |
| 11878 | <condition> is a standard layer 4-7 ACL-based condition (see section 7). |
| 11879 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11880 | Response contents can be analyzed at an early stage of response processing |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 11881 | called "TCP content inspection". During this stage, ACL-based rules are |
| 11882 | evaluated every time the response contents are updated, until either an |
Willy Tarreau | cc1e04b | 2013-09-11 23:20:29 +0200 | [diff] [blame] | 11883 | "accept", "close" or a "reject" rule matches, or a TCP response inspection |
| 11884 | delay is set and expires with no matching rule. |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 11885 | |
| 11886 | Most often, these decisions will consider a protocol recognition or validity. |
| 11887 | |
| 11888 | Content-based rules are evaluated in their exact declaration order. If no |
| 11889 | rule matches or if there is no rule, the default action is to accept the |
| 11890 | contents. There is no specific limit to the number of rules which may be |
| 11891 | inserted. |
| 11892 | |
Thierry FOURNIER | 236657b | 2015-08-19 08:25:14 +0200 | [diff] [blame] | 11893 | Several types of actions are supported : |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 11894 | - accept : |
| 11895 | accepts the response if the condition is true (when used with "if") |
| 11896 | or false (when used with "unless"). The first such rule executed ends |
| 11897 | the rules evaluation. |
| 11898 | |
Willy Tarreau | cc1e04b | 2013-09-11 23:20:29 +0200 | [diff] [blame] | 11899 | - close : |
| 11900 | immediately closes the connection with the server if the condition is |
| 11901 | true (when used with "if"), or false (when used with "unless"). The |
| 11902 | first such rule executed ends the rules evaluation. The main purpose of |
| 11903 | this action is to force a connection to be finished between a client |
| 11904 | and a server after an exchange when the application protocol expects |
| 11905 | some long time outs to elapse first. The goal is to eliminate idle |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 11906 | connections which take significant resources on servers with certain |
Willy Tarreau | cc1e04b | 2013-09-11 23:20:29 +0200 | [diff] [blame] | 11907 | protocols. |
| 11908 | |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 11909 | - reject : |
| 11910 | rejects the response if the condition is true (when used with "if") |
| 11911 | or false (when used with "unless"). The first such rule executed ends |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 11912 | the rules evaluation. Rejected session are immediately closed. |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 11913 | |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11914 | - set-var(<var-name>) <expr> |
| 11915 | Sets a variable. |
| 11916 | |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 11917 | - unset-var(<var-name>) |
| 11918 | Unsets a variable. |
| 11919 | |
Thierry FOURNIER | e0627bd | 2015-08-04 08:20:33 +0200 | [diff] [blame] | 11920 | - sc-inc-gpc0(<sc-id>): |
| 11921 | This action increments the GPC0 counter according to the sticky |
| 11922 | counter designated by <sc-id>. If an error occurs, this action fails |
| 11923 | silently and the actions evaluation continues. |
| 11924 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 11925 | - sc-inc-gpc1(<sc-id>): |
| 11926 | This action increments the GPC1 counter according to the sticky |
| 11927 | counter designated by <sc-id>. If an error occurs, this action fails |
| 11928 | silently and the actions evaluation continues. |
| 11929 | |
Cédric Dufour | 0d7712d | 2019-11-06 18:38:53 +0100 | [diff] [blame] | 11930 | - sc-set-gpt0(<sc-id>) { <int> | <expr> } |
| 11931 | This action sets the 32-bit unsigned GPT0 tag according to the sticky |
| 11932 | counter designated by <sc-id> and the value of <int>/<expr>. The |
| 11933 | expected result is a boolean. If an error occurs, this action silently |
| 11934 | fails and the actions evaluation continues. |
Thierry FOURNIER | 236657b | 2015-08-19 08:25:14 +0200 | [diff] [blame] | 11935 | |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 11936 | - "silent-drop" : |
| 11937 | This stops the evaluation of the rules and makes the client-facing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11938 | connection suddenly disappear using a system-dependent way that tries |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 11939 | to prevent the client from being notified. The effect it then that the |
| 11940 | client still sees an established connection while there's none on |
| 11941 | HAProxy. The purpose is to achieve a comparable effect to "tarpit" |
| 11942 | except that it doesn't use any local resource at all on the machine |
| 11943 | running HAProxy. It can resist much higher loads than "tarpit", and |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11944 | slow down stronger attackers. It is important to understand the impact |
| 11945 | of using this mechanism. All stateful equipment placed between the |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 11946 | client and HAProxy (firewalls, proxies, load balancers) will also keep |
| 11947 | the established connection for a long time and may suffer from this |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 11948 | action. On modern Linux systems running with enough privileges, the |
Willy Tarreau | 2d392c2 | 2015-08-24 01:43:45 +0200 | [diff] [blame] | 11949 | TCP_REPAIR socket option is used to block the emission of a TCP |
| 11950 | reset. On other systems, the socket's TTL is reduced to 1 so that the |
| 11951 | TCP reset doesn't pass the first router, though it's still delivered to |
| 11952 | local networks. Do not use it unless you fully understand how it works. |
| 11953 | |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 11954 | - send-spoe-group <engine-name> <group-name> |
| 11955 | Send a group of SPOE messages. |
| 11956 | |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 11957 | Note that the "if/unless" condition is optional. If no condition is set on |
| 11958 | the action, it is simply performed unconditionally. That can be useful for |
| 11959 | for changing the default action to a reject. |
| 11960 | |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 11961 | It is perfectly possible to match layer 7 contents with "tcp-response |
| 11962 | content" rules, but then it is important to ensure that a full response has |
| 11963 | been buffered, otherwise no contents will match. In order to achieve this, |
| 11964 | the best solution involves detecting the HTTP protocol during the inspection |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 11965 | period. |
| 11966 | |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11967 | The "set-var" is used to set the content of a variable. The variable is |
| 11968 | declared inline. |
| 11969 | |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 11970 | <var-name> The name of the variable starts with an indication about |
| 11971 | its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 11972 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 11973 | "sess" : the variable is shared with the whole session |
| 11974 | "txn" : the variable is shared with the transaction |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11975 | (request and response) |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 11976 | "req" : the variable is shared only during request |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11977 | processing |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 11978 | "res" : the variable is shared only during response |
| 11979 | processing |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11980 | This prefix is followed by a name. The separator is a '.'. |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 11981 | The name may only contain characters 'a-z', 'A-Z', '0-9', |
| 11982 | '.' and '_'. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 11983 | |
| 11984 | <expr> Is a standard HAProxy expression formed by a sample-fetch |
| 11985 | followed by some converters. |
| 11986 | |
| 11987 | Example: |
| 11988 | |
| 11989 | tcp-request content set-var(sess.my_var) src |
| 11990 | |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 11991 | The "unset-var" is used to unset a variable. See above for details about |
| 11992 | <var-name>. |
| 11993 | |
| 11994 | Example: |
| 11995 | |
| 11996 | tcp-request content unset-var(sess.my_var) |
| 11997 | |
Christopher Faulet | 76c09ef | 2017-09-21 11:03:52 +0200 | [diff] [blame] | 11998 | The "send-spoe-group" is used to trigger sending of a group of SPOE |
| 11999 | messages. To do so, the SPOE engine used to send messages must be defined, as |
| 12000 | well as the SPOE group to send. Of course, the SPOE engine must refer to an |
| 12001 | existing SPOE filter. If not engine name is provided on the SPOE filter line, |
| 12002 | the SPOE agent name must be used. |
| 12003 | |
| 12004 | <engine-name> The SPOE engine name. |
| 12005 | |
| 12006 | <group-name> The SPOE group name as specified in the engine configuration. |
| 12007 | |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 12008 | See section 7 about ACL usage. |
| 12009 | |
| 12010 | See also : "tcp-request content", "tcp-response inspect-delay" |
| 12011 | |
| 12012 | |
Willy Tarreau | 4f61429 | 2016-10-21 17:49:36 +0200 | [diff] [blame] | 12013 | tcp-request session <action> [{if | unless} <condition>] |
| 12014 | Perform an action on a validated session depending on a layer 5 condition |
| 12015 | May be used in sections : defaults | frontend | listen | backend |
| 12016 | no | yes | yes | no |
| 12017 | Arguments : |
| 12018 | <action> defines the action to perform if the condition applies. See |
| 12019 | below. |
| 12020 | |
| 12021 | <condition> is a standard layer5-only ACL-based condition (see section 7). |
| 12022 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12023 | Once a session is validated, (i.e. after all handshakes have been completed), |
Willy Tarreau | 4f61429 | 2016-10-21 17:49:36 +0200 | [diff] [blame] | 12024 | it is possible to evaluate some conditions to decide whether this session |
| 12025 | must be accepted or dropped or have its counters tracked. Those conditions |
| 12026 | cannot make use of any data contents because no buffers are allocated yet and |
| 12027 | the processing cannot wait at this stage. The main use case it to copy some |
| 12028 | early information into variables (since variables are accessible in the |
| 12029 | session), or to keep track of some information collected after the handshake, |
| 12030 | such as SSL-level elements (SNI, ciphers, client cert's CN) or information |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12031 | from the PROXY protocol header (e.g. track a source forwarded this way). The |
Willy Tarreau | 4f61429 | 2016-10-21 17:49:36 +0200 | [diff] [blame] | 12032 | extracted information can thus be copied to a variable or tracked using |
| 12033 | "track-sc" rules. Of course it is also possible to decide to accept/reject as |
| 12034 | with other rulesets. Most operations performed here could also be performed |
| 12035 | in "tcp-request content" rules, except that in HTTP these rules are evaluated |
| 12036 | for each new request, and that might not always be acceptable. For example a |
| 12037 | rule might increment a counter on each evaluation. It would also be possible |
| 12038 | that a country is resolved by geolocation from the source IP address, |
| 12039 | assigned to a session-wide variable, then the source address rewritten from |
| 12040 | an HTTP header for all requests. If some contents need to be inspected in |
| 12041 | order to take the decision, the "tcp-request content" statements must be used |
| 12042 | instead. |
| 12043 | |
| 12044 | The "tcp-request session" rules are evaluated in their exact declaration |
| 12045 | order. If no rule matches or if there is no rule, the default action is to |
| 12046 | accept the incoming session. There is no specific limit to the number of |
| 12047 | rules which may be inserted. |
| 12048 | |
| 12049 | Several types of actions are supported : |
| 12050 | - accept : the request is accepted |
| 12051 | - reject : the request is rejected and the connection is closed |
| 12052 | - { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>] |
| 12053 | - sc-inc-gpc0(<sc-id>) |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 12054 | - sc-inc-gpc1(<sc-id>) |
Cédric Dufour | 0d7712d | 2019-11-06 18:38:53 +0100 | [diff] [blame] | 12055 | - sc-set-gpt0(<sc-id>) { <int> | <expr> } |
Willy Tarreau | 4f61429 | 2016-10-21 17:49:36 +0200 | [diff] [blame] | 12056 | - set-var(<var-name>) <expr> |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 12057 | - unset-var(<var-name>) |
Willy Tarreau | 4f61429 | 2016-10-21 17:49:36 +0200 | [diff] [blame] | 12058 | - silent-drop |
| 12059 | |
| 12060 | These actions have the same meaning as their respective counter-parts in |
| 12061 | "tcp-request connection" and "tcp-request content", so please refer to these |
| 12062 | sections for a complete description. |
| 12063 | |
| 12064 | Note that the "if/unless" condition is optional. If no condition is set on |
| 12065 | the action, it is simply performed unconditionally. That can be useful for |
| 12066 | "track-sc*" actions as well as for changing the default action to a reject. |
| 12067 | |
| 12068 | Example: track the original source address by default, or the one advertised |
| 12069 | in the PROXY protocol header for connection coming from the local |
| 12070 | proxies. The first connection-level rule enables receipt of the |
| 12071 | PROXY protocol for these ones, the second rule tracks whatever |
| 12072 | address we decide to keep after optional decoding. |
| 12073 | |
| 12074 | tcp-request connection expect-proxy layer4 if { src -f proxies.lst } |
| 12075 | tcp-request session track-sc0 src |
| 12076 | |
| 12077 | Example: accept all sessions from white-listed hosts, reject too fast |
| 12078 | sessions without counting them, and track accepted sessions. |
| 12079 | This results in session rate being capped from abusive sources. |
| 12080 | |
| 12081 | tcp-request session accept if { src -f /etc/haproxy/whitelist.lst } |
| 12082 | tcp-request session reject if { src_sess_rate gt 10 } |
| 12083 | tcp-request session track-sc0 src |
| 12084 | |
| 12085 | Example: accept all sessions from white-listed hosts, count all other |
| 12086 | sessions and reject too fast ones. This results in abusive ones |
| 12087 | being blocked as long as they don't slow down. |
| 12088 | |
| 12089 | tcp-request session accept if { src -f /etc/haproxy/whitelist.lst } |
| 12090 | tcp-request session track-sc0 src |
| 12091 | tcp-request session reject if { sc0_sess_rate gt 10 } |
| 12092 | |
| 12093 | See section 7 about ACL usage. |
| 12094 | |
| 12095 | See also : "tcp-request connection", "tcp-request content", "stick-table" |
| 12096 | |
| 12097 | |
Emeric Brun | 0a3b67f | 2010-09-24 15:34:53 +0200 | [diff] [blame] | 12098 | tcp-response inspect-delay <timeout> |
| 12099 | Set the maximum allowed time to wait for a response during content inspection |
| 12100 | May be used in sections : defaults | frontend | listen | backend |
| 12101 | no | no | yes | yes |
| 12102 | Arguments : |
| 12103 | <timeout> is the timeout value specified in milliseconds by default, but |
| 12104 | can be in any other unit if the number is suffixed by the unit, |
| 12105 | as explained at the top of this document. |
| 12106 | |
| 12107 | See also : "tcp-response content", "tcp-request inspect-delay". |
| 12108 | |
| 12109 | |
Krzysztof Piotr Oledzki | 5259dfe | 2008-01-21 01:54:06 +0100 | [diff] [blame] | 12110 | timeout check <timeout> |
| 12111 | Set additional check timeout, but only after a connection has been already |
| 12112 | established. |
| 12113 | |
| 12114 | May be used in sections: defaults | frontend | listen | backend |
| 12115 | yes | no | yes | yes |
| 12116 | Arguments: |
| 12117 | <timeout> is the timeout value specified in milliseconds by default, but |
| 12118 | can be in any other unit if the number is suffixed by the unit, |
| 12119 | as explained at the top of this document. |
| 12120 | |
| 12121 | If set, haproxy uses min("timeout connect", "inter") as a connect timeout |
| 12122 | for check and "timeout check" as an additional read timeout. The "min" is |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12123 | used so that people running with *very* long "timeout connect" (e.g. those |
Krzysztof Piotr Oledzki | 5259dfe | 2008-01-21 01:54:06 +0100 | [diff] [blame] | 12124 | who needed this due to the queue or tarpit) do not slow down their checks. |
Willy Tarreau | d7550a2 | 2010-02-10 05:10:19 +0100 | [diff] [blame] | 12125 | (Please also note that there is no valid reason to have such long connect |
| 12126 | timeouts, because "timeout queue" and "timeout tarpit" can always be used to |
| 12127 | avoid that). |
Krzysztof Piotr Oledzki | 5259dfe | 2008-01-21 01:54:06 +0100 | [diff] [blame] | 12128 | |
| 12129 | If "timeout check" is not set haproxy uses "inter" for complete check |
| 12130 | timeout (connect + read) exactly like all <1.3.15 version. |
| 12131 | |
| 12132 | In most cases check request is much simpler and faster to handle than normal |
| 12133 | requests and people may want to kick out laggy servers so this timeout should |
Willy Tarreau | 41a340d | 2008-01-22 12:25:31 +0100 | [diff] [blame] | 12134 | be smaller than "timeout server". |
Krzysztof Piotr Oledzki | 5259dfe | 2008-01-21 01:54:06 +0100 | [diff] [blame] | 12135 | |
| 12136 | This parameter is specific to backends, but can be specified once for all in |
| 12137 | "defaults" sections. This is in fact one of the easiest solutions not to |
| 12138 | forget about it. |
| 12139 | |
Willy Tarreau | 41a340d | 2008-01-22 12:25:31 +0100 | [diff] [blame] | 12140 | See also: "timeout connect", "timeout queue", "timeout server", |
| 12141 | "timeout tarpit". |
Krzysztof Piotr Oledzki | 5259dfe | 2008-01-21 01:54:06 +0100 | [diff] [blame] | 12142 | |
| 12143 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12144 | timeout client <timeout> |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12145 | Set the maximum inactivity time on the client side. |
| 12146 | May be used in sections : defaults | frontend | listen | backend |
| 12147 | yes | yes | yes | no |
| 12148 | Arguments : |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12149 | <timeout> is the timeout value specified in milliseconds by default, but |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12150 | can be in any other unit if the number is suffixed by the unit, |
| 12151 | as explained at the top of this document. |
| 12152 | |
| 12153 | The inactivity timeout applies when the client is expected to acknowledge or |
| 12154 | send data. In HTTP mode, this timeout is particularly important to consider |
| 12155 | during the first phase, when the client sends the request, and during the |
Baptiste Assmann | 2e1941e | 2016-03-06 23:24:12 +0100 | [diff] [blame] | 12156 | response while it is reading data sent by the server. That said, for the |
| 12157 | first phase, it is preferable to set the "timeout http-request" to better |
| 12158 | protect HAProxy from Slowloris like attacks. The value is specified in |
| 12159 | milliseconds by default, but can be in any other unit if the number is |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12160 | suffixed by the unit, as specified at the top of this document. In TCP mode |
| 12161 | (and to a lesser extent, in HTTP mode), it is highly recommended that the |
| 12162 | client timeout remains equal to the server timeout in order to avoid complex |
Willy Tarreau | d2a4aa2 | 2008-01-31 15:28:22 +0100 | [diff] [blame] | 12163 | situations to debug. It is a good practice to cover one or several TCP packet |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12164 | losses by specifying timeouts that are slightly above multiples of 3 seconds |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12165 | (e.g. 4 or 5 seconds). If some long-lived sessions are mixed with short-lived |
| 12166 | sessions (e.g. WebSocket and HTTP), it's worth considering "timeout tunnel", |
Willy Tarreau | 05cdd96 | 2014-05-10 14:30:07 +0200 | [diff] [blame] | 12167 | which overrides "timeout client" and "timeout server" for tunnels, as well as |
| 12168 | "timeout client-fin" for half-closed connections. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12169 | |
| 12170 | This parameter is specific to frontends, but can be specified once for all in |
| 12171 | "defaults" sections. This is in fact one of the easiest solutions not to |
| 12172 | forget about it. An unspecified timeout results in an infinite timeout, which |
| 12173 | is not recommended. Such a usage is accepted and works but reports a warning |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 12174 | during startup because it may result in accumulation of expired sessions in |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12175 | the system if the system's timeouts are not configured either. |
| 12176 | |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 12177 | This also applies to HTTP/2 connections, which will be closed with GOAWAY. |
Lukas Tribus | 75df9d7 | 2017-11-24 19:05:12 +0100 | [diff] [blame] | 12178 | |
Tim Duesterhus | 86e6b6e | 2019-05-14 20:57:59 +0200 | [diff] [blame] | 12179 | See also : "timeout server", "timeout tunnel", "timeout http-request". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12180 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12181 | |
Willy Tarreau | 05cdd96 | 2014-05-10 14:30:07 +0200 | [diff] [blame] | 12182 | timeout client-fin <timeout> |
| 12183 | Set the inactivity timeout on the client side for half-closed connections. |
| 12184 | May be used in sections : defaults | frontend | listen | backend |
| 12185 | yes | yes | yes | no |
| 12186 | Arguments : |
| 12187 | <timeout> is the timeout value specified in milliseconds by default, but |
| 12188 | can be in any other unit if the number is suffixed by the unit, |
| 12189 | as explained at the top of this document. |
| 12190 | |
| 12191 | The inactivity timeout applies when the client is expected to acknowledge or |
| 12192 | send data while one direction is already shut down. This timeout is different |
| 12193 | from "timeout client" in that it only applies to connections which are closed |
| 12194 | in one direction. This is particularly useful to avoid keeping connections in |
| 12195 | FIN_WAIT state for too long when clients do not disconnect cleanly. This |
| 12196 | problem is particularly common long connections such as RDP or WebSocket. |
| 12197 | Note that this timeout can override "timeout tunnel" when a connection shuts |
Willy Tarreau | 599391a | 2017-11-24 10:16:00 +0100 | [diff] [blame] | 12198 | down in one direction. It is applied to idle HTTP/2 connections once a GOAWAY |
| 12199 | frame was sent, often indicating an expectation that the connection quickly |
| 12200 | ends. |
Willy Tarreau | 05cdd96 | 2014-05-10 14:30:07 +0200 | [diff] [blame] | 12201 | |
| 12202 | This parameter is specific to frontends, but can be specified once for all in |
| 12203 | "defaults" sections. By default it is not set, so half-closed connections |
| 12204 | will use the other timeouts (timeout.client or timeout.tunnel). |
| 12205 | |
| 12206 | See also : "timeout client", "timeout server-fin", and "timeout tunnel". |
| 12207 | |
| 12208 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12209 | timeout connect <timeout> |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12210 | Set the maximum time to wait for a connection attempt to a server to succeed. |
| 12211 | May be used in sections : defaults | frontend | listen | backend |
| 12212 | yes | no | yes | yes |
| 12213 | Arguments : |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12214 | <timeout> is the timeout value specified in milliseconds by default, but |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12215 | can be in any other unit if the number is suffixed by the unit, |
| 12216 | as explained at the top of this document. |
| 12217 | |
| 12218 | If the server is located on the same LAN as haproxy, the connection should be |
Willy Tarreau | d2a4aa2 | 2008-01-31 15:28:22 +0100 | [diff] [blame] | 12219 | immediate (less than a few milliseconds). Anyway, it is a good practice to |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 12220 | cover one or several TCP packet losses by specifying timeouts that are |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12221 | slightly above multiples of 3 seconds (e.g. 4 or 5 seconds). By default, the |
Krzysztof Piotr Oledzki | 5259dfe | 2008-01-21 01:54:06 +0100 | [diff] [blame] | 12222 | connect timeout also presets both queue and tarpit timeouts to the same value |
| 12223 | if these have not been specified. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12224 | |
| 12225 | This parameter is specific to backends, but can be specified once for all in |
| 12226 | "defaults" sections. This is in fact one of the easiest solutions not to |
| 12227 | forget about it. An unspecified timeout results in an infinite timeout, which |
| 12228 | is not recommended. Such a usage is accepted and works but reports a warning |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 12229 | during startup because it may result in accumulation of failed sessions in |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12230 | the system if the system's timeouts are not configured either. |
| 12231 | |
Tim Duesterhus | 86e6b6e | 2019-05-14 20:57:59 +0200 | [diff] [blame] | 12232 | See also: "timeout check", "timeout queue", "timeout server", "timeout tarpit". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12233 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 12234 | |
Willy Tarreau | b16a574 | 2010-01-10 14:46:16 +0100 | [diff] [blame] | 12235 | timeout http-keep-alive <timeout> |
| 12236 | Set the maximum allowed time to wait for a new HTTP request to appear |
| 12237 | May be used in sections : defaults | frontend | listen | backend |
| 12238 | yes | yes | yes | yes |
| 12239 | Arguments : |
| 12240 | <timeout> is the timeout value specified in milliseconds by default, but |
| 12241 | can be in any other unit if the number is suffixed by the unit, |
| 12242 | as explained at the top of this document. |
| 12243 | |
| 12244 | By default, the time to wait for a new request in case of keep-alive is set |
| 12245 | by "timeout http-request". However this is not always convenient because some |
| 12246 | people want very short keep-alive timeouts in order to release connections |
| 12247 | faster, and others prefer to have larger ones but still have short timeouts |
| 12248 | once the request has started to present itself. |
| 12249 | |
| 12250 | The "http-keep-alive" timeout covers these needs. It will define how long to |
| 12251 | wait for a new HTTP request to start coming after a response was sent. Once |
| 12252 | the first byte of request has been seen, the "http-request" timeout is used |
| 12253 | to wait for the complete request to come. Note that empty lines prior to a |
| 12254 | new request do not refresh the timeout and are not counted as a new request. |
| 12255 | |
| 12256 | There is also another difference between the two timeouts : when a connection |
| 12257 | expires during timeout http-keep-alive, no error is returned, the connection |
| 12258 | just closes. If the connection expires in "http-request" while waiting for a |
| 12259 | connection to complete, a HTTP 408 error is returned. |
| 12260 | |
| 12261 | In general it is optimal to set this value to a few tens to hundreds of |
| 12262 | milliseconds, to allow users to fetch all objects of a page at once but |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12263 | without waiting for further clicks. Also, if set to a very small value (e.g. |
Willy Tarreau | b16a574 | 2010-01-10 14:46:16 +0100 | [diff] [blame] | 12264 | 1 millisecond) it will probably only accept pipelined requests but not the |
| 12265 | non-pipelined ones. It may be a nice trade-off for very large sites running |
Patrick Mézard | 2382ad6 | 2010-05-09 10:43:32 +0200 | [diff] [blame] | 12266 | with tens to hundreds of thousands of clients. |
Willy Tarreau | b16a574 | 2010-01-10 14:46:16 +0100 | [diff] [blame] | 12267 | |
| 12268 | If this parameter is not set, the "http-request" timeout applies, and if both |
| 12269 | are not set, "timeout client" still applies at the lower level. It should be |
| 12270 | set in the frontend to take effect, unless the frontend is in TCP mode, in |
| 12271 | which case the HTTP backend's timeout will be used. |
| 12272 | |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 12273 | When using HTTP/2 "timeout client" is applied instead. This is so we can keep |
| 12274 | using short keep-alive timeouts in HTTP/1.1 while using longer ones in HTTP/2 |
Lukas Tribus | 75df9d7 | 2017-11-24 19:05:12 +0100 | [diff] [blame] | 12275 | (where we only have one connection per client and a connection setup). |
| 12276 | |
Willy Tarreau | b16a574 | 2010-01-10 14:46:16 +0100 | [diff] [blame] | 12277 | See also : "timeout http-request", "timeout client". |
| 12278 | |
| 12279 | |
Willy Tarreau | 036fae0 | 2008-01-06 13:24:40 +0100 | [diff] [blame] | 12280 | timeout http-request <timeout> |
| 12281 | Set the maximum allowed time to wait for a complete HTTP request |
| 12282 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | cd7afc0 | 2009-07-12 10:03:17 +0200 | [diff] [blame] | 12283 | yes | yes | yes | yes |
Willy Tarreau | 036fae0 | 2008-01-06 13:24:40 +0100 | [diff] [blame] | 12284 | Arguments : |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12285 | <timeout> is the timeout value specified in milliseconds by default, but |
Willy Tarreau | 036fae0 | 2008-01-06 13:24:40 +0100 | [diff] [blame] | 12286 | can be in any other unit if the number is suffixed by the unit, |
| 12287 | as explained at the top of this document. |
| 12288 | |
| 12289 | In order to offer DoS protection, it may be required to lower the maximum |
| 12290 | accepted time to receive a complete HTTP request without affecting the client |
| 12291 | timeout. This helps protecting against established connections on which |
| 12292 | nothing is sent. The client timeout cannot offer a good protection against |
| 12293 | this abuse because it is an inactivity timeout, which means that if the |
| 12294 | attacker sends one character every now and then, the timeout will not |
| 12295 | trigger. With the HTTP request timeout, no matter what speed the client |
Willy Tarreau | 2705a61 | 2014-05-23 17:38:34 +0200 | [diff] [blame] | 12296 | types, the request will be aborted if it does not complete in time. When the |
| 12297 | timeout expires, an HTTP 408 response is sent to the client to inform it |
| 12298 | about the problem, and the connection is closed. The logs will report |
| 12299 | termination codes "cR". Some recent browsers are having problems with this |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12300 | standard, well-documented behavior, so it might be needed to hide the 408 |
Willy Tarreau | 0f228a0 | 2015-05-01 15:37:53 +0200 | [diff] [blame] | 12301 | code using "option http-ignore-probes" or "errorfile 408 /dev/null". See |
| 12302 | more details in the explanations of the "cR" termination code in section 8.5. |
Willy Tarreau | 036fae0 | 2008-01-06 13:24:40 +0100 | [diff] [blame] | 12303 | |
Baptiste Assmann | eccdf43 | 2015-10-28 13:49:01 +0100 | [diff] [blame] | 12304 | By default, this timeout only applies to the header part of the request, |
| 12305 | and not to any data. As soon as the empty line is received, this timeout is |
| 12306 | not used anymore. When combined with "option http-buffer-request", this |
| 12307 | timeout also applies to the body of the request.. |
| 12308 | It is used again on keep-alive connections to wait for a second |
Willy Tarreau | b16a574 | 2010-01-10 14:46:16 +0100 | [diff] [blame] | 12309 | request if "timeout http-keep-alive" is not set. |
Willy Tarreau | 036fae0 | 2008-01-06 13:24:40 +0100 | [diff] [blame] | 12310 | |
| 12311 | Generally it is enough to set it to a few seconds, as most clients send the |
| 12312 | full request immediately upon connection. Add 3 or more seconds to cover TCP |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12313 | retransmits but that's all. Setting it to very low values (e.g. 50 ms) will |
Willy Tarreau | 036fae0 | 2008-01-06 13:24:40 +0100 | [diff] [blame] | 12314 | generally work on local networks as long as there are no packet losses. This |
| 12315 | will prevent people from sending bare HTTP requests using telnet. |
| 12316 | |
| 12317 | If this parameter is not set, the client timeout still applies between each |
Willy Tarreau | cd7afc0 | 2009-07-12 10:03:17 +0200 | [diff] [blame] | 12318 | chunk of the incoming request. It should be set in the frontend to take |
| 12319 | effect, unless the frontend is in TCP mode, in which case the HTTP backend's |
| 12320 | timeout will be used. |
Willy Tarreau | 036fae0 | 2008-01-06 13:24:40 +0100 | [diff] [blame] | 12321 | |
Willy Tarreau | 0f228a0 | 2015-05-01 15:37:53 +0200 | [diff] [blame] | 12322 | See also : "errorfile", "http-ignore-probes", "timeout http-keep-alive", and |
Baptiste Assmann | eccdf43 | 2015-10-28 13:49:01 +0100 | [diff] [blame] | 12323 | "timeout client", "option http-buffer-request". |
Willy Tarreau | 036fae0 | 2008-01-06 13:24:40 +0100 | [diff] [blame] | 12324 | |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12325 | |
| 12326 | timeout queue <timeout> |
| 12327 | Set the maximum time to wait in the queue for a connection slot to be free |
| 12328 | May be used in sections : defaults | frontend | listen | backend |
| 12329 | yes | no | yes | yes |
| 12330 | Arguments : |
| 12331 | <timeout> is the timeout value specified in milliseconds by default, but |
| 12332 | can be in any other unit if the number is suffixed by the unit, |
| 12333 | as explained at the top of this document. |
| 12334 | |
| 12335 | When a server's maxconn is reached, connections are left pending in a queue |
| 12336 | which may be server-specific or global to the backend. In order not to wait |
| 12337 | indefinitely, a timeout is applied to requests pending in the queue. If the |
| 12338 | timeout is reached, it is considered that the request will almost never be |
| 12339 | served, so it is dropped and a 503 error is returned to the client. |
| 12340 | |
| 12341 | The "timeout queue" statement allows to fix the maximum time for a request to |
| 12342 | be left pending in a queue. If unspecified, the same value as the backend's |
| 12343 | connection timeout ("timeout connect") is used, for backwards compatibility |
| 12344 | with older versions with no "timeout queue" parameter. |
| 12345 | |
Tim Duesterhus | 86e6b6e | 2019-05-14 20:57:59 +0200 | [diff] [blame] | 12346 | See also : "timeout connect". |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12347 | |
| 12348 | |
| 12349 | timeout server <timeout> |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12350 | Set the maximum inactivity time on the server side. |
| 12351 | May be used in sections : defaults | frontend | listen | backend |
| 12352 | yes | no | yes | yes |
| 12353 | Arguments : |
| 12354 | <timeout> is the timeout value specified in milliseconds by default, but |
| 12355 | can be in any other unit if the number is suffixed by the unit, |
| 12356 | as explained at the top of this document. |
| 12357 | |
| 12358 | The inactivity timeout applies when the server is expected to acknowledge or |
| 12359 | send data. In HTTP mode, this timeout is particularly important to consider |
| 12360 | during the first phase of the server's response, when it has to send the |
| 12361 | headers, as it directly represents the server's processing time for the |
| 12362 | request. To find out what value to put there, it's often good to start with |
| 12363 | what would be considered as unacceptable response times, then check the logs |
| 12364 | to observe the response time distribution, and adjust the value accordingly. |
| 12365 | |
| 12366 | The value is specified in milliseconds by default, but can be in any other |
| 12367 | unit if the number is suffixed by the unit, as specified at the top of this |
| 12368 | document. In TCP mode (and to a lesser extent, in HTTP mode), it is highly |
| 12369 | recommended that the client timeout remains equal to the server timeout in |
| 12370 | order to avoid complex situations to debug. Whatever the expected server |
Willy Tarreau | d2a4aa2 | 2008-01-31 15:28:22 +0100 | [diff] [blame] | 12371 | response times, it is a good practice to cover at least one or several TCP |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12372 | packet losses by specifying timeouts that are slightly above multiples of 3 |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12373 | seconds (e.g. 4 or 5 seconds minimum). If some long-lived sessions are mixed |
| 12374 | with short-lived sessions (e.g. WebSocket and HTTP), it's worth considering |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 12375 | "timeout tunnel", which overrides "timeout client" and "timeout server" for |
| 12376 | tunnels. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12377 | |
| 12378 | This parameter is specific to backends, but can be specified once for all in |
| 12379 | "defaults" sections. This is in fact one of the easiest solutions not to |
| 12380 | forget about it. An unspecified timeout results in an infinite timeout, which |
| 12381 | is not recommended. Such a usage is accepted and works but reports a warning |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 12382 | during startup because it may result in accumulation of expired sessions in |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12383 | the system if the system's timeouts are not configured either. |
| 12384 | |
Tim Duesterhus | 86e6b6e | 2019-05-14 20:57:59 +0200 | [diff] [blame] | 12385 | See also : "timeout client" and "timeout tunnel". |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12386 | |
Willy Tarreau | 05cdd96 | 2014-05-10 14:30:07 +0200 | [diff] [blame] | 12387 | |
| 12388 | timeout server-fin <timeout> |
| 12389 | Set the inactivity timeout on the server side for half-closed connections. |
| 12390 | May be used in sections : defaults | frontend | listen | backend |
| 12391 | yes | no | yes | yes |
| 12392 | Arguments : |
| 12393 | <timeout> is the timeout value specified in milliseconds by default, but |
| 12394 | can be in any other unit if the number is suffixed by the unit, |
| 12395 | as explained at the top of this document. |
| 12396 | |
| 12397 | The inactivity timeout applies when the server is expected to acknowledge or |
| 12398 | send data while one direction is already shut down. This timeout is different |
| 12399 | from "timeout server" in that it only applies to connections which are closed |
| 12400 | in one direction. This is particularly useful to avoid keeping connections in |
| 12401 | FIN_WAIT state for too long when a remote server does not disconnect cleanly. |
| 12402 | This problem is particularly common long connections such as RDP or WebSocket. |
| 12403 | Note that this timeout can override "timeout tunnel" when a connection shuts |
| 12404 | down in one direction. This setting was provided for completeness, but in most |
| 12405 | situations, it should not be needed. |
| 12406 | |
| 12407 | This parameter is specific to backends, but can be specified once for all in |
| 12408 | "defaults" sections. By default it is not set, so half-closed connections |
| 12409 | will use the other timeouts (timeout.server or timeout.tunnel). |
| 12410 | |
| 12411 | See also : "timeout client-fin", "timeout server", and "timeout tunnel". |
| 12412 | |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12413 | |
| 12414 | timeout tarpit <timeout> |
Cyril Bonté | 78caf84 | 2010-03-10 22:41:43 +0100 | [diff] [blame] | 12415 | Set the duration for which tarpitted connections will be maintained |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12416 | May be used in sections : defaults | frontend | listen | backend |
| 12417 | yes | yes | yes | yes |
| 12418 | Arguments : |
| 12419 | <timeout> is the tarpit duration specified in milliseconds by default, but |
| 12420 | can be in any other unit if the number is suffixed by the unit, |
| 12421 | as explained at the top of this document. |
| 12422 | |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 12423 | When a connection is tarpitted using "http-request tarpit", it is maintained |
| 12424 | open with no activity for a certain amount of time, then closed. "timeout |
| 12425 | tarpit" defines how long it will be maintained open. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12426 | |
| 12427 | The value is specified in milliseconds by default, but can be in any other |
| 12428 | unit if the number is suffixed by the unit, as specified at the top of this |
| 12429 | document. If unspecified, the same value as the backend's connection timeout |
| 12430 | ("timeout connect") is used, for backwards compatibility with older versions |
Cyril Bonté | 78caf84 | 2010-03-10 22:41:43 +0100 | [diff] [blame] | 12431 | with no "timeout tarpit" parameter. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12432 | |
Tim Duesterhus | 86e6b6e | 2019-05-14 20:57:59 +0200 | [diff] [blame] | 12433 | See also : "timeout connect". |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12434 | |
| 12435 | |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 12436 | timeout tunnel <timeout> |
| 12437 | Set the maximum inactivity time on the client and server side for tunnels. |
| 12438 | May be used in sections : defaults | frontend | listen | backend |
| 12439 | yes | no | yes | yes |
| 12440 | Arguments : |
| 12441 | <timeout> is the timeout value specified in milliseconds by default, but |
| 12442 | can be in any other unit if the number is suffixed by the unit, |
| 12443 | as explained at the top of this document. |
| 12444 | |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 12445 | The tunnel timeout applies when a bidirectional connection is established |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 12446 | between a client and a server, and the connection remains inactive in both |
| 12447 | directions. This timeout supersedes both the client and server timeouts once |
| 12448 | the connection becomes a tunnel. In TCP, this timeout is used as soon as no |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12449 | analyzer remains attached to either connection (e.g. tcp content rules are |
| 12450 | accepted). In HTTP, this timeout is used when a connection is upgraded (e.g. |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 12451 | when switching to the WebSocket protocol, or forwarding a CONNECT request |
| 12452 | to a proxy), or after the first response when no keepalive/close option is |
| 12453 | specified. |
| 12454 | |
Willy Tarreau | 05cdd96 | 2014-05-10 14:30:07 +0200 | [diff] [blame] | 12455 | Since this timeout is usually used in conjunction with long-lived connections, |
| 12456 | it usually is a good idea to also set "timeout client-fin" to handle the |
| 12457 | situation where a client suddenly disappears from the net and does not |
| 12458 | acknowledge a close, or sends a shutdown and does not acknowledge pending |
| 12459 | data anymore. This can happen in lossy networks where firewalls are present, |
| 12460 | and is detected by the presence of large amounts of sessions in a FIN_WAIT |
| 12461 | state. |
| 12462 | |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 12463 | The value is specified in milliseconds by default, but can be in any other |
| 12464 | unit if the number is suffixed by the unit, as specified at the top of this |
| 12465 | document. Whatever the expected normal idle time, it is a good practice to |
| 12466 | cover at least one or several TCP packet losses by specifying timeouts that |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12467 | are slightly above multiples of 3 seconds (e.g. 4 or 5 seconds minimum). |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 12468 | |
| 12469 | This parameter is specific to backends, but can be specified once for all in |
| 12470 | "defaults" sections. This is in fact one of the easiest solutions not to |
| 12471 | forget about it. |
| 12472 | |
| 12473 | Example : |
| 12474 | defaults http |
| 12475 | option http-server-close |
| 12476 | timeout connect 5s |
| 12477 | timeout client 30s |
Willy Tarreau | 05cdd96 | 2014-05-10 14:30:07 +0200 | [diff] [blame] | 12478 | timeout client-fin 30s |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 12479 | timeout server 30s |
| 12480 | timeout tunnel 1h # timeout to use with WebSocket and CONNECT |
| 12481 | |
Willy Tarreau | 05cdd96 | 2014-05-10 14:30:07 +0200 | [diff] [blame] | 12482 | See also : "timeout client", "timeout client-fin", "timeout server". |
Willy Tarreau | ce887fd | 2012-05-12 12:50:00 +0200 | [diff] [blame] | 12483 | |
| 12484 | |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12485 | transparent (deprecated) |
| 12486 | Enable client-side transparent proxying |
| 12487 | May be used in sections : defaults | frontend | listen | backend |
Willy Tarreau | 4b1f859 | 2008-12-23 23:13:55 +0100 | [diff] [blame] | 12488 | yes | no | yes | yes |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12489 | Arguments : none |
| 12490 | |
| 12491 | This keyword was introduced in order to provide layer 7 persistence to layer |
| 12492 | 3 load balancers. The idea is to use the OS's ability to redirect an incoming |
| 12493 | connection for a remote address to a local process (here HAProxy), and let |
| 12494 | this process know what address was initially requested. When this option is |
| 12495 | used, sessions without cookies will be forwarded to the original destination |
| 12496 | IP address of the incoming request (which should match that of another |
| 12497 | equipment), while requests with cookies will still be forwarded to the |
| 12498 | appropriate server. |
| 12499 | |
| 12500 | The "transparent" keyword is deprecated, use "option transparent" instead. |
| 12501 | |
| 12502 | Note that contrary to a common belief, this option does NOT make HAProxy |
| 12503 | present the client's IP to the server when establishing the connection. |
| 12504 | |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12505 | See also: "option transparent" |
| 12506 | |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 12507 | unique-id-format <string> |
| 12508 | Generate a unique ID for each request. |
| 12509 | May be used in sections : defaults | frontend | listen | backend |
| 12510 | yes | yes | yes | no |
| 12511 | Arguments : |
| 12512 | <string> is a log-format string. |
| 12513 | |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 12514 | This keyword creates a ID for each request using the custom log format. A |
| 12515 | unique ID is useful to trace a request passing through many components of |
| 12516 | a complex infrastructure. The newly created ID may also be logged using the |
| 12517 | %ID tag the log-format string. |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 12518 | |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 12519 | The format should be composed from elements that are guaranteed to be |
| 12520 | unique when combined together. For instance, if multiple haproxy instances |
| 12521 | are involved, it might be important to include the node name. It is often |
| 12522 | needed to log the incoming connection's source and destination addresses |
| 12523 | and ports. Note that since multiple requests may be performed over the same |
| 12524 | connection, including a request counter may help differentiate them. |
| 12525 | Similarly, a timestamp may protect against a rollover of the counter. |
| 12526 | Logging the process ID will avoid collisions after a service restart. |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 12527 | |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 12528 | It is recommended to use hexadecimal notation for many fields since it |
| 12529 | makes them more compact and saves space in logs. |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 12530 | |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 12531 | Example: |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 12532 | |
Julien Vehent | f21be32 | 2014-03-07 08:27:34 -0500 | [diff] [blame] | 12533 | unique-id-format %{+X}o\ %ci:%cp_%fi:%fp_%Ts_%rt:%pid |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 12534 | |
| 12535 | will generate: |
| 12536 | |
| 12537 | 7F000001:8296_7F00001E:1F90_4F7B0A69_0003:790A |
| 12538 | |
| 12539 | See also: "unique-id-header" |
| 12540 | |
| 12541 | unique-id-header <name> |
| 12542 | Add a unique ID header in the HTTP request. |
| 12543 | May be used in sections : defaults | frontend | listen | backend |
| 12544 | yes | yes | yes | no |
| 12545 | Arguments : |
| 12546 | <name> is the name of the header. |
| 12547 | |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 12548 | Add a unique-id header in the HTTP request sent to the server, using the |
| 12549 | unique-id-format. It can't work if the unique-id-format doesn't exist. |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 12550 | |
Cyril Bonté | 108cf6e | 2012-04-21 23:30:29 +0200 | [diff] [blame] | 12551 | Example: |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 12552 | |
Julien Vehent | f21be32 | 2014-03-07 08:27:34 -0500 | [diff] [blame] | 12553 | unique-id-format %{+X}o\ %ci:%cp_%fi:%fp_%Ts_%rt:%pid |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 12554 | unique-id-header X-Unique-ID |
| 12555 | |
| 12556 | will generate: |
| 12557 | |
| 12558 | X-Unique-ID: 7F000001:8296_7F00001E:1F90_4F7B0A69_0003:790A |
| 12559 | |
| 12560 | See also: "unique-id-format" |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12561 | |
Willy Tarreau | f51658d | 2014-04-23 01:21:56 +0200 | [diff] [blame] | 12562 | use_backend <backend> [{if | unless} <condition>] |
Willy Tarreau | 1d0dfb1 | 2009-07-07 15:10:31 +0200 | [diff] [blame] | 12563 | Switch to a specific backend if/unless an ACL-based condition is matched. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12564 | May be used in sections : defaults | frontend | listen | backend |
| 12565 | no | yes | yes | no |
| 12566 | Arguments : |
Bertrand Jacquin | 702d44f | 2013-11-19 11:43:06 +0100 | [diff] [blame] | 12567 | <backend> is the name of a valid backend or "listen" section, or a |
| 12568 | "log-format" string resolving to a backend name. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12569 | |
Willy Tarreau | f51658d | 2014-04-23 01:21:56 +0200 | [diff] [blame] | 12570 | <condition> is a condition composed of ACLs, as described in section 7. If |
| 12571 | it is omitted, the rule is unconditionally applied. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12572 | |
| 12573 | When doing content-switching, connections arrive on a frontend and are then |
| 12574 | dispatched to various backends depending on a number of conditions. The |
| 12575 | relation between the conditions and the backends is described with the |
Willy Tarreau | 1d0dfb1 | 2009-07-07 15:10:31 +0200 | [diff] [blame] | 12576 | "use_backend" keyword. While it is normally used with HTTP processing, it can |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12577 | also be used in pure TCP, either without content using stateless ACLs (e.g. |
Willy Tarreau | 1d0dfb1 | 2009-07-07 15:10:31 +0200 | [diff] [blame] | 12578 | source address validation) or combined with a "tcp-request" rule to wait for |
| 12579 | some payload. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 12580 | |
| 12581 | There may be as many "use_backend" rules as desired. All of these rules are |
| 12582 | evaluated in their declaration order, and the first one which matches will |
| 12583 | assign the backend. |
| 12584 | |
| 12585 | In the first form, the backend will be used if the condition is met. In the |
| 12586 | second form, the backend will be used if the condition is not met. If no |
| 12587 | condition is valid, the backend defined with "default_backend" will be used. |
| 12588 | If no default backend is defined, either the servers in the same section are |
| 12589 | used (in case of a "listen" section) or, in case of a frontend, no server is |
| 12590 | used and a 503 service unavailable response is returned. |
| 12591 | |
Willy Tarreau | 51aecc7 | 2009-07-12 09:47:04 +0200 | [diff] [blame] | 12592 | Note that it is possible to switch from a TCP frontend to an HTTP backend. In |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 12593 | this case, either the frontend has already checked that the protocol is HTTP, |
Willy Tarreau | 51aecc7 | 2009-07-12 09:47:04 +0200 | [diff] [blame] | 12594 | and backend processing will immediately follow, or the backend will wait for |
| 12595 | a complete HTTP request to get in. This feature is useful when a frontend |
| 12596 | must decode several protocols on a unique port, one of them being HTTP. |
| 12597 | |
Bertrand Jacquin | 702d44f | 2013-11-19 11:43:06 +0100 | [diff] [blame] | 12598 | When <backend> is a simple name, it is resolved at configuration time, and an |
| 12599 | error is reported if the specified backend does not exist. If <backend> is |
| 12600 | a log-format string instead, no check may be done at configuration time, so |
| 12601 | the backend name is resolved dynamically at run time. If the resulting |
| 12602 | backend name does not correspond to any valid backend, no other rule is |
| 12603 | evaluated, and the default_backend directive is applied instead. Note that |
| 12604 | when using dynamic backend names, it is highly recommended to use a prefix |
| 12605 | that no other backend uses in order to ensure that an unauthorized backend |
| 12606 | cannot be forced from the request. |
| 12607 | |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 12608 | It is worth mentioning that "use_backend" rules with an explicit name are |
Bertrand Jacquin | 702d44f | 2013-11-19 11:43:06 +0100 | [diff] [blame] | 12609 | used to detect the association between frontends and backends to compute the |
| 12610 | backend's "fullconn" setting. This cannot be done for dynamic names. |
| 12611 | |
| 12612 | See also: "default_backend", "tcp-request", "fullconn", "log-format", and |
| 12613 | section 7 about ACLs. |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 12614 | |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 12615 | use-fcgi-app <name> |
| 12616 | Defines the FastCGI application to use for the backend. |
| 12617 | May be used in sections : defaults | frontend | listen | backend |
| 12618 | no | no | yes | yes |
| 12619 | Arguments : |
| 12620 | <name> is the name of the FastCGI application to use. |
| 12621 | |
| 12622 | See section 10.1 about FastCGI application setup for details. |
Willy Tarreau | 036fae0 | 2008-01-06 13:24:40 +0100 | [diff] [blame] | 12623 | |
Willy Tarreau | 4a5cade | 2012-04-05 21:09:48 +0200 | [diff] [blame] | 12624 | use-server <server> if <condition> |
| 12625 | use-server <server> unless <condition> |
| 12626 | Only use a specific server if/unless an ACL-based condition is matched. |
| 12627 | May be used in sections : defaults | frontend | listen | backend |
| 12628 | no | no | yes | yes |
| 12629 | Arguments : |
Jerome Magnin | 824186b | 2020-03-29 09:37:12 +0200 | [diff] [blame] | 12630 | <server> is the name of a valid server in the same backend section |
| 12631 | or a "log-format" string resolving to a server name. |
Willy Tarreau | 4a5cade | 2012-04-05 21:09:48 +0200 | [diff] [blame] | 12632 | |
| 12633 | <condition> is a condition composed of ACLs, as described in section 7. |
| 12634 | |
| 12635 | By default, connections which arrive to a backend are load-balanced across |
| 12636 | the available servers according to the configured algorithm, unless a |
| 12637 | persistence mechanism such as a cookie is used and found in the request. |
| 12638 | |
| 12639 | Sometimes it is desirable to forward a particular request to a specific |
| 12640 | server without having to declare a dedicated backend for this server. This |
| 12641 | can be achieved using the "use-server" rules. These rules are evaluated after |
| 12642 | the "redirect" rules and before evaluating cookies, and they have precedence |
| 12643 | on them. There may be as many "use-server" rules as desired. All of these |
| 12644 | rules are evaluated in their declaration order, and the first one which |
| 12645 | matches will assign the server. |
| 12646 | |
| 12647 | If a rule designates a server which is down, and "option persist" is not used |
| 12648 | and no force-persist rule was validated, it is ignored and evaluation goes on |
| 12649 | with the next rules until one matches. |
| 12650 | |
| 12651 | In the first form, the server will be used if the condition is met. In the |
| 12652 | second form, the server will be used if the condition is not met. If no |
| 12653 | condition is valid, the processing continues and the server will be assigned |
| 12654 | according to other persistence mechanisms. |
| 12655 | |
| 12656 | Note that even if a rule is matched, cookie processing is still performed but |
| 12657 | does not assign the server. This allows prefixed cookies to have their prefix |
| 12658 | stripped. |
| 12659 | |
| 12660 | The "use-server" statement works both in HTTP and TCP mode. This makes it |
| 12661 | suitable for use with content-based inspection. For instance, a server could |
Lukas Tribus | a267b5d | 2020-07-19 00:25:06 +0200 | [diff] [blame] | 12662 | be selected in a farm according to the TLS SNI field when using protocols with |
| 12663 | implicit TLS (also see "req_ssl_sni"). And if these servers have their weight |
| 12664 | set to zero, they will not be used for other traffic. |
Willy Tarreau | 4a5cade | 2012-04-05 21:09:48 +0200 | [diff] [blame] | 12665 | |
| 12666 | Example : |
| 12667 | # intercept incoming TLS requests based on the SNI field |
| 12668 | use-server www if { req_ssl_sni -i www.example.com } |
| 12669 | server www 192.168.0.1:443 weight 0 |
| 12670 | use-server mail if { req_ssl_sni -i mail.example.com } |
Lukas Tribus | a267b5d | 2020-07-19 00:25:06 +0200 | [diff] [blame] | 12671 | server mail 192.168.0.1:465 weight 0 |
Willy Tarreau | 4a5cade | 2012-04-05 21:09:48 +0200 | [diff] [blame] | 12672 | use-server imap if { req_ssl_sni -i imap.example.com } |
Lukas Tribus | 98a3e3f | 2017-03-26 12:55:35 +0000 | [diff] [blame] | 12673 | server imap 192.168.0.1:993 weight 0 |
Willy Tarreau | 4a5cade | 2012-04-05 21:09:48 +0200 | [diff] [blame] | 12674 | # all the rest is forwarded to this server |
| 12675 | server default 192.168.0.2:443 check |
| 12676 | |
Jerome Magnin | 824186b | 2020-03-29 09:37:12 +0200 | [diff] [blame] | 12677 | When <server> is a simple name, it is checked against existing servers in the |
| 12678 | configuration and an error is reported if the specified server does not exist. |
| 12679 | If it is a log-format, no check is performed when parsing the configuration, |
| 12680 | and if we can't resolve a valid server name at runtime but the use-server rule |
Ilya Shipitsin | 11057a3 | 2020-06-21 21:18:27 +0500 | [diff] [blame] | 12681 | was conditioned by an ACL returning true, no other use-server rule is applied |
Jerome Magnin | 824186b | 2020-03-29 09:37:12 +0200 | [diff] [blame] | 12682 | and we fall back to load balancing. |
| 12683 | |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 12684 | See also: "use_backend", section 5 about server and section 7 about ACLs. |
Willy Tarreau | 4a5cade | 2012-04-05 21:09:48 +0200 | [diff] [blame] | 12685 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12686 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12687 | 5. Bind and server options |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12688 | -------------------------- |
| 12689 | |
| 12690 | The "bind", "server" and "default-server" keywords support a number of settings |
| 12691 | depending on some build options and on the system HAProxy was built on. These |
| 12692 | settings generally each consist in one word sometimes followed by a value, |
| 12693 | written on the same line as the "bind" or "server" line. All these options are |
| 12694 | described in this section. |
| 12695 | |
| 12696 | |
| 12697 | 5.1. Bind options |
| 12698 | ----------------- |
| 12699 | |
| 12700 | The "bind" keyword supports a certain number of settings which are all passed |
| 12701 | as arguments on the same line. The order in which those arguments appear makes |
| 12702 | no importance, provided that they appear after the bind address. All of these |
| 12703 | parameters are optional. Some of them consist in a single words (booleans), |
| 12704 | while other ones expect a value after them. In this case, the value must be |
| 12705 | provided immediately after the setting name. |
| 12706 | |
| 12707 | The currently supported settings are the following ones. |
| 12708 | |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 12709 | accept-netscaler-cip <magic number> |
| 12710 | Enforces the use of the NetScaler Client IP insertion protocol over any |
| 12711 | connection accepted by any of the TCP sockets declared on the same line. The |
| 12712 | NetScaler Client IP insertion protocol dictates the layer 3/4 addresses of |
| 12713 | the incoming connection to be used everywhere an address is used, with the |
| 12714 | only exception of "tcp-request connection" rules which will only see the |
| 12715 | real connection address. Logs will reflect the addresses indicated in the |
| 12716 | protocol, unless it is violated, in which case the real address will still |
| 12717 | be used. This keyword combined with support from external components can be |
| 12718 | used as an efficient and reliable alternative to the X-Forwarded-For |
Bertrand Jacquin | 9075968 | 2016-06-06 15:35:39 +0100 | [diff] [blame] | 12719 | mechanism which is not always reliable and not even always usable. See also |
| 12720 | "tcp-request connection expect-netscaler-cip" for a finer-grained setting of |
| 12721 | which client is allowed to use the protocol. |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 12722 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12723 | accept-proxy |
| 12724 | Enforces the use of the PROXY protocol over any connection accepted by any of |
Willy Tarreau | 7799267 | 2014-06-14 11:06:17 +0200 | [diff] [blame] | 12725 | the sockets declared on the same line. Versions 1 and 2 of the PROXY protocol |
| 12726 | are supported and correctly detected. The PROXY protocol dictates the layer |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12727 | 3/4 addresses of the incoming connection to be used everywhere an address is |
| 12728 | used, with the only exception of "tcp-request connection" rules which will |
| 12729 | only see the real connection address. Logs will reflect the addresses |
| 12730 | indicated in the protocol, unless it is violated, in which case the real |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12731 | address will still be used. This keyword combined with support from external |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12732 | components can be used as an efficient and reliable alternative to the |
| 12733 | X-Forwarded-For mechanism which is not always reliable and not even always |
Willy Tarreau | 4f0d919 | 2013-06-11 20:40:55 +0200 | [diff] [blame] | 12734 | usable. See also "tcp-request connection expect-proxy" for a finer-grained |
| 12735 | setting of which client is allowed to use the protocol. |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12736 | |
Olivier Houchard | c2aae74 | 2017-09-22 18:26:28 +0200 | [diff] [blame] | 12737 | allow-0rtt |
Bertrand Jacquin | a25282b | 2018-08-14 00:56:13 +0100 | [diff] [blame] | 12738 | Allow receiving early data when using TLSv1.3. This is disabled by default, |
Olivier Houchard | 6975296 | 2019-01-08 15:35:32 +0100 | [diff] [blame] | 12739 | due to security considerations. Because it is vulnerable to replay attacks, |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 12740 | you should only allow if for requests that are safe to replay, i.e. requests |
Olivier Houchard | 6975296 | 2019-01-08 15:35:32 +0100 | [diff] [blame] | 12741 | that are idempotent. You can use the "wait-for-handshake" action for any |
| 12742 | request that wouldn't be safe with early data. |
Olivier Houchard | c2aae74 | 2017-09-22 18:26:28 +0200 | [diff] [blame] | 12743 | |
Willy Tarreau | ab861d3 | 2013-04-02 02:30:41 +0200 | [diff] [blame] | 12744 | alpn <protocols> |
| 12745 | This enables the TLS ALPN extension and advertises the specified protocol |
| 12746 | list as supported on top of ALPN. The protocol list consists in a comma- |
| 12747 | delimited list of protocol names, for instance: "http/1.1,http/1.0" (without |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 12748 | quotes). This requires that the SSL library is built with support for TLS |
Willy Tarreau | ab861d3 | 2013-04-02 02:30:41 +0200 | [diff] [blame] | 12749 | extensions enabled (check with haproxy -vv). The ALPN extension replaces the |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 12750 | initial NPN extension. ALPN is required to enable HTTP/2 on an HTTP frontend. |
| 12751 | Versions of OpenSSL prior to 1.0.2 didn't support ALPN and only supposed the |
| 12752 | now obsolete NPN extension. At the time of writing this, most browsers still |
| 12753 | support both ALPN and NPN for HTTP/2 so a fallback to NPN may still work for |
| 12754 | a while. But ALPN must be used whenever possible. If both HTTP/2 and HTTP/1.1 |
| 12755 | are expected to be supported, both versions can be advertised, in order of |
| 12756 | preference, like below : |
| 12757 | |
| 12758 | bind :443 ssl crt pub.pem alpn h2,http/1.1 |
Willy Tarreau | ab861d3 | 2013-04-02 02:30:41 +0200 | [diff] [blame] | 12759 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12760 | backlog <backlog> |
Willy Tarreau | e2711c7 | 2019-02-27 15:39:41 +0100 | [diff] [blame] | 12761 | Sets the socket's backlog to this value. If unspecified or 0, the frontend's |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12762 | backlog is used instead, which generally defaults to the maxconn value. |
| 12763 | |
Emmanuel Hocdet | e7f2b73 | 2017-01-09 16:15:54 +0100 | [diff] [blame] | 12764 | curves <curves> |
| 12765 | This setting is only available when support for OpenSSL was built in. It sets |
| 12766 | the string describing the list of elliptic curves algorithms ("curve suite") |
| 12767 | that are negotiated during the SSL/TLS handshake with ECDHE. The format of the |
| 12768 | string is a colon-delimited list of curve name. |
| 12769 | Example: "X25519:P-256" (without quote) |
| 12770 | When "curves" is set, "ecdhe" parameter is ignored. |
| 12771 | |
Emeric Brun | 7fb3442 | 2012-09-28 15:26:15 +0200 | [diff] [blame] | 12772 | ecdhe <named curve> |
| 12773 | This setting is only available when support for OpenSSL was built in. It sets |
Emeric Brun | 6924ef8 | 2013-03-06 14:08:53 +0100 | [diff] [blame] | 12774 | the named curve (RFC 4492) used to generate ECDH ephemeral keys. By default, |
| 12775 | used named curve is prime256v1. |
Emeric Brun | 7fb3442 | 2012-09-28 15:26:15 +0200 | [diff] [blame] | 12776 | |
Emeric Brun | fd33a26 | 2012-10-11 16:28:27 +0200 | [diff] [blame] | 12777 | ca-file <cafile> |
Emeric Brun | 1a073b4 | 2012-09-28 17:07:34 +0200 | [diff] [blame] | 12778 | This setting is only available when support for OpenSSL was built in. It |
| 12779 | designates a PEM file from which to load CA certificates used to verify |
| 12780 | client's certificate. |
| 12781 | |
Emeric Brun | b6dc934 | 2012-09-28 17:55:37 +0200 | [diff] [blame] | 12782 | ca-ignore-err [all|<errorID>,...] |
| 12783 | This setting is only available when support for OpenSSL was built in. |
| 12784 | Sets a comma separated list of errorIDs to ignore during verify at depth > 0. |
| 12785 | If set to 'all', all errors are ignored. SSL handshake is not aborted if an |
| 12786 | error is ignored. |
| 12787 | |
Christopher Faulet | 31af49d | 2015-06-09 17:29:50 +0200 | [diff] [blame] | 12788 | ca-sign-file <cafile> |
| 12789 | This setting is only available when support for OpenSSL was built in. It |
| 12790 | designates a PEM file containing both the CA certificate and the CA private |
| 12791 | key used to create and sign server's certificates. This is a mandatory |
| 12792 | setting when the dynamic generation of certificates is enabled. See |
| 12793 | 'generate-certificates' for details. |
| 12794 | |
Bertrand Jacquin | d4d0a23 | 2016-11-13 16:37:12 +0000 | [diff] [blame] | 12795 | ca-sign-pass <passphrase> |
Christopher Faulet | 31af49d | 2015-06-09 17:29:50 +0200 | [diff] [blame] | 12796 | This setting is only available when support for OpenSSL was built in. It is |
| 12797 | the CA private key passphrase. This setting is optional and used only when |
| 12798 | the dynamic generation of certificates is enabled. See |
| 12799 | 'generate-certificates' for details. |
| 12800 | |
Emmanuel Hocdet | 842e94e | 2019-12-16 16:39:17 +0100 | [diff] [blame] | 12801 | ca-verify-file <cafile> |
| 12802 | This setting designates a PEM file from which to load CA certificates used to |
| 12803 | verify client's certificate. It designates CA certificates which must not be |
| 12804 | included in CA names sent in server hello message. Typically, "ca-file" must |
| 12805 | be defined with intermediate certificates, and "ca-verify-file" with |
| 12806 | certificates to ending the chain, like root CA. |
| 12807 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12808 | ciphers <ciphers> |
| 12809 | This setting is only available when support for OpenSSL was built in. It sets |
| 12810 | the string describing the list of cipher algorithms ("cipher suite") that are |
Bertrand Jacquin | 8cf7c1e | 2019-02-03 18:35:25 +0000 | [diff] [blame] | 12811 | negotiated during the SSL/TLS handshake up to TLSv1.2. The format of the |
Bertrand Jacquin | 4f03ab0 | 2019-02-03 18:48:49 +0000 | [diff] [blame] | 12812 | string is defined in "man 1 ciphers" from OpenSSL man pages. For background |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 12813 | information and recommendations see e.g. |
| 12814 | (https://wiki.mozilla.org/Security/Server_Side_TLS) and |
| 12815 | (https://mozilla.github.io/server-side-tls/ssl-config-generator/). For TLSv1.3 |
| 12816 | cipher configuration, please check the "ciphersuites" keyword. |
| 12817 | |
| 12818 | ciphersuites <ciphersuites> |
| 12819 | This setting is only available when support for OpenSSL was built in and |
| 12820 | OpenSSL 1.1.1 or later was used to build HAProxy. It sets the string describing |
| 12821 | the list of cipher algorithms ("cipher suite") that are negotiated during the |
| 12822 | TLSv1.3 handshake. The format of the string is defined in "man 1 ciphers" from |
Bertrand Jacquin | 4f03ab0 | 2019-02-03 18:48:49 +0000 | [diff] [blame] | 12823 | OpenSSL man pages under the "ciphersuites" section. For cipher configuration |
| 12824 | for TLSv1.2 and earlier, please check the "ciphers" keyword. |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12825 | |
Emeric Brun | fd33a26 | 2012-10-11 16:28:27 +0200 | [diff] [blame] | 12826 | crl-file <crlfile> |
Emeric Brun | 1a073b4 | 2012-09-28 17:07:34 +0200 | [diff] [blame] | 12827 | This setting is only available when support for OpenSSL was built in. It |
| 12828 | designates a PEM file from which to load certificate revocation list used |
| 12829 | to verify client's certificate. |
| 12830 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12831 | crt <cert> |
Alex Davies | 0fbf016 | 2013-03-02 16:04:50 +0000 | [diff] [blame] | 12832 | This setting is only available when support for OpenSSL was built in. It |
| 12833 | designates a PEM file containing both the required certificates and any |
| 12834 | associated private keys. This file can be built by concatenating multiple |
| 12835 | PEM files into one (e.g. cat cert.pem key.pem > combined.pem). If your CA |
| 12836 | requires an intermediate certificate, this can also be concatenated into this |
Emmanuel Hocdet | 70df7bf | 2019-01-04 11:08:20 +0100 | [diff] [blame] | 12837 | file. Intermediate certificate can also be shared in a directory via |
| 12838 | "issuers-chain-path" directive. |
Alex Davies | 0fbf016 | 2013-03-02 16:04:50 +0000 | [diff] [blame] | 12839 | |
William Lallemand | 4c5adbf | 2020-02-24 14:23:22 +0100 | [diff] [blame] | 12840 | If the file does not contain a private key, HAProxy will try to load |
| 12841 | the key at the same path suffixed by a ".key". |
| 12842 | |
Alex Davies | 0fbf016 | 2013-03-02 16:04:50 +0000 | [diff] [blame] | 12843 | If the OpenSSL used supports Diffie-Hellman, parameters present in this file |
| 12844 | are loaded. |
| 12845 | |
| 12846 | If a directory name is used instead of a PEM file, then all files found in |
William Lallemand | 3f25ae3 | 2020-02-24 16:30:12 +0100 | [diff] [blame] | 12847 | that directory will be loaded in alphabetic order unless their name ends |
| 12848 | with '.key', '.issuer', '.ocsp' or '.sctl' (reserved extensions). This |
| 12849 | directive may be specified multiple times in order to load certificates from |
| 12850 | multiple files or directories. The certificates will be presented to clients |
| 12851 | who provide a valid TLS Server Name Indication field matching one of their |
| 12852 | CN or alt subjects. Wildcards are supported, where a wildcard character '*' |
| 12853 | is used instead of the first hostname component (e.g. *.example.org matches |
Janusz Dziemidowicz | 2c701b5 | 2015-03-07 23:03:59 +0100 | [diff] [blame] | 12854 | www.example.org but not www.sub.example.org). |
Alex Davies | 0fbf016 | 2013-03-02 16:04:50 +0000 | [diff] [blame] | 12855 | |
| 12856 | If no SNI is provided by the client or if the SSL library does not support |
| 12857 | TLS extensions, or if the client provides an SNI hostname which does not |
| 12858 | match any certificate, then the first loaded certificate will be presented. |
| 12859 | This means that when loading certificates from a directory, it is highly |
Cyril Bonté | 3180f7b | 2015-01-25 00:16:08 +0100 | [diff] [blame] | 12860 | recommended to load the default one first as a file or to ensure that it will |
| 12861 | always be the first one in the directory. |
Alex Davies | 0fbf016 | 2013-03-02 16:04:50 +0000 | [diff] [blame] | 12862 | |
Emeric Brun | e032bfa | 2012-09-28 13:01:45 +0200 | [diff] [blame] | 12863 | Note that the same cert may be loaded multiple times without side effects. |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12864 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12865 | Some CAs (such as GoDaddy) offer a drop down list of server types that do not |
Alex Davies | 0fbf016 | 2013-03-02 16:04:50 +0000 | [diff] [blame] | 12866 | include HAProxy when obtaining a certificate. If this happens be sure to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12867 | choose a web server that the CA believes requires an intermediate CA (for |
| 12868 | GoDaddy, selection Apache Tomcat will get the correct bundle, but many |
Alex Davies | 0fbf016 | 2013-03-02 16:04:50 +0000 | [diff] [blame] | 12869 | others, e.g. nginx, result in a wrong bundle that will not work for some |
| 12870 | clients). |
| 12871 | |
Emeric Brun | 4147b2e | 2014-06-16 18:36:30 +0200 | [diff] [blame] | 12872 | For each PEM file, haproxy checks for the presence of file at the same path |
| 12873 | suffixed by ".ocsp". If such file is found, support for the TLS Certificate |
| 12874 | Status Request extension (also known as "OCSP stapling") is automatically |
| 12875 | enabled. The content of this file is optional. If not empty, it must contain |
| 12876 | a valid OCSP Response in DER format. In order to be valid an OCSP Response |
| 12877 | must comply with the following rules: it has to indicate a good status, |
| 12878 | it has to be a single response for the certificate of the PEM file, and it |
| 12879 | has to be valid at the moment of addition. If these rules are not respected |
| 12880 | the OCSP Response is ignored and a warning is emitted. In order to identify |
| 12881 | which certificate an OCSP Response applies to, the issuer's certificate is |
| 12882 | necessary. If the issuer's certificate is not found in the PEM file, it will |
| 12883 | be loaded from a file at the same path as the PEM file suffixed by ".issuer" |
| 12884 | if it exists otherwise it will fail with an error. |
| 12885 | |
Janusz Dziemidowicz | 2c701b5 | 2015-03-07 23:03:59 +0100 | [diff] [blame] | 12886 | For each PEM file, haproxy also checks for the presence of file at the same |
| 12887 | path suffixed by ".sctl". If such file is found, support for Certificate |
| 12888 | Transparency (RFC6962) TLS extension is enabled. The file must contain a |
| 12889 | valid Signed Certificate Timestamp List, as described in RFC. File is parsed |
| 12890 | to check basic syntax, but no signatures are verified. |
| 12891 | |
yanbzhu | 6c25e9e | 2016-01-05 12:52:02 -0500 | [diff] [blame] | 12892 | There are cases where it is desirable to support multiple key types, e.g. RSA |
| 12893 | and ECDSA in the cipher suites offered to the clients. This allows clients |
| 12894 | that support EC certificates to be able to use EC ciphers, while |
| 12895 | simultaneously supporting older, RSA only clients. |
yanbzhu | d19630c | 2015-12-14 15:10:25 -0500 | [diff] [blame] | 12896 | |
William Lallemand | f9ff3ec | 2020-10-02 17:57:44 +0200 | [diff] [blame] | 12897 | To achieve this, OpenSSL 1.1.1 is required, you can configure this behavior |
| 12898 | by providing one crt entry per certificate type, or by configuring a "cert |
| 12899 | bundle" like it was required before HAProxy 1.8. See "ssl-load-extra-files". |
yanbzhu | d19630c | 2015-12-14 15:10:25 -0500 | [diff] [blame] | 12900 | |
Emeric Brun | b6dc934 | 2012-09-28 17:55:37 +0200 | [diff] [blame] | 12901 | crt-ignore-err <errors> |
Alex Davies | 0fbf016 | 2013-03-02 16:04:50 +0000 | [diff] [blame] | 12902 | This setting is only available when support for OpenSSL was built in. Sets a |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12903 | comma separated list of errorIDs to ignore during verify at depth == 0. If |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 12904 | set to 'all', all errors are ignored. SSL handshake is not aborted if an error |
Alex Davies | 0fbf016 | 2013-03-02 16:04:50 +0000 | [diff] [blame] | 12905 | is ignored. |
Emeric Brun | b6dc934 | 2012-09-28 17:55:37 +0200 | [diff] [blame] | 12906 | |
Emmanuel Hocdet | fe61656 | 2013-01-22 15:31:15 +0100 | [diff] [blame] | 12907 | crt-list <file> |
| 12908 | This setting is only available when support for OpenSSL was built in. It |
Emmanuel Hocdet | 9826329 | 2016-12-29 18:26:15 +0100 | [diff] [blame] | 12909 | designates a list of PEM file with an optional ssl configuration and a SNI |
| 12910 | filter per certificate, with the following format for each line : |
Emmanuel Hocdet | fe61656 | 2013-01-22 15:31:15 +0100 | [diff] [blame] | 12911 | |
Emmanuel Hocdet | 9826329 | 2016-12-29 18:26:15 +0100 | [diff] [blame] | 12912 | <crtfile> [\[<sslbindconf> ...\]] [[!]<snifilter> ...] |
| 12913 | |
William Lallemand | 5d03639 | 2020-06-30 16:11:36 +0200 | [diff] [blame] | 12914 | sslbindconf supports "allow-0rtt", "alpn", "ca-file", "ca-verify-file", |
| 12915 | "ciphers", "ciphersuites", "crl-file", "curves", "ecdhe", "no-ca-names", |
| 12916 | "npn", "verify" configuration. With BoringSSL and Openssl >= 1.1.1 |
| 12917 | "ssl-min-ver" and "ssl-max-ver" are also supported. It overrides the |
| 12918 | configuration set in bind line for the certificate. |
Emmanuel Hocdet | fe61656 | 2013-01-22 15:31:15 +0100 | [diff] [blame] | 12919 | |
Emmanuel Hocdet | 7c41a1b | 2013-05-07 20:20:06 +0200 | [diff] [blame] | 12920 | Wildcards are supported in the SNI filter. Negative filter are also supported, |
Joao Morais | e51fab0 | 2020-11-21 07:42:20 -0300 | [diff] [blame] | 12921 | useful in combination with a wildcard filter to exclude a particular SNI, or |
| 12922 | after the first certificate to exclude a pattern from its CN or Subject Alt |
| 12923 | Name (SAN). The certificates will be presented to clients who provide a valid |
| 12924 | TLS Server Name Indication field matching one of the SNI filters. If no SNI |
| 12925 | filter is specified, the CN and SAN are used. This directive may be specified |
Emmanuel Hocdet | 7c41a1b | 2013-05-07 20:20:06 +0200 | [diff] [blame] | 12926 | multiple times. See the "crt" option for more information. The default |
| 12927 | certificate is still needed to meet OpenSSL expectations. If it is not used, |
| 12928 | the 'strict-sni' option may be used. |
Emmanuel Hocdet | fe61656 | 2013-01-22 15:31:15 +0100 | [diff] [blame] | 12929 | |
William Lallemand | f9ff3ec | 2020-10-02 17:57:44 +0200 | [diff] [blame] | 12930 | Multi-cert bundling (see "ssl-load-extra-files") is supported with crt-list, |
| 12931 | as long as only the base name is given in the crt-list. SNI filter will do |
| 12932 | the same work on all bundled certificates. |
yanbzhu | d19630c | 2015-12-14 15:10:25 -0500 | [diff] [blame] | 12933 | |
William Lallemand | 7c26ed7 | 2020-06-03 17:34:48 +0200 | [diff] [blame] | 12934 | Empty lines as well as lines beginning with a hash ('#') will be ignored. |
| 12935 | |
Joao Morais | aa8fcc4 | 2020-11-24 08:24:30 -0300 | [diff] [blame] | 12936 | The first declared certificate of a bind line is used as the default |
| 12937 | certificate, either from crt or crt-list option, which haproxy should use in |
| 12938 | the TLS handshake if no other certificate matches. This certificate will also |
| 12939 | be used if the provided SNI matches its CN or SAN, even if a matching SNI |
| 12940 | filter is found on any crt-list. The SNI filter !* can be used after the first |
| 12941 | declared certificate to not include its CN and SAN in the SNI tree, so it will |
| 12942 | never match except if no other certificate matches. This way the first |
| 12943 | declared certificate act as a fallback. |
Joao Morais | e51fab0 | 2020-11-21 07:42:20 -0300 | [diff] [blame] | 12944 | |
Emmanuel Hocdet | 9826329 | 2016-12-29 18:26:15 +0100 | [diff] [blame] | 12945 | crt-list file example: |
Joao Morais | e51fab0 | 2020-11-21 07:42:20 -0300 | [diff] [blame] | 12946 | cert1.pem !* |
William Lallemand | 7c26ed7 | 2020-06-03 17:34:48 +0200 | [diff] [blame] | 12947 | # comment |
Emmanuel Hocdet | 0594211 | 2017-02-20 16:11:50 +0100 | [diff] [blame] | 12948 | cert2.pem [alpn h2,http/1.1] |
Emmanuel Hocdet | 9826329 | 2016-12-29 18:26:15 +0100 | [diff] [blame] | 12949 | certW.pem *.domain.tld !secure.domain.tld |
Emmanuel Hocdet | 0594211 | 2017-02-20 16:11:50 +0100 | [diff] [blame] | 12950 | certS.pem [curves X25519:P-256 ciphers ECDHE-ECDSA-AES256-GCM-SHA384] secure.domain.tld |
Emmanuel Hocdet | 9826329 | 2016-12-29 18:26:15 +0100 | [diff] [blame] | 12951 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12952 | defer-accept |
| 12953 | Is an optional keyword which is supported only on certain Linux kernels. It |
| 12954 | states that a connection will only be accepted once some data arrive on it, |
| 12955 | or at worst after the first retransmit. This should be used only on protocols |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12956 | for which the client talks first (e.g. HTTP). It can slightly improve |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 12957 | performance by ensuring that most of the request is already available when |
| 12958 | the connection is accepted. On the other hand, it will not be able to detect |
| 12959 | connections which don't talk. It is important to note that this option is |
| 12960 | broken in all kernels up to 2.6.31, as the connection is never accepted until |
| 12961 | the client talks. This can cause issues with front firewalls which would see |
| 12962 | an established connection while the proxy will only see it in SYN_RECV. This |
| 12963 | option is only supported on TCPv4/TCPv6 sockets and ignored by other ones. |
| 12964 | |
William Lallemand | f6975e9 | 2017-05-26 17:42:10 +0200 | [diff] [blame] | 12965 | expose-fd listeners |
| 12966 | This option is only usable with the stats socket. It gives your stats socket |
| 12967 | the capability to pass listeners FD to another HAProxy process. |
William Lallemand | e202b1e | 2017-06-01 17:38:56 +0200 | [diff] [blame] | 12968 | During a reload with the master-worker mode, the process is automatically |
| 12969 | reexecuted adding -x and one of the stats socket with this option. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 12970 | See also "-x" in the management guide. |
William Lallemand | f6975e9 | 2017-05-26 17:42:10 +0200 | [diff] [blame] | 12971 | |
Emeric Brun | 2cb7ae5 | 2012-10-05 14:14:21 +0200 | [diff] [blame] | 12972 | force-sslv3 |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 12973 | This option enforces use of SSLv3 only on SSL connections instantiated from |
Emeric Brun | 2cb7ae5 | 2012-10-05 14:14:21 +0200 | [diff] [blame] | 12974 | this listener. SSLv3 is generally less expensive than the TLS counterparts |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 12975 | for high connection rates. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 12976 | "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver". |
Emeric Brun | 2cb7ae5 | 2012-10-05 14:14:21 +0200 | [diff] [blame] | 12977 | |
| 12978 | force-tlsv10 |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 12979 | This option enforces use of TLSv1.0 only on SSL connections instantiated from |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 12980 | this listener. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 12981 | "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver". |
Emeric Brun | 2cb7ae5 | 2012-10-05 14:14:21 +0200 | [diff] [blame] | 12982 | |
| 12983 | force-tlsv11 |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 12984 | This option enforces use of TLSv1.1 only on SSL connections instantiated from |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 12985 | this listener. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 12986 | "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver". |
Emeric Brun | 2cb7ae5 | 2012-10-05 14:14:21 +0200 | [diff] [blame] | 12987 | |
| 12988 | force-tlsv12 |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 12989 | This option enforces use of TLSv1.2 only on SSL connections instantiated from |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 12990 | this listener. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 12991 | "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver". |
Emeric Brun | 2cb7ae5 | 2012-10-05 14:14:21 +0200 | [diff] [blame] | 12992 | |
Emmanuel Hocdet | 42fb980 | 2017-03-30 19:29:39 +0200 | [diff] [blame] | 12993 | force-tlsv13 |
| 12994 | This option enforces use of TLSv1.3 only on SSL connections instantiated from |
| 12995 | this listener. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 12996 | "ssl-default-bind-options". See also "ssl-min-ver" and "ssl-max-ver". |
Emmanuel Hocdet | 42fb980 | 2017-03-30 19:29:39 +0200 | [diff] [blame] | 12997 | |
Christopher Faulet | 31af49d | 2015-06-09 17:29:50 +0200 | [diff] [blame] | 12998 | generate-certificates |
| 12999 | This setting is only available when support for OpenSSL was built in. It |
| 13000 | enables the dynamic SSL certificates generation. A CA certificate and its |
| 13001 | private key are necessary (see 'ca-sign-file'). When HAProxy is configured as |
| 13002 | a transparent forward proxy, SSL requests generate errors because of a common |
| 13003 | name mismatch on the certificate presented to the client. With this option |
| 13004 | enabled, HAProxy will try to forge a certificate using the SNI hostname |
| 13005 | indicated by the client. This is done only if no certificate matches the SNI |
| 13006 | hostname (see 'crt-list'). If an error occurs, the default certificate is |
| 13007 | used, else the 'strict-sni' option is set. |
| 13008 | It can also be used when HAProxy is configured as a reverse proxy to ease the |
| 13009 | deployment of an architecture with many backends. |
| 13010 | |
| 13011 | Creating a SSL certificate is an expensive operation, so a LRU cache is used |
| 13012 | to store forged certificates (see 'tune.ssl.ssl-ctx-cache-size'). It |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13013 | increases the HAProxy's memory footprint to reduce latency when the same |
Christopher Faulet | 31af49d | 2015-06-09 17:29:50 +0200 | [diff] [blame] | 13014 | certificate is used many times. |
| 13015 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13016 | gid <gid> |
| 13017 | Sets the group of the UNIX sockets to the designated system gid. It can also |
| 13018 | be set by default in the global section's "unix-bind" statement. Note that |
| 13019 | some platforms simply ignore this. This setting is equivalent to the "group" |
| 13020 | setting except that the group ID is used instead of its name. This setting is |
| 13021 | ignored by non UNIX sockets. |
| 13022 | |
| 13023 | group <group> |
| 13024 | Sets the group of the UNIX sockets to the designated system group. It can |
| 13025 | also be set by default in the global section's "unix-bind" statement. Note |
| 13026 | that some platforms simply ignore this. This setting is equivalent to the |
| 13027 | "gid" setting except that the group name is used instead of its gid. This |
| 13028 | setting is ignored by non UNIX sockets. |
| 13029 | |
| 13030 | id <id> |
| 13031 | Fixes the socket ID. By default, socket IDs are automatically assigned, but |
| 13032 | sometimes it is more convenient to fix them to ease monitoring. This value |
| 13033 | must be strictly positive and unique within the listener/frontend. This |
| 13034 | option can only be used when defining only a single socket. |
| 13035 | |
| 13036 | interface <interface> |
Lukas Tribus | fce2e96 | 2013-02-12 22:13:19 +0100 | [diff] [blame] | 13037 | Restricts the socket to a specific interface. When specified, only packets |
| 13038 | received from that particular interface are processed by the socket. This is |
| 13039 | currently only supported on Linux. The interface must be a primary system |
| 13040 | interface, not an aliased interface. It is also possible to bind multiple |
| 13041 | frontends to the same address if they are bound to different interfaces. Note |
| 13042 | that binding to a network interface requires root privileges. This parameter |
Jérôme Magnin | 6127519 | 2018-02-07 11:39:58 +0100 | [diff] [blame] | 13043 | is only compatible with TCPv4/TCPv6 sockets. When specified, return traffic |
| 13044 | uses the same interface as inbound traffic, and its associated routing table, |
| 13045 | even if there are explicit routes through different interfaces configured. |
| 13046 | This can prove useful to address asymmetric routing issues when the same |
| 13047 | client IP addresses need to be able to reach frontends hosted on different |
| 13048 | interfaces. |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13049 | |
Willy Tarreau | abb175f | 2012-09-24 12:43:26 +0200 | [diff] [blame] | 13050 | level <level> |
| 13051 | This setting is used with the stats sockets only to restrict the nature of |
| 13052 | the commands that can be issued on the socket. It is ignored by other |
| 13053 | sockets. <level> can be one of : |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13054 | - "user" is the least privileged level; only non-sensitive stats can be |
Willy Tarreau | abb175f | 2012-09-24 12:43:26 +0200 | [diff] [blame] | 13055 | read, and no change is allowed. It would make sense on systems where it |
| 13056 | is not easy to restrict access to the socket. |
| 13057 | - "operator" is the default level and fits most common uses. All data can |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13058 | be read, and only non-sensitive changes are permitted (e.g. clear max |
Willy Tarreau | abb175f | 2012-09-24 12:43:26 +0200 | [diff] [blame] | 13059 | counters). |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13060 | - "admin" should be used with care, as everything is permitted (e.g. clear |
Willy Tarreau | abb175f | 2012-09-24 12:43:26 +0200 | [diff] [blame] | 13061 | all counters). |
| 13062 | |
Andjelko Iharos | c4df59e | 2017-07-20 11:59:48 +0200 | [diff] [blame] | 13063 | severity-output <format> |
| 13064 | This setting is used with the stats sockets only to configure severity |
| 13065 | level output prepended to informational feedback messages. Severity |
| 13066 | level of messages can range between 0 and 7, conforming to syslog |
| 13067 | rfc5424. Valid and successful socket commands requesting data |
| 13068 | (i.e. "show map", "get acl foo" etc.) will never have a severity level |
| 13069 | prepended. It is ignored by other sockets. <format> can be one of : |
| 13070 | - "none" (default) no severity level is prepended to feedback messages. |
| 13071 | - "number" severity level is prepended as a number. |
| 13072 | - "string" severity level is prepended as a string following the |
| 13073 | rfc5424 convention. |
| 13074 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13075 | maxconn <maxconn> |
| 13076 | Limits the sockets to this number of concurrent connections. Extraneous |
| 13077 | connections will remain in the system's backlog until a connection is |
| 13078 | released. If unspecified, the limit will be the same as the frontend's |
| 13079 | maxconn. Note that in case of port ranges or multiple addresses, the same |
| 13080 | value will be applied to each socket. This setting enables different |
| 13081 | limitations on expensive sockets, for instance SSL entries which may easily |
| 13082 | eat all memory. |
| 13083 | |
| 13084 | mode <mode> |
| 13085 | Sets the octal mode used to define access permissions on the UNIX socket. It |
| 13086 | can also be set by default in the global section's "unix-bind" statement. |
| 13087 | Note that some platforms simply ignore this. This setting is ignored by non |
| 13088 | UNIX sockets. |
| 13089 | |
| 13090 | mss <maxseg> |
| 13091 | Sets the TCP Maximum Segment Size (MSS) value to be advertised on incoming |
| 13092 | connections. This can be used to force a lower MSS for certain specific |
| 13093 | ports, for instance for connections passing through a VPN. Note that this |
| 13094 | relies on a kernel feature which is theoretically supported under Linux but |
| 13095 | was buggy in all versions prior to 2.6.28. It may or may not work on other |
| 13096 | operating systems. It may also not change the advertised value but change the |
| 13097 | effective size of outgoing segments. The commonly advertised value for TCPv4 |
| 13098 | over Ethernet networks is 1460 = 1500(MTU) - 40(IP+TCP). If this value is |
| 13099 | positive, it will be used as the advertised MSS. If it is negative, it will |
| 13100 | indicate by how much to reduce the incoming connection's advertised MSS for |
| 13101 | outgoing segments. This parameter is only compatible with TCP v4/v6 sockets. |
| 13102 | |
| 13103 | name <name> |
| 13104 | Sets an optional name for these sockets, which will be reported on the stats |
| 13105 | page. |
| 13106 | |
Willy Tarreau | d72f0f3 | 2015-10-13 14:50:22 +0200 | [diff] [blame] | 13107 | namespace <name> |
| 13108 | On Linux, it is possible to specify which network namespace a socket will |
| 13109 | belong to. This directive makes it possible to explicitly bind a listener to |
| 13110 | a namespace different from the default one. Please refer to your operating |
| 13111 | system's documentation to find more details about network namespaces. |
| 13112 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13113 | nice <nice> |
| 13114 | Sets the 'niceness' of connections initiated from the socket. Value must be |
| 13115 | in the range -1024..1024 inclusive, and defaults to zero. Positive values |
| 13116 | means that such connections are more friendly to others and easily offer |
| 13117 | their place in the scheduler. On the opposite, negative values mean that |
| 13118 | connections want to run with a higher priority than others. The difference |
| 13119 | only happens under high loads when the system is close to saturation. |
| 13120 | Negative values are appropriate for low-latency or administration services, |
| 13121 | and high values are generally recommended for CPU intensive tasks such as SSL |
| 13122 | processing or bulk transfers which are less sensible to latency. For example, |
| 13123 | it may make sense to use a positive value for an SMTP socket and a negative |
| 13124 | one for an RDP socket. |
| 13125 | |
Emmanuel Hocdet | 174dfe5 | 2017-07-28 15:01:05 +0200 | [diff] [blame] | 13126 | no-ca-names |
| 13127 | This setting is only available when support for OpenSSL was built in. It |
| 13128 | prevents from send CA names in server hello message when ca-file is used. |
Emmanuel Hocdet | 842e94e | 2019-12-16 16:39:17 +0100 | [diff] [blame] | 13129 | Use "ca-verify-file" instead of "ca-file" with "no-ca-names". |
Emmanuel Hocdet | 174dfe5 | 2017-07-28 15:01:05 +0200 | [diff] [blame] | 13130 | |
Emeric Brun | 9b3009b | 2012-10-05 11:55:06 +0200 | [diff] [blame] | 13131 | no-sslv3 |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13132 | This setting is only available when support for OpenSSL was built in. It |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 13133 | disables support for SSLv3 on any sockets instantiated from the listener when |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13134 | SSL is supported. Note that SSLv2 is forced disabled in the code and cannot |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13135 | be enabled using any configuration option. This option is also available on |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13136 | global statement "ssl-default-bind-options". Use "ssl-min-ver" and |
| 13137 | "ssl-max-ver" instead. |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13138 | |
Emeric Brun | 90ad872 | 2012-10-02 14:00:59 +0200 | [diff] [blame] | 13139 | no-tls-tickets |
| 13140 | This setting is only available when support for OpenSSL was built in. It |
| 13141 | disables the stateless session resumption (RFC 5077 TLS Ticket |
| 13142 | extension) and force to use stateful session resumption. Stateless |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13143 | session resumption is more expensive in CPU usage. This option is also |
| 13144 | available on global statement "ssl-default-bind-options". |
Lukas Tribus | bdb386d | 2020-03-10 00:56:09 +0100 | [diff] [blame] | 13145 | The TLS ticket mechanism is only used up to TLS 1.2. |
| 13146 | Forward Secrecy is compromised with TLS tickets, unless ticket keys |
| 13147 | are periodically rotated (via reload or by using "tls-ticket-keys"). |
Emeric Brun | 90ad872 | 2012-10-02 14:00:59 +0200 | [diff] [blame] | 13148 | |
Emeric Brun | 9b3009b | 2012-10-05 11:55:06 +0200 | [diff] [blame] | 13149 | no-tlsv10 |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13150 | This setting is only available when support for OpenSSL was built in. It |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 13151 | disables support for TLSv1.0 on any sockets instantiated from the listener |
Emeric Brun | 2cb7ae5 | 2012-10-05 14:14:21 +0200 | [diff] [blame] | 13152 | when SSL is supported. Note that SSLv2 is forced disabled in the code and |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13153 | cannot be enabled using any configuration option. This option is also |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13154 | available on global statement "ssl-default-bind-options". Use "ssl-min-ver" |
| 13155 | and "ssl-max-ver" instead. |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13156 | |
Emeric Brun | 9b3009b | 2012-10-05 11:55:06 +0200 | [diff] [blame] | 13157 | no-tlsv11 |
Emeric Brun | f5da493 | 2012-09-28 19:42:54 +0200 | [diff] [blame] | 13158 | This setting is only available when support for OpenSSL was built in. It |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 13159 | disables support for TLSv1.1 on any sockets instantiated from the listener |
Emeric Brun | 2cb7ae5 | 2012-10-05 14:14:21 +0200 | [diff] [blame] | 13160 | when SSL is supported. Note that SSLv2 is forced disabled in the code and |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13161 | cannot be enabled using any configuration option. This option is also |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13162 | available on global statement "ssl-default-bind-options". Use "ssl-min-ver" |
| 13163 | and "ssl-max-ver" instead. |
Emeric Brun | f5da493 | 2012-09-28 19:42:54 +0200 | [diff] [blame] | 13164 | |
Emeric Brun | 9b3009b | 2012-10-05 11:55:06 +0200 | [diff] [blame] | 13165 | no-tlsv12 |
Emeric Brun | f5da493 | 2012-09-28 19:42:54 +0200 | [diff] [blame] | 13166 | This setting is only available when support for OpenSSL was built in. It |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 13167 | disables support for TLSv1.2 on any sockets instantiated from the listener |
Emeric Brun | 2cb7ae5 | 2012-10-05 14:14:21 +0200 | [diff] [blame] | 13168 | when SSL is supported. Note that SSLv2 is forced disabled in the code and |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13169 | cannot be enabled using any configuration option. This option is also |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13170 | available on global statement "ssl-default-bind-options". Use "ssl-min-ver" |
| 13171 | and "ssl-max-ver" instead. |
Emeric Brun | f5da493 | 2012-09-28 19:42:54 +0200 | [diff] [blame] | 13172 | |
Emmanuel Hocdet | 42fb980 | 2017-03-30 19:29:39 +0200 | [diff] [blame] | 13173 | no-tlsv13 |
| 13174 | This setting is only available when support for OpenSSL was built in. It |
| 13175 | disables support for TLSv1.3 on any sockets instantiated from the listener |
| 13176 | when SSL is supported. Note that SSLv2 is forced disabled in the code and |
| 13177 | cannot be enabled using any configuration option. This option is also |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13178 | available on global statement "ssl-default-bind-options". Use "ssl-min-ver" |
| 13179 | and "ssl-max-ver" instead. |
Emmanuel Hocdet | 42fb980 | 2017-03-30 19:29:39 +0200 | [diff] [blame] | 13180 | |
Willy Tarreau | 6c9a3d5 | 2012-10-18 18:57:14 +0200 | [diff] [blame] | 13181 | npn <protocols> |
| 13182 | This enables the NPN TLS extension and advertises the specified protocol list |
| 13183 | as supported on top of NPN. The protocol list consists in a comma-delimited |
| 13184 | list of protocol names, for instance: "http/1.1,http/1.0" (without quotes). |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 13185 | This requires that the SSL library is built with support for TLS extensions |
Willy Tarreau | ab861d3 | 2013-04-02 02:30:41 +0200 | [diff] [blame] | 13186 | enabled (check with haproxy -vv). Note that the NPN extension has been |
Willy Tarreau | 95c4e14 | 2017-11-26 12:18:55 +0100 | [diff] [blame] | 13187 | replaced with the ALPN extension (see the "alpn" keyword), though this one is |
| 13188 | only available starting with OpenSSL 1.0.2. If HTTP/2 is desired on an older |
| 13189 | version of OpenSSL, NPN might still be used as most clients still support it |
| 13190 | at the time of writing this. It is possible to enable both NPN and ALPN |
| 13191 | though it probably doesn't make any sense out of testing. |
Willy Tarreau | 6c9a3d5 | 2012-10-18 18:57:14 +0200 | [diff] [blame] | 13192 | |
Lukas Tribus | 53ae85c | 2017-05-04 15:45:40 +0000 | [diff] [blame] | 13193 | prefer-client-ciphers |
| 13194 | Use the client's preference when selecting the cipher suite, by default |
| 13195 | the server's preference is enforced. This option is also available on |
| 13196 | global statement "ssl-default-bind-options". |
Lukas Tribus | 926594f | 2018-05-18 17:55:57 +0200 | [diff] [blame] | 13197 | Note that with OpenSSL >= 1.1.1 ChaCha20-Poly1305 is reprioritized anyway |
| 13198 | (without setting this option), if a ChaCha20-Poly1305 cipher is at the top of |
| 13199 | the client cipher list. |
Lukas Tribus | 53ae85c | 2017-05-04 15:45:40 +0000 | [diff] [blame] | 13200 | |
Christopher Faulet | c644fa9 | 2017-11-23 22:44:11 +0100 | [diff] [blame] | 13201 | process <process-set>[/<thread-set>] |
Willy Tarreau | a36b324 | 2019-02-02 13:14:34 +0100 | [diff] [blame] | 13202 | This restricts the list of processes or threads on which this listener is |
Christopher Faulet | c644fa9 | 2017-11-23 22:44:11 +0100 | [diff] [blame] | 13203 | allowed to run. It does not enforce any process but eliminates those which do |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13204 | not match. If the frontend uses a "bind-process" setting, the intersection |
Christopher Faulet | c644fa9 | 2017-11-23 22:44:11 +0100 | [diff] [blame] | 13205 | between the two is applied. If in the end the listener is not allowed to run |
| 13206 | on any remaining process, a warning is emitted, and the listener will either |
| 13207 | run on the first process of the listener if a single process was specified, |
| 13208 | or on all of its processes if multiple processes were specified. If a thread |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13209 | set is specified, it limits the threads allowed to process incoming |
Willy Tarreau | a36b324 | 2019-02-02 13:14:34 +0100 | [diff] [blame] | 13210 | connections for this listener, for the the process set. If multiple processes |
| 13211 | and threads are configured, a warning is emitted, as it either results from a |
| 13212 | configuration error or a misunderstanding of these models. For the unlikely |
| 13213 | case where several ranges are needed, this directive may be repeated. |
| 13214 | <process-set> and <thread-set> must use the format |
Christopher Faulet | c644fa9 | 2017-11-23 22:44:11 +0100 | [diff] [blame] | 13215 | |
| 13216 | all | odd | even | number[-[number]] |
| 13217 | |
| 13218 | Ranges can be partially defined. The higher bound can be omitted. In such |
| 13219 | case, it is replaced by the corresponding maximum value. The main purpose of |
| 13220 | this directive is to be used with the stats sockets and have one different |
| 13221 | socket per process. The second purpose is to have multiple bind lines sharing |
| 13222 | the same IP:port but not the same process in a listener, so that the system |
| 13223 | can distribute the incoming connections into multiple queues and allow a |
| 13224 | smoother inter-process load balancing. Currently Linux 3.9 and above is known |
| 13225 | for supporting this. See also "bind-process" and "nbproc". |
Willy Tarreau | 6ae1ba6 | 2014-05-07 19:01:58 +0200 | [diff] [blame] | 13226 | |
Christopher Faulet | a717b99 | 2018-04-10 14:43:00 +0200 | [diff] [blame] | 13227 | proto <name> |
| 13228 | Forces the multiplexer's protocol to use for the incoming connections. It |
| 13229 | must be compatible with the mode of the frontend (TCP or HTTP). It must also |
| 13230 | be usable on the frontend side. The list of available protocols is reported |
| 13231 | in haproxy -vv. |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 13232 | Idea behind this option is to bypass the selection of the best multiplexer's |
Christopher Faulet | a717b99 | 2018-04-10 14:43:00 +0200 | [diff] [blame] | 13233 | protocol for all connections instantiated from this listening socket. For |
Joseph Herlant | 71b4b15 | 2018-11-13 16:55:16 -0800 | [diff] [blame] | 13234 | instance, it is possible to force the http/2 on clear TCP by specifying "proto |
Christopher Faulet | a717b99 | 2018-04-10 14:43:00 +0200 | [diff] [blame] | 13235 | h2" on the bind line. |
| 13236 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13237 | ssl |
| 13238 | This setting is only available when support for OpenSSL was built in. It |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 13239 | enables SSL deciphering on connections instantiated from this listener. A |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13240 | certificate is necessary (see "crt" above). All contents in the buffers will |
| 13241 | appear in clear text, so that ACLs and HTTP processing will only have access |
Emmanuel Hocdet | bd695fe | 2017-05-15 15:53:41 +0200 | [diff] [blame] | 13242 | to deciphered contents. SSLv3 is disabled per default, use "ssl-min-ver SSLv3" |
| 13243 | to enable it. |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13244 | |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13245 | ssl-max-ver [ SSLv3 | TLSv1.0 | TLSv1.1 | TLSv1.2 | TLSv1.3 ] |
| 13246 | This option enforces use of <version> or lower on SSL connections instantiated |
William Lallemand | 50df1cb | 2020-06-02 10:52:24 +0200 | [diff] [blame] | 13247 | from this listener. Using this setting without "ssl-min-ver" can be |
| 13248 | ambiguous because the default ssl-min-ver value could change in future HAProxy |
| 13249 | versions. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13250 | "ssl-default-bind-options". See also "ssl-min-ver". |
| 13251 | |
| 13252 | ssl-min-ver [ SSLv3 | TLSv1.0 | TLSv1.1 | TLSv1.2 | TLSv1.3 ] |
William Lallemand | 50df1cb | 2020-06-02 10:52:24 +0200 | [diff] [blame] | 13253 | This option enforces use of <version> or upper on SSL connections |
| 13254 | instantiated from this listener. The default value is "TLSv1.2". This option |
| 13255 | is also available on global statement "ssl-default-bind-options". |
| 13256 | See also "ssl-max-ver". |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13257 | |
Emmanuel Hocdet | 6562337 | 2013-01-24 17:17:15 +0100 | [diff] [blame] | 13258 | strict-sni |
| 13259 | This setting is only available when support for OpenSSL was built in. The |
| 13260 | SSL/TLS negotiation is allow only if the client provided an SNI which match |
| 13261 | a certificate. The default certificate is not used. |
| 13262 | See the "crt" option for more information. |
| 13263 | |
Willy Tarreau | 2af207a | 2015-02-04 00:45:58 +0100 | [diff] [blame] | 13264 | tcp-ut <delay> |
Tim Düsterhus | 4896c44 | 2016-11-29 02:15:19 +0100 | [diff] [blame] | 13265 | Sets the TCP User Timeout for all incoming connections instantiated from this |
Willy Tarreau | 2af207a | 2015-02-04 00:45:58 +0100 | [diff] [blame] | 13266 | listening socket. This option is available on Linux since version 2.6.37. It |
| 13267 | allows haproxy to configure a timeout for sockets which contain data not |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13268 | receiving an acknowledgment for the configured delay. This is especially |
Willy Tarreau | 2af207a | 2015-02-04 00:45:58 +0100 | [diff] [blame] | 13269 | useful on long-lived connections experiencing long idle periods such as |
| 13270 | remote terminals or database connection pools, where the client and server |
| 13271 | timeouts must remain high to allow a long period of idle, but where it is |
| 13272 | important to detect that the client has disappeared in order to release all |
| 13273 | resources associated with its connection (and the server's session). The |
| 13274 | argument is a delay expressed in milliseconds by default. This only works |
| 13275 | for regular TCP connections, and is ignored for other protocols. |
| 13276 | |
Willy Tarreau | 1c862c5 | 2012-10-05 16:21:00 +0200 | [diff] [blame] | 13277 | tfo |
Lukas Tribus | 0defb90 | 2013-02-13 23:35:39 +0100 | [diff] [blame] | 13278 | Is an optional keyword which is supported only on Linux kernels >= 3.7. It |
Willy Tarreau | 1c862c5 | 2012-10-05 16:21:00 +0200 | [diff] [blame] | 13279 | enables TCP Fast Open on the listening socket, which means that clients which |
| 13280 | support this feature will be able to send a request and receive a response |
| 13281 | during the 3-way handshake starting from second connection, thus saving one |
| 13282 | round-trip after the first connection. This only makes sense with protocols |
| 13283 | that use high connection rates and where each round trip matters. This can |
| 13284 | possibly cause issues with many firewalls which do not accept data on SYN |
| 13285 | packets, so this option should only be enabled once well tested. This option |
Lukas Tribus | 0999f76 | 2013-04-02 16:43:24 +0200 | [diff] [blame] | 13286 | is only supported on TCPv4/TCPv6 sockets and ignored by other ones. You may |
| 13287 | need to build HAProxy with USE_TFO=1 if your libc doesn't define |
| 13288 | TCP_FASTOPEN. |
Willy Tarreau | 1c862c5 | 2012-10-05 16:21:00 +0200 | [diff] [blame] | 13289 | |
Nenad Merdanovic | 188ad3e | 2015-02-27 19:56:50 +0100 | [diff] [blame] | 13290 | tls-ticket-keys <keyfile> |
| 13291 | Sets the TLS ticket keys file to load the keys from. The keys need to be 48 |
Emeric Brun | 9e75477 | 2019-01-10 17:51:55 +0100 | [diff] [blame] | 13292 | or 80 bytes long, depending if aes128 or aes256 is used, encoded with base64 |
| 13293 | with one line per key (ex. openssl rand 80 | openssl base64 -A | xargs echo). |
| 13294 | The first key determines the key length used for next keys: you can't mix |
| 13295 | aes128 and aes256 keys. Number of keys is specified by the TLS_TICKETS_NO |
| 13296 | build option (default 3) and at least as many keys need to be present in |
| 13297 | the file. Last TLS_TICKETS_NO keys will be used for decryption and the |
| 13298 | penultimate one for encryption. This enables easy key rotation by just |
| 13299 | appending new key to the file and reloading the process. Keys must be |
| 13300 | periodically rotated (ex. every 12h) or Perfect Forward Secrecy is |
| 13301 | compromised. It is also a good idea to keep the keys off any permanent |
Nenad Merdanovic | 188ad3e | 2015-02-27 19:56:50 +0100 | [diff] [blame] | 13302 | storage such as hard drives (hint: use tmpfs and don't swap those files). |
| 13303 | Lifetime hint can be changed using tune.ssl.timeout. |
| 13304 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13305 | transparent |
| 13306 | Is an optional keyword which is supported only on certain Linux kernels. It |
| 13307 | indicates that the addresses will be bound even if they do not belong to the |
| 13308 | local machine, and that packets targeting any of these addresses will be |
| 13309 | intercepted just as if the addresses were locally configured. This normally |
| 13310 | requires that IP forwarding is enabled. Caution! do not use this with the |
| 13311 | default address '*', as it would redirect any traffic for the specified port. |
| 13312 | This keyword is available only when HAProxy is built with USE_LINUX_TPROXY=1. |
| 13313 | This parameter is only compatible with TCPv4 and TCPv6 sockets, depending on |
| 13314 | kernel version. Some distribution kernels include backports of the feature, |
| 13315 | so check for support with your vendor. |
| 13316 | |
Willy Tarreau | 77e3af9 | 2012-11-24 15:07:23 +0100 | [diff] [blame] | 13317 | v4v6 |
| 13318 | Is an optional keyword which is supported only on most recent systems |
| 13319 | including Linux kernels >= 2.4.21. It is used to bind a socket to both IPv4 |
| 13320 | and IPv6 when it uses the default address. Doing so is sometimes necessary |
| 13321 | on systems which bind to IPv6 only by default. It has no effect on non-IPv6 |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 13322 | sockets, and is overridden by the "v6only" option. |
Willy Tarreau | 77e3af9 | 2012-11-24 15:07:23 +0100 | [diff] [blame] | 13323 | |
Willy Tarreau | 9b6700f | 2012-11-24 11:55:28 +0100 | [diff] [blame] | 13324 | v6only |
| 13325 | Is an optional keyword which is supported only on most recent systems |
| 13326 | including Linux kernels >= 2.4.21. It is used to bind a socket to IPv6 only |
| 13327 | when it uses the default address. Doing so is sometimes preferred to doing it |
Willy Tarreau | 77e3af9 | 2012-11-24 15:07:23 +0100 | [diff] [blame] | 13328 | system-wide as it is per-listener. It has no effect on non-IPv6 sockets and |
| 13329 | has precedence over the "v4v6" option. |
Willy Tarreau | 9b6700f | 2012-11-24 11:55:28 +0100 | [diff] [blame] | 13330 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13331 | uid <uid> |
| 13332 | Sets the owner of the UNIX sockets to the designated system uid. It can also |
| 13333 | be set by default in the global section's "unix-bind" statement. Note that |
| 13334 | some platforms simply ignore this. This setting is equivalent to the "user" |
| 13335 | setting except that the user numeric ID is used instead of its name. This |
| 13336 | setting is ignored by non UNIX sockets. |
| 13337 | |
| 13338 | user <user> |
| 13339 | Sets the owner of the UNIX sockets to the designated system user. It can also |
| 13340 | be set by default in the global section's "unix-bind" statement. Note that |
| 13341 | some platforms simply ignore this. This setting is equivalent to the "uid" |
| 13342 | setting except that the user name is used instead of its uid. This setting is |
| 13343 | ignored by non UNIX sockets. |
| 13344 | |
Emeric Brun | 1a073b4 | 2012-09-28 17:07:34 +0200 | [diff] [blame] | 13345 | verify [none|optional|required] |
| 13346 | This setting is only available when support for OpenSSL was built in. If set |
| 13347 | to 'none', client certificate is not requested. This is the default. In other |
| 13348 | cases, a client certificate is requested. If the client does not provide a |
| 13349 | certificate after the request and if 'verify' is set to 'required', then the |
| 13350 | handshake is aborted, while it would have succeeded if set to 'optional'. The |
Emeric Brun | fd33a26 | 2012-10-11 16:28:27 +0200 | [diff] [blame] | 13351 | certificate provided by the client is always verified using CAs from |
| 13352 | 'ca-file' and optional CRLs from 'crl-file'. On verify failure the handshake |
| 13353 | is aborted, regardless of the 'verify' option, unless the error code exactly |
| 13354 | matches one of those listed with 'ca-ignore-err' or 'crt-ignore-err'. |
Willy Tarreau | 4a5cade | 2012-04-05 21:09:48 +0200 | [diff] [blame] | 13355 | |
Willy Tarreau | b6205fd | 2012-09-24 12:27:33 +0200 | [diff] [blame] | 13356 | 5.2. Server and default-server options |
Cyril Bonté | f0c6061 | 2010-02-06 14:44:47 +0100 | [diff] [blame] | 13357 | ------------------------------------ |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 13358 | |
Krzysztof Piotr Oledzki | c6df066 | 2010-01-05 16:38:49 +0100 | [diff] [blame] | 13359 | The "server" and "default-server" keywords support a certain number of settings |
| 13360 | which are all passed as arguments on the server line. The order in which those |
| 13361 | arguments appear does not count, and they are all optional. Some of those |
| 13362 | settings are single words (booleans) while others expect one or several values |
| 13363 | after them. In this case, the values must immediately follow the setting name. |
| 13364 | Except default-server, all those settings must be specified after the server's |
| 13365 | address if they are used: |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 13366 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13367 | server <name> <address>[:port] [settings ...] |
Krzysztof Piotr Oledzki | c6df066 | 2010-01-05 16:38:49 +0100 | [diff] [blame] | 13368 | default-server [settings ...] |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 13369 | |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13370 | Note that all these settings are supported both by "server" and "default-server" |
| 13371 | keywords, except "id" which is only supported by "server". |
| 13372 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13373 | The currently supported settings are the following ones. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 13374 | |
Willy Tarreau | ceb4ac9 | 2012-04-28 00:41:46 +0200 | [diff] [blame] | 13375 | addr <ipv4|ipv6> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13376 | Using the "addr" parameter, it becomes possible to use a different IP address |
Baptiste Assmann | 13f8353 | 2016-03-06 23:14:36 +0100 | [diff] [blame] | 13377 | to send health-checks or to probe the agent-check. On some servers, it may be |
| 13378 | desirable to dedicate an IP address to specific component able to perform |
| 13379 | complex tests which are more suitable to health-checks than the application. |
| 13380 | This parameter is ignored if the "check" parameter is not set. See also the |
| 13381 | "port" parameter. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 13382 | |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13383 | agent-check |
| 13384 | Enable an auxiliary agent check which is run independently of a regular |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13385 | health check. An agent health check is performed by making a TCP connection |
Willy Tarreau | 7a0139e | 2018-12-16 08:42:56 +0100 | [diff] [blame] | 13386 | to the port set by the "agent-port" parameter and reading an ASCII string |
| 13387 | terminated by the first '\r' or '\n' met. The string is made of a series of |
| 13388 | words delimited by spaces, tabs or commas in any order, each consisting of : |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13389 | |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13390 | - An ASCII representation of a positive integer percentage, e.g. "75%". |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13391 | Values in this format will set the weight proportional to the initial |
Willy Tarreau | c5af3a6 | 2014-10-07 15:27:33 +0200 | [diff] [blame] | 13392 | weight of a server as configured when haproxy starts. Note that a zero |
| 13393 | weight is reported on the stats page as "DRAIN" since it has the same |
| 13394 | effect on the server (it's removed from the LB farm). |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13395 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13396 | - The string "maxconn:" followed by an integer (no space between). Values |
| 13397 | in this format will set the maxconn of a server. The maximum number of |
| 13398 | connections advertised needs to be multiplied by the number of load |
| 13399 | balancers and different backends that use this health check to get the |
| 13400 | total number of connections the server might receive. Example: maxconn:30 |
Nenad Merdanovic | 174dd37 | 2016-04-24 23:10:06 +0200 | [diff] [blame] | 13401 | |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13402 | - The word "ready". This will turn the server's administrative state to the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13403 | READY mode, thus canceling any DRAIN or MAINT state |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13404 | |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13405 | - The word "drain". This will turn the server's administrative state to the |
| 13406 | DRAIN mode, thus it will not accept any new connections other than those |
| 13407 | that are accepted via persistence. |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13408 | |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13409 | - The word "maint". This will turn the server's administrative state to the |
| 13410 | MAINT mode, thus it will not accept any new connections at all, and health |
| 13411 | checks will be stopped. |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13412 | |
William Dauchy | f8e795c | 2020-09-26 13:35:51 +0200 | [diff] [blame] | 13413 | - The words "down", "fail", or "stopped", optionally followed by a |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13414 | description string after a sharp ('#'). All of these mark the server's |
| 13415 | operating state as DOWN, but since the word itself is reported on the stats |
| 13416 | page, the difference allows an administrator to know if the situation was |
| 13417 | expected or not : the service may intentionally be stopped, may appear up |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13418 | but fail some validity tests, or may be seen as down (e.g. missing process, |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13419 | or port not responding). |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13420 | |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13421 | - The word "up" sets back the server's operating state as UP if health checks |
| 13422 | also report that the service is accessible. |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13423 | |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13424 | Parameters which are not advertised by the agent are not changed. For |
| 13425 | example, an agent might be designed to monitor CPU usage and only report a |
| 13426 | relative weight and never interact with the operating status. Similarly, an |
| 13427 | agent could be designed as an end-user interface with 3 radio buttons |
| 13428 | allowing an administrator to change only the administrative state. However, |
| 13429 | it is important to consider that only the agent may revert its own actions, |
| 13430 | so if a server is set to DRAIN mode or to DOWN state using the agent, the |
| 13431 | agent must implement the other equivalent actions to bring the service into |
| 13432 | operations again. |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13433 | |
Simon Horman | 2f1f955 | 2013-11-25 10:46:37 +0900 | [diff] [blame] | 13434 | Failure to connect to the agent is not considered an error as connectivity |
| 13435 | is tested by the regular health check which is enabled by the "check" |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13436 | parameter. Warning though, it is not a good idea to stop an agent after it |
| 13437 | reports "down", since only an agent reporting "up" will be able to turn the |
| 13438 | server up again. Note that the CLI on the Unix stats socket is also able to |
Willy Tarreau | 989222a | 2016-01-15 10:26:26 +0100 | [diff] [blame] | 13439 | force an agent's result in order to work around a bogus agent if needed. |
Simon Horman | 2f1f955 | 2013-11-25 10:46:37 +0900 | [diff] [blame] | 13440 | |
Willy Tarreau | 81f5d94 | 2013-12-09 20:51:51 +0100 | [diff] [blame] | 13441 | Requires the "agent-port" parameter to be set. See also the "agent-inter" |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13442 | and "no-agent-check" parameters. |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13443 | |
James Brown | 55f9ff1 | 2015-10-21 18:19:05 -0700 | [diff] [blame] | 13444 | agent-send <string> |
| 13445 | If this option is specified, haproxy will send the given string (verbatim) |
| 13446 | to the agent server upon connection. You could, for example, encode |
| 13447 | the backend name into this string, which would enable your agent to send |
| 13448 | different responses based on the backend. Make sure to include a '\n' if |
| 13449 | you want to terminate your request with a newline. |
| 13450 | |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13451 | agent-inter <delay> |
| 13452 | The "agent-inter" parameter sets the interval between two agent checks |
| 13453 | to <delay> milliseconds. If left unspecified, the delay defaults to 2000 ms. |
| 13454 | |
| 13455 | Just as with every other time-based parameter, it may be entered in any |
| 13456 | other explicit unit among { us, ms, s, m, h, d }. The "agent-inter" |
| 13457 | parameter also serves as a timeout for agent checks "timeout check" is |
| 13458 | not set. In order to reduce "resonance" effects when multiple servers are |
| 13459 | hosted on the same hardware, the agent and health checks of all servers |
| 13460 | are started with a small time offset between them. It is also possible to |
| 13461 | add some random noise in the agent and health checks interval using the |
| 13462 | global "spread-checks" keyword. This makes sense for instance when a lot |
| 13463 | of backends use the same servers. |
| 13464 | |
| 13465 | See also the "agent-check" and "agent-port" parameters. |
| 13466 | |
Misiek | 768d860 | 2017-01-09 09:52:43 +0100 | [diff] [blame] | 13467 | agent-addr <addr> |
| 13468 | The "agent-addr" parameter sets address for agent check. |
| 13469 | |
| 13470 | You can offload agent-check to another target, so you can make single place |
| 13471 | managing status and weights of servers defined in haproxy in case you can't |
| 13472 | make self-aware and self-managing services. You can specify both IP or |
| 13473 | hostname, it will be resolved. |
| 13474 | |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13475 | agent-port <port> |
| 13476 | The "agent-port" parameter sets the TCP port used for agent checks. |
| 13477 | |
| 13478 | See also the "agent-check" and "agent-inter" parameters. |
| 13479 | |
Olivier Houchard | 8cb2d2e | 2019-05-06 18:58:48 +0200 | [diff] [blame] | 13480 | allow-0rtt |
| 13481 | Allow sending early data to the server when using TLS 1.3. |
Olivier Houchard | 22c9b44 | 2019-05-06 19:01:04 +0200 | [diff] [blame] | 13482 | Note that early data will be sent only if the client used early data, or |
| 13483 | if the backend uses "retry-on" with the "0rtt-rejected" keyword. |
Olivier Houchard | 8cb2d2e | 2019-05-06 18:58:48 +0200 | [diff] [blame] | 13484 | |
Olivier Houchard | c756600 | 2018-11-20 23:33:50 +0100 | [diff] [blame] | 13485 | alpn <protocols> |
| 13486 | This enables the TLS ALPN extension and advertises the specified protocol |
| 13487 | list as supported on top of ALPN. The protocol list consists in a comma- |
| 13488 | delimited list of protocol names, for instance: "http/1.1,http/1.0" (without |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 13489 | quotes). This requires that the SSL library is built with support for TLS |
Olivier Houchard | c756600 | 2018-11-20 23:33:50 +0100 | [diff] [blame] | 13490 | extensions enabled (check with haproxy -vv). The ALPN extension replaces the |
| 13491 | initial NPN extension. ALPN is required to connect to HTTP/2 servers. |
| 13492 | Versions of OpenSSL prior to 1.0.2 didn't support ALPN and only supposed the |
| 13493 | now obsolete NPN extension. |
| 13494 | If both HTTP/2 and HTTP/1.1 are expected to be supported, both versions can |
| 13495 | be advertised, in order of preference, like below : |
| 13496 | |
| 13497 | server 127.0.0.1:443 ssl crt pub.pem alpn h2,http/1.1 |
| 13498 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13499 | backup |
| 13500 | When "backup" is present on a server line, the server is only used in load |
| 13501 | balancing when all other non-backup servers are unavailable. Requests coming |
| 13502 | with a persistence cookie referencing the server will always be served |
| 13503 | though. By default, only the first operational backup server is used, unless |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13504 | the "allbackups" option is set in the backend. See also the "no-backup" and |
| 13505 | "allbackups" options. |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13506 | |
Emeric Brun | ef42d92 | 2012-10-11 16:11:36 +0200 | [diff] [blame] | 13507 | ca-file <cafile> |
| 13508 | This setting is only available when support for OpenSSL was built in. It |
| 13509 | designates a PEM file from which to load CA certificates used to verify |
| 13510 | server's certificate. |
| 13511 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13512 | check |
Jerome Magnin | 90702bc | 2020-04-26 14:23:04 +0200 | [diff] [blame] | 13513 | This option enables health checks on a server: |
| 13514 | - when not set, no health checking is performed, and the server is always |
| 13515 | considered available. |
| 13516 | - when set and no other check method is configured, the server is considered |
| 13517 | available when a connection can be established at the highest configured |
| 13518 | transport layer. This means TCP by default, or SSL/TLS when "ssl" or |
| 13519 | "check-ssl" are set, both possibly combined with connection prefixes such |
| 13520 | as a PROXY protocol header when "send-proxy" or "check-send-proxy" are |
| 13521 | set. |
| 13522 | - when set and an application-level health check is defined, the |
| 13523 | application-level exchanges are performed on top of the configured |
| 13524 | transport layer and the server is considered available if all of the |
| 13525 | exchanges succeed. |
| 13526 | |
| 13527 | By default, health checks are performed on the same address and port as |
| 13528 | configured on the server, using the same encapsulation parameters (SSL/TLS, |
| 13529 | proxy-protocol header, etc... ). It is possible to change the destination |
| 13530 | address using "addr" and the port using "port". When done, it is assumed the |
| 13531 | server isn't checked on the service port, and configured encapsulation |
Ilya Shipitsin | 4329a9a | 2020-05-05 21:17:10 +0500 | [diff] [blame] | 13532 | parameters are not reused. One must explicitly set "check-send-proxy" to send |
Jerome Magnin | 90702bc | 2020-04-26 14:23:04 +0200 | [diff] [blame] | 13533 | connection headers, "check-ssl" to use SSL/TLS. |
| 13534 | |
| 13535 | When "sni" or "alpn" are set on the server line, their value is not used for |
| 13536 | health checks and one must use "check-sni" or "check-alpn". |
| 13537 | |
| 13538 | The default source address for health check traffic is the same as the one |
| 13539 | defined in the backend. It can be changed with the "source" keyword. |
| 13540 | |
| 13541 | The interval between checks can be set using the "inter" keyword, and the |
| 13542 | "rise" and "fall" keywords can be used to define how many successful or |
| 13543 | failed health checks are required to flag a server available or not |
| 13544 | available. |
| 13545 | |
| 13546 | Optional application-level health checks can be configured with "option |
| 13547 | httpchk", "option mysql-check" "option smtpchk", "option pgsql-check", |
| 13548 | "option ldap-check", or "option redis-check". |
| 13549 | |
| 13550 | Example: |
| 13551 | # simple tcp check |
| 13552 | backend foo |
| 13553 | server s1 192.168.0.1:80 check |
| 13554 | # this does a tcp connect + tls handshake |
| 13555 | backend foo |
| 13556 | server s1 192.168.0.1:443 ssl check |
| 13557 | # simple tcp check is enough for check success |
| 13558 | backend foo |
| 13559 | option tcp-check |
| 13560 | tcp-check connect |
| 13561 | server s1 192.168.0.1:443 ssl check |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13562 | |
Willy Tarreau | 6c16adc | 2012-10-05 00:04:16 +0200 | [diff] [blame] | 13563 | check-send-proxy |
| 13564 | This option forces emission of a PROXY protocol line with outgoing health |
| 13565 | checks, regardless of whether the server uses send-proxy or not for the |
| 13566 | normal traffic. By default, the PROXY protocol is enabled for health checks |
| 13567 | if it is already enabled for normal traffic and if no "port" nor "addr" |
| 13568 | directive is present. However, if such a directive is present, the |
| 13569 | "check-send-proxy" option needs to be used to force the use of the |
| 13570 | protocol. See also the "send-proxy" option for more information. |
| 13571 | |
Olivier Houchard | 9215014 | 2018-12-21 19:47:01 +0100 | [diff] [blame] | 13572 | check-alpn <protocols> |
| 13573 | Defines which protocols to advertise with ALPN. The protocol list consists in |
| 13574 | a comma-delimited list of protocol names, for instance: "http/1.1,http/1.0" |
| 13575 | (without quotes). If it is not set, the server ALPN is used. |
| 13576 | |
Christopher Faulet | edc6ed9 | 2020-04-23 16:27:59 +0200 | [diff] [blame] | 13577 | check-proto <name> |
| 13578 | Forces the multiplexer's protocol to use for the server's health-check |
| 13579 | connections. It must be compatible with the health-check type (TCP or |
| 13580 | HTTP). It must also be usable on the backend side. The list of available |
| 13581 | protocols is reported in haproxy -vv. |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 13582 | Idea behind this option is to bypass the selection of the best multiplexer's |
Christopher Faulet | edc6ed9 | 2020-04-23 16:27:59 +0200 | [diff] [blame] | 13583 | protocol for health-check connections established to this server. |
| 13584 | If not defined, the server one will be used, if set. |
| 13585 | |
Jérôme Magnin | ae9bb76 | 2018-12-09 16:08:26 +0100 | [diff] [blame] | 13586 | check-sni <sni> |
Olivier Houchard | 9130a96 | 2017-10-17 17:33:43 +0200 | [diff] [blame] | 13587 | This option allows you to specify the SNI to be used when doing health checks |
Jérôme Magnin | ae9bb76 | 2018-12-09 16:08:26 +0100 | [diff] [blame] | 13588 | over SSL. It is only possible to use a string to set <sni>. If you want to |
| 13589 | set a SNI for proxied traffic, see "sni". |
Olivier Houchard | 9130a96 | 2017-10-17 17:33:43 +0200 | [diff] [blame] | 13590 | |
Willy Tarreau | 763a95b | 2012-10-04 23:15:39 +0200 | [diff] [blame] | 13591 | check-ssl |
| 13592 | This option forces encryption of all health checks over SSL, regardless of |
| 13593 | whether the server uses SSL or not for the normal traffic. This is generally |
| 13594 | used when an explicit "port" or "addr" directive is specified and SSL health |
| 13595 | checks are not inherited. It is important to understand that this option |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 13596 | inserts an SSL transport layer below the checks, so that a simple TCP connect |
Willy Tarreau | 763a95b | 2012-10-04 23:15:39 +0200 | [diff] [blame] | 13597 | check becomes an SSL connect, which replaces the old ssl-hello-chk. The most |
| 13598 | common use is to send HTTPS checks by combining "httpchk" with SSL checks. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13599 | All SSL settings are common to health checks and traffic (e.g. ciphers). |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13600 | See the "ssl" option for more information and "no-check-ssl" to disable |
| 13601 | this option. |
Willy Tarreau | 763a95b | 2012-10-04 23:15:39 +0200 | [diff] [blame] | 13602 | |
Alexander Liu | 2a54bb7 | 2019-05-22 19:44:48 +0800 | [diff] [blame] | 13603 | check-via-socks4 |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 13604 | This option enables outgoing health checks using upstream socks4 proxy. By |
Alexander Liu | 2a54bb7 | 2019-05-22 19:44:48 +0800 | [diff] [blame] | 13605 | default, the health checks won't go through socks tunnel even it was enabled |
| 13606 | for normal traffic. |
| 13607 | |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 13608 | ciphers <ciphers> |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 13609 | This setting is only available when support for OpenSSL was built in. This |
| 13610 | option sets the string describing the list of cipher algorithms that is |
| 13611 | negotiated during the SSL/TLS handshake with the server. The format of the |
Bertrand Jacquin | 4f03ab0 | 2019-02-03 18:48:49 +0000 | [diff] [blame] | 13612 | string is defined in "man 1 ciphers" from OpenSSL man pages. For background |
| 13613 | information and recommendations see e.g. |
| 13614 | (https://wiki.mozilla.org/Security/Server_Side_TLS) and |
| 13615 | (https://mozilla.github.io/server-side-tls/ssl-config-generator/). For TLSv1.3 |
| 13616 | cipher configuration, please check the "ciphersuites" keyword. |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 13617 | |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 13618 | ciphersuites <ciphersuites> |
| 13619 | This setting is only available when support for OpenSSL was built in and |
| 13620 | OpenSSL 1.1.1 or later was used to build HAProxy. This option sets the string |
| 13621 | describing the list of cipher algorithms that is negotiated during the TLS |
| 13622 | 1.3 handshake with the server. The format of the string is defined in |
Bertrand Jacquin | 4f03ab0 | 2019-02-03 18:48:49 +0000 | [diff] [blame] | 13623 | "man 1 ciphers" from OpenSSL man pages under the "ciphersuites" section. |
| 13624 | For cipher configuration for TLSv1.2 and earlier, please check the "ciphers" |
| 13625 | keyword. |
Dirkjan Bussink | 415150f | 2018-09-14 11:14:21 +0200 | [diff] [blame] | 13626 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13627 | cookie <value> |
| 13628 | The "cookie" parameter sets the cookie value assigned to the server to |
| 13629 | <value>. This value will be checked in incoming requests, and the first |
| 13630 | operational server possessing the same value will be selected. In return, in |
| 13631 | cookie insertion or rewrite modes, this value will be assigned to the cookie |
| 13632 | sent to the client. There is nothing wrong in having several servers sharing |
| 13633 | the same cookie value, and it is in fact somewhat common between normal and |
| 13634 | backup servers. See also the "cookie" keyword in backend section. |
| 13635 | |
Emeric Brun | ef42d92 | 2012-10-11 16:11:36 +0200 | [diff] [blame] | 13636 | crl-file <crlfile> |
| 13637 | This setting is only available when support for OpenSSL was built in. It |
| 13638 | designates a PEM file from which to load certificate revocation list used |
| 13639 | to verify server's certificate. |
| 13640 | |
Emeric Brun | a7aa309 | 2012-10-26 12:58:00 +0200 | [diff] [blame] | 13641 | crt <cert> |
| 13642 | This setting is only available when support for OpenSSL was built in. |
| 13643 | It designates a PEM file from which to load both a certificate and the |
| 13644 | associated private key. This file can be built by concatenating both PEM |
| 13645 | files into one. This certificate will be sent if the server send a client |
| 13646 | certificate request. |
| 13647 | |
Willy Tarreau | 9683909 | 2010-03-29 10:02:24 +0200 | [diff] [blame] | 13648 | disabled |
| 13649 | The "disabled" keyword starts the server in the "disabled" state. That means |
| 13650 | that it is marked down in maintenance mode, and no connection other than the |
| 13651 | ones allowed by persist mode will reach it. It is very well suited to setup |
| 13652 | new servers, because normal traffic will never reach them, while it is still |
| 13653 | possible to test the service by making use of the force-persist mechanism. |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13654 | See also "enabled" setting. |
Willy Tarreau | 9683909 | 2010-03-29 10:02:24 +0200 | [diff] [blame] | 13655 | |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13656 | enabled |
| 13657 | This option may be used as 'server' setting to reset any 'disabled' |
| 13658 | setting which would have been inherited from 'default-server' directive as |
| 13659 | default value. |
| 13660 | It may also be used as 'default-server' setting to reset any previous |
| 13661 | 'default-server' 'disabled' setting. |
Willy Tarreau | 9683909 | 2010-03-29 10:02:24 +0200 | [diff] [blame] | 13662 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13663 | error-limit <count> |
Willy Tarreau | 983e01e | 2010-01-11 18:42:06 +0100 | [diff] [blame] | 13664 | If health observing is enabled, the "error-limit" parameter specifies the |
| 13665 | number of consecutive errors that triggers event selected by the "on-error" |
| 13666 | option. By default it is set to 10 consecutive errors. |
Krzysztof Piotr Oledzki | 97f07b8 | 2009-12-15 22:31:24 +0100 | [diff] [blame] | 13667 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13668 | See also the "check", "error-limit" and "on-error". |
Krzysztof Piotr Oledzki | 97f07b8 | 2009-12-15 22:31:24 +0100 | [diff] [blame] | 13669 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13670 | fall <count> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13671 | The "fall" parameter states that a server will be considered as dead after |
| 13672 | <count> consecutive unsuccessful health checks. This value defaults to 3 if |
| 13673 | unspecified. See also the "check", "inter" and "rise" parameters. |
| 13674 | |
Emeric Brun | 8694b9a | 2012-10-05 14:39:07 +0200 | [diff] [blame] | 13675 | force-sslv3 |
| 13676 | This option enforces use of SSLv3 only when SSL is used to communicate with |
| 13677 | the server. SSLv3 is generally less expensive than the TLS counterparts for |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13678 | high connection rates. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13679 | "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver". |
Emeric Brun | 8694b9a | 2012-10-05 14:39:07 +0200 | [diff] [blame] | 13680 | |
| 13681 | force-tlsv10 |
| 13682 | This option enforces use of TLSv1.0 only when SSL is used to communicate with |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13683 | the server. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13684 | "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver". |
Emeric Brun | 8694b9a | 2012-10-05 14:39:07 +0200 | [diff] [blame] | 13685 | |
| 13686 | force-tlsv11 |
| 13687 | This option enforces use of TLSv1.1 only when SSL is used to communicate with |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13688 | the server. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13689 | "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver". |
Emeric Brun | 8694b9a | 2012-10-05 14:39:07 +0200 | [diff] [blame] | 13690 | |
| 13691 | force-tlsv12 |
| 13692 | This option enforces use of TLSv1.2 only when SSL is used to communicate with |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13693 | the server. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13694 | "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver". |
Emeric Brun | 8694b9a | 2012-10-05 14:39:07 +0200 | [diff] [blame] | 13695 | |
Emmanuel Hocdet | 42fb980 | 2017-03-30 19:29:39 +0200 | [diff] [blame] | 13696 | force-tlsv13 |
| 13697 | This option enforces use of TLSv1.3 only when SSL is used to communicate with |
| 13698 | the server. This option is also available on global statement |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13699 | "ssl-default-server-options". See also "ssl-min-ver" and ssl-max-ver". |
Emmanuel Hocdet | 42fb980 | 2017-03-30 19:29:39 +0200 | [diff] [blame] | 13700 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13701 | id <value> |
Willy Tarreau | 53fb4ae | 2009-10-04 23:04:08 +0200 | [diff] [blame] | 13702 | Set a persistent ID for the server. This ID must be positive and unique for |
| 13703 | the proxy. An unused ID will automatically be assigned if unset. The first |
| 13704 | assigned value will be 1. This ID is currently only returned in statistics. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13705 | |
Willy Tarreau | 6a031d1 | 2016-11-07 19:42:35 +0100 | [diff] [blame] | 13706 | init-addr {last | libc | none | <ip>},[...]* |
| 13707 | Indicate in what order the server's address should be resolved upon startup |
| 13708 | if it uses an FQDN. Attempts are made to resolve the address by applying in |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13709 | turn each of the methods mentioned in the comma-delimited list. The first |
Willy Tarreau | 6a031d1 | 2016-11-07 19:42:35 +0100 | [diff] [blame] | 13710 | method which succeeds is used. If the end of the list is reached without |
| 13711 | finding a working method, an error is thrown. Method "last" suggests to pick |
| 13712 | the address which appears in the state file (see "server-state-file"). Method |
| 13713 | "libc" uses the libc's internal resolver (gethostbyname() or getaddrinfo() |
| 13714 | depending on the operating system and build options). Method "none" |
| 13715 | specifically indicates that the server should start without any valid IP |
| 13716 | address in a down state. It can be useful to ignore some DNS issues upon |
| 13717 | startup, waiting for the situation to get fixed later. Finally, an IP address |
| 13718 | (IPv4 or IPv6) may be provided. It can be the currently known address of the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13719 | server (e.g. filled by a configuration generator), or the address of a dummy |
Willy Tarreau | 6a031d1 | 2016-11-07 19:42:35 +0100 | [diff] [blame] | 13720 | server used to catch old sessions and present them with a decent error |
| 13721 | message for example. When the "first" load balancing algorithm is used, this |
| 13722 | IP address could point to a fake server used to trigger the creation of new |
| 13723 | instances on the fly. This option defaults to "last,libc" indicating that the |
| 13724 | previous address found in the state file (if any) is used first, otherwise |
| 13725 | the libc's resolver is used. This ensures continued compatibility with the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 13726 | historic behavior. |
Willy Tarreau | 6a031d1 | 2016-11-07 19:42:35 +0100 | [diff] [blame] | 13727 | |
| 13728 | Example: |
| 13729 | defaults |
| 13730 | # never fail on address resolution |
| 13731 | default-server init-addr last,libc,none |
| 13732 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13733 | inter <delay> |
| 13734 | fastinter <delay> |
| 13735 | downinter <delay> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13736 | The "inter" parameter sets the interval between two consecutive health checks |
| 13737 | to <delay> milliseconds. If left unspecified, the delay defaults to 2000 ms. |
| 13738 | It is also possible to use "fastinter" and "downinter" to optimize delays |
| 13739 | between checks depending on the server state : |
| 13740 | |
Pieter Baauw | 44fc9df | 2015-09-17 21:30:46 +0200 | [diff] [blame] | 13741 | Server state | Interval used |
| 13742 | ----------------------------------------+---------------------------------- |
| 13743 | UP 100% (non-transitional) | "inter" |
| 13744 | ----------------------------------------+---------------------------------- |
| 13745 | Transitionally UP (going down "fall"), | "fastinter" if set, |
| 13746 | Transitionally DOWN (going up "rise"), | "inter" otherwise. |
| 13747 | or yet unchecked. | |
| 13748 | ----------------------------------------+---------------------------------- |
| 13749 | DOWN 100% (non-transitional) | "downinter" if set, |
| 13750 | | "inter" otherwise. |
| 13751 | ----------------------------------------+---------------------------------- |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 13752 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13753 | Just as with every other time-based parameter, they can be entered in any |
| 13754 | other explicit unit among { us, ms, s, m, h, d }. The "inter" parameter also |
| 13755 | serves as a timeout for health checks sent to servers if "timeout check" is |
| 13756 | not set. In order to reduce "resonance" effects when multiple servers are |
Simon Horman | d60d691 | 2013-11-25 10:46:36 +0900 | [diff] [blame] | 13757 | hosted on the same hardware, the agent and health checks of all servers |
| 13758 | are started with a small time offset between them. It is also possible to |
| 13759 | add some random noise in the agent and health checks interval using the |
| 13760 | global "spread-checks" keyword. This makes sense for instance when a lot |
| 13761 | of backends use the same servers. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13762 | |
Emeric Brun | 9755647 | 2020-05-30 01:42:45 +0200 | [diff] [blame] | 13763 | log-proto <logproto> |
| 13764 | The "log-proto" specifies the protocol used to forward event messages to |
| 13765 | a server configured in a ring section. Possible values are "legacy" |
| 13766 | and "octet-count" corresponding respectively to "Non-transparent-framing" |
| 13767 | and "Octet counting" in rfc6587. "legacy" is the default. |
| 13768 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13769 | maxconn <maxconn> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13770 | The "maxconn" parameter specifies the maximal number of concurrent |
| 13771 | connections that will be sent to this server. If the number of incoming |
Tim Duesterhus | cefbbd9 | 2019-11-27 22:35:27 +0100 | [diff] [blame] | 13772 | concurrent connections goes higher than this value, they will be queued, |
| 13773 | waiting for a slot to be released. This parameter is very important as it can |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13774 | save fragile servers from going down under extreme loads. If a "minconn" |
| 13775 | parameter is specified, the limit becomes dynamic. The default value is "0" |
| 13776 | which means unlimited. See also the "minconn" and "maxqueue" parameters, and |
| 13777 | the backend's "fullconn" keyword. |
| 13778 | |
Tim Duesterhus | cefbbd9 | 2019-11-27 22:35:27 +0100 | [diff] [blame] | 13779 | In HTTP mode this parameter limits the number of concurrent requests instead |
| 13780 | of the number of connections. Multiple requests might be multiplexed over a |
| 13781 | single TCP connection to the server. As an example if you specify a maxconn |
| 13782 | of 50 you might see between 1 and 50 actual server connections, but no more |
| 13783 | than 50 concurrent requests. |
| 13784 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13785 | maxqueue <maxqueue> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13786 | The "maxqueue" parameter specifies the maximal number of connections which |
| 13787 | will wait in the queue for this server. If this limit is reached, next |
| 13788 | requests will be redispatched to other servers instead of indefinitely |
| 13789 | waiting to be served. This will break persistence but may allow people to |
Willy Tarreau | 8ae8c48 | 2020-10-22 17:19:07 +0200 | [diff] [blame] | 13790 | quickly re-log in when the server they try to connect to is dying. Some load |
| 13791 | balancing algorithms such as leastconn take this into account and accept to |
| 13792 | add requests into a server's queue up to this value if it is explicitly set |
| 13793 | to a value greater than zero, which often allows to better smooth the load |
| 13794 | when dealing with single-digit maxconn values. The default value is "0" which |
| 13795 | means the queue is unlimited. See also the "maxconn" and "minconn" parameters |
| 13796 | and "balance leastconn". |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13797 | |
Willy Tarreau | 9c538e0 | 2019-01-23 10:21:49 +0100 | [diff] [blame] | 13798 | max-reuse <count> |
| 13799 | The "max-reuse" argument indicates the HTTP connection processors that they |
| 13800 | should not reuse a server connection more than this number of times to send |
| 13801 | new requests. Permitted values are -1 (the default), which disables this |
| 13802 | limit, or any positive value. Value zero will effectively disable keep-alive. |
| 13803 | This is only used to work around certain server bugs which cause them to leak |
| 13804 | resources over time. The argument is not necessarily respected by the lower |
| 13805 | layers as there might be technical limitations making it impossible to |
| 13806 | enforce. At least HTTP/2 connections to servers will respect it. |
| 13807 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13808 | minconn <minconn> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13809 | When the "minconn" parameter is set, the maxconn limit becomes a dynamic |
| 13810 | limit following the backend's load. The server will always accept at least |
| 13811 | <minconn> connections, never more than <maxconn>, and the limit will be on |
| 13812 | the ramp between both values when the backend has less than <fullconn> |
| 13813 | concurrent connections. This makes it possible to limit the load on the |
| 13814 | server during normal loads, but push it further for important loads without |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 13815 | overloading the server during exceptional loads. See also the "maxconn" |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 13816 | and "maxqueue" parameters, as well as the "fullconn" backend keyword. |
Krzysztof Piotr Oledzki | 97f07b8 | 2009-12-15 22:31:24 +0100 | [diff] [blame] | 13817 | |
Willy Tarreau | d72f0f3 | 2015-10-13 14:50:22 +0200 | [diff] [blame] | 13818 | namespace <name> |
| 13819 | On Linux, it is possible to specify which network namespace a socket will |
| 13820 | belong to. This directive makes it possible to explicitly bind a server to |
| 13821 | a namespace different from the default one. Please refer to your operating |
| 13822 | system's documentation to find more details about network namespaces. |
| 13823 | |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13824 | no-agent-check |
| 13825 | This option may be used as "server" setting to reset any "agent-check" |
| 13826 | setting which would have been inherited from "default-server" directive as |
| 13827 | default value. |
| 13828 | It may also be used as "default-server" setting to reset any previous |
| 13829 | "default-server" "agent-check" setting. |
| 13830 | |
| 13831 | no-backup |
| 13832 | This option may be used as "server" setting to reset any "backup" |
| 13833 | setting which would have been inherited from "default-server" directive as |
| 13834 | default value. |
| 13835 | It may also be used as "default-server" setting to reset any previous |
| 13836 | "default-server" "backup" setting. |
| 13837 | |
| 13838 | no-check |
| 13839 | This option may be used as "server" setting to reset any "check" |
| 13840 | setting which would have been inherited from "default-server" directive as |
| 13841 | default value. |
| 13842 | It may also be used as "default-server" setting to reset any previous |
| 13843 | "default-server" "check" setting. |
| 13844 | |
| 13845 | no-check-ssl |
| 13846 | This option may be used as "server" setting to reset any "check-ssl" |
| 13847 | setting which would have been inherited from "default-server" directive as |
| 13848 | default value. |
| 13849 | It may also be used as "default-server" setting to reset any previous |
| 13850 | "default-server" "check-ssl" setting. |
| 13851 | |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13852 | no-send-proxy |
| 13853 | This option may be used as "server" setting to reset any "send-proxy" |
| 13854 | setting which would have been inherited from "default-server" directive as |
| 13855 | default value. |
| 13856 | It may also be used as "default-server" setting to reset any previous |
| 13857 | "default-server" "send-proxy" setting. |
| 13858 | |
| 13859 | no-send-proxy-v2 |
| 13860 | This option may be used as "server" setting to reset any "send-proxy-v2" |
| 13861 | setting which would have been inherited from "default-server" directive as |
| 13862 | default value. |
| 13863 | It may also be used as "default-server" setting to reset any previous |
| 13864 | "default-server" "send-proxy-v2" setting. |
| 13865 | |
| 13866 | no-send-proxy-v2-ssl |
| 13867 | This option may be used as "server" setting to reset any "send-proxy-v2-ssl" |
| 13868 | setting which would have been inherited from "default-server" directive as |
| 13869 | default value. |
| 13870 | It may also be used as "default-server" setting to reset any previous |
| 13871 | "default-server" "send-proxy-v2-ssl" setting. |
| 13872 | |
| 13873 | no-send-proxy-v2-ssl-cn |
| 13874 | This option may be used as "server" setting to reset any "send-proxy-v2-ssl-cn" |
| 13875 | setting which would have been inherited from "default-server" directive as |
| 13876 | default value. |
| 13877 | It may also be used as "default-server" setting to reset any previous |
| 13878 | "default-server" "send-proxy-v2-ssl-cn" setting. |
| 13879 | |
| 13880 | no-ssl |
| 13881 | This option may be used as "server" setting to reset any "ssl" |
| 13882 | setting which would have been inherited from "default-server" directive as |
| 13883 | default value. |
| 13884 | It may also be used as "default-server" setting to reset any previous |
| 13885 | "default-server" "ssl" setting. |
| 13886 | |
William Dauchy | f637044 | 2020-11-14 19:25:33 +0100 | [diff] [blame] | 13887 | Note that using `default-server ssl` setting and `no-ssl` on server will |
| 13888 | however init SSL connection, so it can be later be enabled through the |
| 13889 | runtime API: see `set server` commands in management doc. |
| 13890 | |
Willy Tarreau | 2a3fb1c | 2015-02-05 16:47:07 +0100 | [diff] [blame] | 13891 | no-ssl-reuse |
| 13892 | This option disables SSL session reuse when SSL is used to communicate with |
| 13893 | the server. It will force the server to perform a full handshake for every |
| 13894 | new connection. It's probably only useful for benchmarking, troubleshooting, |
| 13895 | and for paranoid users. |
| 13896 | |
Emeric Brun | 9b3009b | 2012-10-05 11:55:06 +0200 | [diff] [blame] | 13897 | no-sslv3 |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 13898 | This option disables support for SSLv3 when SSL is used to communicate with |
| 13899 | the server. Note that SSLv2 is disabled in the code and cannot be enabled |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13900 | using any configuration option. Use "ssl-min-ver" and "ssl-max-ver" instead. |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 13901 | |
Emmanuel Hocdet | 6cb2d1e | 2017-03-30 14:43:31 +0200 | [diff] [blame] | 13902 | Supported in default-server: No |
| 13903 | |
Emeric Brun | f9c5c47 | 2012-10-11 15:28:34 +0200 | [diff] [blame] | 13904 | no-tls-tickets |
| 13905 | This setting is only available when support for OpenSSL was built in. It |
| 13906 | disables the stateless session resumption (RFC 5077 TLS Ticket |
| 13907 | extension) and force to use stateful session resumption. Stateless |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13908 | session resumption is more expensive in CPU usage for servers. This option |
| 13909 | is also available on global statement "ssl-default-server-options". |
Lukas Tribus | bdb386d | 2020-03-10 00:56:09 +0100 | [diff] [blame] | 13910 | The TLS ticket mechanism is only used up to TLS 1.2. |
| 13911 | Forward Secrecy is compromised with TLS tickets, unless ticket keys |
| 13912 | are periodically rotated (via reload or by using "tls-ticket-keys"). |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13913 | See also "tls-tickets". |
Emeric Brun | f9c5c47 | 2012-10-11 15:28:34 +0200 | [diff] [blame] | 13914 | |
Emeric Brun | 9b3009b | 2012-10-05 11:55:06 +0200 | [diff] [blame] | 13915 | no-tlsv10 |
Emeric Brun | 8694b9a | 2012-10-05 14:39:07 +0200 | [diff] [blame] | 13916 | This option disables support for TLSv1.0 when SSL is used to communicate with |
Emeric Brun | f5da493 | 2012-09-28 19:42:54 +0200 | [diff] [blame] | 13917 | the server. Note that SSLv2 is disabled in the code and cannot be enabled |
| 13918 | using any configuration option. TLSv1 is more expensive than SSLv3 so it |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13919 | often makes sense to disable it when communicating with local servers. This |
| 13920 | option is also available on global statement "ssl-default-server-options". |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13921 | Use "ssl-min-ver" and "ssl-max-ver" instead. |
Willy Tarreau | 763a95b | 2012-10-04 23:15:39 +0200 | [diff] [blame] | 13922 | |
Emmanuel Hocdet | 6cb2d1e | 2017-03-30 14:43:31 +0200 | [diff] [blame] | 13923 | Supported in default-server: No |
| 13924 | |
Emeric Brun | 9b3009b | 2012-10-05 11:55:06 +0200 | [diff] [blame] | 13925 | no-tlsv11 |
Emeric Brun | 8694b9a | 2012-10-05 14:39:07 +0200 | [diff] [blame] | 13926 | This option disables support for TLSv1.1 when SSL is used to communicate with |
Emeric Brun | f5da493 | 2012-09-28 19:42:54 +0200 | [diff] [blame] | 13927 | the server. Note that SSLv2 is disabled in the code and cannot be enabled |
| 13928 | using any configuration option. TLSv1 is more expensive than SSLv3 so it |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13929 | often makes sense to disable it when communicating with local servers. This |
| 13930 | option is also available on global statement "ssl-default-server-options". |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13931 | Use "ssl-min-ver" and "ssl-max-ver" instead. |
Willy Tarreau | 763a95b | 2012-10-04 23:15:39 +0200 | [diff] [blame] | 13932 | |
Emmanuel Hocdet | 6cb2d1e | 2017-03-30 14:43:31 +0200 | [diff] [blame] | 13933 | Supported in default-server: No |
| 13934 | |
Emeric Brun | 9b3009b | 2012-10-05 11:55:06 +0200 | [diff] [blame] | 13935 | no-tlsv12 |
Emeric Brun | 8694b9a | 2012-10-05 14:39:07 +0200 | [diff] [blame] | 13936 | This option disables support for TLSv1.2 when SSL is used to communicate with |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 13937 | the server. Note that SSLv2 is disabled in the code and cannot be enabled |
| 13938 | using any configuration option. TLSv1 is more expensive than SSLv3 so it |
Emeric Brun | 2c86cbf | 2014-10-30 15:56:50 +0100 | [diff] [blame] | 13939 | often makes sense to disable it when communicating with local servers. This |
| 13940 | option is also available on global statement "ssl-default-server-options". |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13941 | Use "ssl-min-ver" and "ssl-max-ver" instead. |
Emmanuel Hocdet | 42fb980 | 2017-03-30 19:29:39 +0200 | [diff] [blame] | 13942 | |
| 13943 | Supported in default-server: No |
| 13944 | |
| 13945 | no-tlsv13 |
| 13946 | This option disables support for TLSv1.3 when SSL is used to communicate with |
| 13947 | the server. Note that SSLv2 is disabled in the code and cannot be enabled |
| 13948 | using any configuration option. TLSv1 is more expensive than SSLv3 so it |
| 13949 | often makes sense to disable it when communicating with local servers. This |
| 13950 | option is also available on global statement "ssl-default-server-options". |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 13951 | Use "ssl-min-ver" and "ssl-max-ver" instead. |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 13952 | |
Emmanuel Hocdet | 6cb2d1e | 2017-03-30 14:43:31 +0200 | [diff] [blame] | 13953 | Supported in default-server: No |
| 13954 | |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 13955 | no-verifyhost |
| 13956 | This option may be used as "server" setting to reset any "verifyhost" |
| 13957 | setting which would have been inherited from "default-server" directive as |
| 13958 | default value. |
| 13959 | It may also be used as "default-server" setting to reset any previous |
| 13960 | "default-server" "verifyhost" setting. |
Willy Tarreau | 763a95b | 2012-10-04 23:15:39 +0200 | [diff] [blame] | 13961 | |
Frédéric Lécaille | 1b9423d | 2019-07-04 14:19:06 +0200 | [diff] [blame] | 13962 | no-tfo |
| 13963 | This option may be used as "server" setting to reset any "tfo" |
| 13964 | setting which would have been inherited from "default-server" directive as |
| 13965 | default value. |
| 13966 | It may also be used as "default-server" setting to reset any previous |
| 13967 | "default-server" "tfo" setting. |
| 13968 | |
Simon Horman | fa46168 | 2011-06-25 09:39:49 +0900 | [diff] [blame] | 13969 | non-stick |
| 13970 | Never add connections allocated to this sever to a stick-table. |
| 13971 | This may be used in conjunction with backup to ensure that |
| 13972 | stick-table persistence is disabled for backup servers. |
| 13973 | |
Olivier Houchard | c756600 | 2018-11-20 23:33:50 +0100 | [diff] [blame] | 13974 | npn <protocols> |
| 13975 | This enables the NPN TLS extension and advertises the specified protocol list |
| 13976 | as supported on top of NPN. The protocol list consists in a comma-delimited |
| 13977 | list of protocol names, for instance: "http/1.1,http/1.0" (without quotes). |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 13978 | This requires that the SSL library is built with support for TLS extensions |
Olivier Houchard | c756600 | 2018-11-20 23:33:50 +0100 | [diff] [blame] | 13979 | enabled (check with haproxy -vv). Note that the NPN extension has been |
| 13980 | replaced with the ALPN extension (see the "alpn" keyword), though this one is |
| 13981 | only available starting with OpenSSL 1.0.2. |
| 13982 | |
Krzysztof Piotr Oledzki | 97f07b8 | 2009-12-15 22:31:24 +0100 | [diff] [blame] | 13983 | observe <mode> |
| 13984 | This option enables health adjusting based on observing communication with |
| 13985 | the server. By default this functionality is disabled and enabling it also |
| 13986 | requires to enable health checks. There are two supported modes: "layer4" and |
| 13987 | "layer7". In layer4 mode, only successful/unsuccessful tcp connections are |
| 13988 | significant. In layer7, which is only allowed for http proxies, responses |
| 13989 | received from server are verified, like valid/wrong http code, unparsable |
Willy Tarreau | 150d146 | 2012-03-10 08:19:02 +0100 | [diff] [blame] | 13990 | headers, a timeout, etc. Valid status codes include 100 to 499, 501 and 505. |
Krzysztof Piotr Oledzki | 97f07b8 | 2009-12-15 22:31:24 +0100 | [diff] [blame] | 13991 | |
| 13992 | See also the "check", "on-error" and "error-limit". |
| 13993 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 13994 | on-error <mode> |
Krzysztof Piotr Oledzki | 97f07b8 | 2009-12-15 22:31:24 +0100 | [diff] [blame] | 13995 | Select what should happen when enough consecutive errors are detected. |
| 13996 | Currently, four modes are available: |
| 13997 | - fastinter: force fastinter |
| 13998 | - fail-check: simulate a failed check, also forces fastinter (default) |
| 13999 | - sudden-death: simulate a pre-fatal failed health check, one more failed |
| 14000 | check will mark a server down, forces fastinter |
| 14001 | - mark-down: mark the server immediately down and force fastinter |
| 14002 | |
| 14003 | See also the "check", "observe" and "error-limit". |
| 14004 | |
Simon Horman | e0d1bfb | 2011-06-21 14:34:58 +0900 | [diff] [blame] | 14005 | on-marked-down <action> |
| 14006 | Modify what occurs when a server is marked down. |
| 14007 | Currently one action is available: |
Justin Karneges | eb2c24a | 2012-05-24 15:28:52 -0700 | [diff] [blame] | 14008 | - shutdown-sessions: Shutdown peer sessions. When this setting is enabled, |
| 14009 | all connections to the server are immediately terminated when the server |
| 14010 | goes down. It might be used if the health check detects more complex cases |
| 14011 | than a simple connection status, and long timeouts would cause the service |
| 14012 | to remain unresponsive for too long a time. For instance, a health check |
| 14013 | might detect that a database is stuck and that there's no chance to reuse |
| 14014 | existing connections anymore. Connections killed this way are logged with |
| 14015 | a 'D' termination code (for "Down"). |
Simon Horman | e0d1bfb | 2011-06-21 14:34:58 +0900 | [diff] [blame] | 14016 | |
| 14017 | Actions are disabled by default |
| 14018 | |
Justin Karneges | eb2c24a | 2012-05-24 15:28:52 -0700 | [diff] [blame] | 14019 | on-marked-up <action> |
| 14020 | Modify what occurs when a server is marked up. |
| 14021 | Currently one action is available: |
| 14022 | - shutdown-backup-sessions: Shutdown sessions on all backup servers. This is |
| 14023 | done only if the server is not in backup state and if it is not disabled |
| 14024 | (it must have an effective weight > 0). This can be used sometimes to force |
| 14025 | an active server to take all the traffic back after recovery when dealing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14026 | with long sessions (e.g. LDAP, SQL, ...). Doing this can cause more trouble |
| 14027 | than it tries to solve (e.g. incomplete transactions), so use this feature |
Justin Karneges | eb2c24a | 2012-05-24 15:28:52 -0700 | [diff] [blame] | 14028 | with extreme care. Sessions killed because a server comes up are logged |
| 14029 | with an 'U' termination code (for "Up"). |
| 14030 | |
| 14031 | Actions are disabled by default |
| 14032 | |
Willy Tarreau | 2f3f4d3 | 2020-07-01 07:43:51 +0200 | [diff] [blame] | 14033 | pool-low-conn <max> |
| 14034 | Set a low threshold on the number of idling connections for a server, below |
| 14035 | which a thread will not try to steal a connection from another thread. This |
| 14036 | can be useful to improve CPU usage patterns in scenarios involving many very |
| 14037 | fast servers, in order to ensure all threads will keep a few idle connections |
| 14038 | all the time instead of letting them accumulate over one thread and migrating |
| 14039 | them from thread to thread. Typical values of twice the number of threads |
| 14040 | seem to show very good performance already with sub-millisecond response |
| 14041 | times. The default is zero, indicating that any idle connection can be used |
| 14042 | at any time. It is the recommended setting for normal use. This only applies |
| 14043 | to connections that can be shared according to the same principles as those |
| 14044 | applying to "http-reuse". |
| 14045 | |
Olivier Houchard | 006e310 | 2018-12-10 18:30:32 +0100 | [diff] [blame] | 14046 | pool-max-conn <max> |
| 14047 | Set the maximum number of idling connections for a server. -1 means unlimited |
| 14048 | connections, 0 means no idle connections. The default is -1. When idle |
| 14049 | connections are enabled, orphaned idle connections which do not belong to any |
| 14050 | client session anymore are moved to a dedicated pool so that they remain |
| 14051 | usable by future clients. This only applies to connections that can be shared |
| 14052 | according to the same principles as those applying to "http-reuse". |
| 14053 | |
Olivier Houchard | b7b3faa | 2018-12-14 18:15:36 +0100 | [diff] [blame] | 14054 | pool-purge-delay <delay> |
| 14055 | Sets the delay to start purging idle connections. Each <delay> interval, half |
Olivier Houchard | a56eebf | 2019-03-19 16:44:02 +0100 | [diff] [blame] | 14056 | of the idle connections are closed. 0 means we don't keep any idle connection. |
Willy Tarreau | fb55365 | 2019-06-04 14:06:31 +0200 | [diff] [blame] | 14057 | The default is 5s. |
Olivier Houchard | b7b3faa | 2018-12-14 18:15:36 +0100 | [diff] [blame] | 14058 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 14059 | port <port> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14060 | Using the "port" parameter, it becomes possible to use a different port to |
| 14061 | send health-checks. On some servers, it may be desirable to dedicate a port |
| 14062 | to a specific component able to perform complex tests which are more suitable |
| 14063 | to health-checks than the application. It is common to run a simple script in |
| 14064 | inetd for instance. This parameter is ignored if the "check" parameter is not |
| 14065 | set. See also the "addr" parameter. |
| 14066 | |
Christopher Faulet | 8ed0a3e | 2018-04-10 14:45:45 +0200 | [diff] [blame] | 14067 | proto <name> |
Christopher Faulet | 8ed0a3e | 2018-04-10 14:45:45 +0200 | [diff] [blame] | 14068 | Forces the multiplexer's protocol to use for the outgoing connections to this |
| 14069 | server. It must be compatible with the mode of the backend (TCP or HTTP). It |
| 14070 | must also be usable on the backend side. The list of available protocols is |
| 14071 | reported in haproxy -vv. |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 14072 | Idea behind this option is to bypass the selection of the best multiplexer's |
Christopher Faulet | 8ed0a3e | 2018-04-10 14:45:45 +0200 | [diff] [blame] | 14073 | protocol for all connections established to this server. |
| 14074 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14075 | redir <prefix> |
| 14076 | The "redir" parameter enables the redirection mode for all GET and HEAD |
| 14077 | requests addressing this server. This means that instead of having HAProxy |
| 14078 | forward the request to the server, it will send an "HTTP 302" response with |
| 14079 | the "Location" header composed of this prefix immediately followed by the |
| 14080 | requested URI beginning at the leading '/' of the path component. That means |
| 14081 | that no trailing slash should be used after <prefix>. All invalid requests |
| 14082 | will be rejected, and all non-GET or HEAD requests will be normally served by |
| 14083 | the server. Note that since the response is completely forged, no header |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 14084 | mangling nor cookie insertion is possible in the response. However, cookies in |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14085 | requests are still analyzed, making this solution completely usable to direct |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14086 | users to a remote location in case of local disaster. Main use consists in |
| 14087 | increasing bandwidth for static servers by having the clients directly |
| 14088 | connect to them. Note: never use a relative location here, it would cause a |
| 14089 | loop between the client and HAProxy! |
| 14090 | |
| 14091 | Example : server srv1 192.168.1.1:80 redir http://image1.mydomain.com check |
| 14092 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 14093 | rise <count> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14094 | The "rise" parameter states that a server will be considered as operational |
| 14095 | after <count> consecutive successful health checks. This value defaults to 2 |
| 14096 | if unspecified. See also the "check", "inter" and "fall" parameters. |
| 14097 | |
Baptiste Assmann | 8e2d943 | 2018-06-22 15:04:43 +0200 | [diff] [blame] | 14098 | resolve-opts <option>,<option>,... |
| 14099 | Comma separated list of options to apply to DNS resolution linked to this |
| 14100 | server. |
| 14101 | |
| 14102 | Available options: |
| 14103 | |
| 14104 | * allow-dup-ip |
| 14105 | By default, HAProxy prevents IP address duplication in a backend when DNS |
| 14106 | resolution at runtime is in operation. |
| 14107 | That said, for some cases, it makes sense that two servers (in the same |
| 14108 | backend, being resolved by the same FQDN) have the same IP address. |
| 14109 | For such case, simply enable this option. |
| 14110 | This is the opposite of prevent-dup-ip. |
| 14111 | |
Daniel Corbett | f871691 | 2019-11-17 09:48:56 -0500 | [diff] [blame] | 14112 | * ignore-weight |
| 14113 | Ignore any weight that is set within an SRV record. This is useful when |
| 14114 | you would like to control the weights using an alternate method, such as |
| 14115 | using an "agent-check" or through the runtime api. |
| 14116 | |
Baptiste Assmann | 8e2d943 | 2018-06-22 15:04:43 +0200 | [diff] [blame] | 14117 | * prevent-dup-ip |
| 14118 | Ensure HAProxy's default behavior is enforced on a server: prevent re-using |
| 14119 | an IP address already set to a server in the same backend and sharing the |
| 14120 | same fqdn. |
| 14121 | This is the opposite of allow-dup-ip. |
| 14122 | |
| 14123 | Example: |
| 14124 | backend b_myapp |
| 14125 | default-server init-addr none resolvers dns |
| 14126 | server s1 myapp.example.com:80 check resolve-opts allow-dup-ip |
| 14127 | server s2 myapp.example.com:81 check resolve-opts allow-dup-ip |
| 14128 | |
| 14129 | With the option allow-dup-ip set: |
| 14130 | * if the nameserver returns a single IP address, then both servers will use |
| 14131 | it |
| 14132 | * If the nameserver returns 2 IP addresses, then each server will pick up a |
| 14133 | different address |
| 14134 | |
| 14135 | Default value: not set |
| 14136 | |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14137 | resolve-prefer <family> |
| 14138 | When DNS resolution is enabled for a server and multiple IP addresses from |
| 14139 | different families are returned, HAProxy will prefer using an IP address |
| 14140 | from the family mentioned in the "resolve-prefer" parameter. |
| 14141 | Available families: "ipv4" and "ipv6" |
| 14142 | |
Baptiste Assmann | c4aabae | 2015-08-04 22:43:06 +0200 | [diff] [blame] | 14143 | Default value: ipv6 |
| 14144 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 14145 | Example: |
| 14146 | |
| 14147 | server s1 app1.domain.com:80 resolvers mydns resolve-prefer ipv6 |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14148 | |
Thierry Fournier | ac88cfe | 2016-02-17 22:05:30 +0100 | [diff] [blame] | 14149 | resolve-net <network>[,<network[,...]] |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 14150 | This option prioritizes the choice of an ip address matching a network. This is |
Thierry Fournier | ac88cfe | 2016-02-17 22:05:30 +0100 | [diff] [blame] | 14151 | useful with clouds to prefer a local ip. In some cases, a cloud high |
Tim Düsterhus | 4896c44 | 2016-11-29 02:15:19 +0100 | [diff] [blame] | 14152 | availability service can be announced with many ip addresses on many |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14153 | different datacenters. The latency between datacenter is not negligible, so |
| 14154 | this patch permits to prefer a local datacenter. If no address matches the |
Thierry Fournier | ac88cfe | 2016-02-17 22:05:30 +0100 | [diff] [blame] | 14155 | configured network, another address is selected. |
| 14156 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 14157 | Example: |
| 14158 | |
| 14159 | server s1 app1.domain.com:80 resolvers mydns resolve-net 10.0.0.0/8 |
Thierry Fournier | ac88cfe | 2016-02-17 22:05:30 +0100 | [diff] [blame] | 14160 | |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14161 | resolvers <id> |
| 14162 | Points to an existing "resolvers" section to resolve current server's |
| 14163 | hostname. |
| 14164 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 14165 | Example: |
| 14166 | |
| 14167 | server s1 app1.domain.com:80 check resolvers mydns |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14168 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 14169 | See also section 5.3 |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14170 | |
Willy Tarreau | 5ab04ec | 2011-03-20 10:32:26 +0100 | [diff] [blame] | 14171 | send-proxy |
| 14172 | The "send-proxy" parameter enforces use of the PROXY protocol over any |
| 14173 | connection established to this server. The PROXY protocol informs the other |
| 14174 | end about the layer 3/4 addresses of the incoming connection, so that it can |
| 14175 | know the client's address or the public address it accessed to, whatever the |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 14176 | upper layer protocol. For connections accepted by an "accept-proxy" or |
| 14177 | "accept-netscaler-cip" listener, the advertised address will be used. Only |
| 14178 | TCPv4 and TCPv6 address families are supported. Other families such as |
| 14179 | Unix sockets, will report an UNKNOWN family. Servers using this option can |
| 14180 | fully be chained to another instance of haproxy listening with an |
| 14181 | "accept-proxy" setting. This setting must not be used if the server isn't |
| 14182 | aware of the protocol. When health checks are sent to the server, the PROXY |
| 14183 | protocol is automatically used when this option is set, unless there is an |
| 14184 | explicit "port" or "addr" directive, in which case an explicit |
| 14185 | "check-send-proxy" directive would also be needed to use the PROXY protocol. |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 14186 | See also the "no-send-proxy" option of this section and "accept-proxy" and |
| 14187 | "accept-netscaler-cip" option of the "bind" keyword. |
Willy Tarreau | 5ab04ec | 2011-03-20 10:32:26 +0100 | [diff] [blame] | 14188 | |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 14189 | send-proxy-v2 |
| 14190 | The "send-proxy-v2" parameter enforces use of the PROXY protocol version 2 |
| 14191 | over any connection established to this server. The PROXY protocol informs |
| 14192 | the other end about the layer 3/4 addresses of the incoming connection, so |
| 14193 | that it can know the client's address or the public address it accessed to, |
Emmanuel Hocdet | 404d978 | 2017-10-24 10:55:14 +0200 | [diff] [blame] | 14194 | whatever the upper layer protocol. It also send ALPN information if an alpn |
| 14195 | have been negotiated. This setting must not be used if the server isn't aware |
| 14196 | of this version of the protocol. See also the "no-send-proxy-v2" option of |
| 14197 | this section and send-proxy" option of the "bind" keyword. |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 14198 | |
Emmanuel Hocdet | f643b80 | 2018-02-01 15:20:32 +0100 | [diff] [blame] | 14199 | proxy-v2-options <option>[,<option>]* |
Tim Duesterhus | cf6e0c8 | 2020-03-13 12:34:24 +0100 | [diff] [blame] | 14200 | The "proxy-v2-options" parameter add options to send in PROXY protocol |
| 14201 | version 2 when "send-proxy-v2" is used. Options available are: |
| 14202 | |
| 14203 | - ssl : See also "send-proxy-v2-ssl". |
| 14204 | - cert-cn : See also "send-proxy-v2-ssl-cn". |
| 14205 | - ssl-cipher: Name of the used cipher. |
| 14206 | - cert-sig : Signature algorithm of the used certificate. |
| 14207 | - cert-key : Key algorithm of the used certificate |
| 14208 | - authority : Host name value passed by the client (only SNI from a TLS |
| 14209 | connection is supported). |
| 14210 | - crc32c : Checksum of the PROXYv2 header. |
| 14211 | - unique-id : Send a unique ID generated using the frontend's |
| 14212 | "unique-id-format" within the PROXYv2 header. |
| 14213 | This unique-id is primarily meant for "mode tcp". It can |
| 14214 | lead to unexpected results in "mode http", because the |
| 14215 | generated unique ID is also used for the first HTTP request |
| 14216 | within a Keep-Alive connection. |
Emmanuel Hocdet | f643b80 | 2018-02-01 15:20:32 +0100 | [diff] [blame] | 14217 | |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 14218 | send-proxy-v2-ssl |
| 14219 | The "send-proxy-v2-ssl" parameter enforces use of the PROXY protocol version |
| 14220 | 2 over any connection established to this server. The PROXY protocol informs |
| 14221 | the other end about the layer 3/4 addresses of the incoming connection, so |
| 14222 | that it can know the client's address or the public address it accessed to, |
| 14223 | whatever the upper layer protocol. In addition, the SSL information extension |
| 14224 | of the PROXY protocol is added to the PROXY protocol header. This setting |
| 14225 | must not be used if the server isn't aware of this version of the protocol. |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 14226 | See also the "no-send-proxy-v2-ssl" option of this section and the |
| 14227 | "send-proxy-v2" option of the "bind" keyword. |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 14228 | |
| 14229 | send-proxy-v2-ssl-cn |
| 14230 | The "send-proxy-v2-ssl" parameter enforces use of the PROXY protocol version |
| 14231 | 2 over any connection established to this server. The PROXY protocol informs |
| 14232 | the other end about the layer 3/4 addresses of the incoming connection, so |
| 14233 | that it can know the client's address or the public address it accessed to, |
| 14234 | whatever the upper layer protocol. In addition, the SSL information extension |
| 14235 | of the PROXY protocol, along along with the Common Name from the subject of |
| 14236 | the client certificate (if any), is added to the PROXY protocol header. This |
| 14237 | setting must not be used if the server isn't aware of this version of the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14238 | protocol. See also the "no-send-proxy-v2-ssl-cn" option of this section and |
| 14239 | the "send-proxy-v2" option of the "bind" keyword. |
David S | afb7683 | 2014-05-08 23:42:08 -0400 | [diff] [blame] | 14240 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 14241 | slowstart <start_time_in_ms> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14242 | The "slowstart" parameter for a server accepts a value in milliseconds which |
| 14243 | indicates after how long a server which has just come back up will run at |
| 14244 | full speed. Just as with every other time-based parameter, it can be entered |
| 14245 | in any other explicit unit among { us, ms, s, m, h, d }. The speed grows |
| 14246 | linearly from 0 to 100% during this time. The limitation applies to two |
| 14247 | parameters : |
| 14248 | |
| 14249 | - maxconn: the number of connections accepted by the server will grow from 1 |
| 14250 | to 100% of the usual dynamic limit defined by (minconn,maxconn,fullconn). |
| 14251 | |
| 14252 | - weight: when the backend uses a dynamic weighted algorithm, the weight |
| 14253 | grows linearly from 1 to 100%. In this case, the weight is updated at every |
| 14254 | health-check. For this reason, it is important that the "inter" parameter |
| 14255 | is smaller than the "slowstart", in order to maximize the number of steps. |
| 14256 | |
| 14257 | The slowstart never applies when haproxy starts, otherwise it would cause |
| 14258 | trouble to running servers. It only applies when a server has been previously |
| 14259 | seen as failed. |
| 14260 | |
Willy Tarreau | 732eac4 | 2015-07-09 11:40:25 +0200 | [diff] [blame] | 14261 | sni <expression> |
| 14262 | The "sni" parameter evaluates the sample fetch expression, converts it to a |
| 14263 | string and uses the result as the host name sent in the SNI TLS extension to |
| 14264 | the server. A typical use case is to send the SNI received from the client in |
| 14265 | a bridged HTTPS scenario, using the "ssl_fc_sni" sample fetch for the |
Willy Tarreau | 2ab8867 | 2017-07-05 18:23:03 +0200 | [diff] [blame] | 14266 | expression, though alternatives such as req.hdr(host) can also make sense. If |
| 14267 | "verify required" is set (which is the recommended setting), the resulting |
Willy Tarreau | ad92a9a | 2017-07-28 11:38:41 +0200 | [diff] [blame] | 14268 | name will also be matched against the server certificate's names. See the |
Jérôme Magnin | b36a6d2 | 2018-12-09 16:03:40 +0100 | [diff] [blame] | 14269 | "verify" directive for more details. If you want to set a SNI for health |
| 14270 | checks, see the "check-sni" directive for more details. |
Willy Tarreau | 732eac4 | 2015-07-09 11:40:25 +0200 | [diff] [blame] | 14271 | |
Willy Tarreau | c6f4ce8 | 2009-06-10 11:09:37 +0200 | [diff] [blame] | 14272 | source <addr>[:<pl>[-<ph>]] [usesrc { <addr2>[:<port2>] | client | clientip } ] |
Willy Tarreau | bce7088 | 2009-09-07 11:51:47 +0200 | [diff] [blame] | 14273 | source <addr>[:<port>] [usesrc { <addr2>[:<port2>] | hdr_ip(<hdr>[,<occ>]) } ] |
Willy Tarreau | c6f4ce8 | 2009-06-10 11:09:37 +0200 | [diff] [blame] | 14274 | source <addr>[:<pl>[-<ph>]] [interface <name>] ... |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14275 | The "source" parameter sets the source address which will be used when |
| 14276 | connecting to the server. It follows the exact same parameters and principle |
| 14277 | as the backend "source" keyword, except that it only applies to the server |
| 14278 | referencing it. Please consult the "source" keyword for details. |
| 14279 | |
Willy Tarreau | c6f4ce8 | 2009-06-10 11:09:37 +0200 | [diff] [blame] | 14280 | Additionally, the "source" statement on a server line allows one to specify a |
| 14281 | source port range by indicating the lower and higher bounds delimited by a |
| 14282 | dash ('-'). Some operating systems might require a valid IP address when a |
| 14283 | source port range is specified. It is permitted to have the same IP/range for |
| 14284 | several servers. Doing so makes it possible to bypass the maximum of 64k |
| 14285 | total concurrent connections. The limit will then reach 64k connections per |
| 14286 | server. |
| 14287 | |
Lukas Tribus | 7d56c6d | 2016-09-13 09:51:15 +0000 | [diff] [blame] | 14288 | Since Linux 4.2/libc 2.23 IP_BIND_ADDRESS_NO_PORT is set for connections |
| 14289 | specifying the source address without port(s). |
| 14290 | |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 14291 | ssl |
Willy Tarreau | 44f6539 | 2013-06-25 07:56:20 +0200 | [diff] [blame] | 14292 | This option enables SSL ciphering on outgoing connections to the server. It |
| 14293 | is critical to verify server certificates using "verify" when using SSL to |
| 14294 | connect to servers, otherwise the communication is prone to trivial man in |
| 14295 | the-middle attacks rendering SSL useless. When this option is used, health |
| 14296 | checks are automatically sent in SSL too unless there is a "port" or an |
| 14297 | "addr" directive indicating the check should be sent to a different location. |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 14298 | See the "no-ssl" to disable "ssl" option and "check-ssl" option to force |
| 14299 | SSL health checks. |
Willy Tarreau | 763a95b | 2012-10-04 23:15:39 +0200 | [diff] [blame] | 14300 | |
Emmanuel Hocdet | e1c722b | 2017-03-31 15:02:54 +0200 | [diff] [blame] | 14301 | ssl-max-ver [ SSLv3 | TLSv1.0 | TLSv1.1 | TLSv1.2 | TLSv1.3 ] |
| 14302 | This option enforces use of <version> or lower when SSL is used to communicate |
| 14303 | with the server. This option is also available on global statement |
| 14304 | "ssl-default-server-options". See also "ssl-min-ver". |
| 14305 | |
| 14306 | ssl-min-ver [ SSLv3 | TLSv1.0 | TLSv1.1 | TLSv1.2 | TLSv1.3 ] |
| 14307 | This option enforces use of <version> or upper when SSL is used to communicate |
| 14308 | with the server. This option is also available on global statement |
| 14309 | "ssl-default-server-options". See also "ssl-max-ver". |
| 14310 | |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 14311 | ssl-reuse |
| 14312 | This option may be used as "server" setting to reset any "no-ssl-reuse" |
| 14313 | setting which would have been inherited from "default-server" directive as |
| 14314 | default value. |
| 14315 | It may also be used as "default-server" setting to reset any previous |
| 14316 | "default-server" "no-ssl-reuse" setting. |
| 14317 | |
| 14318 | stick |
| 14319 | This option may be used as "server" setting to reset any "non-stick" |
| 14320 | setting which would have been inherited from "default-server" directive as |
| 14321 | default value. |
| 14322 | It may also be used as "default-server" setting to reset any previous |
| 14323 | "default-server" "non-stick" setting. |
Willy Tarreau | a0ee1d0 | 2012-09-10 09:01:23 +0200 | [diff] [blame] | 14324 | |
Alexander Liu | 2a54bb7 | 2019-05-22 19:44:48 +0800 | [diff] [blame] | 14325 | socks4 <addr>:<port> |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 14326 | This option enables upstream socks4 tunnel for outgoing connections to the |
Alexander Liu | 2a54bb7 | 2019-05-22 19:44:48 +0800 | [diff] [blame] | 14327 | server. Using this option won't force the health check to go via socks4 by |
| 14328 | default. You will have to use the keyword "check-via-socks4" to enable it. |
| 14329 | |
Willy Tarreau | 163d462 | 2015-10-13 16:16:41 +0200 | [diff] [blame] | 14330 | tcp-ut <delay> |
| 14331 | Sets the TCP User Timeout for all outgoing connections to this server. This |
| 14332 | option is available on Linux since version 2.6.37. It allows haproxy to |
| 14333 | configure a timeout for sockets which contain data not receiving an |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14334 | acknowledgment for the configured delay. This is especially useful on |
Willy Tarreau | 163d462 | 2015-10-13 16:16:41 +0200 | [diff] [blame] | 14335 | long-lived connections experiencing long idle periods such as remote |
| 14336 | terminals or database connection pools, where the client and server timeouts |
| 14337 | must remain high to allow a long period of idle, but where it is important to |
| 14338 | detect that the server has disappeared in order to release all resources |
| 14339 | associated with its connection (and the client's session). One typical use |
| 14340 | case is also to force dead server connections to die when health checks are |
| 14341 | too slow or during a soft reload since health checks are then disabled. The |
| 14342 | argument is a delay expressed in milliseconds by default. This only works for |
| 14343 | regular TCP connections, and is ignored for other protocols. |
| 14344 | |
Willy Tarreau | 034c88c | 2017-01-23 23:36:45 +0100 | [diff] [blame] | 14345 | tfo |
| 14346 | This option enables using TCP fast open when connecting to servers, on |
| 14347 | systems that support it (currently only the Linux kernel >= 4.11). |
| 14348 | See the "tfo" bind option for more information about TCP fast open. |
| 14349 | Please note that when using tfo, you should also use the "conn-failure", |
| 14350 | "empty-response" and "response-timeout" keywords for "retry-on", or haproxy |
Frédéric Lécaille | 1b9423d | 2019-07-04 14:19:06 +0200 | [diff] [blame] | 14351 | won't be able to retry the connection on failure. See also "no-tfo". |
Willy Tarreau | 034c88c | 2017-01-23 23:36:45 +0100 | [diff] [blame] | 14352 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14353 | track [<proxy>/]<server> |
Willy Tarreau | 3209123 | 2014-05-16 13:52:00 +0200 | [diff] [blame] | 14354 | This option enables ability to set the current state of the server by tracking |
| 14355 | another one. It is possible to track a server which itself tracks another |
| 14356 | server, provided that at the end of the chain, a server has health checks |
| 14357 | enabled. If <proxy> is omitted the current one is used. If disable-on-404 is |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14358 | used, it has to be enabled on both proxies. |
| 14359 | |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 14360 | tls-tickets |
| 14361 | This option may be used as "server" setting to reset any "no-tls-tickets" |
| 14362 | setting which would have been inherited from "default-server" directive as |
| 14363 | default value. |
Lukas Tribus | bdb386d | 2020-03-10 00:56:09 +0100 | [diff] [blame] | 14364 | The TLS ticket mechanism is only used up to TLS 1.2. |
| 14365 | Forward Secrecy is compromised with TLS tickets, unless ticket keys |
| 14366 | are periodically rotated (via reload or by using "tls-ticket-keys"). |
Frédéric Lécaille | d237627 | 2017-03-21 18:52:12 +0100 | [diff] [blame] | 14367 | It may also be used as "default-server" setting to reset any previous |
Bjoern Jacke | 5ab7eb6 | 2020-02-13 14:16:16 +0100 | [diff] [blame] | 14368 | "default-server" "no-tls-tickets" setting. |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 14369 | |
Emeric Brun | ef42d92 | 2012-10-11 16:11:36 +0200 | [diff] [blame] | 14370 | verify [none|required] |
| 14371 | This setting is only available when support for OpenSSL was built in. If set |
Emeric Brun | 850efd5 | 2014-01-29 12:24:34 +0100 | [diff] [blame] | 14372 | to 'none', server certificate is not verified. In the other case, The |
Willy Tarreau | ad92a9a | 2017-07-28 11:38:41 +0200 | [diff] [blame] | 14373 | certificate provided by the server is verified using CAs from 'ca-file' and |
| 14374 | optional CRLs from 'crl-file' after having checked that the names provided in |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14375 | the certificate's subject and subjectAlternateNames attributes match either |
Willy Tarreau | ad92a9a | 2017-07-28 11:38:41 +0200 | [diff] [blame] | 14376 | the name passed using the "sni" directive, or if not provided, the static |
| 14377 | host name passed using the "verifyhost" directive. When no name is found, the |
| 14378 | certificate's names are ignored. For this reason, without SNI it's important |
| 14379 | to use "verifyhost". On verification failure the handshake is aborted. It is |
| 14380 | critically important to verify server certificates when using SSL to connect |
| 14381 | to servers, otherwise the communication is prone to trivial man-in-the-middle |
| 14382 | attacks rendering SSL totally useless. Unless "ssl_server_verify" appears in |
| 14383 | the global section, "verify" is set to "required" by default. |
Emeric Brun | ef42d92 | 2012-10-11 16:11:36 +0200 | [diff] [blame] | 14384 | |
Evan Broder | be55431 | 2013-06-27 00:05:25 -0700 | [diff] [blame] | 14385 | verifyhost <hostname> |
| 14386 | This setting is only available when support for OpenSSL was built in, and |
Willy Tarreau | ad92a9a | 2017-07-28 11:38:41 +0200 | [diff] [blame] | 14387 | only takes effect if 'verify required' is also specified. This directive sets |
| 14388 | a default static hostname to check the server's certificate against when no |
| 14389 | SNI was used to connect to the server. If SNI is not used, this is the only |
| 14390 | way to enable hostname verification. This static hostname, when set, will |
| 14391 | also be used for health checks (which cannot provide an SNI value). If none |
| 14392 | of the hostnames in the certificate match the specified hostname, the |
| 14393 | handshake is aborted. The hostnames in the server-provided certificate may |
| 14394 | include wildcards. See also "verify", "sni" and "no-verifyhost" options. |
Evan Broder | be55431 | 2013-06-27 00:05:25 -0700 | [diff] [blame] | 14395 | |
Krzysztof Piotr Oledzki | c53601c | 2010-01-06 10:50:42 +0100 | [diff] [blame] | 14396 | weight <weight> |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14397 | The "weight" parameter is used to adjust the server's weight relative to |
| 14398 | other servers. All servers will receive a load proportional to their weight |
| 14399 | relative to the sum of all weights, so the higher the weight, the higher the |
Willy Tarreau | 6704d67 | 2009-06-15 10:56:05 +0200 | [diff] [blame] | 14400 | load. The default weight is 1, and the maximal value is 256. A value of 0 |
| 14401 | means the server will not participate in load-balancing but will still accept |
| 14402 | persistent connections. If this parameter is used to distribute the load |
| 14403 | according to server's capacity, it is recommended to start with values which |
| 14404 | can both grow and shrink, for instance between 10 and 100 to leave enough |
| 14405 | room above and below for later adjustments. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14406 | |
| 14407 | |
Cyril Bonté | 46175dd | 2015-07-02 22:45:32 +0200 | [diff] [blame] | 14408 | 5.3. Server IP address resolution using DNS |
| 14409 | ------------------------------------------- |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14410 | |
Baptiste Assmann | 62b75b4 | 2015-09-09 01:11:36 +0200 | [diff] [blame] | 14411 | HAProxy allows using a host name on the server line to retrieve its IP address |
| 14412 | using name servers. By default, HAProxy resolves the name when parsing the |
| 14413 | configuration file, at startup and cache the result for the process' life. |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14414 | This is not sufficient in some cases, such as in Amazon where a server's IP |
| 14415 | can change after a reboot or an ELB Virtual IP can change based on current |
| 14416 | workload. |
| 14417 | This chapter describes how HAProxy can be configured to process server's name |
| 14418 | resolution at run time. |
| 14419 | Whether run time server name resolution has been enable or not, HAProxy will |
| 14420 | carry on doing the first resolution when parsing the configuration. |
| 14421 | |
| 14422 | |
Cyril Bonté | 46175dd | 2015-07-02 22:45:32 +0200 | [diff] [blame] | 14423 | 5.3.1. Global overview |
| 14424 | ---------------------- |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14425 | |
| 14426 | As we've seen in introduction, name resolution in HAProxy occurs at two |
| 14427 | different steps of the process life: |
| 14428 | |
| 14429 | 1. when starting up, HAProxy parses the server line definition and matches a |
| 14430 | host name. It uses libc functions to get the host name resolved. This |
| 14431 | resolution relies on /etc/resolv.conf file. |
| 14432 | |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14433 | 2. at run time, HAProxy performs periodically name resolutions for servers |
| 14434 | requiring DNS resolutions. |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14435 | |
| 14436 | A few other events can trigger a name resolution at run time: |
| 14437 | - when a server's health check ends up in a connection timeout: this may be |
| 14438 | because the server has a new IP address. So we need to trigger a name |
| 14439 | resolution to know this new IP. |
| 14440 | |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14441 | When using resolvers, the server name can either be a hostname, or a SRV label. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14442 | HAProxy considers anything that starts with an underscore as a SRV label. If a |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14443 | SRV label is specified, then the corresponding SRV records will be retrieved |
| 14444 | from the DNS server, and the provided hostnames will be used. The SRV label |
| 14445 | will be checked periodically, and if any server are added or removed, haproxy |
| 14446 | will automatically do the same. |
Olivier Houchard | ecfa18d | 2017-08-07 17:30:03 +0200 | [diff] [blame] | 14447 | |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14448 | A few things important to notice: |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 14449 | - all the name servers are queried in the meantime. HAProxy will process the |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14450 | first valid response. |
| 14451 | |
| 14452 | - a resolution is considered as invalid (NX, timeout, refused), when all the |
| 14453 | servers return an error. |
| 14454 | |
| 14455 | |
Cyril Bonté | 46175dd | 2015-07-02 22:45:32 +0200 | [diff] [blame] | 14456 | 5.3.2. The resolvers section |
| 14457 | ---------------------------- |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14458 | |
| 14459 | This section is dedicated to host information related to name resolution in |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14460 | HAProxy. There can be as many as resolvers section as needed. Each section can |
| 14461 | contain many name servers. |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14462 | |
Baptiste Assmann | 62b75b4 | 2015-09-09 01:11:36 +0200 | [diff] [blame] | 14463 | When multiple name servers are configured in a resolvers section, then HAProxy |
| 14464 | uses the first valid response. In case of invalid responses, only the last one |
| 14465 | is treated. Purpose is to give the chance to a slow server to deliver a valid |
| 14466 | answer after a fast faulty or outdated server. |
| 14467 | |
| 14468 | When each server returns a different error type, then only the last error is |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14469 | used by HAProxy. The following processing is applied on this error: |
Baptiste Assmann | 62b75b4 | 2015-09-09 01:11:36 +0200 | [diff] [blame] | 14470 | |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14471 | 1. HAProxy retries the same DNS query with a new query type. The A queries are |
| 14472 | switch to AAAA or the opposite. SRV queries are not concerned here. Timeout |
| 14473 | errors are also excluded. |
Baptiste Assmann | 62b75b4 | 2015-09-09 01:11:36 +0200 | [diff] [blame] | 14474 | |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14475 | 2. When the fallback on the query type was done (or not applicable), HAProxy |
| 14476 | retries the original DNS query, with the preferred query type. |
Baptiste Assmann | 62b75b4 | 2015-09-09 01:11:36 +0200 | [diff] [blame] | 14477 | |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14478 | 3. HAProxy retries previous steps <resolve_retires> times. If no valid |
| 14479 | response is received after that, it stops the DNS resolution and reports |
| 14480 | the error. |
Baptiste Assmann | 62b75b4 | 2015-09-09 01:11:36 +0200 | [diff] [blame] | 14481 | |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14482 | For example, with 2 name servers configured in a resolvers section, the |
| 14483 | following scenarios are possible: |
| 14484 | |
| 14485 | - First response is valid and is applied directly, second response is |
| 14486 | ignored |
| 14487 | |
| 14488 | - First response is invalid and second one is valid, then second response is |
| 14489 | applied |
| 14490 | |
| 14491 | - First response is a NX domain and second one a truncated response, then |
| 14492 | HAProxy retries the query with a new type |
| 14493 | |
| 14494 | - First response is a NX domain and second one is a timeout, then HAProxy |
| 14495 | retries the query with a new type |
| 14496 | |
| 14497 | - Query timed out for both name servers, then HAProxy retries it with the |
| 14498 | same query type |
Baptiste Assmann | 62b75b4 | 2015-09-09 01:11:36 +0200 | [diff] [blame] | 14499 | |
Olivier Houchard | a8c6db8 | 2017-07-06 18:46:47 +0200 | [diff] [blame] | 14500 | As a DNS server may not answer all the IPs in one DNS request, haproxy keeps |
| 14501 | a cache of previous answers, an answer will be considered obsolete after |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14502 | <hold obsolete> seconds without the IP returned. |
Olivier Houchard | a8c6db8 | 2017-07-06 18:46:47 +0200 | [diff] [blame] | 14503 | |
Baptiste Assmann | 62b75b4 | 2015-09-09 01:11:36 +0200 | [diff] [blame] | 14504 | |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14505 | resolvers <resolvers id> |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14506 | Creates a new name server list labeled <resolvers id> |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14507 | |
| 14508 | A resolvers section accept the following parameters: |
| 14509 | |
Baptiste Assmann | 2af08fe | 2017-08-14 00:13:01 +0200 | [diff] [blame] | 14510 | accepted_payload_size <nb> |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14511 | Defines the maximum payload size accepted by HAProxy and announced to all the |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14512 | name servers configured in this resolvers section. |
Baptiste Assmann | 2af08fe | 2017-08-14 00:13:01 +0200 | [diff] [blame] | 14513 | <nb> is in bytes. If not set, HAProxy announces 512. (minimal value defined |
| 14514 | by RFC 6891) |
| 14515 | |
Baptiste Assmann | 9d8dbbc | 2017-08-18 23:35:08 +0200 | [diff] [blame] | 14516 | Note: the maximum allowed value is 8192. |
| 14517 | |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14518 | nameserver <id> <ip>:<port> |
| 14519 | DNS server description: |
| 14520 | <id> : label of the server, should be unique |
| 14521 | <ip> : IP address of the server |
| 14522 | <port> : port where the DNS service actually runs |
| 14523 | |
Ben Draut | 44e609b | 2018-05-29 15:40:08 -0600 | [diff] [blame] | 14524 | parse-resolv-conf |
| 14525 | Adds all nameservers found in /etc/resolv.conf to this resolvers nameservers |
| 14526 | list. Ordered as if each nameserver in /etc/resolv.conf was individually |
| 14527 | placed in the resolvers section in place of this directive. |
| 14528 | |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14529 | hold <status> <period> |
| 14530 | Defines <period> during which the last name resolution should be kept based |
| 14531 | on last resolution <status> |
Baptiste Assmann | 987e16d | 2016-11-02 22:23:31 +0100 | [diff] [blame] | 14532 | <status> : last name resolution status. Acceptable values are "nx", |
Olivier Houchard | a8c6db8 | 2017-07-06 18:46:47 +0200 | [diff] [blame] | 14533 | "other", "refused", "timeout", "valid", "obsolete". |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14534 | <period> : interval between two successive name resolution when the last |
| 14535 | answer was in <status>. It follows the HAProxy time format. |
| 14536 | <period> is in milliseconds by default. |
| 14537 | |
Baptiste Assmann | 686408b | 2017-08-18 10:15:42 +0200 | [diff] [blame] | 14538 | Default value is 10s for "valid", 0s for "obsolete" and 30s for others. |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14539 | |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14540 | resolve_retries <nb> |
| 14541 | Defines the number <nb> of queries to send to resolve a server name before |
| 14542 | giving up. |
| 14543 | Default value: 3 |
| 14544 | |
Baptiste Assmann | 62b75b4 | 2015-09-09 01:11:36 +0200 | [diff] [blame] | 14545 | A retry occurs on name server timeout or when the full sequence of DNS query |
| 14546 | type failover is over and we need to start up from the default ANY query |
| 14547 | type. |
| 14548 | |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14549 | timeout <event> <time> |
| 14550 | Defines timeouts related to name resolution |
| 14551 | <event> : the event on which the <time> timeout period applies to. |
| 14552 | events available are: |
Frédéric Lécaille | 93d3316 | 2019-03-06 09:35:59 +0100 | [diff] [blame] | 14553 | - resolve : default time to trigger name resolutions when no |
| 14554 | other time applied. |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14555 | Default value: 1s |
| 14556 | - retry : time between two DNS queries, when no valid response |
Frédéric Lécaille | 93d3316 | 2019-03-06 09:35:59 +0100 | [diff] [blame] | 14557 | have been received. |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14558 | Default value: 1s |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14559 | <time> : time related to the event. It follows the HAProxy time format. |
| 14560 | <time> is expressed in milliseconds. |
| 14561 | |
Olivier Doucet | aa1ea8a | 2016-08-05 17:15:20 +0200 | [diff] [blame] | 14562 | Example: |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14563 | |
| 14564 | resolvers mydns |
| 14565 | nameserver dns1 10.0.0.1:53 |
| 14566 | nameserver dns2 10.0.0.2:53 |
Ben Draut | 44e609b | 2018-05-29 15:40:08 -0600 | [diff] [blame] | 14567 | parse-resolv-conf |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14568 | resolve_retries 3 |
Christopher Faulet | 67957bd | 2017-09-27 11:00:59 +0200 | [diff] [blame] | 14569 | timeout resolve 1s |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14570 | timeout retry 1s |
Baptiste Assmann | 987e16d | 2016-11-02 22:23:31 +0100 | [diff] [blame] | 14571 | hold other 30s |
| 14572 | hold refused 30s |
| 14573 | hold nx 30s |
| 14574 | hold timeout 30s |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14575 | hold valid 10s |
Olivier Houchard | a8c6db8 | 2017-07-06 18:46:47 +0200 | [diff] [blame] | 14576 | hold obsolete 30s |
Baptiste Assmann | 1fa6666 | 2015-04-14 00:28:47 +0200 | [diff] [blame] | 14577 | |
| 14578 | |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 14579 | 6. Cache |
| 14580 | --------- |
| 14581 | |
| 14582 | HAProxy provides a cache, which was designed to perform cache on small objects |
| 14583 | (favicon, css...). This is a minimalist low-maintenance cache which runs in |
| 14584 | RAM. |
| 14585 | |
| 14586 | The cache is based on a memory which is shared between processes and threads, |
| 14587 | this memory is split in blocks of 1k. |
| 14588 | |
| 14589 | If an object is not used anymore, it can be deleted to store a new object |
| 14590 | independently of its expiration date. The oldest objects are deleted first |
| 14591 | when we try to allocate a new one. |
| 14592 | |
| 14593 | The cache uses a hash of the host header and the URI as the key. |
| 14594 | |
| 14595 | It's possible to view the status of a cache using the Unix socket command |
| 14596 | "show cache" consult section 9.3 "Unix Socket commands" of Management Guide |
| 14597 | for more details. |
| 14598 | |
| 14599 | When an object is delivered from the cache, the server name in the log is |
| 14600 | replaced by "<CACHE>". |
| 14601 | |
| 14602 | |
| 14603 | 6.1. Limitation |
| 14604 | ---------------- |
| 14605 | |
| 14606 | The cache won't store and won't deliver objects in these cases: |
| 14607 | |
| 14608 | - If the response is not a 200 |
Remi Tricot-Le Breton | 4f73083 | 2020-11-26 15:51:50 +0100 | [diff] [blame] | 14609 | - If the response contains a Vary header and either the process-vary option is |
| 14610 | disabled, or a currently unmanaged header is specified in the Vary value (only |
| 14611 | accept-encoding and referer are managed for now) |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 14612 | - If the Content-Length + the headers size is greater than "max-object-size" |
| 14613 | - If the response is not cacheable |
Remi Tricot-Le Breton | d493bc8 | 2020-11-26 15:51:29 +0100 | [diff] [blame] | 14614 | - If the response does not have an explicit expiration time (s-maxage or max-age |
| 14615 | Cache-Control directives or Expires header) or a validator (ETag or Last-Modified |
| 14616 | headers) |
Remi Tricot-Le Breton | 5853c0c | 2020-12-10 17:58:43 +0100 | [diff] [blame] | 14617 | - If the process-vary option is enabled and there are already max-secondary-entries |
| 14618 | entries with the same primary key as the current response |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 14619 | |
| 14620 | - If the request is not a GET |
| 14621 | - If the HTTP version of the request is smaller than 1.1 |
| 14622 | - If the request contains an Authorization header |
| 14623 | |
| 14624 | |
| 14625 | 6.2. Setup |
| 14626 | ----------- |
| 14627 | |
| 14628 | To setup a cache, you must define a cache section and use it in a proxy with |
| 14629 | the corresponding http-request and response actions. |
| 14630 | |
| 14631 | |
| 14632 | 6.2.1. Cache section |
| 14633 | --------------------- |
| 14634 | |
| 14635 | cache <name> |
| 14636 | Declare a cache section, allocate a shared cache memory named <name>, the |
| 14637 | size of cache is mandatory. |
| 14638 | |
| 14639 | total-max-size <megabytes> |
| 14640 | Define the size in RAM of the cache in megabytes. This size is split in |
| 14641 | blocks of 1kB which are used by the cache entries. Its maximum value is 4095. |
| 14642 | |
| 14643 | max-object-size <bytes> |
| 14644 | Define the maximum size of the objects to be cached. Must not be greater than |
| 14645 | an half of "total-max-size". If not set, it equals to a 256th of the cache size. |
| 14646 | All objects with sizes larger than "max-object-size" will not be cached. |
| 14647 | |
| 14648 | max-age <seconds> |
Remi Tricot-Le Breton | 5853c0c | 2020-12-10 17:58:43 +0100 | [diff] [blame] | 14649 | Define the maximum expiration duration. The expiration is set as the lowest |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 14650 | value between the s-maxage or max-age (in this order) directive in the |
| 14651 | Cache-Control response header and this value. The default value is 60 |
| 14652 | seconds, which means that you can't cache an object more than 60 seconds by |
| 14653 | default. |
| 14654 | |
Remi Tricot-Le Breton | e6cc5b5 | 2020-12-23 18:13:53 +0100 | [diff] [blame] | 14655 | process-vary <on/off> |
| 14656 | Enable or disable the processing of the Vary header. When disabled, a response |
Remi Tricot-Le Breton | 754b242 | 2020-11-16 15:56:10 +0100 | [diff] [blame] | 14657 | containing such a header will never be cached. When enabled, we need to calculate |
| 14658 | a preliminary hash for a subset of request headers on all the incoming requests |
| 14659 | (which might come with a cpu cost) which will be used to build a secondary key |
Remi Tricot-Le Breton | e6cc5b5 | 2020-12-23 18:13:53 +0100 | [diff] [blame] | 14660 | for a given request (see RFC 7234#4.1). The default value is off (disabled). |
Remi Tricot-Le Breton | 754b242 | 2020-11-16 15:56:10 +0100 | [diff] [blame] | 14661 | |
Remi Tricot-Le Breton | 5853c0c | 2020-12-10 17:58:43 +0100 | [diff] [blame] | 14662 | max-secondary-entries <number> |
| 14663 | Define the maximum number of simultaneous secondary entries with the same primary |
| 14664 | key in the cache. This needs the vary support to be enabled. Its default value is 10 |
| 14665 | and should be passed a strictly positive integer. |
| 14666 | |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 14667 | |
| 14668 | 6.2.2. Proxy section |
| 14669 | --------------------- |
| 14670 | |
| 14671 | http-request cache-use <name> [ { if | unless } <condition> ] |
| 14672 | Try to deliver a cached object from the cache <name>. This directive is also |
| 14673 | mandatory to store the cache as it calculates the cache hash. If you want to |
| 14674 | use a condition for both storage and delivering that's a good idea to put it |
| 14675 | after this one. |
| 14676 | |
| 14677 | http-response cache-store <name> [ { if | unless } <condition> ] |
| 14678 | Store an http-response within the cache. The storage of the response headers |
| 14679 | is done at this step, which means you can use others http-response actions |
| 14680 | to modify headers before or after the storage of the response. This action |
| 14681 | is responsible for the setup of the cache storage filter. |
| 14682 | |
| 14683 | |
| 14684 | Example: |
| 14685 | |
| 14686 | backend bck1 |
| 14687 | mode http |
| 14688 | |
| 14689 | http-request cache-use foobar |
| 14690 | http-response cache-store foobar |
| 14691 | server srv1 127.0.0.1:80 |
| 14692 | |
| 14693 | cache foobar |
| 14694 | total-max-size 4 |
| 14695 | max-age 240 |
| 14696 | |
| 14697 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14698 | 7. Using ACLs and fetching samples |
| 14699 | ---------------------------------- |
| 14700 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14701 | HAProxy is capable of extracting data from request or response streams, from |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14702 | client or server information, from tables, environmental information etc... |
| 14703 | The action of extracting such data is called fetching a sample. Once retrieved, |
| 14704 | these samples may be used for various purposes such as a key to a stick-table, |
| 14705 | but most common usages consist in matching them against predefined constant |
| 14706 | data called patterns. |
| 14707 | |
| 14708 | |
| 14709 | 7.1. ACL basics |
| 14710 | --------------- |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14711 | |
| 14712 | The use of Access Control Lists (ACL) provides a flexible solution to perform |
| 14713 | content switching and generally to take decisions based on content extracted |
| 14714 | from the request, the response or any environmental status. The principle is |
| 14715 | simple : |
| 14716 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14717 | - extract a data sample from a stream, table or the environment |
Willy Tarreau | e6b11e4 | 2013-11-26 19:02:32 +0100 | [diff] [blame] | 14718 | - optionally apply some format conversion to the extracted sample |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14719 | - apply one or multiple pattern matching methods on this sample |
| 14720 | - perform actions only when a pattern matches the sample |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14721 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14722 | The actions generally consist in blocking a request, selecting a backend, or |
| 14723 | adding a header. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14724 | |
| 14725 | In order to define a test, the "acl" keyword is used. The syntax is : |
| 14726 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14727 | acl <aclname> <criterion> [flags] [operator] [<value>] ... |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14728 | |
| 14729 | This creates a new ACL <aclname> or completes an existing one with new tests. |
| 14730 | Those tests apply to the portion of request/response specified in <criterion> |
| 14731 | and may be adjusted with optional flags [flags]. Some criteria also support |
Willy Tarreau | e6b11e4 | 2013-11-26 19:02:32 +0100 | [diff] [blame] | 14732 | an operator which may be specified before the set of values. Optionally some |
| 14733 | conversion operators may be applied to the sample, and they will be specified |
| 14734 | as a comma-delimited list of keywords just after the first keyword. The values |
| 14735 | are of the type supported by the criterion, and are separated by spaces. |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14736 | |
| 14737 | ACL names must be formed from upper and lower case letters, digits, '-' (dash), |
| 14738 | '_' (underscore) , '.' (dot) and ':' (colon). ACL names are case-sensitive, |
| 14739 | which means that "my_acl" and "My_Acl" are two different ACLs. |
| 14740 | |
| 14741 | There is no enforced limit to the number of ACLs. The unused ones do not affect |
| 14742 | performance, they just consume a small amount of memory. |
| 14743 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14744 | The criterion generally is the name of a sample fetch method, or one of its ACL |
| 14745 | specific declinations. The default test method is implied by the output type of |
| 14746 | this sample fetch method. The ACL declinations can describe alternate matching |
Willy Tarreau | e6b11e4 | 2013-11-26 19:02:32 +0100 | [diff] [blame] | 14747 | methods of a same sample fetch method. The sample fetch methods are the only |
| 14748 | ones supporting a conversion. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14749 | |
| 14750 | Sample fetch methods return data which can be of the following types : |
| 14751 | - boolean |
| 14752 | - integer (signed or unsigned) |
| 14753 | - IPv4 or IPv6 address |
| 14754 | - string |
| 14755 | - data block |
| 14756 | |
Willy Tarreau | e6b11e4 | 2013-11-26 19:02:32 +0100 | [diff] [blame] | 14757 | Converters transform any of these data into any of these. For example, some |
| 14758 | converters might convert a string to a lower-case string while other ones |
| 14759 | would turn a string to an IPv4 address, or apply a netmask to an IP address. |
| 14760 | The resulting sample is of the type of the last converter applied to the list, |
| 14761 | which defaults to the type of the sample fetch method. |
| 14762 | |
Thierry FOURNIER | 2a06e39 | 2014-05-11 15:49:55 +0200 | [diff] [blame] | 14763 | Each sample or converter returns data of a specific type, specified with its |
| 14764 | keyword in this documentation. When an ACL is declared using a standard sample |
| 14765 | fetch method, certain types automatically involved a default matching method |
| 14766 | which are summarized in the table below : |
| 14767 | |
| 14768 | +---------------------+-----------------+ |
| 14769 | | Sample or converter | Default | |
| 14770 | | output type | matching method | |
| 14771 | +---------------------+-----------------+ |
| 14772 | | boolean | bool | |
| 14773 | +---------------------+-----------------+ |
| 14774 | | integer | int | |
| 14775 | +---------------------+-----------------+ |
| 14776 | | ip | ip | |
| 14777 | +---------------------+-----------------+ |
| 14778 | | string | str | |
| 14779 | +---------------------+-----------------+ |
| 14780 | | binary | none, use "-m" | |
| 14781 | +---------------------+-----------------+ |
| 14782 | |
| 14783 | Note that in order to match a binary samples, it is mandatory to specify a |
| 14784 | matching method, see below. |
| 14785 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14786 | The ACL engine can match these types against patterns of the following types : |
| 14787 | - boolean |
| 14788 | - integer or integer range |
| 14789 | - IP address / network |
| 14790 | - string (exact, substring, suffix, prefix, subdir, domain) |
| 14791 | - regular expression |
| 14792 | - hex block |
| 14793 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 14794 | The following ACL flags are currently supported : |
| 14795 | |
Willy Tarreau | 2b5285d | 2010-05-09 23:45:24 +0200 | [diff] [blame] | 14796 | -i : ignore case during matching of all subsequent patterns. |
| 14797 | -f : load patterns from a file. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14798 | -m : use a specific pattern matching method |
Thierry FOURNIER | b7729c9 | 2014-02-11 16:24:41 +0100 | [diff] [blame] | 14799 | -n : forbid the DNS resolutions |
Thierry FOURNIER | 9860c41 | 2014-01-29 14:23:29 +0100 | [diff] [blame] | 14800 | -M : load the file pointed by -f like a map file. |
Thierry FOURNIER | 3534d88 | 2014-01-20 17:01:44 +0100 | [diff] [blame] | 14801 | -u : force the unique id of the ACL |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 14802 | -- : force end of flags. Useful when a string looks like one of the flags. |
| 14803 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14804 | The "-f" flag is followed by the name of a file from which all lines will be |
| 14805 | read as individual values. It is even possible to pass multiple "-f" arguments |
| 14806 | if the patterns are to be loaded from multiple files. Empty lines as well as |
| 14807 | lines beginning with a sharp ('#') will be ignored. All leading spaces and tabs |
| 14808 | will be stripped. If it is absolutely necessary to insert a valid pattern |
| 14809 | beginning with a sharp, just prefix it with a space so that it is not taken for |
| 14810 | a comment. Depending on the data type and match method, haproxy may load the |
| 14811 | lines into a binary tree, allowing very fast lookups. This is true for IPv4 and |
| 14812 | exact string matching. In this case, duplicates will automatically be removed. |
| 14813 | |
Thierry FOURNIER | 9860c41 | 2014-01-29 14:23:29 +0100 | [diff] [blame] | 14814 | The "-M" flag allows an ACL to use a map file. If this flag is set, the file is |
| 14815 | parsed as two column file. The first column contains the patterns used by the |
| 14816 | ACL, and the second column contain the samples. The sample can be used later by |
| 14817 | a map. This can be useful in some rare cases where an ACL would just be used to |
| 14818 | check for the existence of a pattern in a map before a mapping is applied. |
| 14819 | |
Thierry FOURNIER | 3534d88 | 2014-01-20 17:01:44 +0100 | [diff] [blame] | 14820 | The "-u" flag forces the unique id of the ACL. This unique id is used with the |
| 14821 | socket interface to identify ACL and dynamically change its values. Note that a |
| 14822 | file is always identified by its name even if an id is set. |
| 14823 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14824 | Also, note that the "-i" flag applies to subsequent entries and not to entries |
| 14825 | loaded from files preceding it. For instance : |
| 14826 | |
| 14827 | acl valid-ua hdr(user-agent) -f exact-ua.lst -i -f generic-ua.lst test |
| 14828 | |
| 14829 | In this example, each line of "exact-ua.lst" will be exactly matched against |
| 14830 | the "user-agent" header of the request. Then each line of "generic-ua" will be |
| 14831 | case-insensitively matched. Then the word "test" will be insensitively matched |
| 14832 | as well. |
| 14833 | |
| 14834 | The "-m" flag is used to select a specific pattern matching method on the input |
| 14835 | sample. All ACL-specific criteria imply a pattern matching method and generally |
| 14836 | do not need this flag. However, this flag is useful with generic sample fetch |
| 14837 | methods to describe how they're going to be matched against the patterns. This |
| 14838 | is required for sample fetches which return data type for which there is no |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14839 | obvious matching method (e.g. string or binary). When "-m" is specified and |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14840 | followed by a pattern matching method name, this method is used instead of the |
| 14841 | default one for the criterion. This makes it possible to match contents in ways |
| 14842 | that were not initially planned, or with sample fetch methods which return a |
| 14843 | string. The matching method also affects the way the patterns are parsed. |
| 14844 | |
Thierry FOURNIER | b7729c9 | 2014-02-11 16:24:41 +0100 | [diff] [blame] | 14845 | The "-n" flag forbids the dns resolutions. It is used with the load of ip files. |
| 14846 | By default, if the parser cannot parse ip address it considers that the parsed |
| 14847 | string is maybe a domain name and try dns resolution. The flag "-n" disable this |
| 14848 | resolution. It is useful for detecting malformed ip lists. Note that if the DNS |
| 14849 | server is not reachable, the haproxy configuration parsing may last many minutes |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 14850 | waiting for the timeout. During this time no error messages are displayed. The |
Thierry FOURNIER | b7729c9 | 2014-02-11 16:24:41 +0100 | [diff] [blame] | 14851 | flag "-n" disable this behavior. Note also that during the runtime, this |
| 14852 | function is disabled for the dynamic acl modifications. |
| 14853 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14854 | There are some restrictions however. Not all methods can be used with all |
| 14855 | sample fetch methods. Also, if "-m" is used in conjunction with "-f", it must |
| 14856 | be placed first. The pattern matching method must be one of the following : |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14857 | |
| 14858 | - "found" : only check if the requested sample could be found in the stream, |
| 14859 | but do not compare it against any pattern. It is recommended not |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14860 | to pass any pattern to avoid confusion. This matching method is |
| 14861 | particularly useful to detect presence of certain contents such |
| 14862 | as headers, cookies, etc... even if they are empty and without |
| 14863 | comparing them to anything nor counting them. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14864 | |
| 14865 | - "bool" : check the value as a boolean. It can only be applied to fetches |
| 14866 | which return a boolean or integer value, and takes no pattern. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14867 | Value zero or false does not match, all other values do match. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14868 | |
| 14869 | - "int" : match the value as an integer. It can be used with integer and |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14870 | boolean samples. Boolean false is integer 0, true is integer 1. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14871 | |
| 14872 | - "ip" : match the value as an IPv4 or IPv6 address. It is compatible |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14873 | with IP address samples only, so it is implied and never needed. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14874 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 14875 | - "bin" : match the contents against a hexadecimal string representing a |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14876 | binary sequence. This may be used with binary or string samples. |
| 14877 | |
| 14878 | - "len" : match the sample's length as an integer. This may be used with |
| 14879 | binary or string samples. |
| 14880 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14881 | - "str" : exact match : match the contents against a string. This may be |
| 14882 | used with binary or string samples. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14883 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14884 | - "sub" : substring match : check that the contents contain at least one of |
| 14885 | the provided string patterns. This may be used with binary or |
| 14886 | string samples. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14887 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14888 | - "reg" : regex match : match the contents against a list of regular |
| 14889 | expressions. This may be used with binary or string samples. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14890 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14891 | - "beg" : prefix match : check that the contents begin like the provided |
| 14892 | string patterns. This may be used with binary or string samples. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14893 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14894 | - "end" : suffix match : check that the contents end like the provided |
| 14895 | string patterns. This may be used with binary or string samples. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14896 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14897 | - "dir" : subdir match : check that a slash-delimited portion of the |
| 14898 | contents exactly matches one of the provided string patterns. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14899 | This may be used with binary or string samples. |
| 14900 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14901 | - "dom" : domain match : check that a dot-delimited portion of the contents |
| 14902 | exactly match one of the provided string patterns. This may be |
| 14903 | used with binary or string samples. |
Willy Tarreau | 5adeda1 | 2013-03-31 22:13:34 +0200 | [diff] [blame] | 14904 | |
| 14905 | For example, to quickly detect the presence of cookie "JSESSIONID" in an HTTP |
| 14906 | request, it is possible to do : |
| 14907 | |
| 14908 | acl jsess_present cook(JSESSIONID) -m found |
| 14909 | |
| 14910 | In order to apply a regular expression on the 500 first bytes of data in the |
| 14911 | buffer, one would use the following acl : |
| 14912 | |
| 14913 | acl script_tag payload(0,500) -m reg -i <script> |
| 14914 | |
Willy Tarreau | e6b11e4 | 2013-11-26 19:02:32 +0100 | [diff] [blame] | 14915 | On systems where the regex library is much slower when using "-i", it is |
| 14916 | possible to convert the sample to lowercase before matching, like this : |
| 14917 | |
| 14918 | acl script_tag payload(0,500),lower -m reg <script> |
| 14919 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14920 | All ACL-specific criteria imply a default matching method. Most often, these |
| 14921 | criteria are composed by concatenating the name of the original sample fetch |
| 14922 | method and the matching method. For example, "hdr_beg" applies the "beg" match |
| 14923 | to samples retrieved using the "hdr" fetch method. Since all ACL-specific |
| 14924 | criteria rely on a sample fetch method, it is always possible instead to use |
| 14925 | the original sample fetch method and the explicit matching method using "-m". |
Willy Tarreau | 2b5285d | 2010-05-09 23:45:24 +0200 | [diff] [blame] | 14926 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14927 | If an alternate match is specified using "-m" on an ACL-specific criterion, |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 14928 | the matching method is simply applied to the underlying sample fetch method. |
| 14929 | For example, all ACLs below are exact equivalent : |
Willy Tarreau | 2b5285d | 2010-05-09 23:45:24 +0200 | [diff] [blame] | 14930 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14931 | acl short_form hdr_beg(host) www. |
| 14932 | acl alternate1 hdr_beg(host) -m beg www. |
| 14933 | acl alternate2 hdr_dom(host) -m beg www. |
| 14934 | acl alternate3 hdr(host) -m beg www. |
Willy Tarreau | 2b5285d | 2010-05-09 23:45:24 +0200 | [diff] [blame] | 14935 | |
Willy Tarreau | 2b5285d | 2010-05-09 23:45:24 +0200 | [diff] [blame] | 14936 | |
Thierry FOURNIER | 2a06e39 | 2014-05-11 15:49:55 +0200 | [diff] [blame] | 14937 | The table below summarizes the compatibility matrix between sample or converter |
| 14938 | types and the pattern types to fetch against. It indicates for each compatible |
| 14939 | combination the name of the matching method to be used, surrounded with angle |
| 14940 | brackets ">" and "<" when the method is the default one and will work by |
| 14941 | default without "-m". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 14942 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14943 | +-------------------------------------------------+ |
| 14944 | | Input sample type | |
| 14945 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | 2a06e39 | 2014-05-11 15:49:55 +0200 | [diff] [blame] | 14946 | | pattern type | boolean | integer | ip | string | binary | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14947 | +----------------------+---------+---------+---------+---------+---------+ |
| 14948 | | none (presence only) | found | found | found | found | found | |
| 14949 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | 2a06e39 | 2014-05-11 15:49:55 +0200 | [diff] [blame] | 14950 | | none (boolean value) |> bool <| bool | | bool | | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14951 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | 2a06e39 | 2014-05-11 15:49:55 +0200 | [diff] [blame] | 14952 | | integer (value) | int |> int <| int | int | | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14953 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | e3ded59 | 2013-12-06 15:36:54 +0100 | [diff] [blame] | 14954 | | integer (length) | len | len | len | len | len | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14955 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | 2a06e39 | 2014-05-11 15:49:55 +0200 | [diff] [blame] | 14956 | | IP address | | |> ip <| ip | ip | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14957 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | 2a06e39 | 2014-05-11 15:49:55 +0200 | [diff] [blame] | 14958 | | exact string | str | str | str |> str <| str | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14959 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | e3ded59 | 2013-12-06 15:36:54 +0100 | [diff] [blame] | 14960 | | prefix | beg | beg | beg | beg | beg | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14961 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | e3ded59 | 2013-12-06 15:36:54 +0100 | [diff] [blame] | 14962 | | suffix | end | end | end | end | end | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14963 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | e3ded59 | 2013-12-06 15:36:54 +0100 | [diff] [blame] | 14964 | | substring | sub | sub | sub | sub | sub | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14965 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | e3ded59 | 2013-12-06 15:36:54 +0100 | [diff] [blame] | 14966 | | subdir | dir | dir | dir | dir | dir | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14967 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | e3ded59 | 2013-12-06 15:36:54 +0100 | [diff] [blame] | 14968 | | domain | dom | dom | dom | dom | dom | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14969 | +----------------------+---------+---------+---------+---------+---------+ |
Thierry FOURNIER | e3ded59 | 2013-12-06 15:36:54 +0100 | [diff] [blame] | 14970 | | regex | reg | reg | reg | reg | reg | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14971 | +----------------------+---------+---------+---------+---------+---------+ |
| 14972 | | hex block | | | | bin | bin | |
| 14973 | +----------------------+---------+---------+---------+---------+---------+ |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 14974 | |
| 14975 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14976 | 7.1.1. Matching booleans |
| 14977 | ------------------------ |
| 14978 | |
| 14979 | In order to match a boolean, no value is needed and all values are ignored. |
| 14980 | Boolean matching is used by default for all fetch methods of type "boolean". |
| 14981 | When boolean matching is used, the fetched value is returned as-is, which means |
| 14982 | that a boolean "true" will always match and a boolean "false" will never match. |
| 14983 | |
| 14984 | Boolean matching may also be enforced using "-m bool" on fetch methods which |
| 14985 | return an integer value. Then, integer value 0 is converted to the boolean |
| 14986 | "false" and all other values are converted to "true". |
| 14987 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 14988 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 14989 | 7.1.2. Matching integers |
| 14990 | ------------------------ |
| 14991 | |
| 14992 | Integer matching applies by default to integer fetch methods. It can also be |
| 14993 | enforced on boolean fetches using "-m int". In this case, "false" is converted |
| 14994 | to the integer 0, and "true" is converted to the integer 1. |
| 14995 | |
| 14996 | Integer matching also supports integer ranges and operators. Note that integer |
| 14997 | matching only applies to positive values. A range is a value expressed with a |
| 14998 | lower and an upper bound separated with a colon, both of which may be omitted. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 14999 | |
| 15000 | For instance, "1024:65535" is a valid range to represent a range of |
| 15001 | unprivileged ports, and "1024:" would also work. "0:1023" is a valid |
| 15002 | representation of privileged ports, and ":1023" would also work. |
| 15003 | |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 15004 | As a special case, some ACL functions support decimal numbers which are in fact |
| 15005 | two integers separated by a dot. This is used with some version checks for |
| 15006 | instance. All integer properties apply to those decimal numbers, including |
| 15007 | ranges and operators. |
| 15008 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15009 | For an easier usage, comparison operators are also supported. Note that using |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 15010 | operators with ranges does not make much sense and is strongly discouraged. |
| 15011 | Similarly, it does not make much sense to perform order comparisons with a set |
| 15012 | of values. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15013 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 15014 | Available operators for integer matching are : |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15015 | |
| 15016 | eq : true if the tested value equals at least one value |
| 15017 | ge : true if the tested value is greater than or equal to at least one value |
| 15018 | gt : true if the tested value is greater than at least one value |
| 15019 | le : true if the tested value is less than or equal to at least one value |
| 15020 | lt : true if the tested value is less than at least one value |
| 15021 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 15022 | For instance, the following ACL matches any negative Content-Length header : |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15023 | |
| 15024 | acl negative-length hdr_val(content-length) lt 0 |
| 15025 | |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 15026 | This one matches SSL versions between 3.0 and 3.1 (inclusive) : |
| 15027 | |
| 15028 | acl sslv3 req_ssl_ver 3:3.1 |
| 15029 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15030 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15031 | 7.1.3. Matching strings |
| 15032 | ----------------------- |
| 15033 | |
| 15034 | String matching applies to string or binary fetch methods, and exists in 6 |
| 15035 | different forms : |
| 15036 | |
| 15037 | - exact match (-m str) : the extracted string must exactly match the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15038 | patterns; |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15039 | |
| 15040 | - substring match (-m sub) : the patterns are looked up inside the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15041 | extracted string, and the ACL matches if any of them is found inside; |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15042 | |
| 15043 | - prefix match (-m beg) : the patterns are compared with the beginning of |
| 15044 | the extracted string, and the ACL matches if any of them matches. |
| 15045 | |
| 15046 | - suffix match (-m end) : the patterns are compared with the end of the |
| 15047 | extracted string, and the ACL matches if any of them matches. |
| 15048 | |
Baptiste Assmann | 33db600 | 2016-03-06 23:32:10 +0100 | [diff] [blame] | 15049 | - subdir match (-m dir) : the patterns are looked up inside the extracted |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15050 | string, delimited with slashes ("/"), and the ACL matches if any of them |
| 15051 | matches. |
| 15052 | |
| 15053 | - domain match (-m dom) : the patterns are looked up inside the extracted |
| 15054 | string, delimited with dots ("."), and the ACL matches if any of them |
| 15055 | matches. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15056 | |
| 15057 | String matching applies to verbatim strings as they are passed, with the |
| 15058 | exception of the backslash ("\") which makes it possible to escape some |
| 15059 | characters such as the space. If the "-i" flag is passed before the first |
| 15060 | string, then the matching will be performed ignoring the case. In order |
| 15061 | to match the string "-i", either set it second, or pass the "--" flag |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 15062 | before the first string. Same applies of course to match the string "--". |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15063 | |
Mathias Weiersmueller | cb250fc | 2019-12-02 09:43:40 +0100 | [diff] [blame] | 15064 | Do not use string matches for binary fetches which might contain null bytes |
| 15065 | (0x00), as the comparison stops at the occurrence of the first null byte. |
| 15066 | Instead, convert the binary fetch to a hex string with the hex converter first. |
| 15067 | |
| 15068 | Example: |
| 15069 | # matches if the string <tag> is present in the binary sample |
| 15070 | acl tag_found req.payload(0,0),hex -m sub 3C7461673E |
| 15071 | |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15072 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15073 | 7.1.4. Matching regular expressions (regexes) |
| 15074 | --------------------------------------------- |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15075 | |
| 15076 | Just like with string matching, regex matching applies to verbatim strings as |
| 15077 | they are passed, with the exception of the backslash ("\") which makes it |
| 15078 | possible to escape some characters such as the space. If the "-i" flag is |
| 15079 | passed before the first regex, then the matching will be performed ignoring |
| 15080 | the case. In order to match the string "-i", either set it second, or pass |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 15081 | the "--" flag before the first string. Same principle applies of course to |
| 15082 | match the string "--". |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15083 | |
| 15084 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15085 | 7.1.5. Matching arbitrary data blocks |
| 15086 | ------------------------------------- |
| 15087 | |
| 15088 | It is possible to match some extracted samples against a binary block which may |
| 15089 | not safely be represented as a string. For this, the patterns must be passed as |
| 15090 | a series of hexadecimal digits in an even number, when the match method is set |
| 15091 | to binary. Each sequence of two digits will represent a byte. The hexadecimal |
| 15092 | digits may be used upper or lower case. |
| 15093 | |
| 15094 | Example : |
| 15095 | # match "Hello\n" in the input stream (\x48 \x65 \x6c \x6c \x6f \x0a) |
| 15096 | acl hello payload(0,6) -m bin 48656c6c6f0a |
| 15097 | |
| 15098 | |
| 15099 | 7.1.6. Matching IPv4 and IPv6 addresses |
| 15100 | --------------------------------------- |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15101 | |
| 15102 | IPv4 addresses values can be specified either as plain addresses or with a |
| 15103 | netmask appended, in which case the IPv4 address matches whenever it is |
| 15104 | within the network. Plain addresses may also be replaced with a resolvable |
Willy Tarreau | d2a4aa2 | 2008-01-31 15:28:22 +0100 | [diff] [blame] | 15105 | host name, but this practice is generally discouraged as it makes it more |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 15106 | difficult to read and debug configurations. If hostnames are used, you should |
| 15107 | at least ensure that they are present in /etc/hosts so that the configuration |
| 15108 | does not depend on any random DNS match at the moment the configuration is |
| 15109 | parsed. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15110 | |
Daniel Schneller | eba5634 | 2016-04-13 00:26:52 +0200 | [diff] [blame] | 15111 | The dotted IPv4 address notation is supported in both regular as well as the |
| 15112 | abbreviated form with all-0-octets omitted: |
| 15113 | |
| 15114 | +------------------+------------------+------------------+ |
| 15115 | | Example 1 | Example 2 | Example 3 | |
| 15116 | +------------------+------------------+------------------+ |
| 15117 | | 192.168.0.1 | 10.0.0.12 | 127.0.0.1 | |
| 15118 | | 192.168.1 | 10.12 | 127.1 | |
| 15119 | | 192.168.0.1/22 | 10.0.0.12/8 | 127.0.0.1/8 | |
| 15120 | | 192.168.1/22 | 10.12/8 | 127.1/8 | |
| 15121 | +------------------+------------------+------------------+ |
| 15122 | |
| 15123 | Notice that this is different from RFC 4632 CIDR address notation in which |
| 15124 | 192.168.42/24 would be equivalent to 192.168.42.0/24. |
| 15125 | |
Willy Tarreau | ceb4ac9 | 2012-04-28 00:41:46 +0200 | [diff] [blame] | 15126 | IPv6 may be entered in their usual form, with or without a netmask appended. |
| 15127 | Only bit counts are accepted for IPv6 netmasks. In order to avoid any risk of |
| 15128 | trouble with randomly resolved IP addresses, host names are never allowed in |
| 15129 | IPv6 patterns. |
| 15130 | |
| 15131 | HAProxy is also able to match IPv4 addresses with IPv6 addresses in the |
| 15132 | following situations : |
| 15133 | - tested address is IPv4, pattern address is IPv4, the match applies |
| 15134 | in IPv4 using the supplied mask if any. |
| 15135 | - tested address is IPv6, pattern address is IPv6, the match applies |
| 15136 | in IPv6 using the supplied mask if any. |
| 15137 | - tested address is IPv6, pattern address is IPv4, the match applies in IPv4 |
| 15138 | using the pattern's mask if the IPv6 address matches with 2002:IPV4::, |
| 15139 | ::IPV4 or ::ffff:IPV4, otherwise it fails. |
| 15140 | - tested address is IPv4, pattern address is IPv6, the IPv4 address is first |
| 15141 | converted to IPv6 by prefixing ::ffff: in front of it, then the match is |
| 15142 | applied in IPv6 using the supplied IPv6 mask. |
| 15143 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15144 | |
| 15145 | 7.2. Using ACLs to form conditions |
| 15146 | ---------------------------------- |
| 15147 | |
| 15148 | Some actions are only performed upon a valid condition. A condition is a |
| 15149 | combination of ACLs with operators. 3 operators are supported : |
| 15150 | |
| 15151 | - AND (implicit) |
| 15152 | - OR (explicit with the "or" keyword or the "||" operator) |
| 15153 | - Negation with the exclamation mark ("!") |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15154 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15155 | A condition is formed as a disjunctive form: |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 15156 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15157 | [!]acl1 [!]acl2 ... [!]acln { or [!]acl1 [!]acl2 ... [!]acln } ... |
Willy Tarreau | bef91e7 | 2013-03-31 23:14:46 +0200 | [diff] [blame] | 15158 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15159 | Such conditions are generally used after an "if" or "unless" statement, |
| 15160 | indicating when the condition will trigger the action. |
Willy Tarreau | bef91e7 | 2013-03-31 23:14:46 +0200 | [diff] [blame] | 15161 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15162 | For instance, to block HTTP requests to the "*" URL with methods other than |
| 15163 | "OPTIONS", as well as POST requests without content-length, and GET or HEAD |
| 15164 | requests with a content-length greater than 0, and finally every request which |
| 15165 | is not either GET/HEAD/POST/OPTIONS ! |
| 15166 | |
| 15167 | acl missing_cl hdr_cnt(Content-length) eq 0 |
Jarno Huuskonen | 84c51ec | 2017-04-03 14:20:34 +0300 | [diff] [blame] | 15168 | http-request deny if HTTP_URL_STAR !METH_OPTIONS || METH_POST missing_cl |
| 15169 | http-request deny if METH_GET HTTP_CONTENT |
| 15170 | http-request deny unless METH_GET or METH_POST or METH_OPTIONS |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15171 | |
| 15172 | To select a different backend for requests to static contents on the "www" site |
| 15173 | and to every request on the "img", "video", "download" and "ftp" hosts : |
| 15174 | |
| 15175 | acl url_static path_beg /static /images /img /css |
| 15176 | acl url_static path_end .gif .png .jpg .css .js |
| 15177 | acl host_www hdr_beg(host) -i www |
| 15178 | acl host_static hdr_beg(host) -i img. video. download. ftp. |
| 15179 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15180 | # now use backend "static" for all static-only hosts, and for static URLs |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15181 | # of host "www". Use backend "www" for the rest. |
| 15182 | use_backend static if host_static or host_www url_static |
| 15183 | use_backend www if host_www |
| 15184 | |
| 15185 | It is also possible to form rules using "anonymous ACLs". Those are unnamed ACL |
| 15186 | expressions that are built on the fly without needing to be declared. They must |
| 15187 | be enclosed between braces, with a space before and after each brace (because |
| 15188 | the braces must be seen as independent words). Example : |
| 15189 | |
| 15190 | The following rule : |
| 15191 | |
| 15192 | acl missing_cl hdr_cnt(Content-length) eq 0 |
Jarno Huuskonen | 84c51ec | 2017-04-03 14:20:34 +0300 | [diff] [blame] | 15193 | http-request deny if METH_POST missing_cl |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15194 | |
| 15195 | Can also be written that way : |
| 15196 | |
Jarno Huuskonen | 84c51ec | 2017-04-03 14:20:34 +0300 | [diff] [blame] | 15197 | http-request deny if METH_POST { hdr_cnt(Content-length) eq 0 } |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15198 | |
| 15199 | It is generally not recommended to use this construct because it's a lot easier |
| 15200 | to leave errors in the configuration when written that way. However, for very |
| 15201 | simple rules matching only one source IP address for instance, it can make more |
| 15202 | sense to use them than to declare ACLs with random names. Another example of |
| 15203 | good use is the following : |
| 15204 | |
| 15205 | With named ACLs : |
| 15206 | |
| 15207 | acl site_dead nbsrv(dynamic) lt 2 |
| 15208 | acl site_dead nbsrv(static) lt 2 |
| 15209 | monitor fail if site_dead |
| 15210 | |
| 15211 | With anonymous ACLs : |
| 15212 | |
| 15213 | monitor fail if { nbsrv(dynamic) lt 2 } || { nbsrv(static) lt 2 } |
| 15214 | |
Jarno Huuskonen | 84c51ec | 2017-04-03 14:20:34 +0300 | [diff] [blame] | 15215 | See section 4.2 for detailed help on the "http-request deny" and "use_backend" |
| 15216 | keywords. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15217 | |
| 15218 | |
| 15219 | 7.3. Fetching samples |
| 15220 | --------------------- |
| 15221 | |
| 15222 | Historically, sample fetch methods were only used to retrieve data to match |
| 15223 | against patterns using ACLs. With the arrival of stick-tables, a new class of |
| 15224 | sample fetch methods was created, most often sharing the same syntax as their |
| 15225 | ACL counterpart. These sample fetch methods are also known as "fetches". As |
| 15226 | of now, ACLs and fetches have converged. All ACL fetch methods have been made |
| 15227 | available as fetch methods, and ACLs may use any sample fetch method as well. |
| 15228 | |
| 15229 | This section details all available sample fetch methods and their output type. |
| 15230 | Some sample fetch methods have deprecated aliases that are used to maintain |
| 15231 | compatibility with existing configurations. They are then explicitly marked as |
| 15232 | deprecated and should not be used in new setups. |
| 15233 | |
| 15234 | The ACL derivatives are also indicated when available, with their respective |
| 15235 | matching methods. These ones all have a well defined default pattern matching |
| 15236 | method, so it is never necessary (though allowed) to pass the "-m" option to |
| 15237 | indicate how the sample will be matched using ACLs. |
| 15238 | |
| 15239 | As indicated in the sample type versus matching compatibility matrix above, |
| 15240 | when using a generic sample fetch method in an ACL, the "-m" option is |
| 15241 | mandatory unless the sample type is one of boolean, integer, IPv4 or IPv6. When |
| 15242 | the same keyword exists as an ACL keyword and as a standard fetch method, the |
| 15243 | ACL engine will automatically pick the ACL-only one by default. |
| 15244 | |
| 15245 | Some of these keywords support one or multiple mandatory arguments, and one or |
| 15246 | multiple optional arguments. These arguments are strongly typed and are checked |
| 15247 | when the configuration is parsed so that there is no risk of running with an |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15248 | incorrect argument (e.g. an unresolved backend name). Fetch function arguments |
| 15249 | are passed between parenthesis and are delimited by commas. When an argument |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15250 | is optional, it will be indicated below between square brackets ('[ ]'). When |
| 15251 | all arguments are optional, the parenthesis may be omitted. |
| 15252 | |
| 15253 | Thus, the syntax of a standard sample fetch method is one of the following : |
| 15254 | - name |
| 15255 | - name(arg1) |
| 15256 | - name(arg1,arg2) |
| 15257 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15258 | |
| 15259 | 7.3.1. Converters |
| 15260 | ----------------- |
| 15261 | |
Willy Tarreau | e6b11e4 | 2013-11-26 19:02:32 +0100 | [diff] [blame] | 15262 | Sample fetch methods may be combined with transformations to be applied on top |
| 15263 | of the fetched sample (also called "converters"). These combinations form what |
| 15264 | is called "sample expressions" and the result is a "sample". Initially this |
| 15265 | was only supported by "stick on" and "stick store-request" directives but this |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15266 | has now be extended to all places where samples may be used (ACLs, log-format, |
Willy Tarreau | e6b11e4 | 2013-11-26 19:02:32 +0100 | [diff] [blame] | 15267 | unique-id-format, add-header, ...). |
| 15268 | |
| 15269 | These transformations are enumerated as a series of specific keywords after the |
| 15270 | sample fetch method. These keywords may equally be appended immediately after |
| 15271 | the fetch keyword's argument, delimited by a comma. These keywords can also |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15272 | support some arguments (e.g. a netmask) which must be passed in parenthesis. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 15273 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15274 | A certain category of converters are bitwise and arithmetic operators which |
| 15275 | support performing basic operations on integers. Some bitwise operations are |
| 15276 | supported (and, or, xor, cpl) and some arithmetic operations are supported |
| 15277 | (add, sub, mul, div, mod, neg). Some comparators are provided (odd, even, not, |
| 15278 | bool) which make it possible to report a match without having to write an ACL. |
| 15279 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15280 | The currently available list of transformation keywords include : |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 15281 | |
Ben Shillito | f25e8e5 | 2016-12-02 14:25:37 +0000 | [diff] [blame] | 15282 | 51d.single(<prop>[,<prop>*]) |
| 15283 | Returns values for the properties requested as a string, where values are |
| 15284 | separated by the delimiter specified with "51degrees-property-separator". |
| 15285 | The device is identified using the User-Agent header passed to the |
| 15286 | converter. The function can be passed up to five property names, and if a |
| 15287 | property name can't be found, the value "NoData" is returned. |
| 15288 | |
| 15289 | Example : |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15290 | # Here the header "X-51D-DeviceTypeMobileTablet" is added to the request, |
| 15291 | # containing values for the three properties requested by using the |
Ben Shillito | f25e8e5 | 2016-12-02 14:25:37 +0000 | [diff] [blame] | 15292 | # User-Agent passed to the converter. |
| 15293 | frontend http-in |
| 15294 | bind *:8081 |
| 15295 | default_backend servers |
| 15296 | http-request set-header X-51D-DeviceTypeMobileTablet \ |
| 15297 | %[req.fhdr(User-Agent),51d.single(DeviceType,IsMobile,IsTablet)] |
| 15298 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15299 | add(<value>) |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15300 | Adds <value> to the input value of type signed integer, and returns the |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 15301 | result as a signed integer. <value> can be a numeric value or a variable |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15302 | name. The name of the variable starts with an indication about its scope. The |
| 15303 | scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 15304 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15305 | "sess" : the variable is shared with the whole session |
| 15306 | "txn" : the variable is shared with the transaction (request and response) |
| 15307 | "req" : the variable is shared only during request processing |
| 15308 | "res" : the variable is shared only during response processing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15309 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 15310 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15311 | |
Nenad Merdanovic | c31499d | 2019-03-23 11:00:32 +0100 | [diff] [blame] | 15312 | aes_gcm_dec(<bits>,<nonce>,<key>,<aead_tag>) |
| 15313 | Decrypts the raw byte input using the AES128-GCM, AES192-GCM or |
| 15314 | AES256-GCM algorithm, depending on the <bits> parameter. All other parameters |
| 15315 | need to be base64 encoded and the returned result is in raw byte format. |
| 15316 | If the <aead_tag> validation fails, the converter doesn't return any data. |
| 15317 | The <nonce>, <key> and <aead_tag> can either be strings or variables. This |
| 15318 | converter requires at least OpenSSL 1.0.1. |
| 15319 | |
| 15320 | Example: |
| 15321 | http-response set-header X-Decrypted-Text %[var(txn.enc),\ |
| 15322 | aes_gcm_dec(128,txn.nonce,Zm9vb2Zvb29mb29wZm9vbw==,txn.aead_tag)] |
| 15323 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15324 | and(<value>) |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15325 | Performs a bitwise "AND" between <value> and the input value of type signed |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 15326 | integer, and returns the result as an signed integer. <value> can be a |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15327 | numeric value or a variable name. The name of the variable starts with an |
| 15328 | indication about its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 15329 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15330 | "sess" : the variable is shared with the whole session |
| 15331 | "txn" : the variable is shared with the transaction (request and response) |
| 15332 | "req" : the variable is shared only during request processing |
| 15333 | "res" : the variable is shared only during response processing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15334 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 15335 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15336 | |
Holger Just | 1bfc24b | 2017-05-06 00:56:53 +0200 | [diff] [blame] | 15337 | b64dec |
| 15338 | Converts (decodes) a base64 encoded input string to its binary |
| 15339 | representation. It performs the inverse operation of base64(). |
| 15340 | |
Emeric Brun | 53d1a98 | 2014-04-30 18:21:37 +0200 | [diff] [blame] | 15341 | base64 |
| 15342 | Converts a binary input sample to a base64 string. It is used to log or |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15343 | transfer binary content in a way that can be reliably transferred (e.g. |
Emeric Brun | 53d1a98 | 2014-04-30 18:21:37 +0200 | [diff] [blame] | 15344 | an SSL ID can be copied in a header). |
| 15345 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15346 | bool |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15347 | Returns a boolean TRUE if the input value of type signed integer is |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15348 | non-null, otherwise returns FALSE. Used in conjunction with and(), it can be |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15349 | used to report true/false for bit testing on input values (e.g. verify the |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15350 | presence of a flag). |
| 15351 | |
Emeric Brun | 54c4ac8 | 2014-11-03 15:32:43 +0100 | [diff] [blame] | 15352 | bytes(<offset>[,<length>]) |
| 15353 | Extracts some bytes from an input binary sample. The result is a binary |
| 15354 | sample starting at an offset (in bytes) of the original sample and |
Tim Düsterhus | 4896c44 | 2016-11-29 02:15:19 +0100 | [diff] [blame] | 15355 | optionally truncated at the given length. |
Emeric Brun | 54c4ac8 | 2014-11-03 15:32:43 +0100 | [diff] [blame] | 15356 | |
Willy Tarreau | 280f42b | 2018-02-19 15:34:12 +0100 | [diff] [blame] | 15357 | concat([<start>],[<var>],[<end>]) |
| 15358 | Concatenates up to 3 fields after the current sample which is then turned to |
| 15359 | a string. The first one, <start>, is a constant string, that will be appended |
| 15360 | immediately after the existing sample. It may be omitted if not used. The |
| 15361 | second one, <var>, is a variable name. The variable will be looked up, its |
| 15362 | contents converted to a string, and it will be appended immediately after the |
| 15363 | <first> part. If the variable is not found, nothing is appended. It may be |
| 15364 | omitted as well. The third field, <end> is a constant string that will be |
| 15365 | appended after the variable. It may also be omitted. Together, these elements |
| 15366 | allow to concatenate variables with delimiters to an existing set of |
| 15367 | variables. This can be used to build new variables made of a succession of |
Willy Tarreau | ef21fac | 2020-02-14 13:37:20 +0100 | [diff] [blame] | 15368 | other variables, such as colon-delimited values. If commas or closing |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 15369 | parenthesis are needed as delimiters, they must be protected by quotes or |
Willy Tarreau | ef21fac | 2020-02-14 13:37:20 +0100 | [diff] [blame] | 15370 | backslashes, themselves protected so that they are not stripped by the first |
| 15371 | level parser. See examples below. |
Willy Tarreau | 280f42b | 2018-02-19 15:34:12 +0100 | [diff] [blame] | 15372 | |
| 15373 | Example: |
| 15374 | tcp-request session set-var(sess.src) src |
| 15375 | tcp-request session set-var(sess.dn) ssl_c_s_dn |
| 15376 | tcp-request session set-var(txn.sig) str(),concat(<ip=,sess.ip,>),concat(<dn=,sess.dn,>) |
Willy Tarreau | ef21fac | 2020-02-14 13:37:20 +0100 | [diff] [blame] | 15377 | tcp-request session set-var(txn.ipport) "str(),concat('addr=(',sess.ip),concat(',',sess.port,')')" |
Willy Tarreau | 280f42b | 2018-02-19 15:34:12 +0100 | [diff] [blame] | 15378 | http-request set-header x-hap-sig %[var(txn.sig)] |
| 15379 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15380 | cpl |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15381 | Takes the input value of type signed integer, applies a ones-complement |
| 15382 | (flips all bits) and returns the result as an signed integer. |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15383 | |
Willy Tarreau | 8059977 | 2015-01-20 19:35:24 +0100 | [diff] [blame] | 15384 | crc32([<avalanche>]) |
| 15385 | Hashes a binary input sample into an unsigned 32-bit quantity using the CRC32 |
| 15386 | hash function. Optionally, it is possible to apply a full avalanche hash |
| 15387 | function to the output if the optional <avalanche> argument equals 1. This |
| 15388 | converter uses the same functions as used by the various hash-based load |
| 15389 | balancing algorithms, so it will provide exactly the same results. It is |
| 15390 | provided for compatibility with other software which want a CRC32 to be |
| 15391 | computed on some input keys, so it follows the most common implementation as |
| 15392 | found in Ethernet, Gzip, PNG, etc... It is slower than the other algorithms |
| 15393 | but may provide a better or at least less predictable distribution. It must |
| 15394 | not be used for security purposes as a 32-bit hash is trivial to break. See |
Emmanuel Hocdet | 50791a7 | 2018-03-21 11:19:01 +0100 | [diff] [blame] | 15395 | also "djb2", "sdbm", "wt6", "crc32c" and the "hash-type" directive. |
| 15396 | |
| 15397 | crc32c([<avalanche>]) |
| 15398 | Hashes a binary input sample into an unsigned 32-bit quantity using the CRC32C |
| 15399 | hash function. Optionally, it is possible to apply a full avalanche hash |
| 15400 | function to the output if the optional <avalanche> argument equals 1. This |
| 15401 | converter uses the same functions as described in RFC4960, Appendix B [8]. |
| 15402 | It is provided for compatibility with other software which want a CRC32C to be |
| 15403 | computed on some input keys. It is slower than the other algorithms and it must |
| 15404 | not be used for security purposes as a 32-bit hash is trivial to break. See |
| 15405 | also "djb2", "sdbm", "wt6", "crc32" and the "hash-type" directive. |
Willy Tarreau | 8059977 | 2015-01-20 19:35:24 +0100 | [diff] [blame] | 15406 | |
Christopher Faulet | ea159d6 | 2020-04-01 16:21:44 +0200 | [diff] [blame] | 15407 | cut_crlf |
| 15408 | Cuts the string representation of the input sample on the first carriage |
| 15409 | return ('\r') or newline ('\n') character found. Only the string length is |
| 15410 | updated. |
| 15411 | |
David Carlier | 29b3ca3 | 2015-09-25 14:09:21 +0100 | [diff] [blame] | 15412 | da-csv-conv(<prop>[,<prop>*]) |
David Carlier | 4542b10 | 2015-06-01 13:54:29 +0200 | [diff] [blame] | 15413 | Asks the DeviceAtlas converter to identify the User Agent string passed on |
| 15414 | input, and to emit a string made of the concatenation of the properties |
| 15415 | enumerated in argument, delimited by the separator defined by the global |
| 15416 | keyword "deviceatlas-property-separator", or by default the pipe character |
David Carlier | 840b024 | 2016-03-16 10:09:55 +0000 | [diff] [blame] | 15417 | ('|'). There's a limit of 12 different properties imposed by the haproxy |
David Carlier | 4542b10 | 2015-06-01 13:54:29 +0200 | [diff] [blame] | 15418 | configuration language. |
| 15419 | |
| 15420 | Example: |
| 15421 | frontend www |
Cyril Bonté | 307ee1e | 2015-09-28 23:16:06 +0200 | [diff] [blame] | 15422 | bind *:8881 |
| 15423 | default_backend servers |
David Carlier | 840b024 | 2016-03-16 10:09:55 +0000 | [diff] [blame] | 15424 | http-request set-header X-DeviceAtlas-Data %[req.fhdr(User-Agent),da-csv(primaryHardwareType,osName,osVersion,browserName,browserVersion,browserRenderingEngine)] |
David Carlier | 4542b10 | 2015-06-01 13:54:29 +0200 | [diff] [blame] | 15425 | |
Willy Tarreau | 0851fd5 | 2019-12-17 10:07:25 +0100 | [diff] [blame] | 15426 | debug([<prefix][,<destination>]) |
| 15427 | This converter is used as debug tool. It takes a capture of the input sample |
| 15428 | and sends it to event sink <destination>, which may designate a ring buffer |
| 15429 | such as "buf0", as well as "stdout", or "stderr". Available sinks may be |
| 15430 | checked at run time by issuing "show events" on the CLI. When not specified, |
| 15431 | the output will be "buf0", which may be consulted via the CLI's "show events" |
| 15432 | command. An optional prefix <prefix> may be passed to help distinguish |
| 15433 | outputs from multiple expressions. It will then appear before the colon in |
| 15434 | the output message. The input sample is passed as-is on the output, so that |
| 15435 | it is safe to insert the debug converter anywhere in a chain, even with non- |
| 15436 | printable sample types. |
| 15437 | |
| 15438 | Example: |
| 15439 | tcp-request connection track-sc0 src,debug(track-sc) |
Thierry FOURNIER | 9687c77 | 2015-05-07 15:46:29 +0200 | [diff] [blame] | 15440 | |
Patrick Gansterer | 8e36651 | 2020-04-22 16:47:57 +0200 | [diff] [blame] | 15441 | digest(<algorithm>) |
| 15442 | Converts a binary input sample to a message digest. The result is a binary |
| 15443 | sample. The <algorithm> must be an OpenSSL message digest name (e.g. sha256). |
| 15444 | |
| 15445 | Please note that this converter is only available when haproxy has been |
| 15446 | compiled with USE_OPENSSL. |
| 15447 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15448 | div(<value>) |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15449 | Divides the input value of type signed integer by <value>, and returns the |
| 15450 | result as an signed integer. If <value> is null, the largest unsigned |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 15451 | integer is returned (typically 2^63-1). <value> can be a numeric value or a |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15452 | variable name. The name of the variable starts with an indication about its |
| 15453 | scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 15454 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15455 | "sess" : the variable is shared with the whole session |
| 15456 | "txn" : the variable is shared with the transaction (request and response) |
| 15457 | "req" : the variable is shared only during request processing |
| 15458 | "res" : the variable is shared only during response processing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15459 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 15460 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15461 | |
Willy Tarreau | 23ec4ca | 2014-07-15 20:15:37 +0200 | [diff] [blame] | 15462 | djb2([<avalanche>]) |
| 15463 | Hashes a binary input sample into an unsigned 32-bit quantity using the DJB2 |
| 15464 | hash function. Optionally, it is possible to apply a full avalanche hash |
| 15465 | function to the output if the optional <avalanche> argument equals 1. This |
| 15466 | converter uses the same functions as used by the various hash-based load |
| 15467 | balancing algorithms, so it will provide exactly the same results. It is |
| 15468 | mostly intended for debugging, but can be used as a stick-table entry to |
| 15469 | collect rough statistics. It must not be used for security purposes as a |
Emmanuel Hocdet | 50791a7 | 2018-03-21 11:19:01 +0100 | [diff] [blame] | 15470 | 32-bit hash is trivial to break. See also "crc32", "sdbm", "wt6", "crc32c", |
| 15471 | and the "hash-type" directive. |
Willy Tarreau | 23ec4ca | 2014-07-15 20:15:37 +0200 | [diff] [blame] | 15472 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15473 | even |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15474 | Returns a boolean TRUE if the input value of type signed integer is even |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15475 | otherwise returns FALSE. It is functionally equivalent to "not,and(1),bool". |
| 15476 | |
Marcin Deranek | 9631a28 | 2018-04-16 14:30:46 +0200 | [diff] [blame] | 15477 | field(<index>,<delimiters>[,<count>]) |
| 15478 | Extracts the substring at the given index counting from the beginning |
| 15479 | (positive index) or from the end (negative index) considering given delimiters |
| 15480 | from an input string. Indexes start at 1 or -1 and delimiters are a string |
| 15481 | formatted list of chars. Optionally you can specify <count> of fields to |
| 15482 | extract (default: 1). Value of 0 indicates extraction of all remaining |
| 15483 | fields. |
| 15484 | |
| 15485 | Example : |
| 15486 | str(f1_f2_f3__f5),field(5,_) # f5 |
| 15487 | str(f1_f2_f3__f5),field(2,_,0) # f2_f3__f5 |
| 15488 | str(f1_f2_f3__f5),field(2,_,2) # f2_f3 |
| 15489 | str(f1_f2_f3__f5),field(-2,_,3) # f2_f3_ |
| 15490 | str(f1_f2_f3__f5),field(-3,_,0) # f1_f2_f3 |
Emeric Brun | f399b0d | 2014-11-03 17:07:03 +0100 | [diff] [blame] | 15491 | |
Baptiste Assmann | e138dda | 2020-10-22 15:39:03 +0200 | [diff] [blame] | 15492 | fix_is_valid |
| 15493 | Parses a binary payload and performs sanity checks regarding FIX (Financial |
| 15494 | Information eXchange): |
| 15495 | |
| 15496 | - checks that all tag IDs and values are not empty and the tags IDs are well |
| 15497 | numeric |
Ilya Shipitsin | 2272d8a | 2020-12-21 01:22:40 +0500 | [diff] [blame] | 15498 | - checks the BeginString tag is the first tag with a valid FIX version |
Baptiste Assmann | e138dda | 2020-10-22 15:39:03 +0200 | [diff] [blame] | 15499 | - checks the BodyLength tag is the second one with the right body length |
| 15500 | - checks the MstType tag is the third tag. |
| 15501 | - checks that last tag in the message is the CheckSum tag with a valid |
| 15502 | checksum |
| 15503 | |
| 15504 | Due to current HAProxy design, only the first message sent by the client and |
| 15505 | the server can be parsed. |
| 15506 | |
| 15507 | This converter returns a boolean, true if the payload contains a valid FIX |
| 15508 | message, false if not. |
| 15509 | |
| 15510 | See also the fix_tag_value converter. |
| 15511 | |
| 15512 | Example: |
| 15513 | tcp-request inspect-delay 10s |
| 15514 | tcp-request content reject unless { req.payload(0,0),fix_is_valid } |
| 15515 | |
| 15516 | fix_tag_value(<tag>) |
| 15517 | Parses a FIX (Financial Information eXchange) message and extracts the value |
| 15518 | from the tag <tag>. <tag> can be a string or an integer pointing to the |
| 15519 | desired tag. Any integer value is accepted, but only the following strings |
| 15520 | are translated into their integer equivalent: BeginString, BodyLength, |
| 15521 | MsgType, SenderComID, TargetComID, CheckSum. More tag names can be easily |
| 15522 | added. |
| 15523 | |
| 15524 | Due to current HAProxy design, only the first message sent by the client and |
| 15525 | the server can be parsed. No message validation is performed by this |
| 15526 | converter. It is highly recommended to validate the message first using |
| 15527 | fix_is_valid converter. |
| 15528 | |
| 15529 | See also the fix_is_valid converter. |
| 15530 | |
| 15531 | Example: |
| 15532 | tcp-request inspect-delay 10s |
| 15533 | tcp-request content reject unless { req.payload(0,0),fix_is_valid } |
| 15534 | # MsgType tag ID is 35, so both lines below will return the same content |
| 15535 | tcp-request content set-var(txn.foo) req.payload(0,0),fix_tag_value(35) |
| 15536 | tcp-request content set-var(txn.bar) req.payload(0,0),fix_tag_value(MsgType) |
| 15537 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15538 | hex |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15539 | Converts a binary input sample to a hex string containing two hex digits per |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15540 | input byte. It is used to log or transfer hex dumps of some binary input data |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15541 | in a way that can be reliably transferred (e.g. an SSL ID can be copied in a |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15542 | header). |
Thierry FOURNIER | 2f49d6d | 2014-03-12 15:01:52 +0100 | [diff] [blame] | 15543 | |
Dragan Dosen | 3f957b2 | 2017-10-24 09:27:34 +0200 | [diff] [blame] | 15544 | hex2i |
| 15545 | Converts a hex string containing two hex digits per input byte to an |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 15546 | integer. If the input value cannot be converted, then zero is returned. |
Dragan Dosen | 3f957b2 | 2017-10-24 09:27:34 +0200 | [diff] [blame] | 15547 | |
Christopher Faulet | 4ccc12f | 2020-04-01 09:08:32 +0200 | [diff] [blame] | 15548 | htonl |
| 15549 | Converts the input integer value to its 32-bit binary representation in the |
| 15550 | network byte order. Because sample fetches own signed 64-bit integer, when |
| 15551 | this converter is used, the input integer value is first casted to an |
| 15552 | unsigned 32-bit integer. |
| 15553 | |
Patrick Gansterer | 8e36651 | 2020-04-22 16:47:57 +0200 | [diff] [blame] | 15554 | hmac(<algorithm>, <key>) |
| 15555 | Converts a binary input sample to a message authentication code with the given |
| 15556 | key. The result is a binary sample. The <algorithm> must be one of the |
| 15557 | registered OpenSSL message digest names (e.g. sha256). The <key> parameter must |
| 15558 | be base64 encoded and can either be a string or a variable. |
| 15559 | |
| 15560 | Please note that this converter is only available when haproxy has been |
| 15561 | compiled with USE_OPENSSL. |
| 15562 | |
Cyril Bonté | 6bcd182 | 2019-11-05 23:13:59 +0100 | [diff] [blame] | 15563 | http_date([<offset],[<unit>]) |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15564 | Converts an integer supposed to contain a date since epoch to a string |
| 15565 | representing this date in a format suitable for use in HTTP header fields. If |
Damien Claisse | ae6f125 | 2019-10-30 15:57:28 +0000 | [diff] [blame] | 15566 | an offset value is specified, then it is added to the date before the |
| 15567 | conversion is operated. This is particularly useful to emit Date header fields, |
| 15568 | Expires values in responses when combined with a positive offset, or |
| 15569 | Last-Modified values when the offset is negative. |
| 15570 | If a unit value is specified, then consider the timestamp as either |
| 15571 | "s" for seconds (default behavior), "ms" for milliseconds, or "us" for |
| 15572 | microseconds since epoch. Offset is assumed to have the same unit as |
| 15573 | input timestamp. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 15574 | |
Tim Duesterhus | 3943e4f | 2020-09-11 14:25:23 +0200 | [diff] [blame] | 15575 | iif(<true>,<false>) |
| 15576 | Returns the <true> string if the input value is true. Returns the <false> |
| 15577 | string otherwise. |
| 15578 | |
| 15579 | Example: |
Tim Duesterhus | 870713b | 2020-09-11 17:13:12 +0200 | [diff] [blame] | 15580 | http-request set-header x-forwarded-proto %[ssl_fc,iif(https,http)] |
Tim Duesterhus | 3943e4f | 2020-09-11 14:25:23 +0200 | [diff] [blame] | 15581 | |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 15582 | in_table(<table>) |
| 15583 | Uses the string representation of the input sample to perform a look up in |
| 15584 | the specified table. If the key is not found in the table, a boolean false |
| 15585 | is returned. Otherwise a boolean true is returned. This can be used to verify |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15586 | the presence of a certain key in a table tracking some elements (e.g. whether |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 15587 | or not a source IP address or an Authorization header was already seen). |
| 15588 | |
Tim Duesterhus | 1478aa7 | 2018-01-25 16:24:51 +0100 | [diff] [blame] | 15589 | ipmask(<mask4>, [<mask6>]) |
| 15590 | Apply a mask to an IP address, and use the result for lookups and storage. |
Willy Tarreau | ffcb2e4 | 2014-07-10 16:29:08 +0200 | [diff] [blame] | 15591 | This can be used to make all hosts within a certain mask to share the same |
Tim Duesterhus | 1478aa7 | 2018-01-25 16:24:51 +0100 | [diff] [blame] | 15592 | table entries and as such use the same server. The mask4 can be passed in |
| 15593 | dotted form (e.g. 255.255.255.0) or in CIDR form (e.g. 24). The mask6 can |
| 15594 | be passed in quadruplet form (e.g. ffff:ffff::) or in CIDR form (e.g. 64). |
| 15595 | If no mask6 is given IPv6 addresses will fail to convert for backwards |
| 15596 | compatibility reasons. |
Willy Tarreau | ffcb2e4 | 2014-07-10 16:29:08 +0200 | [diff] [blame] | 15597 | |
Thierry FOURNIER | 317e1c4 | 2014-08-12 10:20:47 +0200 | [diff] [blame] | 15598 | json([<input-code>]) |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15599 | Escapes the input string and produces an ASCII output string ready to use as a |
Thierry FOURNIER | 317e1c4 | 2014-08-12 10:20:47 +0200 | [diff] [blame] | 15600 | JSON string. The converter tries to decode the input string according to the |
Herve COMMOWICK | 8dfe863 | 2016-08-05 12:01:20 +0200 | [diff] [blame] | 15601 | <input-code> parameter. It can be "ascii", "utf8", "utf8s", "utf8p" or |
Thierry FOURNIER | 317e1c4 | 2014-08-12 10:20:47 +0200 | [diff] [blame] | 15602 | "utf8ps". The "ascii" decoder never fails. The "utf8" decoder detects 3 types |
| 15603 | of errors: |
| 15604 | - bad UTF-8 sequence (lone continuation byte, bad number of continuation |
| 15605 | bytes, ...) |
| 15606 | - invalid range (the decoded value is within a UTF-8 prohibited range), |
| 15607 | - code overlong (the value is encoded with more bytes than necessary). |
| 15608 | |
| 15609 | The UTF-8 JSON encoding can produce a "too long value" error when the UTF-8 |
| 15610 | character is greater than 0xffff because the JSON string escape specification |
| 15611 | only authorizes 4 hex digits for the value encoding. The UTF-8 decoder exists |
| 15612 | in 4 variants designated by a combination of two suffix letters : "p" for |
| 15613 | "permissive" and "s" for "silently ignore". The behaviors of the decoders |
| 15614 | are : |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15615 | - "ascii" : never fails; |
| 15616 | - "utf8" : fails on any detected errors; |
| 15617 | - "utf8s" : never fails, but removes characters corresponding to errors; |
Thierry FOURNIER | 317e1c4 | 2014-08-12 10:20:47 +0200 | [diff] [blame] | 15618 | - "utf8p" : accepts and fixes the overlong errors, but fails on any other |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15619 | error; |
Thierry FOURNIER | 317e1c4 | 2014-08-12 10:20:47 +0200 | [diff] [blame] | 15620 | - "utf8ps" : never fails, accepts and fixes the overlong errors, but removes |
| 15621 | characters corresponding to the other errors. |
| 15622 | |
| 15623 | This converter is particularly useful for building properly escaped JSON for |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15624 | logging to servers which consume JSON-formatted traffic logs. |
Thierry FOURNIER | 317e1c4 | 2014-08-12 10:20:47 +0200 | [diff] [blame] | 15625 | |
| 15626 | Example: |
Thierry FOURNIER | 317e1c4 | 2014-08-12 10:20:47 +0200 | [diff] [blame] | 15627 | capture request header Host len 15 |
Herve COMMOWICK | 8dfe863 | 2016-08-05 12:01:20 +0200 | [diff] [blame] | 15628 | capture request header user-agent len 150 |
| 15629 | log-format '{"ip":"%[src]","user-agent":"%[capture.req.hdr(1),json(utf8s)]"}' |
Thierry FOURNIER | 317e1c4 | 2014-08-12 10:20:47 +0200 | [diff] [blame] | 15630 | |
| 15631 | Input request from client 127.0.0.1: |
| 15632 | GET / HTTP/1.0 |
| 15633 | User-Agent: Very "Ugly" UA 1/2 |
| 15634 | |
| 15635 | Output log: |
| 15636 | {"ip":"127.0.0.1","user-agent":"Very \"Ugly\" UA 1\/2"} |
| 15637 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15638 | language(<value>[,<default>]) |
| 15639 | Returns the value with the highest q-factor from a list as extracted from the |
| 15640 | "accept-language" header using "req.fhdr". Values with no q-factor have a |
| 15641 | q-factor of 1. Values with a q-factor of 0 are dropped. Only values which |
| 15642 | belong to the list of semi-colon delimited <values> will be considered. The |
| 15643 | argument <value> syntax is "lang[;lang[;lang[;...]]]". If no value matches the |
| 15644 | given list and a default value is provided, it is returned. Note that language |
| 15645 | names may have a variant after a dash ('-'). If this variant is present in the |
| 15646 | list, it will be matched, but if it is not, only the base language is checked. |
| 15647 | The match is case-sensitive, and the output string is always one of those |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15648 | provided in arguments. The ordering of arguments is meaningless, only the |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15649 | ordering of the values in the request counts, as the first value among |
| 15650 | multiple sharing the same q-factor is used. |
Thierry FOURNIER | ad90351 | 2014-04-11 17:51:01 +0200 | [diff] [blame] | 15651 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15652 | Example : |
Thierry FOURNIER | ad90351 | 2014-04-11 17:51:01 +0200 | [diff] [blame] | 15653 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15654 | # this configuration switches to the backend matching a |
| 15655 | # given language based on the request : |
Thierry FOURNIER | ad90351 | 2014-04-11 17:51:01 +0200 | [diff] [blame] | 15656 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15657 | acl es req.fhdr(accept-language),language(es;fr;en) -m str es |
| 15658 | acl fr req.fhdr(accept-language),language(es;fr;en) -m str fr |
| 15659 | acl en req.fhdr(accept-language),language(es;fr;en) -m str en |
| 15660 | use_backend spanish if es |
| 15661 | use_backend french if fr |
| 15662 | use_backend english if en |
| 15663 | default_backend choose_your_language |
Thierry FOURNIER | ad90351 | 2014-04-11 17:51:01 +0200 | [diff] [blame] | 15664 | |
Willy Tarreau | 60a2ee7 | 2017-12-15 07:13:48 +0100 | [diff] [blame] | 15665 | length |
Etienne Carriere | ed0d24e | 2017-12-13 13:41:34 +0100 | [diff] [blame] | 15666 | Get the length of the string. This can only be placed after a string |
| 15667 | sample fetch function or after a transformation keyword returning a string |
| 15668 | type. The result is of type integer. |
| 15669 | |
Willy Tarreau | ffcb2e4 | 2014-07-10 16:29:08 +0200 | [diff] [blame] | 15670 | lower |
| 15671 | Convert a string sample to lower case. This can only be placed after a string |
| 15672 | sample fetch function or after a transformation keyword returning a string |
| 15673 | type. The result is of type string. |
| 15674 | |
Willy Tarreau | 0dbfdba | 2014-07-10 16:37:47 +0200 | [diff] [blame] | 15675 | ltime(<format>[,<offset>]) |
| 15676 | Converts an integer supposed to contain a date since epoch to a string |
| 15677 | representing this date in local time using a format defined by the <format> |
| 15678 | string using strftime(3). The purpose is to allow any date format to be used |
| 15679 | in logs. An optional <offset> in seconds may be applied to the input date |
| 15680 | (positive or negative). See the strftime() man page for the format supported |
| 15681 | by your operating system. See also the utime converter. |
| 15682 | |
| 15683 | Example : |
| 15684 | |
| 15685 | # Emit two colons, one with the local time and another with ip:port |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15686 | # e.g. 20140710162350 127.0.0.1:57325 |
Willy Tarreau | 0dbfdba | 2014-07-10 16:37:47 +0200 | [diff] [blame] | 15687 | log-format %[date,ltime(%Y%m%d%H%M%S)]\ %ci:%cp |
| 15688 | |
Christopher Faulet | 51fc9d1 | 2020-04-01 17:24:41 +0200 | [diff] [blame] | 15689 | ltrim(<chars>) |
| 15690 | Skips any characters from <chars> from the beginning of the string |
| 15691 | representation of the input sample. |
| 15692 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15693 | map(<map_file>[,<default_value>]) |
| 15694 | map_<match_type>(<map_file>[,<default_value>]) |
| 15695 | map_<match_type>_<output_type>(<map_file>[,<default_value>]) |
| 15696 | Search the input value from <map_file> using the <match_type> matching method, |
| 15697 | and return the associated value converted to the type <output_type>. If the |
| 15698 | input value cannot be found in the <map_file>, the converter returns the |
| 15699 | <default_value>. If the <default_value> is not set, the converter fails and |
| 15700 | acts as if no input value could be fetched. If the <match_type> is not set, it |
| 15701 | defaults to "str". Likewise, if the <output_type> is not set, it defaults to |
| 15702 | "str". For convenience, the "map" keyword is an alias for "map_str" and maps a |
| 15703 | string to another string. |
Thierry FOURNIER | d5f624d | 2013-11-26 11:52:33 +0100 | [diff] [blame] | 15704 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15705 | It is important to avoid overlapping between the keys : IP addresses and |
| 15706 | strings are stored in trees, so the first of the finest match will be used. |
| 15707 | Other keys are stored in lists, so the first matching occurrence will be used. |
Thierry FOURNIER | d5f624d | 2013-11-26 11:52:33 +0100 | [diff] [blame] | 15708 | |
Tim Düsterhus | 4896c44 | 2016-11-29 02:15:19 +0100 | [diff] [blame] | 15709 | The following array contains the list of all map functions available sorted by |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15710 | input type, match type and output type. |
Thierry FOURNIER | d5f624d | 2013-11-26 11:52:33 +0100 | [diff] [blame] | 15711 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15712 | input type | match method | output type str | output type int | output type ip |
| 15713 | -----------+--------------+-----------------+-----------------+--------------- |
| 15714 | str | str | map_str | map_str_int | map_str_ip |
| 15715 | -----------+--------------+-----------------+-----------------+--------------- |
Willy Tarreau | 787a4c0 | 2014-05-10 07:55:30 +0200 | [diff] [blame] | 15716 | str | beg | map_beg | map_beg_int | map_end_ip |
| 15717 | -----------+--------------+-----------------+-----------------+--------------- |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15718 | str | sub | map_sub | map_sub_int | map_sub_ip |
| 15719 | -----------+--------------+-----------------+-----------------+--------------- |
| 15720 | str | dir | map_dir | map_dir_int | map_dir_ip |
| 15721 | -----------+--------------+-----------------+-----------------+--------------- |
| 15722 | str | dom | map_dom | map_dom_int | map_dom_ip |
| 15723 | -----------+--------------+-----------------+-----------------+--------------- |
| 15724 | str | end | map_end | map_end_int | map_end_ip |
| 15725 | -----------+--------------+-----------------+-----------------+--------------- |
Ruoshan Huang | 3c5e374 | 2016-12-02 16:25:31 +0800 | [diff] [blame] | 15726 | str | reg | map_reg | map_reg_int | map_reg_ip |
| 15727 | -----------+--------------+-----------------+-----------------+--------------- |
| 15728 | str | reg | map_regm | map_reg_int | map_reg_ip |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15729 | -----------+--------------+-----------------+-----------------+--------------- |
| 15730 | int | int | map_int | map_int_int | map_int_ip |
| 15731 | -----------+--------------+-----------------+-----------------+--------------- |
| 15732 | ip | ip | map_ip | map_ip_int | map_ip_ip |
| 15733 | -----------+--------------+-----------------+-----------------+--------------- |
Thierry FOURNIER | d5f624d | 2013-11-26 11:52:33 +0100 | [diff] [blame] | 15734 | |
Thierry Fournier | 8feaa66 | 2016-02-10 22:55:20 +0100 | [diff] [blame] | 15735 | The special map called "map_regm" expect matching zone in the regular |
| 15736 | expression and modify the output replacing back reference (like "\1") by |
| 15737 | the corresponding match text. |
| 15738 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15739 | The file contains one key + value per line. Lines which start with '#' are |
| 15740 | ignored, just like empty lines. Leading tabs and spaces are stripped. The key |
| 15741 | is then the first "word" (series of non-space/tabs characters), and the value |
| 15742 | is what follows this series of space/tab till the end of the line excluding |
| 15743 | trailing spaces/tabs. |
Thierry FOURNIER | d5f624d | 2013-11-26 11:52:33 +0100 | [diff] [blame] | 15744 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 15745 | Example : |
| 15746 | |
| 15747 | # this is a comment and is ignored |
| 15748 | 2.22.246.0/23 United Kingdom \n |
| 15749 | <-><-----------><--><------------><----> |
| 15750 | | | | | `- trailing spaces ignored |
| 15751 | | | | `---------- value |
| 15752 | | | `-------------------- middle spaces ignored |
| 15753 | | `---------------------------- key |
| 15754 | `------------------------------------ leading spaces ignored |
| 15755 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15756 | mod(<value>) |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15757 | Divides the input value of type signed integer by <value>, and returns the |
| 15758 | remainder as an signed integer. If <value> is null, then zero is returned. |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 15759 | <value> can be a numeric value or a variable name. The name of the variable |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15760 | starts with an indication about its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 15761 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15762 | "sess" : the variable is shared with the whole session |
| 15763 | "txn" : the variable is shared with the transaction (request and response) |
| 15764 | "req" : the variable is shared only during request processing |
| 15765 | "res" : the variable is shared only during response processing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15766 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 15767 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15768 | |
Baptiste Assmann | e279ca6 | 2020-10-27 18:10:06 +0100 | [diff] [blame] | 15769 | mqtt_field_value(<packettype>,<fieldname or property ID>) |
| 15770 | Returns value of <fieldname> found in input MQTT payload of type |
| 15771 | <packettype>. |
| 15772 | <packettype> can be either a string (case insensitive matching) or a numeric |
| 15773 | value corresponding to the type of packet we're supposed to extract data |
| 15774 | from. |
| 15775 | Supported string and integers can be found here: |
| 15776 | https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc398718021 |
| 15777 | https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901022 |
| 15778 | |
| 15779 | <fieldname> depends on <packettype> and can be any of the following below. |
| 15780 | (note that <fieldname> matching is case insensitive). |
| 15781 | <property id> can only be found in MQTT v5.0 streams. check this table: |
| 15782 | https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901029 |
| 15783 | |
| 15784 | - CONNECT (or 1): flags, protocol_name, protocol_version, client_identifier, |
| 15785 | will_topic, will_payload, username, password, keepalive |
| 15786 | OR any property ID as a numeric value (for MQTT v5.0 |
| 15787 | packets only): |
| 15788 | 17: Session Expiry Interval |
| 15789 | 33: Receive Maximum |
| 15790 | 39: Maximum Packet Size |
| 15791 | 34: Topic Alias Maximum |
| 15792 | 25: Request Response Information |
| 15793 | 23: Request Problem Information |
| 15794 | 21: Authentication Method |
| 15795 | 22: Authentication Data |
| 15796 | 18: Will Delay Interval |
| 15797 | 1: Payload Format Indicator |
| 15798 | 2: Message Expiry Interval |
| 15799 | 3: Content Type |
| 15800 | 8: Response Topic |
| 15801 | 9: Correlation Data |
| 15802 | Not supported yet: |
| 15803 | 38: User Property |
| 15804 | |
| 15805 | - CONNACK (or 2): flags, protocol_version, reason_code |
| 15806 | OR any property ID as a numeric value (for MQTT v5.0 |
| 15807 | packets only): |
| 15808 | 17: Session Expiry Interval |
| 15809 | 33: Receive Maximum |
| 15810 | 36: Maximum QoS |
| 15811 | 37: Retain Available |
| 15812 | 39: Maximum Packet Size |
| 15813 | 18: Assigned Client Identifier |
| 15814 | 34: Topic Alias Maximum |
| 15815 | 31: Reason String |
| 15816 | 40; Wildcard Subscription Available |
| 15817 | 41: Subscription Identifiers Available |
| 15818 | 42: Shared Subscription Available |
| 15819 | 19: Server Keep Alive |
| 15820 | 26: Response Information |
| 15821 | 28: Server Reference |
| 15822 | 21: Authentication Method |
| 15823 | 22: Authentication Data |
| 15824 | Not supported yet: |
| 15825 | 38: User Property |
| 15826 | |
| 15827 | Due to current HAProxy design, only the first message sent by the client and |
| 15828 | the server can be parsed. Thus this converter can extract data only from |
| 15829 | CONNECT and CONNACK packet types. CONNECT is the first message sent by the |
| 15830 | client and CONNACK is the first response sent by the server. |
| 15831 | |
| 15832 | Example: |
| 15833 | |
| 15834 | acl data_in_buffer req.len ge 4 |
| 15835 | tcp-request content set-var(txn.username) \ |
| 15836 | req.payload(0,0),mqtt_field_value(connect,protocol_name) \ |
| 15837 | if data_in_buffer |
| 15838 | # do the same as above |
| 15839 | tcp-request content set-var(txn.username) \ |
| 15840 | req.payload(0,0),mqtt_field_value(1,protocol_name) \ |
| 15841 | if data_in_buffer |
| 15842 | |
| 15843 | mqtt_is_valid |
| 15844 | Checks that the binary input is a valid MQTT packet. It returns a boolean. |
| 15845 | |
| 15846 | Due to current HAProxy design, only the first message sent by the client and |
| 15847 | the server can be parsed. Thus this converter can extract data only from |
| 15848 | CONNECT and CONNACK packet types. CONNECT is the first message sent by the |
| 15849 | client and CONNACK is the first response sent by the server. |
| 15850 | |
| 15851 | Example: |
| 15852 | |
| 15853 | acl data_in_buffer req.len ge 4 |
| 15854 | tcp-request content reject unless req.payload(0,0),mqtt_is_valid |
| 15855 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15856 | mul(<value>) |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15857 | Multiplies the input value of type signed integer by <value>, and returns |
Thierry FOURNIER | 00c005c | 2015-07-08 01:10:21 +0200 | [diff] [blame] | 15858 | the product as an signed integer. In case of overflow, the largest possible |
| 15859 | value for the sign is returned so that the operation doesn't wrap around. |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 15860 | <value> can be a numeric value or a variable name. The name of the variable |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15861 | starts with an indication about its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 15862 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15863 | "sess" : the variable is shared with the whole session |
| 15864 | "txn" : the variable is shared with the transaction (request and response) |
| 15865 | "req" : the variable is shared only during request processing |
| 15866 | "res" : the variable is shared only during response processing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15867 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 15868 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15869 | |
Nenad Merdanovic | b7e7c47 | 2017-03-12 21:56:55 +0100 | [diff] [blame] | 15870 | nbsrv |
| 15871 | Takes an input value of type string, interprets it as a backend name and |
| 15872 | returns the number of usable servers in that backend. Can be used in places |
| 15873 | where we want to look up a backend from a dynamic name, like a result of a |
| 15874 | map lookup. |
| 15875 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15876 | neg |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15877 | Takes the input value of type signed integer, computes the opposite value, |
| 15878 | and returns the remainder as an signed integer. 0 is identity. This operator |
| 15879 | is provided for reversed subtracts : in order to subtract the input from a |
| 15880 | constant, simply perform a "neg,add(value)". |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15881 | |
| 15882 | not |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15883 | Returns a boolean FALSE if the input value of type signed integer is |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15884 | non-null, otherwise returns TRUE. Used in conjunction with and(), it can be |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15885 | used to report true/false for bit testing on input values (e.g. verify the |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15886 | absence of a flag). |
| 15887 | |
| 15888 | odd |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15889 | Returns a boolean TRUE if the input value of type signed integer is odd |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15890 | otherwise returns FALSE. It is functionally equivalent to "and(1),bool". |
| 15891 | |
| 15892 | or(<value>) |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 15893 | Performs a bitwise "OR" between <value> and the input value of type signed |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 15894 | integer, and returns the result as an signed integer. <value> can be a |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15895 | numeric value or a variable name. The name of the variable starts with an |
| 15896 | indication about its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 15897 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 15898 | "sess" : the variable is shared with the whole session |
| 15899 | "txn" : the variable is shared with the transaction (request and response) |
| 15900 | "req" : the variable is shared only during request processing |
| 15901 | "res" : the variable is shared only during response processing |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 15902 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 15903 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 15904 | |
Frédéric Lécaille | bfe6138 | 2019-03-06 14:34:36 +0100 | [diff] [blame] | 15905 | protobuf(<field_number>,[<field_type>]) |
| 15906 | This extracts the protocol buffers message field in raw mode of an input binary |
| 15907 | sample representation of a protocol buffer message with <field_number> as field |
| 15908 | number (dotted notation) if <field_type> is not present, or as an integer sample |
| 15909 | if this field is present (see also "ungrpc" below). |
| 15910 | The list of the authorized types is the following one: "int32", "int64", "uint32", |
| 15911 | "uint64", "sint32", "sint64", "bool", "enum" for the "varint" wire type 0 |
| 15912 | "fixed64", "sfixed64", "double" for the 64bit wire type 1, "fixed32", "sfixed32", |
| 15913 | "float" for the wire type 5. Note that "string" is considered as a length-delimited |
| 15914 | type, so it does not require any <field_type> argument to be extracted. |
| 15915 | More information may be found here about the protocol buffers message field types: |
| 15916 | https://developers.google.com/protocol-buffers/docs/encoding |
| 15917 | |
Willy Tarreau | c4dc350 | 2015-01-23 20:39:28 +0100 | [diff] [blame] | 15918 | regsub(<regex>,<subst>[,<flags>]) |
Willy Tarreau | 7eda849 | 2015-01-20 19:47:06 +0100 | [diff] [blame] | 15919 | Applies a regex-based substitution to the input string. It does the same |
| 15920 | operation as the well-known "sed" utility with "s/<regex>/<subst>/". By |
| 15921 | default it will replace in the input string the first occurrence of the |
| 15922 | largest part matching the regular expression <regex> with the substitution |
| 15923 | string <subst>. It is possible to replace all occurrences instead by adding |
| 15924 | the flag "g" in the third argument <flags>. It is also possible to make the |
| 15925 | regex case insensitive by adding the flag "i" in <flags>. Since <flags> is a |
| 15926 | string, it is made up from the concatenation of all desired flags. Thus if |
| 15927 | both "i" and "g" are desired, using "gi" or "ig" will have the same effect. |
Willy Tarreau | ef21fac | 2020-02-14 13:37:20 +0100 | [diff] [blame] | 15928 | The first use of this converter is to replace certain characters or sequence |
| 15929 | of characters with other ones. |
| 15930 | |
| 15931 | It is highly recommended to enclose the regex part using protected quotes to |
| 15932 | improve clarity and never have a closing parenthesis from the regex mixed up |
| 15933 | with the parenthesis from the function. Just like in Bourne shell, the first |
| 15934 | level of quotes is processed when delimiting word groups on the line, a |
| 15935 | second level is usable for argument. It is recommended to use single quotes |
| 15936 | outside since these ones do not try to resolve backslashes nor dollar signs. |
Willy Tarreau | 7eda849 | 2015-01-20 19:47:06 +0100 | [diff] [blame] | 15937 | |
Willy Tarreau | cd0d2ed | 2020-02-14 17:33:06 +0100 | [diff] [blame] | 15938 | Examples: |
Willy Tarreau | 7eda849 | 2015-01-20 19:47:06 +0100 | [diff] [blame] | 15939 | |
| 15940 | # de-duplicate "/" in header "x-path". |
| 15941 | # input: x-path: /////a///b/c/xzxyz/ |
| 15942 | # output: x-path: /a/b/c/xzxyz/ |
Willy Tarreau | ef21fac | 2020-02-14 13:37:20 +0100 | [diff] [blame] | 15943 | http-request set-header x-path "%[hdr(x-path),regsub('/+','/','g')]" |
Willy Tarreau | 7eda849 | 2015-01-20 19:47:06 +0100 | [diff] [blame] | 15944 | |
Willy Tarreau | cd0d2ed | 2020-02-14 17:33:06 +0100 | [diff] [blame] | 15945 | # copy query string to x-query and drop all leading '?', ';' and '&' |
| 15946 | http-request set-header x-query "%[query,regsub([?;&]*,'')]" |
| 15947 | |
Jerome Magnin | 07e1e3c | 2020-02-16 19:20:19 +0100 | [diff] [blame] | 15948 | # capture groups and backreferences |
| 15949 | # both lines do the same. |
Willy Tarreau | 465dc7d | 2020-10-08 18:05:56 +0200 | [diff] [blame] | 15950 | http-request redirect location %[url,'regsub("(foo|bar)([0-9]+)?","\2\1",i)'] |
Jerome Magnin | 07e1e3c | 2020-02-16 19:20:19 +0100 | [diff] [blame] | 15951 | http-request redirect location %[url,regsub(\"(foo|bar)([0-9]+)?\",\"\2\1\",i)] |
| 15952 | |
Thierry FOURNIER | 35ab275 | 2015-05-28 13:22:03 +0200 | [diff] [blame] | 15953 | capture-req(<id>) |
| 15954 | Capture the string entry in the request slot <id> and returns the entry as |
| 15955 | is. If the slot doesn't exist, the capture fails silently. |
| 15956 | |
| 15957 | See also: "declare capture", "http-request capture", |
Baptiste Assmann | 5ac425c | 2015-10-21 23:13:46 +0200 | [diff] [blame] | 15958 | "http-response capture", "capture.req.hdr" and |
| 15959 | "capture.res.hdr" (sample fetches). |
Thierry FOURNIER | 35ab275 | 2015-05-28 13:22:03 +0200 | [diff] [blame] | 15960 | |
| 15961 | capture-res(<id>) |
| 15962 | Capture the string entry in the response slot <id> and returns the entry as |
| 15963 | is. If the slot doesn't exist, the capture fails silently. |
| 15964 | |
| 15965 | See also: "declare capture", "http-request capture", |
Baptiste Assmann | 5ac425c | 2015-10-21 23:13:46 +0200 | [diff] [blame] | 15966 | "http-response capture", "capture.req.hdr" and |
| 15967 | "capture.res.hdr" (sample fetches). |
Thierry FOURNIER | 35ab275 | 2015-05-28 13:22:03 +0200 | [diff] [blame] | 15968 | |
Christopher Faulet | 568415a | 2020-04-01 17:24:47 +0200 | [diff] [blame] | 15969 | rtrim(<chars>) |
| 15970 | Skips any characters from <chars> from the end of the string representation |
| 15971 | of the input sample. |
| 15972 | |
Willy Tarreau | 23ec4ca | 2014-07-15 20:15:37 +0200 | [diff] [blame] | 15973 | sdbm([<avalanche>]) |
| 15974 | Hashes a binary input sample into an unsigned 32-bit quantity using the SDBM |
| 15975 | hash function. Optionally, it is possible to apply a full avalanche hash |
| 15976 | function to the output if the optional <avalanche> argument equals 1. This |
| 15977 | converter uses the same functions as used by the various hash-based load |
| 15978 | balancing algorithms, so it will provide exactly the same results. It is |
| 15979 | mostly intended for debugging, but can be used as a stick-table entry to |
| 15980 | collect rough statistics. It must not be used for security purposes as a |
Emmanuel Hocdet | 50791a7 | 2018-03-21 11:19:01 +0100 | [diff] [blame] | 15981 | 32-bit hash is trivial to break. See also "crc32", "djb2", "wt6", "crc32c", |
| 15982 | and the "hash-type" directive. |
Willy Tarreau | 23ec4ca | 2014-07-15 20:15:37 +0200 | [diff] [blame] | 15983 | |
Tim Duesterhus | f38175c | 2020-06-09 11:48:42 +0200 | [diff] [blame] | 15984 | secure_memcmp(<var>) |
| 15985 | Compares the contents of <var> with the input value. Both values are treated |
| 15986 | as a binary string. Returns a boolean indicating whether both binary strings |
| 15987 | match. |
| 15988 | |
| 15989 | If both binary strings have the same length then the comparison will be |
| 15990 | performed in constant time. |
| 15991 | |
| 15992 | Please note that this converter is only available when haproxy has been |
| 15993 | compiled with USE_OPENSSL. |
| 15994 | |
| 15995 | Example : |
| 15996 | |
| 15997 | http-request set-var(txn.token) hdr(token) |
| 15998 | # Check whether the token sent by the client matches the secret token |
| 15999 | # value, without leaking the contents using a timing attack. |
| 16000 | acl token_given str(my_secret_token),secure_memcmp(txn.token) |
| 16001 | |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 16002 | set-var(<var name>) |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16003 | Sets a variable with the input content and returns the content on the output |
| 16004 | as-is. The variable keeps the value and the associated input type. The name of |
| 16005 | the variable starts with an indication about its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 16006 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16007 | "sess" : the variable is shared with the whole session |
| 16008 | "txn" : the variable is shared with the transaction (request and |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 16009 | response), |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16010 | "req" : the variable is shared only during request processing, |
| 16011 | "res" : the variable is shared only during response processing. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 16012 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 16013 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 16014 | |
Dragan Dosen | 6e5a9ca | 2017-10-24 09:18:23 +0200 | [diff] [blame] | 16015 | sha1 |
Tim Duesterhus | d437630 | 2019-06-17 12:41:44 +0200 | [diff] [blame] | 16016 | Converts a binary input sample to a SHA-1 digest. The result is a binary |
Dragan Dosen | 6e5a9ca | 2017-10-24 09:18:23 +0200 | [diff] [blame] | 16017 | sample with length of 20 bytes. |
| 16018 | |
Tim Duesterhus | d437630 | 2019-06-17 12:41:44 +0200 | [diff] [blame] | 16019 | sha2([<bits>]) |
| 16020 | Converts a binary input sample to a digest in the SHA-2 family. The result |
| 16021 | is a binary sample with length of <bits>/8 bytes. |
| 16022 | |
| 16023 | Valid values for <bits> are 224, 256, 384, 512, each corresponding to |
| 16024 | SHA-<bits>. The default value is 256. |
| 16025 | |
| 16026 | Please note that this converter is only available when haproxy has been |
| 16027 | compiled with USE_OPENSSL. |
| 16028 | |
Nenad Merdanovic | 177adc9 | 2019-08-27 01:58:13 +0200 | [diff] [blame] | 16029 | srv_queue |
| 16030 | Takes an input value of type string, either a server name or <backend>/<server> |
| 16031 | format and returns the number of queued sessions on that server. Can be used |
| 16032 | in places where we want to look up queued sessions from a dynamic name, like a |
| 16033 | cookie value (e.g. req.cook(SRVID),srv_queue) and then make a decision to break |
| 16034 | persistence or direct a request elsewhere. |
| 16035 | |
Tim Duesterhus | ca097c1 | 2018-04-27 21:18:45 +0200 | [diff] [blame] | 16036 | strcmp(<var>) |
| 16037 | Compares the contents of <var> with the input value of type string. Returns |
| 16038 | the result as a signed integer compatible with strcmp(3): 0 if both strings |
| 16039 | are identical. A value less than 0 if the left string is lexicographically |
| 16040 | smaller than the right string or if the left string is shorter. A value greater |
| 16041 | than 0 otherwise (right string greater than left string or the right string is |
| 16042 | shorter). |
| 16043 | |
Tim Duesterhus | f38175c | 2020-06-09 11:48:42 +0200 | [diff] [blame] | 16044 | See also the secure_memcmp converter if you need to compare two binary |
| 16045 | strings in constant time. |
| 16046 | |
Tim Duesterhus | ca097c1 | 2018-04-27 21:18:45 +0200 | [diff] [blame] | 16047 | Example : |
| 16048 | |
| 16049 | http-request set-var(txn.host) hdr(host) |
| 16050 | # Check whether the client is attempting domain fronting. |
| 16051 | acl ssl_sni_http_host_match ssl_fc_sni,strcmp(txn.host) eq 0 |
| 16052 | |
| 16053 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 16054 | sub(<value>) |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 16055 | Subtracts <value> from the input value of type signed integer, and returns |
| 16056 | the result as an signed integer. Note: in order to subtract the input from |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 16057 | a constant, simply perform a "neg,add(value)". <value> can be a numeric value |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16058 | or a variable name. The name of the variable starts with an indication about |
| 16059 | its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 16060 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16061 | "sess" : the variable is shared with the whole session |
| 16062 | "txn" : the variable is shared with the transaction (request and |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 16063 | response), |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16064 | "req" : the variable is shared only during request processing, |
| 16065 | "res" : the variable is shared only during response processing. |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 16066 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 16067 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 16068 | |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 16069 | table_bytes_in_rate(<table>) |
| 16070 | Uses the string representation of the input sample to perform a look up in |
| 16071 | the specified table. If the key is not found in the table, integer value zero |
| 16072 | is returned. Otherwise the converter returns the average client-to-server |
| 16073 | bytes rate associated with the input sample in the designated table, measured |
| 16074 | in amount of bytes over the period configured in the table. See also the |
| 16075 | sc_bytes_in_rate sample fetch keyword. |
| 16076 | |
| 16077 | |
| 16078 | table_bytes_out_rate(<table>) |
| 16079 | Uses the string representation of the input sample to perform a look up in |
| 16080 | the specified table. If the key is not found in the table, integer value zero |
| 16081 | is returned. Otherwise the converter returns the average server-to-client |
| 16082 | bytes rate associated with the input sample in the designated table, measured |
| 16083 | in amount of bytes over the period configured in the table. See also the |
| 16084 | sc_bytes_out_rate sample fetch keyword. |
| 16085 | |
| 16086 | table_conn_cnt(<table>) |
| 16087 | Uses the string representation of the input sample to perform a look up in |
| 16088 | the specified table. If the key is not found in the table, integer value zero |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16089 | is returned. Otherwise the converter returns the cumulative number of incoming |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 16090 | connections associated with the input sample in the designated table. See |
| 16091 | also the sc_conn_cnt sample fetch keyword. |
| 16092 | |
| 16093 | table_conn_cur(<table>) |
| 16094 | Uses the string representation of the input sample to perform a look up in |
| 16095 | the specified table. If the key is not found in the table, integer value zero |
| 16096 | is returned. Otherwise the converter returns the current amount of concurrent |
| 16097 | tracked connections associated with the input sample in the designated table. |
| 16098 | See also the sc_conn_cur sample fetch keyword. |
| 16099 | |
| 16100 | table_conn_rate(<table>) |
| 16101 | Uses the string representation of the input sample to perform a look up in |
| 16102 | the specified table. If the key is not found in the table, integer value zero |
| 16103 | is returned. Otherwise the converter returns the average incoming connection |
| 16104 | rate associated with the input sample in the designated table. See also the |
| 16105 | sc_conn_rate sample fetch keyword. |
| 16106 | |
Thierry FOURNIER | 236657b | 2015-08-19 08:25:14 +0200 | [diff] [blame] | 16107 | table_gpt0(<table>) |
| 16108 | Uses the string representation of the input sample to perform a look up in |
| 16109 | the specified table. If the key is not found in the table, boolean value zero |
| 16110 | is returned. Otherwise the converter returns the current value of the first |
| 16111 | general purpose tag associated with the input sample in the designated table. |
| 16112 | See also the sc_get_gpt0 sample fetch keyword. |
| 16113 | |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 16114 | table_gpc0(<table>) |
| 16115 | Uses the string representation of the input sample to perform a look up in |
| 16116 | the specified table. If the key is not found in the table, integer value zero |
| 16117 | is returned. Otherwise the converter returns the current value of the first |
| 16118 | general purpose counter associated with the input sample in the designated |
| 16119 | table. See also the sc_get_gpc0 sample fetch keyword. |
| 16120 | |
| 16121 | table_gpc0_rate(<table>) |
| 16122 | Uses the string representation of the input sample to perform a look up in |
| 16123 | the specified table. If the key is not found in the table, integer value zero |
| 16124 | is returned. Otherwise the converter returns the frequency which the gpc0 |
| 16125 | counter was incremented over the configured period in the table, associated |
| 16126 | with the input sample in the designated table. See also the sc_get_gpc0_rate |
| 16127 | sample fetch keyword. |
| 16128 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 16129 | table_gpc1(<table>) |
| 16130 | Uses the string representation of the input sample to perform a look up in |
| 16131 | the specified table. If the key is not found in the table, integer value zero |
| 16132 | is returned. Otherwise the converter returns the current value of the second |
| 16133 | general purpose counter associated with the input sample in the designated |
| 16134 | table. See also the sc_get_gpc1 sample fetch keyword. |
| 16135 | |
| 16136 | table_gpc1_rate(<table>) |
| 16137 | Uses the string representation of the input sample to perform a look up in |
| 16138 | the specified table. If the key is not found in the table, integer value zero |
| 16139 | is returned. Otherwise the converter returns the frequency which the gpc1 |
| 16140 | counter was incremented over the configured period in the table, associated |
| 16141 | with the input sample in the designated table. See also the sc_get_gpc1_rate |
| 16142 | sample fetch keyword. |
| 16143 | |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 16144 | table_http_err_cnt(<table>) |
| 16145 | Uses the string representation of the input sample to perform a look up in |
| 16146 | the specified table. If the key is not found in the table, integer value zero |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16147 | is returned. Otherwise the converter returns the cumulative number of HTTP |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 16148 | errors associated with the input sample in the designated table. See also the |
| 16149 | sc_http_err_cnt sample fetch keyword. |
| 16150 | |
| 16151 | table_http_err_rate(<table>) |
| 16152 | Uses the string representation of the input sample to perform a look up in |
| 16153 | the specified table. If the key is not found in the table, integer value zero |
| 16154 | is returned. Otherwise the average rate of HTTP errors associated with the |
| 16155 | input sample in the designated table, measured in amount of errors over the |
| 16156 | period configured in the table. See also the sc_http_err_rate sample fetch |
| 16157 | keyword. |
| 16158 | |
| 16159 | table_http_req_cnt(<table>) |
| 16160 | Uses the string representation of the input sample to perform a look up in |
| 16161 | the specified table. If the key is not found in the table, integer value zero |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16162 | is returned. Otherwise the converter returns the cumulative number of HTTP |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 16163 | requests associated with the input sample in the designated table. See also |
| 16164 | the sc_http_req_cnt sample fetch keyword. |
| 16165 | |
| 16166 | table_http_req_rate(<table>) |
| 16167 | Uses the string representation of the input sample to perform a look up in |
| 16168 | the specified table. If the key is not found in the table, integer value zero |
| 16169 | is returned. Otherwise the average rate of HTTP requests associated with the |
| 16170 | input sample in the designated table, measured in amount of requests over the |
| 16171 | period configured in the table. See also the sc_http_req_rate sample fetch |
| 16172 | keyword. |
| 16173 | |
| 16174 | table_kbytes_in(<table>) |
| 16175 | Uses the string representation of the input sample to perform a look up in |
| 16176 | the specified table. If the key is not found in the table, integer value zero |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16177 | is returned. Otherwise the converter returns the cumulative number of client- |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 16178 | to-server data associated with the input sample in the designated table, |
| 16179 | measured in kilobytes. The test is currently performed on 32-bit integers, |
| 16180 | which limits values to 4 terabytes. See also the sc_kbytes_in sample fetch |
| 16181 | keyword. |
| 16182 | |
| 16183 | table_kbytes_out(<table>) |
| 16184 | Uses the string representation of the input sample to perform a look up in |
| 16185 | the specified table. If the key is not found in the table, integer value zero |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16186 | is returned. Otherwise the converter returns the cumulative number of server- |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 16187 | to-client data associated with the input sample in the designated table, |
| 16188 | measured in kilobytes. The test is currently performed on 32-bit integers, |
| 16189 | which limits values to 4 terabytes. See also the sc_kbytes_out sample fetch |
| 16190 | keyword. |
| 16191 | |
| 16192 | table_server_id(<table>) |
| 16193 | Uses the string representation of the input sample to perform a look up in |
| 16194 | the specified table. If the key is not found in the table, integer value zero |
| 16195 | is returned. Otherwise the converter returns the server ID associated with |
| 16196 | the input sample in the designated table. A server ID is associated to a |
| 16197 | sample by a "stick" rule when a connection to a server succeeds. A server ID |
| 16198 | zero means that no server is associated with this key. |
| 16199 | |
| 16200 | table_sess_cnt(<table>) |
| 16201 | Uses the string representation of the input sample to perform a look up in |
| 16202 | the specified table. If the key is not found in the table, integer value zero |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16203 | is returned. Otherwise the converter returns the cumulative number of incoming |
Willy Tarreau | d9f316a | 2014-07-10 14:03:38 +0200 | [diff] [blame] | 16204 | sessions associated with the input sample in the designated table. Note that |
| 16205 | a session here refers to an incoming connection being accepted by the |
| 16206 | "tcp-request connection" rulesets. See also the sc_sess_cnt sample fetch |
| 16207 | keyword. |
| 16208 | |
| 16209 | table_sess_rate(<table>) |
| 16210 | Uses the string representation of the input sample to perform a look up in |
| 16211 | the specified table. If the key is not found in the table, integer value zero |
| 16212 | is returned. Otherwise the converter returns the average incoming session |
| 16213 | rate associated with the input sample in the designated table. Note that a |
| 16214 | session here refers to an incoming connection being accepted by the |
| 16215 | "tcp-request connection" rulesets. See also the sc_sess_rate sample fetch |
| 16216 | keyword. |
| 16217 | |
| 16218 | table_trackers(<table>) |
| 16219 | Uses the string representation of the input sample to perform a look up in |
| 16220 | the specified table. If the key is not found in the table, integer value zero |
| 16221 | is returned. Otherwise the converter returns the current amount of concurrent |
| 16222 | connections tracking the same key as the input sample in the designated |
| 16223 | table. It differs from table_conn_cur in that it does not rely on any stored |
| 16224 | information but on the table's reference count (the "use" value which is |
| 16225 | returned by "show table" on the CLI). This may sometimes be more suited for |
| 16226 | layer7 tracking. It can be used to tell a server how many concurrent |
| 16227 | connections there are from a given address for example. See also the |
| 16228 | sc_trackers sample fetch keyword. |
| 16229 | |
Willy Tarreau | ffcb2e4 | 2014-07-10 16:29:08 +0200 | [diff] [blame] | 16230 | upper |
| 16231 | Convert a string sample to upper case. This can only be placed after a string |
| 16232 | sample fetch function or after a transformation keyword returning a string |
| 16233 | type. The result is of type string. |
| 16234 | |
Willy Tarreau | 62ba9ba | 2020-04-23 17:54:47 +0200 | [diff] [blame] | 16235 | url_dec([<in_form>]) |
| 16236 | Takes an url-encoded string provided as input and returns the decoded version |
| 16237 | as output. The input and the output are of type string. If the <in_form> |
| 16238 | argument is set to a non-zero integer value, the input string is assumed to |
| 16239 | be part of a form or query string and the '+' character will be turned into a |
| 16240 | space (' '). Otherwise this will only happen after a question mark indicating |
| 16241 | a query string ('?'). |
Thierry FOURNIER | 82ff3c9 | 2015-05-07 15:46:20 +0200 | [diff] [blame] | 16242 | |
Frédéric Lécaille | 756d97f | 2019-03-04 19:03:48 +0100 | [diff] [blame] | 16243 | ungrpc(<field_number>,[<field_type>]) |
Frédéric Lécaille | 50290fb | 2019-02-27 14:34:51 +0100 | [diff] [blame] | 16244 | This extracts the protocol buffers message field in raw mode of an input binary |
Frédéric Lécaille | bfe6138 | 2019-03-06 14:34:36 +0100 | [diff] [blame] | 16245 | sample representation of a gRPC message with <field_number> as field number |
| 16246 | (dotted notation) if <field_type> is not present, or as an integer sample if this |
| 16247 | field is present. |
Frédéric Lécaille | 756d97f | 2019-03-04 19:03:48 +0100 | [diff] [blame] | 16248 | The list of the authorized types is the following one: "int32", "int64", "uint32", |
| 16249 | "uint64", "sint32", "sint64", "bool", "enum" for the "varint" wire type 0 |
| 16250 | "fixed64", "sfixed64", "double" for the 64bit wire type 1, "fixed32", "sfixed32", |
| 16251 | "float" for the wire type 5. Note that "string" is considered as a length-delimited |
Frédéric Lécaille | 93d3316 | 2019-03-06 09:35:59 +0100 | [diff] [blame] | 16252 | type, so it does not require any <field_type> argument to be extracted. |
Frédéric Lécaille | 756d97f | 2019-03-04 19:03:48 +0100 | [diff] [blame] | 16253 | More information may be found here about the protocol buffers message field types: |
| 16254 | https://developers.google.com/protocol-buffers/docs/encoding |
Frédéric Lécaille | 50290fb | 2019-02-27 14:34:51 +0100 | [diff] [blame] | 16255 | |
| 16256 | Example: |
| 16257 | // with such a protocol buffer .proto file content adapted from |
| 16258 | // https://github.com/grpc/grpc/blob/master/examples/protos/route_guide.proto |
| 16259 | |
| 16260 | message Point { |
| 16261 | int32 latitude = 1; |
| 16262 | int32 longitude = 2; |
| 16263 | } |
| 16264 | |
| 16265 | message PPoint { |
| 16266 | Point point = 59; |
| 16267 | } |
| 16268 | |
| 16269 | message Rectangle { |
| 16270 | // One corner of the rectangle. |
| 16271 | PPoint lo = 48; |
| 16272 | // The other corner of the rectangle. |
| 16273 | PPoint hi = 49; |
| 16274 | } |
| 16275 | |
Peter Gervai | df4c9d2 | 2020-06-11 18:05:11 +0200 | [diff] [blame] | 16276 | let's say a body request is made of a "Rectangle" object value (two PPoint |
| 16277 | protocol buffers messages), the four protocol buffers fields could be |
| 16278 | extracted with these "ungrpc" directives: |
Frédéric Lécaille | 50290fb | 2019-02-27 14:34:51 +0100 | [diff] [blame] | 16279 | |
Frédéric Lécaille | 756d97f | 2019-03-04 19:03:48 +0100 | [diff] [blame] | 16280 | req.body,ungrpc(48.59.1,int32) # "latitude" of "lo" first PPoint |
| 16281 | req.body,ungrpc(48.59.2,int32) # "longitude" of "lo" first PPoint |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 16282 | req.body,ungrpc(49.59.1,int32) # "latitude" of "hi" second PPoint |
Frédéric Lécaille | 756d97f | 2019-03-04 19:03:48 +0100 | [diff] [blame] | 16283 | req.body,ungrpc(49.59.2,int32) # "longitude" of "hi" second PPoint |
| 16284 | |
Peter Gervai | df4c9d2 | 2020-06-11 18:05:11 +0200 | [diff] [blame] | 16285 | We could also extract the intermediary 48.59 field as a binary sample as follows: |
Frédéric Lécaille | 756d97f | 2019-03-04 19:03:48 +0100 | [diff] [blame] | 16286 | |
Frédéric Lécaille | 93d3316 | 2019-03-06 09:35:59 +0100 | [diff] [blame] | 16287 | req.body,ungrpc(48.59) |
Frédéric Lécaille | 756d97f | 2019-03-04 19:03:48 +0100 | [diff] [blame] | 16288 | |
Peter Gervai | df4c9d2 | 2020-06-11 18:05:11 +0200 | [diff] [blame] | 16289 | As a gRPC message is always made of a gRPC header followed by protocol buffers |
| 16290 | messages, in the previous example the "latitude" of "lo" first PPoint |
| 16291 | could be extracted with these equivalent directives: |
Frédéric Lécaille | bfe6138 | 2019-03-06 14:34:36 +0100 | [diff] [blame] | 16292 | |
| 16293 | req.body,ungrpc(48.59),protobuf(1,int32) |
| 16294 | req.body,ungrpc(48),protobuf(59.1,int32) |
| 16295 | req.body,ungrpc(48),protobuf(59),protobuf(1,int32) |
| 16296 | |
Peter Gervai | df4c9d2 | 2020-06-11 18:05:11 +0200 | [diff] [blame] | 16297 | Note that the first convert must be "ungrpc", the remaining ones must be |
| 16298 | "protobuf" and only the last one may have or not a second argument to |
| 16299 | interpret the previous binary sample. |
Frédéric Lécaille | bfe6138 | 2019-03-06 14:34:36 +0100 | [diff] [blame] | 16300 | |
Frédéric Lécaille | 50290fb | 2019-02-27 14:34:51 +0100 | [diff] [blame] | 16301 | |
Christopher Faulet | 85d79c9 | 2016-11-09 16:54:56 +0100 | [diff] [blame] | 16302 | unset-var(<var name>) |
| 16303 | Unsets a variable if the input content is defined. The name of the variable |
| 16304 | starts with an indication about its scope. The scopes allowed are: |
| 16305 | "proc" : the variable is shared with the whole process |
| 16306 | "sess" : the variable is shared with the whole session |
| 16307 | "txn" : the variable is shared with the transaction (request and |
| 16308 | response), |
| 16309 | "req" : the variable is shared only during request processing, |
| 16310 | "res" : the variable is shared only during response processing. |
| 16311 | This prefix is followed by a name. The separator is a '.'. The name may only |
| 16312 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
| 16313 | |
Willy Tarreau | 0dbfdba | 2014-07-10 16:37:47 +0200 | [diff] [blame] | 16314 | utime(<format>[,<offset>]) |
| 16315 | Converts an integer supposed to contain a date since epoch to a string |
| 16316 | representing this date in UTC time using a format defined by the <format> |
| 16317 | string using strftime(3). The purpose is to allow any date format to be used |
| 16318 | in logs. An optional <offset> in seconds may be applied to the input date |
| 16319 | (positive or negative). See the strftime() man page for the format supported |
| 16320 | by your operating system. See also the ltime converter. |
| 16321 | |
| 16322 | Example : |
| 16323 | |
| 16324 | # Emit two colons, one with the UTC time and another with ip:port |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16325 | # e.g. 20140710162350 127.0.0.1:57325 |
Willy Tarreau | 0dbfdba | 2014-07-10 16:37:47 +0200 | [diff] [blame] | 16326 | log-format %[date,utime(%Y%m%d%H%M%S)]\ %ci:%cp |
| 16327 | |
Marcin Deranek | 9631a28 | 2018-04-16 14:30:46 +0200 | [diff] [blame] | 16328 | word(<index>,<delimiters>[,<count>]) |
| 16329 | Extracts the nth word counting from the beginning (positive index) or from |
| 16330 | the end (negative index) considering given delimiters from an input string. |
| 16331 | Indexes start at 1 or -1 and delimiters are a string formatted list of chars. |
Jerome Magnin | 8820932 | 2020-01-28 13:33:44 +0100 | [diff] [blame] | 16332 | Delimiters at the beginning or end of the input string are ignored. |
Marcin Deranek | 9631a28 | 2018-04-16 14:30:46 +0200 | [diff] [blame] | 16333 | Optionally you can specify <count> of words to extract (default: 1). |
| 16334 | Value of 0 indicates extraction of all remaining words. |
| 16335 | |
| 16336 | Example : |
| 16337 | str(f1_f2_f3__f5),word(4,_) # f5 |
| 16338 | str(f1_f2_f3__f5),word(2,_,0) # f2_f3__f5 |
| 16339 | str(f1_f2_f3__f5),word(3,_,2) # f3__f5 |
| 16340 | str(f1_f2_f3__f5),word(-2,_,3) # f1_f2_f3 |
| 16341 | str(f1_f2_f3__f5),word(-3,_,0) # f1_f2 |
Jerome Magnin | 8820932 | 2020-01-28 13:33:44 +0100 | [diff] [blame] | 16342 | str(/f1/f2/f3/f4),word(1,/) # f1 |
Emeric Brun | c9a0f6d | 2014-11-25 14:09:01 +0100 | [diff] [blame] | 16343 | |
Willy Tarreau | 23ec4ca | 2014-07-15 20:15:37 +0200 | [diff] [blame] | 16344 | wt6([<avalanche>]) |
| 16345 | Hashes a binary input sample into an unsigned 32-bit quantity using the WT6 |
| 16346 | hash function. Optionally, it is possible to apply a full avalanche hash |
| 16347 | function to the output if the optional <avalanche> argument equals 1. This |
| 16348 | converter uses the same functions as used by the various hash-based load |
| 16349 | balancing algorithms, so it will provide exactly the same results. It is |
| 16350 | mostly intended for debugging, but can be used as a stick-table entry to |
| 16351 | collect rough statistics. It must not be used for security purposes as a |
Emmanuel Hocdet | 50791a7 | 2018-03-21 11:19:01 +0100 | [diff] [blame] | 16352 | 32-bit hash is trivial to break. See also "crc32", "djb2", "sdbm", "crc32c", |
| 16353 | and the "hash-type" directive. |
Willy Tarreau | 23ec4ca | 2014-07-15 20:15:37 +0200 | [diff] [blame] | 16354 | |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 16355 | xor(<value>) |
| 16356 | Performs a bitwise "XOR" (exclusive OR) between <value> and the input value |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 16357 | of type signed integer, and returns the result as an signed integer. |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 16358 | <value> can be a numeric value or a variable name. The name of the variable |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16359 | starts with an indication about its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 16360 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16361 | "sess" : the variable is shared with the whole session |
| 16362 | "txn" : the variable is shared with the transaction (request and |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 16363 | response), |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16364 | "req" : the variable is shared only during request processing, |
| 16365 | "res" : the variable is shared only during response processing. |
Thierry FOURNIER | 5d86fae | 2015-07-07 21:10:16 +0200 | [diff] [blame] | 16366 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 16367 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Willy Tarreau | 9770787 | 2015-01-27 15:12:13 +0100 | [diff] [blame] | 16368 | |
Dragan Dosen | 04bf0cc | 2020-12-22 21:44:33 +0100 | [diff] [blame] | 16369 | xxh3([<seed>]) |
| 16370 | Hashes a binary input sample into a signed 64-bit quantity using the XXH3 |
| 16371 | 64-bit variant of the XXhash hash function. This hash supports a seed which |
| 16372 | defaults to zero but a different value maybe passed as the <seed> argument. |
| 16373 | This hash is known to be very good and very fast so it can be used to hash |
| 16374 | URLs and/or URL parameters for use as stick-table keys to collect statistics |
| 16375 | with a low collision rate, though care must be taken as the algorithm is not |
| 16376 | considered as cryptographically secure. |
| 16377 | |
Thierry FOURNIER | 01e0974 | 2016-12-26 11:46:11 +0100 | [diff] [blame] | 16378 | xxh32([<seed>]) |
| 16379 | Hashes a binary input sample into an unsigned 32-bit quantity using the 32-bit |
| 16380 | variant of the XXHash hash function. This hash supports a seed which defaults |
| 16381 | to zero but a different value maybe passed as the <seed> argument. This hash |
| 16382 | is known to be very good and very fast so it can be used to hash URLs and/or |
| 16383 | URL parameters for use as stick-table keys to collect statistics with a low |
| 16384 | collision rate, though care must be taken as the algorithm is not considered |
| 16385 | as cryptographically secure. |
| 16386 | |
| 16387 | xxh64([<seed>]) |
| 16388 | Hashes a binary input sample into a signed 64-bit quantity using the 64-bit |
| 16389 | variant of the XXHash hash function. This hash supports a seed which defaults |
| 16390 | to zero but a different value maybe passed as the <seed> argument. This hash |
| 16391 | is known to be very good and very fast so it can be used to hash URLs and/or |
| 16392 | URL parameters for use as stick-table keys to collect statistics with a low |
| 16393 | collision rate, though care must be taken as the algorithm is not considered |
| 16394 | as cryptographically secure. |
| 16395 | |
Thierry FOURNIER | d5f624d | 2013-11-26 11:52:33 +0100 | [diff] [blame] | 16396 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 16397 | 7.3.2. Fetching samples from internal states |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16398 | -------------------------------------------- |
| 16399 | |
| 16400 | A first set of sample fetch methods applies to internal information which does |
| 16401 | not even relate to any client information. These ones are sometimes used with |
| 16402 | "monitor-fail" directives to report an internal status to external watchers. |
| 16403 | The sample fetch methods described in this section are usable anywhere. |
| 16404 | |
| 16405 | always_false : boolean |
| 16406 | Always returns the boolean "false" value. It may be used with ACLs as a |
| 16407 | temporary replacement for another one when adjusting configurations. |
| 16408 | |
| 16409 | always_true : boolean |
| 16410 | Always returns the boolean "true" value. It may be used with ACLs as a |
| 16411 | temporary replacement for another one when adjusting configurations. |
| 16412 | |
| 16413 | avg_queue([<backend>]) : integer |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 16414 | Returns the total number of queued connections of the designated backend |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16415 | divided by the number of active servers. The current backend is used if no |
| 16416 | backend is specified. This is very similar to "queue" except that the size of |
| 16417 | the farm is considered, in order to give a more accurate measurement of the |
| 16418 | time it may take for a new connection to be processed. The main usage is with |
| 16419 | ACL to return a sorry page to new users when it becomes certain they will get |
| 16420 | a degraded service, or to pass to the backend servers in a header so that |
| 16421 | they decide to work in degraded mode or to disable some functions to speed up |
| 16422 | the processing a bit. Note that in the event there would not be any active |
| 16423 | server anymore, twice the number of queued connections would be considered as |
| 16424 | the measured value. This is a fair estimate, as we expect one server to get |
| 16425 | back soon anyway, but we still prefer to send new traffic to another backend |
| 16426 | if in better shape. See also the "queue", "be_conn", and "be_sess_rate" |
| 16427 | sample fetches. |
Krzysztof Piotr Oledzki | 346f76d | 2010-01-12 21:59:30 +0100 | [diff] [blame] | 16428 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16429 | be_conn([<backend>]) : integer |
Willy Tarreau | a36af91 | 2009-10-10 12:02:45 +0200 | [diff] [blame] | 16430 | Applies to the number of currently established connections on the backend, |
| 16431 | possibly including the connection being evaluated. If no backend name is |
| 16432 | specified, the current one is used. But it is also possible to check another |
| 16433 | backend. It can be used to use a specific farm when the nominal one is full. |
Patrick Hemmer | 4cdf3ab | 2018-06-14 17:10:27 -0400 | [diff] [blame] | 16434 | See also the "fe_conn", "queue", "be_conn_free", and "be_sess_rate" criteria. |
| 16435 | |
| 16436 | be_conn_free([<backend>]) : integer |
| 16437 | Returns an integer value corresponding to the number of available connections |
| 16438 | across available servers in the backend. Queue slots are not included. Backup |
| 16439 | servers are also not included, unless all other servers are down. If no |
| 16440 | backend name is specified, the current one is used. But it is also possible |
| 16441 | to check another backend. It can be used to use a specific farm when the |
Patrick Hemmer | 155e93e | 2018-06-14 18:01:35 -0400 | [diff] [blame] | 16442 | nominal one is full. See also the "be_conn", "connslots", and "srv_conn_free" |
| 16443 | criteria. |
Patrick Hemmer | 4cdf3ab | 2018-06-14 17:10:27 -0400 | [diff] [blame] | 16444 | |
| 16445 | OTHER CAVEATS AND NOTES: if any of the server maxconn, or maxqueue is 0 |
| 16446 | (meaning unlimited), then this fetch clearly does not make sense, in which |
| 16447 | case the value returned will be -1. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 16448 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16449 | be_sess_rate([<backend>]) : integer |
| 16450 | Returns an integer value corresponding to the sessions creation rate on the |
| 16451 | backend, in number of new sessions per second. This is used with ACLs to |
| 16452 | switch to an alternate backend when an expensive or fragile one reaches too |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16453 | high a session rate, or to limit abuse of service (e.g. prevent sucking of an |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16454 | online dictionary). It can also be useful to add this element to logs using a |
| 16455 | log-format directive. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 16456 | |
| 16457 | Example : |
| 16458 | # Redirect to an error page if the dictionary is requested too often |
| 16459 | backend dynamic |
| 16460 | mode http |
| 16461 | acl being_scanned be_sess_rate gt 100 |
| 16462 | redirect location /denied.html if being_scanned |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 16463 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16464 | bin(<hex>) : bin |
Thierry FOURNIER | cc10329 | 2015-06-06 19:30:17 +0200 | [diff] [blame] | 16465 | Returns a binary chain. The input is the hexadecimal representation |
| 16466 | of the string. |
| 16467 | |
| 16468 | bool(<bool>) : bool |
| 16469 | Returns a boolean value. <bool> can be 'true', 'false', '1' or '0'. |
| 16470 | 'false' and '0' are the same. 'true' and '1' are the same. |
| 16471 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16472 | connslots([<backend>]) : integer |
| 16473 | Returns an integer value corresponding to the number of connection slots |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 16474 | still available in the backend, by totaling the maximum amount of |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16475 | connections on all servers and the maximum queue size. This is probably only |
| 16476 | used with ACLs. |
Tait Clarridge | 7896d52 | 2012-12-05 21:39:31 -0500 | [diff] [blame] | 16477 | |
Jeffrey 'jf' Lim | 5051d7b | 2008-09-04 01:03:03 +0800 | [diff] [blame] | 16478 | The basic idea here is to be able to measure the number of connection "slots" |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 16479 | still available (connection + queue), so that anything beyond that (intended |
Jeffrey 'jf' Lim | 5051d7b | 2008-09-04 01:03:03 +0800 | [diff] [blame] | 16480 | usage; see "use_backend" keyword) can be redirected to a different backend. |
| 16481 | |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 16482 | 'connslots' = number of available server connection slots, + number of |
| 16483 | available server queue slots. |
Jeffrey 'jf' Lim | 5051d7b | 2008-09-04 01:03:03 +0800 | [diff] [blame] | 16484 | |
Willy Tarreau | a36af91 | 2009-10-10 12:02:45 +0200 | [diff] [blame] | 16485 | Note that while "fe_conn" may be used, "connslots" comes in especially |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 16486 | useful when you have a case of traffic going to one single ip, splitting into |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16487 | multiple backends (perhaps using ACLs to do name-based load balancing) and |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 16488 | you want to be able to differentiate between different backends, and their |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16489 | available "connslots". Also, whereas "nbsrv" only measures servers that are |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16490 | actually *down*, this fetch is more fine-grained and looks into the number of |
Willy Tarreau | a36af91 | 2009-10-10 12:02:45 +0200 | [diff] [blame] | 16491 | available connection slots as well. See also "queue" and "avg_queue". |
Jeffrey 'jf' Lim | 5051d7b | 2008-09-04 01:03:03 +0800 | [diff] [blame] | 16492 | |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 16493 | OTHER CAVEATS AND NOTES: at this point in time, the code does not take care |
| 16494 | of dynamic connections. Also, if any of the server maxconn, or maxqueue is 0, |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16495 | then this fetch clearly does not make sense, in which case the value returned |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 16496 | will be -1. |
Jeffrey 'jf' Lim | 5051d7b | 2008-09-04 01:03:03 +0800 | [diff] [blame] | 16497 | |
Willy Tarreau | 70fe944 | 2018-11-22 16:07:39 +0100 | [diff] [blame] | 16498 | cpu_calls : integer |
| 16499 | Returns the number of calls to the task processing the stream or current |
| 16500 | request since it was allocated. This number is reset for each new request on |
| 16501 | the same connections in case of HTTP keep-alive. This value should usually be |
| 16502 | low and stable (around 2 calls for a typically simple request) but may become |
| 16503 | high if some processing (compression, caching or analysis) is performed. This |
| 16504 | is purely for performance monitoring purposes. |
| 16505 | |
| 16506 | cpu_ns_avg : integer |
| 16507 | Returns the average number of nanoseconds spent in each call to the task |
| 16508 | processing the stream or current request. This number is reset for each new |
| 16509 | request on the same connections in case of HTTP keep-alive. This value |
| 16510 | indicates the overall cost of processing the request or the connection for |
| 16511 | each call. There is no good nor bad value but the time spent in a call |
| 16512 | automatically causes latency for other processing (see lat_ns_avg below), |
| 16513 | and may affect other connection's apparent response time. Certain operations |
| 16514 | like compression, complex regex matching or heavy Lua operations may directly |
| 16515 | affect this value, and having it in the logs will make it easier to spot the |
| 16516 | faulty processing that needs to be fixed to recover decent performance. |
| 16517 | Note: this value is exactly cpu_ns_tot divided by cpu_calls. |
| 16518 | |
| 16519 | cpu_ns_tot : integer |
| 16520 | Returns the total number of nanoseconds spent in each call to the task |
| 16521 | processing the stream or current request. This number is reset for each new |
| 16522 | request on the same connections in case of HTTP keep-alive. This value |
| 16523 | indicates the overall cost of processing the request or the connection for |
| 16524 | each call. There is no good nor bad value but the time spent in a call |
| 16525 | automatically causes latency for other processing (see lat_ns_avg below), |
| 16526 | induces CPU costs on the machine, and may affect other connection's apparent |
| 16527 | response time. Certain operations like compression, complex regex matching or |
| 16528 | heavy Lua operations may directly affect this value, and having it in the |
| 16529 | logs will make it easier to spot the faulty processing that needs to be fixed |
| 16530 | to recover decent performance. The value may be artificially high due to a |
| 16531 | high cpu_calls count, for example when processing many HTTP chunks, and for |
| 16532 | this reason it is often preferred to log cpu_ns_avg instead. |
| 16533 | |
Cyril Bonté | 6bcd182 | 2019-11-05 23:13:59 +0100 | [diff] [blame] | 16534 | date([<offset>],[<unit>]) : integer |
Willy Tarreau | 6236d3a | 2013-07-25 14:28:25 +0200 | [diff] [blame] | 16535 | Returns the current date as the epoch (number of seconds since 01/01/1970). |
Damien Claisse | ae6f125 | 2019-10-30 15:57:28 +0000 | [diff] [blame] | 16536 | |
| 16537 | If an offset value is specified, then it is added to the current date before |
| 16538 | returning the value. This is particularly useful to compute relative dates, |
| 16539 | as both positive and negative offsets are allowed. |
Willy Tarreau | 276fae9 | 2013-07-25 14:36:01 +0200 | [diff] [blame] | 16540 | It is useful combined with the http_date converter. |
| 16541 | |
Damien Claisse | ae6f125 | 2019-10-30 15:57:28 +0000 | [diff] [blame] | 16542 | <unit> is facultative, and can be set to "s" for seconds (default behavior), |
| 16543 | "ms" for milliseconds or "us" for microseconds. |
| 16544 | If unit is set, return value is an integer reflecting either seconds, |
| 16545 | milliseconds or microseconds since epoch, plus offset. |
| 16546 | It is useful when a time resolution of less than a second is needed. |
| 16547 | |
Willy Tarreau | 276fae9 | 2013-07-25 14:36:01 +0200 | [diff] [blame] | 16548 | Example : |
| 16549 | |
| 16550 | # set an expires header to now+1 hour in every response |
| 16551 | http-response set-header Expires %[date(3600),http_date] |
Willy Tarreau | 6236d3a | 2013-07-25 14:28:25 +0200 | [diff] [blame] | 16552 | |
Damien Claisse | ae6f125 | 2019-10-30 15:57:28 +0000 | [diff] [blame] | 16553 | # set an expires header to now+1 hour in every response, with |
| 16554 | # millisecond granularity |
| 16555 | http-response set-header Expires %[date(3600000,ms),http_date(0,ms)] |
| 16556 | |
Etienne Carriere | a792a0a | 2018-01-17 13:43:24 +0100 | [diff] [blame] | 16557 | date_us : integer |
| 16558 | Return the microseconds part of the date (the "second" part is returned by |
| 16559 | date sample). This sample is coherent with the date sample as it is comes |
| 16560 | from the same timeval structure. |
| 16561 | |
Willy Tarreau | d716f9b | 2017-10-13 11:03:15 +0200 | [diff] [blame] | 16562 | distcc_body(<token>[,<occ>]) : binary |
| 16563 | Parses a distcc message and returns the body associated to occurrence #<occ> |
| 16564 | of the token <token>. Occurrences start at 1, and when unspecified, any may |
| 16565 | match though in practice only the first one is checked for now. This can be |
| 16566 | used to extract file names or arguments in files built using distcc through |
| 16567 | haproxy. Please refer to distcc's protocol documentation for the complete |
| 16568 | list of supported tokens. |
| 16569 | |
| 16570 | distcc_param(<token>[,<occ>]) : integer |
| 16571 | Parses a distcc message and returns the parameter associated to occurrence |
| 16572 | #<occ> of the token <token>. Occurrences start at 1, and when unspecified, |
| 16573 | any may match though in practice only the first one is checked for now. This |
| 16574 | can be used to extract certain information such as the protocol version, the |
| 16575 | file size or the argument in files built using distcc through haproxy. |
| 16576 | Another use case consists in waiting for the start of the preprocessed file |
| 16577 | contents before connecting to the server to avoid keeping idle connections. |
| 16578 | Please refer to distcc's protocol documentation for the complete list of |
| 16579 | supported tokens. |
| 16580 | |
| 16581 | Example : |
| 16582 | # wait up to 20s for the pre-processed file to be uploaded |
| 16583 | tcp-request inspect-delay 20s |
| 16584 | tcp-request content accept if { distcc_param(DOTI) -m found } |
| 16585 | # send large files to the big farm |
| 16586 | use_backend big_farm if { distcc_param(DOTI) gt 1000000 } |
| 16587 | |
Willy Tarreau | 595ec54 | 2013-06-12 21:34:28 +0200 | [diff] [blame] | 16588 | env(<name>) : string |
| 16589 | Returns a string containing the value of environment variable <name>. As a |
| 16590 | reminder, environment variables are per-process and are sampled when the |
| 16591 | process starts. This can be useful to pass some information to a next hop |
| 16592 | server, or with ACLs to take specific action when the process is started a |
| 16593 | certain way. |
| 16594 | |
| 16595 | Examples : |
| 16596 | # Pass the Via header to next hop with the local hostname in it |
| 16597 | http-request add-header Via 1.1\ %[env(HOSTNAME)] |
| 16598 | |
| 16599 | # reject cookie-less requests when the STOP environment variable is set |
| 16600 | http-request deny if !{ cook(SESSIONID) -m found } { env(STOP) -m found } |
| 16601 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16602 | fe_conn([<frontend>]) : integer |
| 16603 | Returns the number of currently established connections on the frontend, |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 16604 | possibly including the connection being evaluated. If no frontend name is |
| 16605 | specified, the current one is used. But it is also possible to check another |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16606 | frontend. It can be used to return a sorry page before hard-blocking, or to |
| 16607 | use a specific backend to drain new requests when the farm is considered |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16608 | full. This is mostly used with ACLs but can also be used to pass some |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16609 | statistics to servers in HTTP headers. See also the "dst_conn", "be_conn", |
| 16610 | "fe_sess_rate" fetches. |
Willy Tarreau | a36af91 | 2009-10-10 12:02:45 +0200 | [diff] [blame] | 16611 | |
Nenad Merdanovic | ad9a7e9 | 2016-10-03 04:57:37 +0200 | [diff] [blame] | 16612 | fe_req_rate([<frontend>]) : integer |
| 16613 | Returns an integer value corresponding to the number of HTTP requests per |
| 16614 | second sent to a frontend. This number can differ from "fe_sess_rate" in |
| 16615 | situations where client-side keep-alive is enabled. |
| 16616 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16617 | fe_sess_rate([<frontend>]) : integer |
| 16618 | Returns an integer value corresponding to the sessions creation rate on the |
| 16619 | frontend, in number of new sessions per second. This is used with ACLs to |
| 16620 | limit the incoming session rate to an acceptable range in order to prevent |
| 16621 | abuse of service at the earliest moment, for example when combined with other |
| 16622 | layer 4 ACLs in order to force the clients to wait a bit for the rate to go |
| 16623 | down below the limit. It can also be useful to add this element to logs using |
| 16624 | a log-format directive. See also the "rate-limit sessions" directive for use |
| 16625 | in frontends. |
Willy Tarreau | 079ff0a | 2009-03-05 21:34:28 +0100 | [diff] [blame] | 16626 | |
| 16627 | Example : |
| 16628 | # This frontend limits incoming mails to 10/s with a max of 100 |
| 16629 | # concurrent connections. We accept any connection below 10/s, and |
| 16630 | # force excess clients to wait for 100 ms. Since clients are limited to |
| 16631 | # 100 max, there cannot be more than 10 incoming mails per second. |
| 16632 | frontend mail |
| 16633 | bind :25 |
| 16634 | mode tcp |
| 16635 | maxconn 100 |
| 16636 | acl too_fast fe_sess_rate ge 10 |
| 16637 | tcp-request inspect-delay 100ms |
| 16638 | tcp-request content accept if ! too_fast |
| 16639 | tcp-request content accept if WAIT_END |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 16640 | |
Nenad Merdanovic | 807a6e7 | 2017-03-12 22:00:00 +0100 | [diff] [blame] | 16641 | hostname : string |
| 16642 | Returns the system hostname. |
| 16643 | |
Thierry FOURNIER | 07ee64e | 2015-07-06 23:43:03 +0200 | [diff] [blame] | 16644 | int(<integer>) : signed integer |
| 16645 | Returns a signed integer. |
| 16646 | |
Thierry FOURNIER | cc10329 | 2015-06-06 19:30:17 +0200 | [diff] [blame] | 16647 | ipv4(<ipv4>) : ipv4 |
| 16648 | Returns an ipv4. |
| 16649 | |
| 16650 | ipv6(<ipv6>) : ipv6 |
| 16651 | Returns an ipv6. |
| 16652 | |
Willy Tarreau | 70fe944 | 2018-11-22 16:07:39 +0100 | [diff] [blame] | 16653 | lat_ns_avg : integer |
| 16654 | Returns the average number of nanoseconds spent between the moment the task |
| 16655 | handling the stream is woken up and the moment it is effectively called. This |
| 16656 | number is reset for each new request on the same connections in case of HTTP |
| 16657 | keep-alive. This value indicates the overall latency inflicted to the current |
| 16658 | request by all other requests being processed in parallel, and is a direct |
| 16659 | indicator of perceived performance due to noisy neighbours. In order to keep |
| 16660 | the value low, it is possible to reduce the scheduler's run queue depth using |
| 16661 | "tune.runqueue-depth", to reduce the number of concurrent events processed at |
| 16662 | once using "tune.maxpollevents", to decrease the stream's nice value using |
Willy Tarreau | e7723bd | 2020-06-24 11:11:02 +0200 | [diff] [blame] | 16663 | the "nice" option on the "bind" lines or in the frontend, to enable low |
| 16664 | latency scheduling using "tune.sched.low-latency", or to look for other heavy |
| 16665 | requests in logs (those exhibiting large values of "cpu_ns_avg"), whose |
| 16666 | processing needs to be adjusted or fixed. Compression of large buffers could |
| 16667 | be a culprit, like heavy regex or long lists of regex. Note: this value is |
| 16668 | exactly lat_ns_tot divided by cpu_calls. |
Willy Tarreau | 70fe944 | 2018-11-22 16:07:39 +0100 | [diff] [blame] | 16669 | |
| 16670 | lat_ns_tot : integer |
| 16671 | Returns the total number of nanoseconds spent between the moment the task |
| 16672 | handling the stream is woken up and the moment it is effectively called. This |
| 16673 | number is reset for each new request on the same connections in case of HTTP |
| 16674 | keep-alive. This value indicates the overall latency inflicted to the current |
| 16675 | request by all other requests being processed in parallel, and is a direct |
| 16676 | indicator of perceived performance due to noisy neighbours. In order to keep |
| 16677 | the value low, it is possible to reduce the scheduler's run queue depth using |
| 16678 | "tune.runqueue-depth", to reduce the number of concurrent events processed at |
| 16679 | once using "tune.maxpollevents", to decrease the stream's nice value using |
Willy Tarreau | e7723bd | 2020-06-24 11:11:02 +0200 | [diff] [blame] | 16680 | the "nice" option on the "bind" lines or in the frontend, to enable low |
| 16681 | latency scheduling using "tune.sched.low-latency", or to look for other heavy |
| 16682 | requests in logs (those exhibiting large values of "cpu_ns_avg"), whose |
| 16683 | processing needs to be adjusted or fixed. Compression of large buffers could |
| 16684 | be a culprit, like heavy regex or long lists of regex. Note: while it |
Willy Tarreau | 70fe944 | 2018-11-22 16:07:39 +0100 | [diff] [blame] | 16685 | may intuitively seem that the total latency adds to a transfer time, it is |
| 16686 | almost never true because while a task waits for the CPU, network buffers |
| 16687 | continue to fill up and the next call will process more at once. The value |
| 16688 | may be artificially high due to a high cpu_calls count, for example when |
| 16689 | processing many HTTP chunks, and for this reason it is often preferred to log |
| 16690 | lat_ns_avg instead, which is a more relevant performance indicator. |
| 16691 | |
Thierry FOURNIER | cc10329 | 2015-06-06 19:30:17 +0200 | [diff] [blame] | 16692 | meth(<method>) : method |
| 16693 | Returns a method. |
| 16694 | |
Willy Tarreau | 0f30d26 | 2014-11-24 16:02:05 +0100 | [diff] [blame] | 16695 | nbproc : integer |
| 16696 | Returns an integer value corresponding to the number of processes that were |
| 16697 | started (it equals the global "nbproc" setting). This is useful for logging |
| 16698 | and debugging purposes. |
| 16699 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16700 | nbsrv([<backend>]) : integer |
| 16701 | Returns an integer value corresponding to the number of usable servers of |
| 16702 | either the current backend or the named backend. This is mostly used with |
| 16703 | ACLs but can also be useful when added to logs. This is normally used to |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 16704 | switch to an alternate backend when the number of servers is too low to |
| 16705 | to handle some load. It is useful to report a failure when combined with |
| 16706 | "monitor fail". |
Willy Tarreau | 079ff0a | 2009-03-05 21:34:28 +0100 | [diff] [blame] | 16707 | |
Patrick Hemmer | fabb24f | 2018-08-13 14:07:57 -0400 | [diff] [blame] | 16708 | prio_class : integer |
| 16709 | Returns the priority class of the current session for http mode or connection |
| 16710 | for tcp mode. The value will be that set by the last call to "http-request |
| 16711 | set-priority-class" or "tcp-request content set-priority-class". |
| 16712 | |
| 16713 | prio_offset : integer |
| 16714 | Returns the priority offset of the current session for http mode or |
| 16715 | connection for tcp mode. The value will be that set by the last call to |
| 16716 | "http-request set-priority-offset" or "tcp-request content |
| 16717 | set-priority-offset". |
| 16718 | |
Willy Tarreau | 0f30d26 | 2014-11-24 16:02:05 +0100 | [diff] [blame] | 16719 | proc : integer |
| 16720 | Returns an integer value corresponding to the position of the process calling |
| 16721 | the function, between 1 and global.nbproc. This is useful for logging and |
| 16722 | debugging purposes. |
| 16723 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16724 | queue([<backend>]) : integer |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 16725 | Returns the total number of queued connections of the designated backend, |
| 16726 | including all the connections in server queues. If no backend name is |
| 16727 | specified, the current one is used, but it is also possible to check another |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16728 | one. This is useful with ACLs or to pass statistics to backend servers. This |
| 16729 | can be used to take actions when queuing goes above a known level, generally |
| 16730 | indicating a surge of traffic or a massive slowdown on the servers. One |
| 16731 | possible action could be to reject new users but still accept old ones. See |
| 16732 | also the "avg_queue", "be_conn", and "be_sess_rate" fetches. |
| 16733 | |
Willy Tarreau | 84310e2 | 2014-02-14 11:59:04 +0100 | [diff] [blame] | 16734 | rand([<range>]) : integer |
| 16735 | Returns a random integer value within a range of <range> possible values, |
| 16736 | starting at zero. If the range is not specified, it defaults to 2^32, which |
| 16737 | gives numbers between 0 and 4294967295. It can be useful to pass some values |
| 16738 | needed to take some routing decisions for example, or just for debugging |
| 16739 | purposes. This random must not be used for security purposes. |
| 16740 | |
Luca Schimweg | 8a694b8 | 2019-09-10 15:42:52 +0200 | [diff] [blame] | 16741 | uuid([<version>]) : string |
| 16742 | Returns a UUID following the RFC4122 standard. If the version is not |
| 16743 | specified, a UUID version 4 (fully random) is returned. |
| 16744 | Currently, only version 4 is supported. |
| 16745 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16746 | srv_conn([<backend>/]<server>) : integer |
| 16747 | Returns an integer value corresponding to the number of currently established |
| 16748 | connections on the designated server, possibly including the connection being |
| 16749 | evaluated. If <backend> is omitted, then the server is looked up in the |
| 16750 | current backend. It can be used to use a specific farm when one server is |
| 16751 | full, or to inform the server about our view of the number of active |
Patrick Hemmer | 155e93e | 2018-06-14 18:01:35 -0400 | [diff] [blame] | 16752 | connections with it. See also the "fe_conn", "be_conn", "queue", and |
| 16753 | "srv_conn_free" fetch methods. |
| 16754 | |
| 16755 | srv_conn_free([<backend>/]<server>) : integer |
| 16756 | Returns an integer value corresponding to the number of available connections |
| 16757 | on the designated server, possibly including the connection being evaluated. |
| 16758 | The value does not include queue slots. If <backend> is omitted, then the |
| 16759 | server is looked up in the current backend. It can be used to use a specific |
| 16760 | farm when one server is full, or to inform the server about our view of the |
| 16761 | number of active connections with it. See also the "be_conn_free" and |
| 16762 | "srv_conn" fetch methods. |
| 16763 | |
| 16764 | OTHER CAVEATS AND NOTES: If the server maxconn is 0, then this fetch clearly |
| 16765 | does not make sense, in which case the value returned will be -1. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16766 | |
| 16767 | srv_is_up([<backend>/]<server>) : boolean |
| 16768 | Returns true when the designated server is UP, and false when it is either |
| 16769 | DOWN or in maintenance mode. If <backend> is omitted, then the server is |
| 16770 | looked up in the current backend. It is mainly used to take action based on |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16771 | an external status reported via a health check (e.g. a geographical site's |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16772 | availability). Another possible use which is more of a hack consists in |
| 16773 | using dummy servers as boolean variables that can be enabled or disabled from |
| 16774 | the CLI, so that rules depending on those ACLs can be tweaked in realtime. |
| 16775 | |
Willy Tarreau | ff2b7af | 2017-10-13 11:46:26 +0200 | [diff] [blame] | 16776 | srv_queue([<backend>/]<server>) : integer |
| 16777 | Returns an integer value corresponding to the number of connections currently |
| 16778 | pending in the designated server's queue. If <backend> is omitted, then the |
| 16779 | server is looked up in the current backend. It can sometimes be used together |
| 16780 | with the "use-server" directive to force to use a known faster server when it |
| 16781 | is not much loaded. See also the "srv_conn", "avg_queue" and "queue" sample |
| 16782 | fetch methods. |
| 16783 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16784 | srv_sess_rate([<backend>/]<server>) : integer |
| 16785 | Returns an integer corresponding to the sessions creation rate on the |
| 16786 | designated server, in number of new sessions per second. If <backend> is |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 16787 | omitted, then the server is looked up in the current backend. This is mostly |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16788 | used with ACLs but can make sense with logs too. This is used to switch to an |
| 16789 | alternate backend when an expensive or fragile one reaches too high a session |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16790 | rate, or to limit abuse of service (e.g. prevent latent requests from |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16791 | overloading servers). |
| 16792 | |
| 16793 | Example : |
| 16794 | # Redirect to a separate back |
| 16795 | acl srv1_full srv_sess_rate(be1/srv1) gt 50 |
| 16796 | acl srv2_full srv_sess_rate(be1/srv2) gt 50 |
| 16797 | use_backend be2 if srv1_full or srv2_full |
| 16798 | |
Christopher Faulet | 1bea865 | 2020-07-10 16:03:45 +0200 | [diff] [blame] | 16799 | srv_iweight([<backend>/]<server>): integer |
| 16800 | Returns an integer corresponding to the server's initial weight. If <backend> |
| 16801 | is omitted, then the server is looked up in the current backend. See also |
| 16802 | "srv_weight" and "srv_uweight". |
| 16803 | |
| 16804 | srv_uweight([<backend>/]<server>): integer |
| 16805 | Returns an integer corresponding to the user visible server's weight. If |
| 16806 | <backend> is omitted, then the server is looked up in the current |
| 16807 | backend. See also "srv_weight" and "srv_iweight". |
| 16808 | |
| 16809 | srv_weight([<backend>/]<server>): integer |
| 16810 | Returns an integer corresponding to the current (or effective) server's |
| 16811 | weight. If <backend> is omitted, then the server is looked up in the current |
| 16812 | backend. See also "srv_iweight" and "srv_uweight". |
| 16813 | |
Willy Tarreau | 0f30d26 | 2014-11-24 16:02:05 +0100 | [diff] [blame] | 16814 | stopping : boolean |
| 16815 | Returns TRUE if the process calling the function is currently stopping. This |
| 16816 | can be useful for logging, or for relaxing certain checks or helping close |
| 16817 | certain connections upon graceful shutdown. |
| 16818 | |
Thierry FOURNIER | cc10329 | 2015-06-06 19:30:17 +0200 | [diff] [blame] | 16819 | str(<string>) : string |
| 16820 | Returns a string. |
| 16821 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16822 | table_avl([<table>]) : integer |
| 16823 | Returns the total number of available entries in the current proxy's |
| 16824 | stick-table or in the designated stick-table. See also table_cnt. |
| 16825 | |
| 16826 | table_cnt([<table>]) : integer |
| 16827 | Returns the total number of entries currently in use in the current proxy's |
| 16828 | stick-table or in the designated stick-table. See also src_conn_cnt and |
| 16829 | table_avl for other entry counting methods. |
| 16830 | |
Christopher Faulet | 34adb2a | 2017-11-21 21:45:38 +0100 | [diff] [blame] | 16831 | thread : integer |
| 16832 | Returns an integer value corresponding to the position of the thread calling |
| 16833 | the function, between 0 and (global.nbthread-1). This is useful for logging |
| 16834 | and debugging purposes. |
| 16835 | |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 16836 | var(<var-name>) : undefined |
| 16837 | Returns a variable with the stored type. If the variable is not set, the |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16838 | sample fetch fails. The name of the variable starts with an indication |
| 16839 | about its scope. The scopes allowed are: |
Christopher Faulet | ff2613e | 2016-11-09 11:36:17 +0100 | [diff] [blame] | 16840 | "proc" : the variable is shared with the whole process |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16841 | "sess" : the variable is shared with the whole session |
| 16842 | "txn" : the variable is shared with the transaction (request and |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 16843 | response), |
Daniel Schneller | 0b54705 | 2016-03-21 20:46:57 +0100 | [diff] [blame] | 16844 | "req" : the variable is shared only during request processing, |
| 16845 | "res" : the variable is shared only during response processing. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 16846 | This prefix is followed by a name. The separator is a '.'. The name may only |
Christopher Faulet | b71557a | 2016-10-31 10:49:03 +0100 | [diff] [blame] | 16847 | contain characters 'a-z', 'A-Z', '0-9', '.' and '_'. |
Thierry FOURNIER | 4834bc7 | 2015-06-06 19:29:07 +0200 | [diff] [blame] | 16848 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 16849 | 7.3.3. Fetching samples at Layer 4 |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16850 | ---------------------------------- |
| 16851 | |
| 16852 | The layer 4 usually describes just the transport layer which in haproxy is |
| 16853 | closest to the connection, where no content is yet made available. The fetch |
| 16854 | methods described here are usable as low as the "tcp-request connection" rule |
| 16855 | sets unless they require some future information. Those generally include |
| 16856 | TCP/IP addresses and ports, as well as elements from stick-tables related to |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 16857 | the incoming connection. For retrieving a value from a sticky counters, the |
| 16858 | counter number can be explicitly set as 0, 1, or 2 using the pre-defined |
Moemen MHEDHBI | 9cf4634 | 2018-09-25 17:50:53 +0200 | [diff] [blame] | 16859 | "sc0_", "sc1_", or "sc2_" prefix. These three pre-defined prefixes can only be |
| 16860 | used if MAX_SESS_STKCTR value does not exceed 3, otherwise the counter number |
| 16861 | can be specified as the first integer argument when using the "sc_" prefix. |
| 16862 | Starting from "sc_0" to "sc_N" where N is (MAX_SESS_STKCTR-1). An optional |
| 16863 | table may be specified with the "sc*" form, in which case the currently |
| 16864 | tracked key will be looked up into this alternate table instead of the table |
| 16865 | currently being tracked. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16866 | |
Jérôme Magnin | 35e53a6 | 2019-01-16 14:38:37 +0100 | [diff] [blame] | 16867 | bc_http_major : integer |
Jérôme Magnin | 8657742 | 2018-12-07 09:03:11 +0100 | [diff] [blame] | 16868 | Returns the backend connection's HTTP major version encoding, which may be 1 |
| 16869 | for HTTP/0.9 to HTTP/1.1 or 2 for HTTP/2. Note, this is based on the on-wire |
| 16870 | encoding and not the version present in the request header. |
| 16871 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16872 | be_id : integer |
| 16873 | Returns an integer containing the current backend's id. It can be used in |
Christopher Faulet | d1b4464 | 2020-04-30 09:51:15 +0200 | [diff] [blame] | 16874 | frontends with responses to check which backend processed the request. It can |
| 16875 | also be used in a tcp-check or an http-check ruleset. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16876 | |
Marcin Deranek | d2471c2 | 2016-12-12 14:08:05 +0100 | [diff] [blame] | 16877 | be_name : string |
| 16878 | Returns a string containing the current backend's name. It can be used in |
Christopher Faulet | d1b4464 | 2020-04-30 09:51:15 +0200 | [diff] [blame] | 16879 | frontends with responses to check which backend processed the request. It can |
| 16880 | also be used in a tcp-check or an http-check ruleset. |
Marcin Deranek | d2471c2 | 2016-12-12 14:08:05 +0100 | [diff] [blame] | 16881 | |
Amaury Denoyelle | d91d779 | 2020-12-10 13:43:56 +0100 | [diff] [blame] | 16882 | be_server_timeout : integer |
| 16883 | Returns the configuration value in millisecond for the server timeout of the |
| 16884 | current backend. This timeout can be overwritten by a "set-timeout" rule. See |
| 16885 | also the "cur_server_timeout". |
| 16886 | |
| 16887 | be_tunnel_timeout : integer |
| 16888 | Returns the configuration value in millisecond for the tunnel timeout of the |
| 16889 | current backend. This timeout can be overwritten by a "set-timeout" rule. See |
| 16890 | also the "cur_tunnel_timeout". |
| 16891 | |
Amaury Denoyelle | f7719a2 | 2020-12-10 13:43:58 +0100 | [diff] [blame] | 16892 | cur_server_timeout : integer |
| 16893 | Returns the currently applied server timeout in millisecond for the stream. |
| 16894 | In the default case, this will be equal to be_server_timeout unless a |
| 16895 | "set-timeout" rule has been applied. See also "be_server_timeout". |
| 16896 | |
| 16897 | cur_tunnel_timeout : integer |
| 16898 | Returns the currently applied tunnel timeout in millisecond for the stream. |
| 16899 | In the default case, this will be equal to be_tunnel_timeout unless a |
| 16900 | "set-timeout" rule has been applied. See also "be_tunnel_timeout". |
| 16901 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16902 | dst : ip |
| 16903 | This is the destination IPv4 address of the connection on the client side, |
| 16904 | which is the address the client connected to. It can be useful when running |
| 16905 | in transparent mode. It is of type IP and works on both IPv4 and IPv6 tables. |
| 16906 | On IPv6 tables, IPv4 address is mapped to its IPv6 equivalent, according to |
Willy Tarreau | 64ded3d | 2019-01-23 10:02:15 +0100 | [diff] [blame] | 16907 | RFC 4291. When the incoming connection passed through address translation or |
| 16908 | redirection involving connection tracking, the original destination address |
| 16909 | before the redirection will be reported. On Linux systems, the source and |
| 16910 | destination may seldom appear reversed if the nf_conntrack_tcp_loose sysctl |
| 16911 | is set, because a late response may reopen a timed out connection and switch |
| 16912 | what is believed to be the source and the destination. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16913 | |
| 16914 | dst_conn : integer |
| 16915 | Returns an integer value corresponding to the number of currently established |
| 16916 | connections on the same socket including the one being evaluated. It is |
| 16917 | normally used with ACLs but can as well be used to pass the information to |
| 16918 | servers in an HTTP header or in logs. It can be used to either return a sorry |
| 16919 | page before hard-blocking, or to use a specific backend to drain new requests |
| 16920 | when the socket is considered saturated. This offers the ability to assign |
| 16921 | different limits to different listening ports or addresses. See also the |
| 16922 | "fe_conn" and "be_conn" fetches. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 16923 | |
Willy Tarreau | 16e0156 | 2016-08-09 16:46:18 +0200 | [diff] [blame] | 16924 | dst_is_local : boolean |
| 16925 | Returns true if the destination address of the incoming connection is local |
| 16926 | to the system, or false if the address doesn't exist on the system, meaning |
| 16927 | that it was intercepted in transparent mode. It can be useful to apply |
| 16928 | certain rules by default to forwarded traffic and other rules to the traffic |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 16929 | targeting the real address of the machine. For example the stats page could |
Willy Tarreau | 16e0156 | 2016-08-09 16:46:18 +0200 | [diff] [blame] | 16930 | be delivered only on this address, or SSH access could be locally redirected. |
| 16931 | Please note that the check involves a few system calls, so it's better to do |
| 16932 | it only once per connection. |
| 16933 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 16934 | dst_port : integer |
| 16935 | Returns an integer value corresponding to the destination TCP port of the |
| 16936 | connection on the client side, which is the port the client connected to. |
| 16937 | This might be used when running in transparent mode, when assigning dynamic |
| 16938 | ports to some clients for a whole application session, to stick all users to |
| 16939 | a same server, or to pass the destination port information to a server using |
| 16940 | an HTTP header. |
| 16941 | |
Willy Tarreau | 60ca10a | 2017-08-18 15:26:54 +0200 | [diff] [blame] | 16942 | fc_http_major : integer |
| 16943 | Reports the front connection's HTTP major version encoding, which may be 1 |
| 16944 | for HTTP/0.9 to HTTP/1.1 or 2 for HTTP/2. Note, this is based on the on-wire |
| 16945 | encoding and not on the version present in the request header. |
| 16946 | |
Geoff Simmons | 7185b78 | 2019-08-27 18:31:16 +0200 | [diff] [blame] | 16947 | fc_pp_authority : string |
| 16948 | Returns the authority TLV sent by the client in the PROXY protocol header, |
| 16949 | if any. |
| 16950 | |
Tim Duesterhus | d1b15b6 | 2020-03-13 12:34:23 +0100 | [diff] [blame] | 16951 | fc_pp_unique_id : string |
| 16952 | Returns the unique ID TLV sent by the client in the PROXY protocol header, |
| 16953 | if any. |
| 16954 | |
Emeric Brun | 4f60301 | 2017-01-05 15:11:44 +0100 | [diff] [blame] | 16955 | fc_rcvd_proxy : boolean |
| 16956 | Returns true if the client initiated the connection with a PROXY protocol |
| 16957 | header. |
| 16958 | |
Thierry Fournier / OZON.IO | 6310bef | 2016-07-24 20:16:50 +0200 | [diff] [blame] | 16959 | fc_rtt(<unit>) : integer |
| 16960 | Returns the Round Trip Time (RTT) measured by the kernel for the client |
| 16961 | connection. <unit> is facultative, by default the unit is milliseconds. <unit> |
| 16962 | can be set to "ms" for milliseconds or "us" for microseconds. If the server |
| 16963 | connection is not established, if the connection is not TCP or if the |
| 16964 | operating system does not support TCP_INFO, for example Linux kernels before |
| 16965 | 2.4, the sample fetch fails. |
| 16966 | |
| 16967 | fc_rttvar(<unit>) : integer |
| 16968 | Returns the Round Trip Time (RTT) variance measured by the kernel for the |
| 16969 | client connection. <unit> is facultative, by default the unit is milliseconds. |
| 16970 | <unit> can be set to "ms" for milliseconds or "us" for microseconds. If the |
| 16971 | server connection is not established, if the connection is not TCP or if the |
| 16972 | operating system does not support TCP_INFO, for example Linux kernels before |
| 16973 | 2.4, the sample fetch fails. |
| 16974 | |
Christopher Faulet | ba0c53e | 2019-10-17 14:40:48 +0200 | [diff] [blame] | 16975 | fc_unacked : integer |
Joe Williams | 30fcd39 | 2016-08-10 07:06:44 -0700 | [diff] [blame] | 16976 | Returns the unacked counter measured by the kernel for the client connection. |
| 16977 | If the server connection is not established, if the connection is not TCP or |
| 16978 | if the operating system does not support TCP_INFO, for example Linux kernels |
| 16979 | before 2.4, the sample fetch fails. |
| 16980 | |
Christopher Faulet | ba0c53e | 2019-10-17 14:40:48 +0200 | [diff] [blame] | 16981 | fc_sacked : integer |
Joe Williams | 30fcd39 | 2016-08-10 07:06:44 -0700 | [diff] [blame] | 16982 | Returns the sacked counter measured by the kernel for the client connection. |
| 16983 | If the server connection is not established, if the connection is not TCP or |
| 16984 | if the operating system does not support TCP_INFO, for example Linux kernels |
| 16985 | before 2.4, the sample fetch fails. |
| 16986 | |
Christopher Faulet | ba0c53e | 2019-10-17 14:40:48 +0200 | [diff] [blame] | 16987 | fc_retrans : integer |
Joe Williams | 30fcd39 | 2016-08-10 07:06:44 -0700 | [diff] [blame] | 16988 | Returns the retransmits counter measured by the kernel for the client |
| 16989 | connection. If the server connection is not established, if the connection is |
| 16990 | not TCP or if the operating system does not support TCP_INFO, for example |
| 16991 | Linux kernels before 2.4, the sample fetch fails. |
| 16992 | |
Christopher Faulet | ba0c53e | 2019-10-17 14:40:48 +0200 | [diff] [blame] | 16993 | fc_fackets : integer |
Joe Williams | 30fcd39 | 2016-08-10 07:06:44 -0700 | [diff] [blame] | 16994 | Returns the fack counter measured by the kernel for the client |
| 16995 | connection. If the server connection is not established, if the connection is |
| 16996 | not TCP or if the operating system does not support TCP_INFO, for example |
| 16997 | Linux kernels before 2.4, the sample fetch fails. |
| 16998 | |
Christopher Faulet | ba0c53e | 2019-10-17 14:40:48 +0200 | [diff] [blame] | 16999 | fc_lost : integer |
Joe Williams | 30fcd39 | 2016-08-10 07:06:44 -0700 | [diff] [blame] | 17000 | Returns the lost counter measured by the kernel for the client |
| 17001 | connection. If the server connection is not established, if the connection is |
| 17002 | not TCP or if the operating system does not support TCP_INFO, for example |
| 17003 | Linux kernels before 2.4, the sample fetch fails. |
| 17004 | |
Christopher Faulet | ba0c53e | 2019-10-17 14:40:48 +0200 | [diff] [blame] | 17005 | fc_reordering : integer |
Joe Williams | 30fcd39 | 2016-08-10 07:06:44 -0700 | [diff] [blame] | 17006 | Returns the reordering counter measured by the kernel for the client |
| 17007 | connection. If the server connection is not established, if the connection is |
| 17008 | not TCP or if the operating system does not support TCP_INFO, for example |
| 17009 | Linux kernels before 2.4, the sample fetch fails. |
| 17010 | |
Marcin Deranek | 9a66dfb | 2018-04-13 14:37:50 +0200 | [diff] [blame] | 17011 | fe_defbe : string |
| 17012 | Returns a string containing the frontend's default backend name. It can be |
| 17013 | used in frontends to check which backend will handle requests by default. |
| 17014 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17015 | fe_id : integer |
| 17016 | Returns an integer containing the current frontend's id. It can be used in |
Marcin Deranek | 6e413ed | 2016-12-13 12:40:01 +0100 | [diff] [blame] | 17017 | backends to check from which frontend it was called, or to stick all users |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17018 | coming via a same frontend to the same server. |
| 17019 | |
Marcin Deranek | d2471c2 | 2016-12-12 14:08:05 +0100 | [diff] [blame] | 17020 | fe_name : string |
| 17021 | Returns a string containing the current frontend's name. It can be used in |
| 17022 | backends to check from which frontend it was called, or to stick all users |
| 17023 | coming via a same frontend to the same server. |
| 17024 | |
Amaury Denoyelle | da184d5 | 2020-12-10 13:43:55 +0100 | [diff] [blame] | 17025 | fe_client_timeout : integer |
| 17026 | Returns the configuration value in millisecond for the client timeout of the |
| 17027 | current frontend. |
| 17028 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17029 | sc_bytes_in_rate(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17030 | sc0_bytes_in_rate([<table>]) : integer |
| 17031 | sc1_bytes_in_rate([<table>]) : integer |
| 17032 | sc2_bytes_in_rate([<table>]) : integer |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17033 | Returns the average client-to-server bytes rate from the currently tracked |
| 17034 | counters, measured in amount of bytes over the period configured in the |
| 17035 | table. See also src_bytes_in_rate. |
| 17036 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17037 | sc_bytes_out_rate(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17038 | sc0_bytes_out_rate([<table>]) : integer |
| 17039 | sc1_bytes_out_rate([<table>]) : integer |
| 17040 | sc2_bytes_out_rate([<table>]) : integer |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17041 | Returns the average server-to-client bytes rate from the currently tracked |
| 17042 | counters, measured in amount of bytes over the period configured in the |
| 17043 | table. See also src_bytes_out_rate. |
| 17044 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17045 | sc_clr_gpc0(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17046 | sc0_clr_gpc0([<table>]) : integer |
| 17047 | sc1_clr_gpc0([<table>]) : integer |
| 17048 | sc2_clr_gpc0([<table>]) : integer |
Willy Tarreau | f73cd11 | 2011-08-13 01:45:16 +0200 | [diff] [blame] | 17049 | Clears the first General Purpose Counter associated to the currently tracked |
| 17050 | counters, and returns its previous value. Before the first invocation, the |
Willy Tarreau | 869948b | 2013-01-04 14:14:57 +0100 | [diff] [blame] | 17051 | stored value is zero, so first invocation will always return zero. This is |
| 17052 | typically used as a second ACL in an expression in order to mark a connection |
| 17053 | when a first ACL was verified : |
Willy Tarreau | f73cd11 | 2011-08-13 01:45:16 +0200 | [diff] [blame] | 17054 | |
Jarno Huuskonen | 676f622 | 2017-03-30 09:19:45 +0300 | [diff] [blame] | 17055 | Example: |
Willy Tarreau | f73cd11 | 2011-08-13 01:45:16 +0200 | [diff] [blame] | 17056 | # block if 5 consecutive requests continue to come faster than 10 sess |
| 17057 | # per second, and reset the counter as soon as the traffic slows down. |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 17058 | acl abuse sc0_http_req_rate gt 10 |
| 17059 | acl kill sc0_inc_gpc0 gt 5 |
| 17060 | acl save sc0_clr_gpc0 ge 0 |
Willy Tarreau | f73cd11 | 2011-08-13 01:45:16 +0200 | [diff] [blame] | 17061 | tcp-request connection accept if !abuse save |
| 17062 | tcp-request connection reject if abuse kill |
| 17063 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 17064 | sc_clr_gpc1(<ctr>[,<table>]) : integer |
| 17065 | sc0_clr_gpc1([<table>]) : integer |
| 17066 | sc1_clr_gpc1([<table>]) : integer |
| 17067 | sc2_clr_gpc1([<table>]) : integer |
| 17068 | Clears the second General Purpose Counter associated to the currently tracked |
| 17069 | counters, and returns its previous value. Before the first invocation, the |
| 17070 | stored value is zero, so first invocation will always return zero. This is |
| 17071 | typically used as a second ACL in an expression in order to mark a connection |
| 17072 | when a first ACL was verified. |
| 17073 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17074 | sc_conn_cnt(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17075 | sc0_conn_cnt([<table>]) : integer |
| 17076 | sc1_conn_cnt([<table>]) : integer |
| 17077 | sc2_conn_cnt([<table>]) : integer |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17078 | Returns the cumulative number of incoming connections from currently tracked |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17079 | counters. See also src_conn_cnt. |
| 17080 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17081 | sc_conn_cur(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17082 | sc0_conn_cur([<table>]) : integer |
| 17083 | sc1_conn_cur([<table>]) : integer |
| 17084 | sc2_conn_cur([<table>]) : integer |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17085 | Returns the current amount of concurrent connections tracking the same |
| 17086 | tracked counters. This number is automatically incremented when tracking |
| 17087 | begins and decremented when tracking stops. See also src_conn_cur. |
| 17088 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17089 | sc_conn_rate(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17090 | sc0_conn_rate([<table>]) : integer |
| 17091 | sc1_conn_rate([<table>]) : integer |
| 17092 | sc2_conn_rate([<table>]) : integer |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17093 | Returns the average connection rate from the currently tracked counters, |
| 17094 | measured in amount of connections over the period configured in the table. |
| 17095 | See also src_conn_rate. |
| 17096 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17097 | sc_get_gpc0(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17098 | sc0_get_gpc0([<table>]) : integer |
| 17099 | sc1_get_gpc0([<table>]) : integer |
| 17100 | sc2_get_gpc0([<table>]) : integer |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17101 | Returns the value of the first General Purpose Counter associated to the |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17102 | currently tracked counters. See also src_get_gpc0 and sc/sc0/sc1/sc2_inc_gpc0. |
Willy Tarreau | ba2ffd1 | 2013-05-29 15:54:14 +0200 | [diff] [blame] | 17103 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 17104 | sc_get_gpc1(<ctr>[,<table>]) : integer |
| 17105 | sc0_get_gpc1([<table>]) : integer |
| 17106 | sc1_get_gpc1([<table>]) : integer |
| 17107 | sc2_get_gpc1([<table>]) : integer |
| 17108 | Returns the value of the second General Purpose Counter associated to the |
| 17109 | currently tracked counters. See also src_get_gpc1 and sc/sc0/sc1/sc2_inc_gpc1. |
| 17110 | |
Thierry FOURNIER | 236657b | 2015-08-19 08:25:14 +0200 | [diff] [blame] | 17111 | sc_get_gpt0(<ctr>[,<table>]) : integer |
| 17112 | sc0_get_gpt0([<table>]) : integer |
| 17113 | sc1_get_gpt0([<table>]) : integer |
| 17114 | sc2_get_gpt0([<table>]) : integer |
| 17115 | Returns the value of the first General Purpose Tag associated to the |
| 17116 | currently tracked counters. See also src_get_gpt0. |
| 17117 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17118 | sc_gpc0_rate(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17119 | sc0_gpc0_rate([<table>]) : integer |
| 17120 | sc1_gpc0_rate([<table>]) : integer |
| 17121 | sc2_gpc0_rate([<table>]) : integer |
Willy Tarreau | ba2ffd1 | 2013-05-29 15:54:14 +0200 | [diff] [blame] | 17122 | Returns the average increment rate of the first General Purpose Counter |
| 17123 | associated to the currently tracked counters. It reports the frequency |
| 17124 | which the gpc0 counter was incremented over the configured period. See also |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17125 | src_gpc0_rate, sc/sc0/sc1/sc2_get_gpc0, and sc/sc0/sc1/sc2_inc_gpc0. Note |
| 17126 | that the "gpc0_rate" counter must be stored in the stick-table for a value to |
| 17127 | be returned, as "gpc0" only holds the event count. |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17128 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 17129 | sc_gpc1_rate(<ctr>[,<table>]) : integer |
| 17130 | sc0_gpc1_rate([<table>]) : integer |
| 17131 | sc1_gpc1_rate([<table>]) : integer |
| 17132 | sc2_gpc1_rate([<table>]) : integer |
| 17133 | Returns the average increment rate of the second General Purpose Counter |
| 17134 | associated to the currently tracked counters. It reports the frequency |
| 17135 | which the gpc1 counter was incremented over the configured period. See also |
| 17136 | src_gpcA_rate, sc/sc0/sc1/sc2_get_gpc1, and sc/sc0/sc1/sc2_inc_gpc1. Note |
| 17137 | that the "gpc1_rate" counter must be stored in the stick-table for a value to |
| 17138 | be returned, as "gpc1" only holds the event count. |
| 17139 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17140 | sc_http_err_cnt(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17141 | sc0_http_err_cnt([<table>]) : integer |
| 17142 | sc1_http_err_cnt([<table>]) : integer |
| 17143 | sc2_http_err_cnt([<table>]) : integer |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17144 | Returns the cumulative number of HTTP errors from the currently tracked |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17145 | counters. This includes the both request errors and 4xx error responses. |
| 17146 | See also src_http_err_cnt. |
| 17147 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17148 | sc_http_err_rate(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17149 | sc0_http_err_rate([<table>]) : integer |
| 17150 | sc1_http_err_rate([<table>]) : integer |
| 17151 | sc2_http_err_rate([<table>]) : integer |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17152 | Returns the average rate of HTTP errors from the currently tracked counters, |
| 17153 | measured in amount of errors over the period configured in the table. This |
| 17154 | includes the both request errors and 4xx error responses. See also |
| 17155 | src_http_err_rate. |
| 17156 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17157 | sc_http_req_cnt(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17158 | sc0_http_req_cnt([<table>]) : integer |
| 17159 | sc1_http_req_cnt([<table>]) : integer |
| 17160 | sc2_http_req_cnt([<table>]) : integer |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17161 | Returns the cumulative number of HTTP requests from the currently tracked |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17162 | counters. This includes every started request, valid or not. See also |
| 17163 | src_http_req_cnt. |
| 17164 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17165 | sc_http_req_rate(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17166 | sc0_http_req_rate([<table>]) : integer |
| 17167 | sc1_http_req_rate([<table>]) : integer |
| 17168 | sc2_http_req_rate([<table>]) : integer |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17169 | Returns the average rate of HTTP requests from the currently tracked |
| 17170 | counters, measured in amount of requests over the period configured in |
| 17171 | the table. This includes every started request, valid or not. See also |
| 17172 | src_http_req_rate. |
| 17173 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17174 | sc_inc_gpc0(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17175 | sc0_inc_gpc0([<table>]) : integer |
| 17176 | sc1_inc_gpc0([<table>]) : integer |
| 17177 | sc2_inc_gpc0([<table>]) : integer |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17178 | Increments the first General Purpose Counter associated to the currently |
Willy Tarreau | 869948b | 2013-01-04 14:14:57 +0100 | [diff] [blame] | 17179 | tracked counters, and returns its new value. Before the first invocation, |
| 17180 | the stored value is zero, so first invocation will increase it to 1 and will |
| 17181 | return 1. This is typically used as a second ACL in an expression in order |
| 17182 | to mark a connection when a first ACL was verified : |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17183 | |
Jarno Huuskonen | 676f622 | 2017-03-30 09:19:45 +0300 | [diff] [blame] | 17184 | Example: |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 17185 | acl abuse sc0_http_req_rate gt 10 |
| 17186 | acl kill sc0_inc_gpc0 gt 0 |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17187 | tcp-request connection reject if abuse kill |
| 17188 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 17189 | sc_inc_gpc1(<ctr>[,<table>]) : integer |
| 17190 | sc0_inc_gpc1([<table>]) : integer |
| 17191 | sc1_inc_gpc1([<table>]) : integer |
| 17192 | sc2_inc_gpc1([<table>]) : integer |
| 17193 | Increments the second General Purpose Counter associated to the currently |
| 17194 | tracked counters, and returns its new value. Before the first invocation, |
| 17195 | the stored value is zero, so first invocation will increase it to 1 and will |
| 17196 | return 1. This is typically used as a second ACL in an expression in order |
| 17197 | to mark a connection when a first ACL was verified. |
| 17198 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17199 | sc_kbytes_in(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17200 | sc0_kbytes_in([<table>]) : integer |
| 17201 | sc1_kbytes_in([<table>]) : integer |
| 17202 | sc2_kbytes_in([<table>]) : integer |
Willy Tarreau | a01b974 | 2014-07-10 15:29:24 +0200 | [diff] [blame] | 17203 | Returns the total amount of client-to-server data from the currently tracked |
| 17204 | counters, measured in kilobytes. The test is currently performed on 32-bit |
| 17205 | integers, which limits values to 4 terabytes. See also src_kbytes_in. |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17206 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17207 | sc_kbytes_out(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17208 | sc0_kbytes_out([<table>]) : integer |
| 17209 | sc1_kbytes_out([<table>]) : integer |
| 17210 | sc2_kbytes_out([<table>]) : integer |
Willy Tarreau | a01b974 | 2014-07-10 15:29:24 +0200 | [diff] [blame] | 17211 | Returns the total amount of server-to-client data from the currently tracked |
| 17212 | counters, measured in kilobytes. The test is currently performed on 32-bit |
| 17213 | integers, which limits values to 4 terabytes. See also src_kbytes_out. |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17214 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17215 | sc_sess_cnt(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17216 | sc0_sess_cnt([<table>]) : integer |
| 17217 | sc1_sess_cnt([<table>]) : integer |
| 17218 | sc2_sess_cnt([<table>]) : integer |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17219 | Returns the cumulative number of incoming connections that were transformed |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17220 | into sessions, which means that they were accepted by a "tcp-request |
| 17221 | connection" rule, from the currently tracked counters. A backend may count |
| 17222 | more sessions than connections because each connection could result in many |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 17223 | backend sessions if some HTTP keep-alive is performed over the connection |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17224 | with the client. See also src_sess_cnt. |
| 17225 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17226 | sc_sess_rate(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17227 | sc0_sess_rate([<table>]) : integer |
| 17228 | sc1_sess_rate([<table>]) : integer |
| 17229 | sc2_sess_rate([<table>]) : integer |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17230 | Returns the average session rate from the currently tracked counters, |
| 17231 | measured in amount of sessions over the period configured in the table. A |
| 17232 | session is a connection that got past the early "tcp-request connection" |
| 17233 | rules. A backend may count more sessions than connections because each |
| 17234 | connection could result in many backend sessions if some HTTP keep-alive is |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 17235 | performed over the connection with the client. See also src_sess_rate. |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17236 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17237 | sc_tracked(<ctr>[,<table>]) : boolean |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17238 | sc0_tracked([<table>]) : boolean |
| 17239 | sc1_tracked([<table>]) : boolean |
| 17240 | sc2_tracked([<table>]) : boolean |
Willy Tarreau | 6f1615f | 2013-06-03 15:15:22 +0200 | [diff] [blame] | 17241 | Returns true if the designated session counter is currently being tracked by |
| 17242 | the current session. This can be useful when deciding whether or not we want |
| 17243 | to set some values in a header passed to the server. |
| 17244 | |
Cyril Bonté | 62ba870 | 2014-04-22 23:52:25 +0200 | [diff] [blame] | 17245 | sc_trackers(<ctr>[,<table>]) : integer |
Willy Tarreau | 0f791d4 | 2013-07-23 19:56:43 +0200 | [diff] [blame] | 17246 | sc0_trackers([<table>]) : integer |
| 17247 | sc1_trackers([<table>]) : integer |
| 17248 | sc2_trackers([<table>]) : integer |
Willy Tarreau | 2406db4 | 2012-12-09 12:16:43 +0100 | [diff] [blame] | 17249 | Returns the current amount of concurrent connections tracking the same |
| 17250 | tracked counters. This number is automatically incremented when tracking |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 17251 | begins and decremented when tracking stops. It differs from sc0_conn_cur in |
Willy Tarreau | 2406db4 | 2012-12-09 12:16:43 +0100 | [diff] [blame] | 17252 | that it does not rely on any stored information but on the table's reference |
| 17253 | count (the "use" value which is returned by "show table" on the CLI). This |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17254 | may sometimes be more suited for layer7 tracking. It can be used to tell a |
| 17255 | server how many concurrent connections there are from a given address for |
| 17256 | example. |
Willy Tarreau | 2406db4 | 2012-12-09 12:16:43 +0100 | [diff] [blame] | 17257 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17258 | so_id : integer |
| 17259 | Returns an integer containing the current listening socket's id. It is useful |
| 17260 | in frontends involving many "bind" lines, or to stick all users coming via a |
| 17261 | same socket to the same server. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 17262 | |
Jerome Magnin | eb421b2 | 2020-03-27 22:08:40 +0100 | [diff] [blame] | 17263 | so_name : string |
| 17264 | Returns a string containing the current listening socket's name, as defined |
| 17265 | with name on a "bind" line. It can serve the same purposes as so_id but with |
| 17266 | strings instead of integers. |
| 17267 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17268 | src : ip |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17269 | This is the source IPv4 address of the client of the session. It is of type |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17270 | IP and works on both IPv4 and IPv6 tables. On IPv6 tables, IPv4 addresses are |
| 17271 | mapped to their IPv6 equivalent, according to RFC 4291. Note that it is the |
| 17272 | TCP-level source address which is used, and not the address of a client |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 17273 | behind a proxy. However if the "accept-proxy" or "accept-netscaler-cip" bind |
| 17274 | directive is used, it can be the address of a client behind another |
| 17275 | PROXY-protocol compatible component for all rule sets except |
Willy Tarreau | 64ded3d | 2019-01-23 10:02:15 +0100 | [diff] [blame] | 17276 | "tcp-request connection" which sees the real address. When the incoming |
| 17277 | connection passed through address translation or redirection involving |
| 17278 | connection tracking, the original destination address before the redirection |
| 17279 | will be reported. On Linux systems, the source and destination may seldom |
| 17280 | appear reversed if the nf_conntrack_tcp_loose sysctl is set, because a late |
| 17281 | response may reopen a timed out connection and switch what is believed to be |
| 17282 | the source and the destination. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 17283 | |
Thierry FOURNIER | d5f624d | 2013-11-26 11:52:33 +0100 | [diff] [blame] | 17284 | Example: |
| 17285 | # add an HTTP header in requests with the originating address' country |
| 17286 | http-request set-header X-Country %[src,map_ip(geoip.lst)] |
| 17287 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17288 | src_bytes_in_rate([<table>]) : integer |
| 17289 | Returns the average bytes rate from the incoming connection's source address |
| 17290 | in the current proxy's stick-table or in the designated stick-table, measured |
| 17291 | in amount of bytes over the period configured in the table. If the address is |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17292 | not found, zero is returned. See also sc/sc0/sc1/sc2_bytes_in_rate. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17293 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17294 | src_bytes_out_rate([<table>]) : integer |
| 17295 | Returns the average bytes rate to the incoming connection's source address in |
| 17296 | the current proxy's stick-table or in the designated stick-table, measured in |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17297 | amount of bytes over the period configured in the table. If the address is |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17298 | not found, zero is returned. See also sc/sc0/sc1/sc2_bytes_out_rate. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17299 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17300 | src_clr_gpc0([<table>]) : integer |
| 17301 | Clears the first General Purpose Counter associated to the incoming |
| 17302 | connection's source address in the current proxy's stick-table or in the |
| 17303 | designated stick-table, and returns its previous value. If the address is not |
| 17304 | found, an entry is created and 0 is returned. This is typically used as a |
| 17305 | second ACL in an expression in order to mark a connection when a first ACL |
| 17306 | was verified : |
Willy Tarreau | f73cd11 | 2011-08-13 01:45:16 +0200 | [diff] [blame] | 17307 | |
Jarno Huuskonen | 676f622 | 2017-03-30 09:19:45 +0300 | [diff] [blame] | 17308 | Example: |
Willy Tarreau | f73cd11 | 2011-08-13 01:45:16 +0200 | [diff] [blame] | 17309 | # block if 5 consecutive requests continue to come faster than 10 sess |
| 17310 | # per second, and reset the counter as soon as the traffic slows down. |
| 17311 | acl abuse src_http_req_rate gt 10 |
| 17312 | acl kill src_inc_gpc0 gt 5 |
Willy Tarreau | 869948b | 2013-01-04 14:14:57 +0100 | [diff] [blame] | 17313 | acl save src_clr_gpc0 ge 0 |
Willy Tarreau | f73cd11 | 2011-08-13 01:45:16 +0200 | [diff] [blame] | 17314 | tcp-request connection accept if !abuse save |
| 17315 | tcp-request connection reject if abuse kill |
| 17316 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 17317 | src_clr_gpc1([<table>]) : integer |
| 17318 | Clears the second General Purpose Counter associated to the incoming |
| 17319 | connection's source address in the current proxy's stick-table or in the |
| 17320 | designated stick-table, and returns its previous value. If the address is not |
| 17321 | found, an entry is created and 0 is returned. This is typically used as a |
| 17322 | second ACL in an expression in order to mark a connection when a first ACL |
| 17323 | was verified. |
| 17324 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17325 | src_conn_cnt([<table>]) : integer |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17326 | Returns the cumulative number of connections initiated from the current |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17327 | incoming connection's source address in the current proxy's stick-table or in |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17328 | the designated stick-table. If the address is not found, zero is returned. |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17329 | See also sc/sc0/sc1/sc2_conn_cnt. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17330 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17331 | src_conn_cur([<table>]) : integer |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17332 | Returns the current amount of concurrent connections initiated from the |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17333 | current incoming connection's source address in the current proxy's |
| 17334 | stick-table or in the designated stick-table. If the address is not found, |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17335 | zero is returned. See also sc/sc0/sc1/sc2_conn_cur. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17336 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17337 | src_conn_rate([<table>]) : integer |
| 17338 | Returns the average connection rate from the incoming connection's source |
| 17339 | address in the current proxy's stick-table or in the designated stick-table, |
| 17340 | measured in amount of connections over the period configured in the table. If |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17341 | the address is not found, zero is returned. See also sc/sc0/sc1/sc2_conn_rate. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17342 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17343 | src_get_gpc0([<table>]) : integer |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17344 | Returns the value of the first General Purpose Counter associated to the |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17345 | incoming connection's source address in the current proxy's stick-table or in |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17346 | the designated stick-table. If the address is not found, zero is returned. |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17347 | See also sc/sc0/sc1/sc2_get_gpc0 and src_inc_gpc0. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17348 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 17349 | src_get_gpc1([<table>]) : integer |
| 17350 | Returns the value of the second General Purpose Counter associated to the |
| 17351 | incoming connection's source address in the current proxy's stick-table or in |
| 17352 | the designated stick-table. If the address is not found, zero is returned. |
| 17353 | See also sc/sc0/sc1/sc2_get_gpc1 and src_inc_gpc1. |
| 17354 | |
Thierry FOURNIER | 236657b | 2015-08-19 08:25:14 +0200 | [diff] [blame] | 17355 | src_get_gpt0([<table>]) : integer |
| 17356 | Returns the value of the first General Purpose Tag associated to the |
| 17357 | incoming connection's source address in the current proxy's stick-table or in |
| 17358 | the designated stick-table. If the address is not found, zero is returned. |
| 17359 | See also sc/sc0/sc1/sc2_get_gpt0. |
| 17360 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17361 | src_gpc0_rate([<table>]) : integer |
Willy Tarreau | ba2ffd1 | 2013-05-29 15:54:14 +0200 | [diff] [blame] | 17362 | Returns the average increment rate of the first General Purpose Counter |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17363 | associated to the incoming connection's source address in the current proxy's |
Willy Tarreau | ba2ffd1 | 2013-05-29 15:54:14 +0200 | [diff] [blame] | 17364 | stick-table or in the designated stick-table. It reports the frequency |
| 17365 | which the gpc0 counter was incremented over the configured period. See also |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17366 | sc/sc0/sc1/sc2_gpc0_rate, src_get_gpc0, and sc/sc0/sc1/sc2_inc_gpc0. Note |
| 17367 | that the "gpc0_rate" counter must be stored in the stick-table for a value to |
| 17368 | be returned, as "gpc0" only holds the event count. |
Willy Tarreau | ba2ffd1 | 2013-05-29 15:54:14 +0200 | [diff] [blame] | 17369 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 17370 | src_gpc1_rate([<table>]) : integer |
| 17371 | Returns the average increment rate of the second General Purpose Counter |
| 17372 | associated to the incoming connection's source address in the current proxy's |
| 17373 | stick-table or in the designated stick-table. It reports the frequency |
| 17374 | which the gpc1 counter was incremented over the configured period. See also |
| 17375 | sc/sc0/sc1/sc2_gpc1_rate, src_get_gpc1, and sc/sc0/sc1/sc2_inc_gpc1. Note |
| 17376 | that the "gpc1_rate" counter must be stored in the stick-table for a value to |
| 17377 | be returned, as "gpc1" only holds the event count. |
| 17378 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17379 | src_http_err_cnt([<table>]) : integer |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17380 | Returns the cumulative number of HTTP errors from the incoming connection's |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17381 | source address in the current proxy's stick-table or in the designated |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17382 | stick-table. This includes the both request errors and 4xx error responses. |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17383 | See also sc/sc0/sc1/sc2_http_err_cnt. If the address is not found, zero is |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17384 | returned. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17385 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17386 | src_http_err_rate([<table>]) : integer |
| 17387 | Returns the average rate of HTTP errors from the incoming connection's source |
| 17388 | address in the current proxy's stick-table or in the designated stick-table, |
| 17389 | measured in amount of errors over the period configured in the table. This |
| 17390 | includes the both request errors and 4xx error responses. If the address is |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17391 | not found, zero is returned. See also sc/sc0/sc1/sc2_http_err_rate. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17392 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17393 | src_http_req_cnt([<table>]) : integer |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17394 | Returns the cumulative number of HTTP requests from the incoming connection's |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17395 | source address in the current proxy's stick-table or in the designated stick- |
| 17396 | table. This includes every started request, valid or not. If the address is |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17397 | not found, zero is returned. See also sc/sc0/sc1/sc2_http_req_cnt. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17398 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17399 | src_http_req_rate([<table>]) : integer |
| 17400 | Returns the average rate of HTTP requests from the incoming connection's |
| 17401 | source address in the current proxy's stick-table or in the designated stick- |
| 17402 | table, measured in amount of requests over the period configured in the |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17403 | table. This includes every started request, valid or not. If the address is |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17404 | not found, zero is returned. See also sc/sc0/sc1/sc2_http_req_rate. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17405 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17406 | src_inc_gpc0([<table>]) : integer |
| 17407 | Increments the first General Purpose Counter associated to the incoming |
| 17408 | connection's source address in the current proxy's stick-table or in the |
| 17409 | designated stick-table, and returns its new value. If the address is not |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 17410 | found, an entry is created and 1 is returned. See also sc0/sc2/sc2_inc_gpc0. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17411 | This is typically used as a second ACL in an expression in order to mark a |
| 17412 | connection when a first ACL was verified : |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17413 | |
Jarno Huuskonen | 676f622 | 2017-03-30 09:19:45 +0300 | [diff] [blame] | 17414 | Example: |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17415 | acl abuse src_http_req_rate gt 10 |
Willy Tarreau | 869948b | 2013-01-04 14:14:57 +0100 | [diff] [blame] | 17416 | acl kill src_inc_gpc0 gt 0 |
Willy Tarreau | e965652 | 2010-08-17 15:40:09 +0200 | [diff] [blame] | 17417 | tcp-request connection reject if abuse kill |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17418 | |
Frédéric Lécaille | 6778b27 | 2018-01-29 15:22:53 +0100 | [diff] [blame] | 17419 | src_inc_gpc1([<table>]) : integer |
| 17420 | Increments the second General Purpose Counter associated to the incoming |
| 17421 | connection's source address in the current proxy's stick-table or in the |
| 17422 | designated stick-table, and returns its new value. If the address is not |
| 17423 | found, an entry is created and 1 is returned. See also sc0/sc2/sc2_inc_gpc1. |
| 17424 | This is typically used as a second ACL in an expression in order to mark a |
| 17425 | connection when a first ACL was verified. |
| 17426 | |
Willy Tarreau | 16e0156 | 2016-08-09 16:46:18 +0200 | [diff] [blame] | 17427 | src_is_local : boolean |
| 17428 | Returns true if the source address of the incoming connection is local to the |
| 17429 | system, or false if the address doesn't exist on the system, meaning that it |
| 17430 | comes from a remote machine. Note that UNIX addresses are considered local. |
| 17431 | It can be useful to apply certain access restrictions based on where the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17432 | client comes from (e.g. require auth or https for remote machines). Please |
Willy Tarreau | 16e0156 | 2016-08-09 16:46:18 +0200 | [diff] [blame] | 17433 | note that the check involves a few system calls, so it's better to do it only |
| 17434 | once per connection. |
| 17435 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17436 | src_kbytes_in([<table>]) : integer |
Willy Tarreau | a01b974 | 2014-07-10 15:29:24 +0200 | [diff] [blame] | 17437 | Returns the total amount of data received from the incoming connection's |
| 17438 | source address in the current proxy's stick-table or in the designated |
| 17439 | stick-table, measured in kilobytes. If the address is not found, zero is |
| 17440 | returned. The test is currently performed on 32-bit integers, which limits |
| 17441 | values to 4 terabytes. See also sc/sc0/sc1/sc2_kbytes_in. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17442 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17443 | src_kbytes_out([<table>]) : integer |
Willy Tarreau | a01b974 | 2014-07-10 15:29:24 +0200 | [diff] [blame] | 17444 | Returns the total amount of data sent to the incoming connection's source |
| 17445 | address in the current proxy's stick-table or in the designated stick-table, |
| 17446 | measured in kilobytes. If the address is not found, zero is returned. The |
| 17447 | test is currently performed on 32-bit integers, which limits values to 4 |
| 17448 | terabytes. See also sc/sc0/sc1/sc2_kbytes_out. |
Willy Tarreau | a975b8f | 2010-06-05 19:13:27 +0200 | [diff] [blame] | 17449 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17450 | src_port : integer |
| 17451 | Returns an integer value corresponding to the TCP source port of the |
| 17452 | connection on the client side, which is the port the client connected from. |
| 17453 | Usage of this function is very limited as modern protocols do not care much |
| 17454 | about source ports nowadays. |
Willy Tarreau | 079ff0a | 2009-03-05 21:34:28 +0100 | [diff] [blame] | 17455 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17456 | src_sess_cnt([<table>]) : integer |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17457 | Returns the cumulative number of connections initiated from the incoming |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17458 | connection's source IPv4 address in the current proxy's stick-table or in the |
| 17459 | designated stick-table, that were transformed into sessions, which means that |
| 17460 | they were accepted by "tcp-request" rules. If the address is not found, zero |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17461 | is returned. See also sc/sc0/sc1/sc2_sess_cnt. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17462 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17463 | src_sess_rate([<table>]) : integer |
| 17464 | Returns the average session rate from the incoming connection's source |
| 17465 | address in the current proxy's stick-table or in the designated stick-table, |
| 17466 | measured in amount of sessions over the period configured in the table. A |
| 17467 | session is a connection that went past the early "tcp-request" rules. If the |
Willy Tarreau | 4d4149c | 2013-07-23 19:33:46 +0200 | [diff] [blame] | 17468 | address is not found, zero is returned. See also sc/sc0/sc1/sc2_sess_rate. |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17469 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17470 | src_updt_conn_cnt([<table>]) : integer |
| 17471 | Creates or updates the entry associated to the incoming connection's source |
| 17472 | address in the current proxy's stick-table or in the designated stick-table. |
| 17473 | This table must be configured to store the "conn_cnt" data type, otherwise |
| 17474 | the match will be ignored. The current count is incremented by one, and the |
| 17475 | expiration timer refreshed. The updated count is returned, so this match |
| 17476 | can't return zero. This was used to reject service abusers based on their |
| 17477 | source address. Note: it is recommended to use the more complete "track-sc*" |
| 17478 | actions in "tcp-request" rules instead. |
Willy Tarreau | a975b8f | 2010-06-05 19:13:27 +0200 | [diff] [blame] | 17479 | |
| 17480 | Example : |
| 17481 | # This frontend limits incoming SSH connections to 3 per 10 second for |
| 17482 | # each source address, and rejects excess connections until a 10 second |
| 17483 | # silence is observed. At most 20 addresses are tracked. |
| 17484 | listen ssh |
| 17485 | bind :22 |
| 17486 | mode tcp |
| 17487 | maxconn 100 |
Willy Tarreau | c9705a1 | 2010-07-27 20:05:50 +0200 | [diff] [blame] | 17488 | stick-table type ip size 20 expire 10s store conn_cnt |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17489 | tcp-request content reject if { src_updt_conn_cnt gt 3 } |
Willy Tarreau | a975b8f | 2010-06-05 19:13:27 +0200 | [diff] [blame] | 17490 | server local 127.0.0.1:22 |
| 17491 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17492 | srv_id : integer |
| 17493 | Returns an integer containing the server's id when processing the response. |
| 17494 | While it's almost only used with ACLs, it may be used for logging or |
Christopher Faulet | d1b4464 | 2020-04-30 09:51:15 +0200 | [diff] [blame] | 17495 | debugging. It can also be used in a tcp-check or an http-check ruleset. |
Hervé COMMOWICK | daa824e | 2011-08-05 12:09:44 +0200 | [diff] [blame] | 17496 | |
vkill | 1dfd165 | 2019-10-30 16:58:14 +0800 | [diff] [blame] | 17497 | srv_name : string |
| 17498 | Returns a string containing the server's name when processing the response. |
| 17499 | While it's almost only used with ACLs, it may be used for logging or |
Christopher Faulet | d1b4464 | 2020-04-30 09:51:15 +0200 | [diff] [blame] | 17500 | debugging. It can also be used in a tcp-check or an http-check ruleset. |
vkill | 1dfd165 | 2019-10-30 16:58:14 +0800 | [diff] [blame] | 17501 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 17502 | 7.3.4. Fetching samples at Layer 5 |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17503 | ---------------------------------- |
Willy Tarreau | 0b1cd94 | 2010-05-16 22:18:27 +0200 | [diff] [blame] | 17504 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17505 | The layer 5 usually describes just the session layer which in haproxy is |
| 17506 | closest to the session once all the connection handshakes are finished, but |
| 17507 | when no content is yet made available. The fetch methods described here are |
| 17508 | usable as low as the "tcp-request content" rule sets unless they require some |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 17509 | future information. Those generally include the results of SSL negotiations. |
Willy Tarreau | c735a07 | 2011-03-29 00:57:02 +0200 | [diff] [blame] | 17510 | |
Ben Shillito | f25e8e5 | 2016-12-02 14:25:37 +0000 | [diff] [blame] | 17511 | 51d.all(<prop>[,<prop>*]) : string |
| 17512 | Returns values for the properties requested as a string, where values are |
| 17513 | separated by the delimiter specified with "51degrees-property-separator". |
| 17514 | The device is identified using all the important HTTP headers from the |
| 17515 | request. The function can be passed up to five property names, and if a |
| 17516 | property name can't be found, the value "NoData" is returned. |
| 17517 | |
| 17518 | Example : |
| 17519 | # Here the header "X-51D-DeviceTypeMobileTablet" is added to the request |
| 17520 | # containing the three properties requested using all relevant headers from |
| 17521 | # the request. |
| 17522 | frontend http-in |
| 17523 | bind *:8081 |
| 17524 | default_backend servers |
| 17525 | http-request set-header X-51D-DeviceTypeMobileTablet \ |
| 17526 | %[51d.all(DeviceType,IsMobile,IsTablet)] |
| 17527 | |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17528 | ssl_bc : boolean |
| 17529 | Returns true when the back connection was made via an SSL/TLS transport |
| 17530 | layer and is locally deciphered. This means the outgoing connection was made |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17531 | other a server with the "ssl" option. It can be used in a tcp-check or an |
| 17532 | http-check ruleset. |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17533 | |
| 17534 | ssl_bc_alg_keysize : integer |
| 17535 | Returns the symmetric cipher key size supported in bits when the outgoing |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17536 | connection was made over an SSL/TLS transport layer. It can be used in a |
| 17537 | tcp-check or an http-check ruleset. |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17538 | |
Olivier Houchard | 6b77f49 | 2018-11-22 18:18:29 +0100 | [diff] [blame] | 17539 | ssl_bc_alpn : string |
| 17540 | This extracts the Application Layer Protocol Negotiation field from an |
| 17541 | outgoing connection made via a TLS transport layer. |
Michael Prokop | 4438c60 | 2019-05-24 10:25:45 +0200 | [diff] [blame] | 17542 | The result is a string containing the protocol name negotiated with the |
Olivier Houchard | 6b77f49 | 2018-11-22 18:18:29 +0100 | [diff] [blame] | 17543 | server. The SSL library must have been built with support for TLS |
| 17544 | extensions enabled (check haproxy -vv). Note that the TLS ALPN extension is |
| 17545 | not advertised unless the "alpn" keyword on the "server" line specifies a |
| 17546 | protocol list. Also, nothing forces the server to pick a protocol from this |
| 17547 | list, any other one may be requested. The TLS ALPN extension is meant to |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17548 | replace the TLS NPN extension. See also "ssl_bc_npn". It can be used in a |
| 17549 | tcp-check or an http-check ruleset. |
Olivier Houchard | 6b77f49 | 2018-11-22 18:18:29 +0100 | [diff] [blame] | 17550 | |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17551 | ssl_bc_cipher : string |
| 17552 | Returns the name of the used cipher when the outgoing connection was made |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17553 | over an SSL/TLS transport layer. It can be used in a tcp-check or an |
| 17554 | http-check ruleset. |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17555 | |
Patrick Hemmer | 6567466 | 2019-06-04 08:13:03 -0400 | [diff] [blame] | 17556 | ssl_bc_client_random : binary |
| 17557 | Returns the client random of the back connection when the incoming connection |
| 17558 | was made over an SSL/TLS transport layer. It is useful to to decrypt traffic |
| 17559 | sent using ephemeral ciphers. This requires OpenSSL >= 1.1.0, or BoringSSL. |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17560 | It can be used in a tcp-check or an http-check ruleset. |
Patrick Hemmer | 6567466 | 2019-06-04 08:13:03 -0400 | [diff] [blame] | 17561 | |
Emeric Brun | 74f7ffa | 2018-02-19 16:14:12 +0100 | [diff] [blame] | 17562 | ssl_bc_is_resumed : boolean |
| 17563 | Returns true when the back connection was made over an SSL/TLS transport |
| 17564 | layer and the newly created SSL session was resumed using a cached |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17565 | session or a TLS ticket. It can be used in a tcp-check or an http-check |
| 17566 | ruleset. |
Emeric Brun | 74f7ffa | 2018-02-19 16:14:12 +0100 | [diff] [blame] | 17567 | |
Olivier Houchard | 6b77f49 | 2018-11-22 18:18:29 +0100 | [diff] [blame] | 17568 | ssl_bc_npn : string |
| 17569 | This extracts the Next Protocol Negotiation field from an outgoing connection |
| 17570 | made via a TLS transport layer. The result is a string containing the |
Michael Prokop | 4438c60 | 2019-05-24 10:25:45 +0200 | [diff] [blame] | 17571 | protocol name negotiated with the server . The SSL library must have been |
Olivier Houchard | 6b77f49 | 2018-11-22 18:18:29 +0100 | [diff] [blame] | 17572 | built with support for TLS extensions enabled (check haproxy -vv). Note that |
| 17573 | the TLS NPN extension is not advertised unless the "npn" keyword on the |
| 17574 | "server" line specifies a protocol list. Also, nothing forces the server to |
| 17575 | pick a protocol from this list, any other one may be used. Please note that |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17576 | the TLS NPN extension was replaced with ALPN. It can be used in a tcp-check |
| 17577 | or an http-check ruleset. |
Olivier Houchard | 6b77f49 | 2018-11-22 18:18:29 +0100 | [diff] [blame] | 17578 | |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17579 | ssl_bc_protocol : string |
| 17580 | Returns the name of the used protocol when the outgoing connection was made |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17581 | over an SSL/TLS transport layer. It can be used in a tcp-check or an |
| 17582 | http-check ruleset. |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17583 | |
Emeric Brun | b73a9b0 | 2014-04-30 18:49:19 +0200 | [diff] [blame] | 17584 | ssl_bc_unique_id : binary |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17585 | When the outgoing connection was made over an SSL/TLS transport layer, |
Emeric Brun | b73a9b0 | 2014-04-30 18:49:19 +0200 | [diff] [blame] | 17586 | returns the TLS unique ID as defined in RFC5929 section 3. The unique id |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17587 | can be encoded to base64 using the converter: "ssl_bc_unique_id,base64". It |
| 17588 | can be used in a tcp-check or an http-check ruleset. |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17589 | |
Patrick Hemmer | 6567466 | 2019-06-04 08:13:03 -0400 | [diff] [blame] | 17590 | ssl_bc_server_random : binary |
| 17591 | Returns the server random of the back connection when the incoming connection |
| 17592 | was made over an SSL/TLS transport layer. It is useful to to decrypt traffic |
| 17593 | sent using ephemeral ciphers. This requires OpenSSL >= 1.1.0, or BoringSSL. |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17594 | It can be used in a tcp-check or an http-check ruleset. |
Patrick Hemmer | 6567466 | 2019-06-04 08:13:03 -0400 | [diff] [blame] | 17595 | |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17596 | ssl_bc_session_id : binary |
| 17597 | Returns the SSL ID of the back connection when the outgoing connection was |
| 17598 | made over an SSL/TLS transport layer. It is useful to log if we want to know |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17599 | if session was reused or not. It can be used in a tcp-check or an http-check |
| 17600 | ruleset. |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17601 | |
Patrick Hemmer | e027547 | 2018-04-28 19:15:51 -0400 | [diff] [blame] | 17602 | ssl_bc_session_key : binary |
| 17603 | Returns the SSL session master key of the back connection when the outgoing |
| 17604 | connection was made over an SSL/TLS transport layer. It is useful to decrypt |
| 17605 | traffic sent using ephemeral ciphers. This requires OpenSSL >= 1.1.0, or |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17606 | BoringSSL. It can be used in a tcp-check or an http-check ruleset. |
Patrick Hemmer | e027547 | 2018-04-28 19:15:51 -0400 | [diff] [blame] | 17607 | |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17608 | ssl_bc_use_keysize : integer |
| 17609 | Returns the symmetric cipher key size used in bits when the outgoing |
Christopher Faulet | d92ea7f | 2020-04-30 10:03:55 +0200 | [diff] [blame] | 17610 | connection was made over an SSL/TLS transport layer. It can be used in a |
| 17611 | tcp-check or an http-check ruleset. |
Emeric Brun | 645ae79 | 2014-04-30 14:21:06 +0200 | [diff] [blame] | 17612 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17613 | ssl_c_ca_err : integer |
| 17614 | When the incoming connection was made over an SSL/TLS transport layer, |
| 17615 | returns the ID of the first error detected during verification of the client |
| 17616 | certificate at depth > 0, or 0 if no error was encountered during this |
| 17617 | verification process. Please refer to your SSL library's documentation to |
| 17618 | find the exhaustive list of error codes. |
Willy Tarreau | c735a07 | 2011-03-29 00:57:02 +0200 | [diff] [blame] | 17619 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17620 | ssl_c_ca_err_depth : integer |
| 17621 | When the incoming connection was made over an SSL/TLS transport layer, |
| 17622 | returns the depth in the CA chain of the first error detected during the |
| 17623 | verification of the client certificate. If no error is encountered, 0 is |
| 17624 | returned. |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 17625 | |
Christopher Faulet | 70d10d1 | 2020-11-06 12:10:33 +0100 | [diff] [blame] | 17626 | ssl_c_chain_der : binary |
William Dauchy | a598b50 | 2020-08-06 18:11:38 +0200 | [diff] [blame] | 17627 | Returns the DER formatted chain certificate presented by the client when the |
| 17628 | incoming connection was made over an SSL/TLS transport layer. When used for |
| 17629 | an ACL, the value(s) to match against can be passed in hexadecimal form. One |
Ilya Shipitsin | 2272d8a | 2020-12-21 01:22:40 +0500 | [diff] [blame] | 17630 | can parse the result with any lib accepting ASN.1 DER data. It currently |
William Dauchy | a598b50 | 2020-08-06 18:11:38 +0200 | [diff] [blame] | 17631 | does not support resumed sessions. |
| 17632 | |
Christopher Faulet | 70d10d1 | 2020-11-06 12:10:33 +0100 | [diff] [blame] | 17633 | ssl_c_der : binary |
| 17634 | Returns the DER formatted certificate presented by the client when the |
| 17635 | incoming connection was made over an SSL/TLS transport layer. When used for |
| 17636 | an ACL, the value(s) to match against can be passed in hexadecimal form. |
| 17637 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17638 | ssl_c_err : integer |
| 17639 | When the incoming connection was made over an SSL/TLS transport layer, |
| 17640 | returns the ID of the first error detected during verification at depth 0, or |
| 17641 | 0 if no error was encountered during this verification process. Please refer |
| 17642 | to your SSL library's documentation to find the exhaustive list of error |
| 17643 | codes. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 17644 | |
Elliot Otchet | 71f8297 | 2020-01-15 08:12:14 -0500 | [diff] [blame] | 17645 | ssl_c_i_dn([<entry>[,<occ>[,<format>]]]) : string |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17646 | When the incoming connection was made over an SSL/TLS transport layer, |
| 17647 | returns the full distinguished name of the issuer of the certificate |
| 17648 | presented by the client when no <entry> is specified, or the value of the |
| 17649 | first given entry found from the beginning of the DN. If a positive/negative |
| 17650 | occurrence number is specified as the optional second argument, it returns |
| 17651 | the value of the nth given entry value from the beginning/end of the DN. |
| 17652 | For instance, "ssl_c_i_dn(OU,2)" the second organization unit, and |
| 17653 | "ssl_c_i_dn(CN)" retrieves the common name. |
Elliot Otchet | 71f8297 | 2020-01-15 08:12:14 -0500 | [diff] [blame] | 17654 | The <format> parameter allows you to receive the DN suitable for |
| 17655 | consumption by different protocols. Currently supported is rfc2253 for |
| 17656 | LDAP v3. |
| 17657 | If you'd like to modify the format only you can specify an empty string |
| 17658 | and zero for the first two parameters. Example: ssl_c_i_dn(,0,rfc2253) |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 17659 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17660 | ssl_c_key_alg : string |
| 17661 | Returns the name of the algorithm used to generate the key of the certificate |
| 17662 | presented by the client when the incoming connection was made over an SSL/TLS |
| 17663 | transport layer. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 17664 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17665 | ssl_c_notafter : string |
| 17666 | Returns the end date presented by the client as a formatted string |
| 17667 | YYMMDDhhmmss[Z] when the incoming connection was made over an SSL/TLS |
| 17668 | transport layer. |
Emeric Brun | bede3d0 | 2009-06-30 17:54:00 +0200 | [diff] [blame] | 17669 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17670 | ssl_c_notbefore : string |
| 17671 | Returns the start date presented by the client as a formatted string |
| 17672 | YYMMDDhhmmss[Z] when the incoming connection was made over an SSL/TLS |
| 17673 | transport layer. |
Willy Tarreau | b6672b5 | 2011-12-12 17:23:41 +0100 | [diff] [blame] | 17674 | |
Elliot Otchet | 71f8297 | 2020-01-15 08:12:14 -0500 | [diff] [blame] | 17675 | ssl_c_s_dn([<entry>[,<occ>[,<format>]]]) : string |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17676 | When the incoming connection was made over an SSL/TLS transport layer, |
| 17677 | returns the full distinguished name of the subject of the certificate |
| 17678 | presented by the client when no <entry> is specified, or the value of the |
| 17679 | first given entry found from the beginning of the DN. If a positive/negative |
| 17680 | occurrence number is specified as the optional second argument, it returns |
| 17681 | the value of the nth given entry value from the beginning/end of the DN. |
| 17682 | For instance, "ssl_c_s_dn(OU,2)" the second organization unit, and |
| 17683 | "ssl_c_s_dn(CN)" retrieves the common name. |
Elliot Otchet | 71f8297 | 2020-01-15 08:12:14 -0500 | [diff] [blame] | 17684 | The <format> parameter allows you to receive the DN suitable for |
| 17685 | consumption by different protocols. Currently supported is rfc2253 for |
| 17686 | LDAP v3. |
| 17687 | If you'd like to modify the format only you can specify an empty string |
| 17688 | and zero for the first two parameters. Example: ssl_c_s_dn(,0,rfc2253) |
Willy Tarreau | b6672b5 | 2011-12-12 17:23:41 +0100 | [diff] [blame] | 17689 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17690 | ssl_c_serial : binary |
| 17691 | Returns the serial of the certificate presented by the client when the |
| 17692 | incoming connection was made over an SSL/TLS transport layer. When used for |
| 17693 | an ACL, the value(s) to match against can be passed in hexadecimal form. |
Emeric Brun | 2525b6b | 2012-10-18 15:59:43 +0200 | [diff] [blame] | 17694 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17695 | ssl_c_sha1 : binary |
| 17696 | Returns the SHA-1 fingerprint of the certificate presented by the client when |
| 17697 | the incoming connection was made over an SSL/TLS transport layer. This can be |
| 17698 | used to stick a client to a server, or to pass this information to a server. |
Willy Tarreau | 2d0caa3 | 2014-07-02 19:01:22 +0200 | [diff] [blame] | 17699 | Note that the output is binary, so if you want to pass that signature to the |
| 17700 | server, you need to encode it in hex or base64, such as in the example below: |
| 17701 | |
Jarno Huuskonen | 676f622 | 2017-03-30 09:19:45 +0300 | [diff] [blame] | 17702 | Example: |
Willy Tarreau | 2d0caa3 | 2014-07-02 19:01:22 +0200 | [diff] [blame] | 17703 | http-request set-header X-SSL-Client-SHA1 %[ssl_c_sha1,hex] |
Emeric Brun | 2525b6b | 2012-10-18 15:59:43 +0200 | [diff] [blame] | 17704 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17705 | ssl_c_sig_alg : string |
| 17706 | Returns the name of the algorithm used to sign the certificate presented by |
| 17707 | the client when the incoming connection was made over an SSL/TLS transport |
| 17708 | layer. |
Emeric Brun | 8785589 | 2012-10-17 17:39:35 +0200 | [diff] [blame] | 17709 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17710 | ssl_c_used : boolean |
| 17711 | Returns true if current SSL session uses a client certificate even if current |
| 17712 | connection uses SSL session resumption. See also "ssl_fc_has_crt". |
Emeric Brun | 7f56e74 | 2012-10-19 18:15:40 +0200 | [diff] [blame] | 17713 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17714 | ssl_c_verify : integer |
| 17715 | Returns the verify result error ID when the incoming connection was made over |
| 17716 | an SSL/TLS transport layer, otherwise zero if no error is encountered. Please |
| 17717 | refer to your SSL library's documentation for an exhaustive list of error |
| 17718 | codes. |
Emeric Brun | ce5ad80 | 2012-10-22 14:11:22 +0200 | [diff] [blame] | 17719 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17720 | ssl_c_version : integer |
| 17721 | Returns the version of the certificate presented by the client when the |
| 17722 | incoming connection was made over an SSL/TLS transport layer. |
Emeric Brun | ce5ad80 | 2012-10-22 14:11:22 +0200 | [diff] [blame] | 17723 | |
Emeric Brun | 43e7958 | 2014-10-29 19:03:26 +0100 | [diff] [blame] | 17724 | ssl_f_der : binary |
| 17725 | Returns the DER formatted certificate presented by the frontend when the |
| 17726 | incoming connection was made over an SSL/TLS transport layer. When used for |
| 17727 | an ACL, the value(s) to match against can be passed in hexadecimal form. |
| 17728 | |
Elliot Otchet | 71f8297 | 2020-01-15 08:12:14 -0500 | [diff] [blame] | 17729 | ssl_f_i_dn([<entry>[,<occ>[,<format>]]]) : string |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17730 | When the incoming connection was made over an SSL/TLS transport layer, |
| 17731 | returns the full distinguished name of the issuer of the certificate |
| 17732 | presented by the frontend when no <entry> is specified, or the value of the |
| 17733 | first given entry found from the beginning of the DN. If a positive/negative |
Emeric Brun | 8785589 | 2012-10-17 17:39:35 +0200 | [diff] [blame] | 17734 | occurrence number is specified as the optional second argument, it returns |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17735 | the value of the nth given entry value from the beginning/end of the DN. |
| 17736 | For instance, "ssl_f_i_dn(OU,2)" the second organization unit, and |
| 17737 | "ssl_f_i_dn(CN)" retrieves the common name. |
Elliot Otchet | 71f8297 | 2020-01-15 08:12:14 -0500 | [diff] [blame] | 17738 | The <format> parameter allows you to receive the DN suitable for |
| 17739 | consumption by different protocols. Currently supported is rfc2253 for |
| 17740 | LDAP v3. |
| 17741 | If you'd like to modify the format only you can specify an empty string |
| 17742 | and zero for the first two parameters. Example: ssl_f_i_dn(,0,rfc2253) |
Emeric Brun | 8785589 | 2012-10-17 17:39:35 +0200 | [diff] [blame] | 17743 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17744 | ssl_f_key_alg : string |
| 17745 | Returns the name of the algorithm used to generate the key of the certificate |
| 17746 | presented by the frontend when the incoming connection was made over an |
| 17747 | SSL/TLS transport layer. |
Emeric Brun | 7f56e74 | 2012-10-19 18:15:40 +0200 | [diff] [blame] | 17748 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17749 | ssl_f_notafter : string |
| 17750 | Returns the end date presented by the frontend as a formatted string |
| 17751 | YYMMDDhhmmss[Z] when the incoming connection was made over an SSL/TLS |
| 17752 | transport layer. |
Emeric Brun | 2525b6b | 2012-10-18 15:59:43 +0200 | [diff] [blame] | 17753 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17754 | ssl_f_notbefore : string |
| 17755 | Returns the start date presented by the frontend as a formatted string |
| 17756 | YYMMDDhhmmss[Z] when the incoming connection was made over an SSL/TLS |
| 17757 | transport layer. |
Emeric Brun | 8785589 | 2012-10-17 17:39:35 +0200 | [diff] [blame] | 17758 | |
Elliot Otchet | 71f8297 | 2020-01-15 08:12:14 -0500 | [diff] [blame] | 17759 | ssl_f_s_dn([<entry>[,<occ>[,<format>]]]) : string |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17760 | When the incoming connection was made over an SSL/TLS transport layer, |
| 17761 | returns the full distinguished name of the subject of the certificate |
| 17762 | presented by the frontend when no <entry> is specified, or the value of the |
| 17763 | first given entry found from the beginning of the DN. If a positive/negative |
| 17764 | occurrence number is specified as the optional second argument, it returns |
| 17765 | the value of the nth given entry value from the beginning/end of the DN. |
| 17766 | For instance, "ssl_f_s_dn(OU,2)" the second organization unit, and |
| 17767 | "ssl_f_s_dn(CN)" retrieves the common name. |
Elliot Otchet | 71f8297 | 2020-01-15 08:12:14 -0500 | [diff] [blame] | 17768 | The <format> parameter allows you to receive the DN suitable for |
| 17769 | consumption by different protocols. Currently supported is rfc2253 for |
| 17770 | LDAP v3. |
| 17771 | If you'd like to modify the format only you can specify an empty string |
| 17772 | and zero for the first two parameters. Example: ssl_f_s_dn(,0,rfc2253) |
Emeric Brun | ce5ad80 | 2012-10-22 14:11:22 +0200 | [diff] [blame] | 17773 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17774 | ssl_f_serial : binary |
| 17775 | Returns the serial of the certificate presented by the frontend when the |
| 17776 | incoming connection was made over an SSL/TLS transport layer. When used for |
| 17777 | an ACL, the value(s) to match against can be passed in hexadecimal form. |
Emeric Brun | 8785589 | 2012-10-17 17:39:35 +0200 | [diff] [blame] | 17778 | |
Emeric Brun | 55f4fa8 | 2014-04-30 17:11:25 +0200 | [diff] [blame] | 17779 | ssl_f_sha1 : binary |
| 17780 | Returns the SHA-1 fingerprint of the certificate presented by the frontend |
| 17781 | when the incoming connection was made over an SSL/TLS transport layer. This |
| 17782 | can be used to know which certificate was chosen using SNI. |
| 17783 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17784 | ssl_f_sig_alg : string |
| 17785 | Returns the name of the algorithm used to sign the certificate presented by |
| 17786 | the frontend when the incoming connection was made over an SSL/TLS transport |
| 17787 | layer. |
Emeric Brun | 7f56e74 | 2012-10-19 18:15:40 +0200 | [diff] [blame] | 17788 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17789 | ssl_f_version : integer |
| 17790 | Returns the version of the certificate presented by the frontend when the |
| 17791 | incoming connection was made over an SSL/TLS transport layer. |
| 17792 | |
| 17793 | ssl_fc : boolean |
Emeric Brun | 2525b6b | 2012-10-18 15:59:43 +0200 | [diff] [blame] | 17794 | Returns true when the front connection was made via an SSL/TLS transport |
| 17795 | layer and is locally deciphered. This means it has matched a socket declared |
| 17796 | with a "bind" line having the "ssl" option. |
| 17797 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17798 | Example : |
| 17799 | # This passes "X-Proto: https" to servers when client connects over SSL |
| 17800 | listen http-https |
| 17801 | bind :80 |
| 17802 | bind :443 ssl crt /etc/haproxy.pem |
| 17803 | http-request add-header X-Proto https if { ssl_fc } |
| 17804 | |
| 17805 | ssl_fc_alg_keysize : integer |
| 17806 | Returns the symmetric cipher key size supported in bits when the incoming |
| 17807 | connection was made over an SSL/TLS transport layer. |
| 17808 | |
| 17809 | ssl_fc_alpn : string |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 17810 | This extracts the Application Layer Protocol Negotiation field from an |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17811 | incoming connection made via a TLS transport layer and locally deciphered by |
| 17812 | haproxy. The result is a string containing the protocol name advertised by |
| 17813 | the client. The SSL library must have been built with support for TLS |
| 17814 | extensions enabled (check haproxy -vv). Note that the TLS ALPN extension is |
| 17815 | not advertised unless the "alpn" keyword on the "bind" line specifies a |
| 17816 | protocol list. Also, nothing forces the client to pick a protocol from this |
| 17817 | list, any other one may be requested. The TLS ALPN extension is meant to |
| 17818 | replace the TLS NPN extension. See also "ssl_fc_npn". |
| 17819 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17820 | ssl_fc_cipher : string |
| 17821 | Returns the name of the used cipher when the incoming connection was made |
| 17822 | over an SSL/TLS transport layer. |
Willy Tarreau | ab861d3 | 2013-04-02 02:30:41 +0200 | [diff] [blame] | 17823 | |
Thierry FOURNIER | 5bf7732 | 2017-02-25 12:45:22 +0100 | [diff] [blame] | 17824 | ssl_fc_cipherlist_bin : binary |
| 17825 | Returns the binary form of the client hello cipher list. The maximum returned |
| 17826 | value length is according with the value of |
Emmanuel Hocdet | aaee750 | 2017-03-07 18:34:58 +0100 | [diff] [blame] | 17827 | "tune.ssl.capture-cipherlist-size". |
Thierry FOURNIER | 5bf7732 | 2017-02-25 12:45:22 +0100 | [diff] [blame] | 17828 | |
| 17829 | ssl_fc_cipherlist_hex : string |
| 17830 | Returns the binary form of the client hello cipher list encoded as |
| 17831 | hexadecimal. The maximum returned value length is according with the value of |
Emmanuel Hocdet | aaee750 | 2017-03-07 18:34:58 +0100 | [diff] [blame] | 17832 | "tune.ssl.capture-cipherlist-size". |
Thierry FOURNIER | 5bf7732 | 2017-02-25 12:45:22 +0100 | [diff] [blame] | 17833 | |
| 17834 | ssl_fc_cipherlist_str : string |
| 17835 | Returns the decoded text form of the client hello cipher list. The maximum |
| 17836 | number of ciphers returned is according with the value of |
| 17837 | "tune.ssl.capture-cipherlist-size". Note that this sample-fetch is only |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 17838 | available with OpenSSL >= 1.0.2. If the function is not enabled, this |
Emmanuel Hocdet | ddcde19 | 2017-09-01 17:32:08 +0200 | [diff] [blame] | 17839 | sample-fetch returns the hash like "ssl_fc_cipherlist_xxh". |
Thierry FOURNIER | 5bf7732 | 2017-02-25 12:45:22 +0100 | [diff] [blame] | 17840 | |
| 17841 | ssl_fc_cipherlist_xxh : integer |
| 17842 | Returns a xxh64 of the cipher list. This hash can be return only is the value |
| 17843 | "tune.ssl.capture-cipherlist-size" is set greater than 0, however the hash |
Emmanuel Hocdet | aaee750 | 2017-03-07 18:34:58 +0100 | [diff] [blame] | 17844 | take in account all the data of the cipher list. |
Thierry FOURNIER | 5bf7732 | 2017-02-25 12:45:22 +0100 | [diff] [blame] | 17845 | |
Patrick Hemmer | 6567466 | 2019-06-04 08:13:03 -0400 | [diff] [blame] | 17846 | ssl_fc_client_random : binary |
| 17847 | Returns the client random of the front connection when the incoming connection |
| 17848 | was made over an SSL/TLS transport layer. It is useful to to decrypt traffic |
| 17849 | sent using ephemeral ciphers. This requires OpenSSL >= 1.1.0, or BoringSSL. |
| 17850 | |
William Lallemand | 7d42ef5 | 2020-07-06 11:41:30 +0200 | [diff] [blame] | 17851 | ssl_fc_client_early_traffic_secret : string |
| 17852 | Return the CLIENT_EARLY_TRAFFIC_SECRET as an hexadecimal string for the |
| 17853 | front connection when the incoming connection was made over a TLS 1.3 |
| 17854 | transport layer. |
| 17855 | Require OpenSSL >= 1.1.1. This is one of the keys dumped by the OpenSSL |
| 17856 | keylog callback to generate the SSLKEYLOGFILE. The SSL Key logging must be |
| 17857 | activated with "tune.ssl.keylog on" in the global section. See also |
| 17858 | "tune.ssl.keylog" |
| 17859 | |
| 17860 | ssl_fc_client_handshake_traffic_secret : string |
| 17861 | Return the CLIENT_HANDSHAKE_TRAFFIC_SECRET as an hexadecimal string for the |
| 17862 | front connection when the incoming connection was made over a TLS 1.3 |
| 17863 | transport layer. |
| 17864 | Require OpenSSL >= 1.1.1. This is one of the keys dumped by the OpenSSL |
| 17865 | keylog callback to generate the SSLKEYLOGFILE. The SSL Key logging must be |
| 17866 | activated with "tune.ssl.keylog on" in the global section. See also |
| 17867 | "tune.ssl.keylog" |
| 17868 | |
| 17869 | ssl_fc_client_traffic_secret_0 : string |
| 17870 | Return the CLIENT_TRAFFIC_SECRET_0 as an hexadecimal string for the |
| 17871 | front connection when the incoming connection was made over a TLS 1.3 |
| 17872 | transport layer. |
| 17873 | Require OpenSSL >= 1.1.1. This is one of the keys dumped by the OpenSSL |
| 17874 | keylog callback to generate the SSLKEYLOGFILE. The SSL Key logging must be |
| 17875 | activated with "tune.ssl.keylog on" in the global section. See also |
| 17876 | "tune.ssl.keylog" |
| 17877 | |
| 17878 | ssl_fc_exporter_secret : string |
| 17879 | Return the EXPORTER_SECRET as an hexadecimal string for the |
| 17880 | front connection when the incoming connection was made over a TLS 1.3 |
| 17881 | transport layer. |
| 17882 | Require OpenSSL >= 1.1.1. This is one of the keys dumped by the OpenSSL |
| 17883 | keylog callback to generate the SSLKEYLOGFILE. The SSL Key logging must be |
| 17884 | activated with "tune.ssl.keylog on" in the global section. See also |
| 17885 | "tune.ssl.keylog" |
| 17886 | |
| 17887 | ssl_fc_early_exporter_secret : string |
| 17888 | Return the EARLY_EXPORTER_SECRET as an hexadecimal string for the |
| 17889 | front connection when the incoming connection was made over an TLS 1.3 |
| 17890 | transport layer. |
| 17891 | Require OpenSSL >= 1.1.1. This is one of the keys dumped by the OpenSSL |
| 17892 | keylog callback to generate the SSLKEYLOGFILE. The SSL Key logging must be |
| 17893 | activated with "tune.ssl.keylog on" in the global section. See also |
| 17894 | "tune.ssl.keylog" |
| 17895 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17896 | ssl_fc_has_crt : boolean |
Emeric Brun | 2525b6b | 2012-10-18 15:59:43 +0200 | [diff] [blame] | 17897 | Returns true if a client certificate is present in an incoming connection over |
| 17898 | SSL/TLS transport layer. Useful if 'verify' statement is set to 'optional'. |
Emeric Brun | 9143d37 | 2012-12-20 15:44:16 +0100 | [diff] [blame] | 17899 | Note: on SSL session resumption with Session ID or TLS ticket, client |
| 17900 | certificate is not present in the current connection but may be retrieved |
| 17901 | from the cache or the ticket. So prefer "ssl_c_used" if you want to check if |
| 17902 | current SSL session uses a client certificate. |
Emeric Brun | 2525b6b | 2012-10-18 15:59:43 +0200 | [diff] [blame] | 17903 | |
Olivier Houchard | ccaa7de | 2017-10-02 11:51:03 +0200 | [diff] [blame] | 17904 | ssl_fc_has_early : boolean |
| 17905 | Returns true if early data were sent, and the handshake didn't happen yet. As |
| 17906 | it has security implications, it is useful to be able to refuse those, or |
| 17907 | wait until the handshake happened. |
| 17908 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17909 | ssl_fc_has_sni : boolean |
| 17910 | This checks for the presence of a Server Name Indication TLS extension (SNI) |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 17911 | in an incoming connection was made over an SSL/TLS transport layer. Returns |
| 17912 | true when the incoming connection presents a TLS SNI field. This requires |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 17913 | that the SSL library is built with support for TLS extensions enabled (check |
Willy Tarreau | f7bc57c | 2012-10-03 00:19:48 +0200 | [diff] [blame] | 17914 | haproxy -vv). |
Willy Tarreau | 7875d09 | 2012-09-10 08:20:03 +0200 | [diff] [blame] | 17915 | |
Nenad Merdanovic | 1516fe3 | 2016-05-17 03:31:21 +0200 | [diff] [blame] | 17916 | ssl_fc_is_resumed : boolean |
Nenad Merdanovic | 26ea822 | 2015-05-18 02:28:57 +0200 | [diff] [blame] | 17917 | Returns true if the SSL/TLS session has been resumed through the use of |
Jérôme Magnin | 4a326cb | 2018-01-15 14:01:17 +0100 | [diff] [blame] | 17918 | SSL session cache or TLS tickets on an incoming connection over an SSL/TLS |
| 17919 | transport layer. |
Nenad Merdanovic | 26ea822 | 2015-05-18 02:28:57 +0200 | [diff] [blame] | 17920 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17921 | ssl_fc_npn : string |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 17922 | This extracts the Next Protocol Negotiation field from an incoming connection |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17923 | made via a TLS transport layer and locally deciphered by haproxy. The result |
| 17924 | is a string containing the protocol name advertised by the client. The SSL |
| 17925 | library must have been built with support for TLS extensions enabled (check |
| 17926 | haproxy -vv). Note that the TLS NPN extension is not advertised unless the |
| 17927 | "npn" keyword on the "bind" line specifies a protocol list. Also, nothing |
| 17928 | forces the client to pick a protocol from this list, any other one may be |
| 17929 | requested. Please note that the TLS NPN extension was replaced with ALPN. |
Willy Tarreau | a33c654 | 2012-10-15 13:19:06 +0200 | [diff] [blame] | 17930 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17931 | ssl_fc_protocol : string |
| 17932 | Returns the name of the used protocol when the incoming connection was made |
| 17933 | over an SSL/TLS transport layer. |
Willy Tarreau | 7875d09 | 2012-09-10 08:20:03 +0200 | [diff] [blame] | 17934 | |
Emeric Brun | b73a9b0 | 2014-04-30 18:49:19 +0200 | [diff] [blame] | 17935 | ssl_fc_unique_id : binary |
David S | c1ad52e | 2014-04-08 18:48:47 -0400 | [diff] [blame] | 17936 | When the incoming connection was made over an SSL/TLS transport layer, |
Emeric Brun | b73a9b0 | 2014-04-30 18:49:19 +0200 | [diff] [blame] | 17937 | returns the TLS unique ID as defined in RFC5929 section 3. The unique id |
| 17938 | can be encoded to base64 using the converter: "ssl_bc_unique_id,base64". |
David S | c1ad52e | 2014-04-08 18:48:47 -0400 | [diff] [blame] | 17939 | |
William Lallemand | 7d42ef5 | 2020-07-06 11:41:30 +0200 | [diff] [blame] | 17940 | ssl_fc_server_handshake_traffic_secret : string |
| 17941 | Return the SERVER_HANDSHAKE_TRAFFIC_SECRET as an hexadecimal string for the |
| 17942 | front connection when the incoming connection was made over a TLS 1.3 |
| 17943 | transport layer. |
| 17944 | Require OpenSSL >= 1.1.1. This is one of the keys dumped by the OpenSSL |
| 17945 | keylog callback to generate the SSLKEYLOGFILE. The SSL Key logging must be |
| 17946 | activated with "tune.ssl.keylog on" in the global section. See also |
| 17947 | "tune.ssl.keylog" |
| 17948 | |
| 17949 | ssl_fc_server_traffic_secret_0 : string |
| 17950 | Return the SERVER_TRAFFIC_SECRET_0 as an hexadecimal string for the |
| 17951 | front connection when the incoming connection was made over an TLS 1.3 |
| 17952 | transport layer. |
| 17953 | Require OpenSSL >= 1.1.1. This is one of the keys dumped by the OpenSSL |
| 17954 | keylog callback to generate the SSLKEYLOGFILE. The SSL Key logging must be |
| 17955 | activated with "tune.ssl.keylog on" in the global section. See also |
| 17956 | "tune.ssl.keylog" |
| 17957 | |
Patrick Hemmer | 6567466 | 2019-06-04 08:13:03 -0400 | [diff] [blame] | 17958 | ssl_fc_server_random : binary |
| 17959 | Returns the server random of the front connection when the incoming connection |
| 17960 | was made over an SSL/TLS transport layer. It is useful to to decrypt traffic |
| 17961 | sent using ephemeral ciphers. This requires OpenSSL >= 1.1.0, or BoringSSL. |
| 17962 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17963 | ssl_fc_session_id : binary |
| 17964 | Returns the SSL ID of the front connection when the incoming connection was |
| 17965 | made over an SSL/TLS transport layer. It is useful to stick a given client to |
| 17966 | a server. It is important to note that some browsers refresh their session ID |
| 17967 | every few minutes. |
Willy Tarreau | 7875d09 | 2012-09-10 08:20:03 +0200 | [diff] [blame] | 17968 | |
Patrick Hemmer | e027547 | 2018-04-28 19:15:51 -0400 | [diff] [blame] | 17969 | ssl_fc_session_key : binary |
| 17970 | Returns the SSL session master key of the front connection when the incoming |
| 17971 | connection was made over an SSL/TLS transport layer. It is useful to decrypt |
| 17972 | traffic sent using ephemeral ciphers. This requires OpenSSL >= 1.1.0, or |
| 17973 | BoringSSL. |
| 17974 | |
| 17975 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17976 | ssl_fc_sni : string |
| 17977 | This extracts the Server Name Indication TLS extension (SNI) field from an |
| 17978 | incoming connection made via an SSL/TLS transport layer and locally |
| 17979 | deciphered by haproxy. The result (when present) typically is a string |
| 17980 | matching the HTTPS host name (253 chars or less). The SSL library must have |
| 17981 | been built with support for TLS extensions enabled (check haproxy -vv). |
| 17982 | |
| 17983 | This fetch is different from "req_ssl_sni" above in that it applies to the |
| 17984 | connection being deciphered by haproxy and not to SSL contents being blindly |
| 17985 | forwarded. See also "ssl_fc_sni_end" and "ssl_fc_sni_reg" below. This |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 17986 | requires that the SSL library is built with support for TLS extensions |
Cyril Bonté | 9c1eb1e | 2012-10-09 22:45:34 +0200 | [diff] [blame] | 17987 | enabled (check haproxy -vv). |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 17988 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17989 | ACL derivatives : |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17990 | ssl_fc_sni_end : suffix match |
| 17991 | ssl_fc_sni_reg : regex match |
Emeric Brun | 589fcad | 2012-10-16 14:13:26 +0200 | [diff] [blame] | 17992 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 17993 | ssl_fc_use_keysize : integer |
| 17994 | Returns the symmetric cipher key size used in bits when the incoming |
| 17995 | connection was made over an SSL/TLS transport layer. |
Willy Tarreau | b6fb420 | 2008-07-20 11:18:28 +0200 | [diff] [blame] | 17996 | |
William Lallemand | bfa3e81 | 2020-06-25 20:07:18 +0200 | [diff] [blame] | 17997 | ssl_s_der : binary |
| 17998 | Returns the DER formatted certificate presented by the server when the |
| 17999 | outgoing connection was made over an SSL/TLS transport layer. When used for |
| 18000 | an ACL, the value(s) to match against can be passed in hexadecimal form. |
| 18001 | |
William Dauchy | a598b50 | 2020-08-06 18:11:38 +0200 | [diff] [blame] | 18002 | ssl_s_chain_der : binary |
| 18003 | Returns the DER formatted chain certificate presented by the server when the |
| 18004 | outgoing connection was made over an SSL/TLS transport layer. When used for |
| 18005 | an ACL, the value(s) to match against can be passed in hexadecimal form. One |
Ilya Shipitsin | 2272d8a | 2020-12-21 01:22:40 +0500 | [diff] [blame] | 18006 | can parse the result with any lib accepting ASN.1 DER data. It currently |
William Dauchy | a598b50 | 2020-08-06 18:11:38 +0200 | [diff] [blame] | 18007 | does not support resumed sessions. |
| 18008 | |
William Lallemand | bfa3e81 | 2020-06-25 20:07:18 +0200 | [diff] [blame] | 18009 | ssl_s_key_alg : string |
| 18010 | Returns the name of the algorithm used to generate the key of the certificate |
| 18011 | presented by the server when the outgoing connection was made over an |
| 18012 | SSL/TLS transport layer. |
| 18013 | |
| 18014 | ssl_s_notafter : string |
| 18015 | Returns the end date presented by the server as a formatted string |
| 18016 | YYMMDDhhmmss[Z] when the outgoing connection was made over an SSL/TLS |
| 18017 | transport layer. |
| 18018 | |
| 18019 | ssl_s_notbefore : string |
| 18020 | Returns the start date presented by the server as a formatted string |
| 18021 | YYMMDDhhmmss[Z] when the outgoing connection was made over an SSL/TLS |
| 18022 | transport layer. |
| 18023 | |
| 18024 | ssl_s_i_dn([<entry>[,<occ>[,<format>]]]) : string |
| 18025 | When the outgoing connection was made over an SSL/TLS transport layer, |
| 18026 | returns the full distinguished name of the issuer of the certificate |
| 18027 | presented by the server when no <entry> is specified, or the value of the |
| 18028 | first given entry found from the beginning of the DN. If a positive/negative |
| 18029 | occurrence number is specified as the optional second argument, it returns |
| 18030 | the value of the nth given entry value from the beginning/end of the DN. |
William Lallemand | 8f600c8 | 2020-06-26 09:55:06 +0200 | [diff] [blame] | 18031 | For instance, "ssl_s_i_dn(OU,2)" the second organization unit, and |
| 18032 | "ssl_s_i_dn(CN)" retrieves the common name. |
William Lallemand | bfa3e81 | 2020-06-25 20:07:18 +0200 | [diff] [blame] | 18033 | The <format> parameter allows you to receive the DN suitable for |
| 18034 | consumption by different protocols. Currently supported is rfc2253 for |
| 18035 | LDAP v3. |
| 18036 | If you'd like to modify the format only you can specify an empty string |
| 18037 | and zero for the first two parameters. Example: ssl_s_i_dn(,0,rfc2253) |
| 18038 | |
| 18039 | ssl_s_s_dn([<entry>[,<occ>[,<format>]]]) : string |
| 18040 | When the outgoing connection was made over an SSL/TLS transport layer, |
| 18041 | returns the full distinguished name of the subject of the certificate |
| 18042 | presented by the server when no <entry> is specified, or the value of the |
| 18043 | first given entry found from the beginning of the DN. If a positive/negative |
| 18044 | occurrence number is specified as the optional second argument, it returns |
| 18045 | the value of the nth given entry value from the beginning/end of the DN. |
William Lallemand | 8f600c8 | 2020-06-26 09:55:06 +0200 | [diff] [blame] | 18046 | For instance, "ssl_s_s_dn(OU,2)" the second organization unit, and |
| 18047 | "ssl_s_s_dn(CN)" retrieves the common name. |
William Lallemand | bfa3e81 | 2020-06-25 20:07:18 +0200 | [diff] [blame] | 18048 | The <format> parameter allows you to receive the DN suitable for |
| 18049 | consumption by different protocols. Currently supported is rfc2253 for |
| 18050 | LDAP v3. |
| 18051 | If you'd like to modify the format only you can specify an empty string |
| 18052 | and zero for the first two parameters. Example: ssl_s_s_dn(,0,rfc2253) |
| 18053 | |
| 18054 | ssl_s_serial : binary |
| 18055 | Returns the serial of the certificate presented by the server when the |
| 18056 | outgoing connection was made over an SSL/TLS transport layer. When used for |
| 18057 | an ACL, the value(s) to match against can be passed in hexadecimal form. |
| 18058 | |
| 18059 | ssl_s_sha1 : binary |
| 18060 | Returns the SHA-1 fingerprint of the certificate presented by the server |
| 18061 | when the outgoing connection was made over an SSL/TLS transport layer. This |
| 18062 | can be used to know which certificate was chosen using SNI. |
| 18063 | |
| 18064 | ssl_s_sig_alg : string |
| 18065 | Returns the name of the algorithm used to sign the certificate presented by |
| 18066 | the server when the outgoing connection was made over an SSL/TLS transport |
| 18067 | layer. |
| 18068 | |
| 18069 | ssl_s_version : integer |
| 18070 | Returns the version of the certificate presented by the server when the |
| 18071 | outgoing connection was made over an SSL/TLS transport layer. |
Willy Tarreau | b6fb420 | 2008-07-20 11:18:28 +0200 | [diff] [blame] | 18072 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 18073 | 7.3.5. Fetching samples from buffer contents (Layer 6) |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18074 | ------------------------------------------------------ |
Willy Tarreau | b6fb420 | 2008-07-20 11:18:28 +0200 | [diff] [blame] | 18075 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18076 | Fetching samples from buffer contents is a bit different from the previous |
| 18077 | sample fetches above because the sampled data are ephemeral. These data can |
| 18078 | only be used when they're available and will be lost when they're forwarded. |
| 18079 | For this reason, samples fetched from buffer contents during a request cannot |
| 18080 | be used in a response for example. Even while the data are being fetched, they |
| 18081 | can change. Sometimes it is necessary to set some delays or combine multiple |
| 18082 | sample fetch methods to ensure that the expected data are complete and usable, |
| 18083 | for example through TCP request content inspection. Please see the "tcp-request |
| 18084 | content" keyword for more detailed information on the subject. |
Willy Tarreau | 6264477 | 2008-07-16 18:36:06 +0200 | [diff] [blame] | 18085 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18086 | payload(<offset>,<length>) : binary (deprecated) |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 18087 | This is an alias for "req.payload" when used in the context of a request (e.g. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18088 | "stick on", "stick match"), and for "res.payload" when used in the context of |
| 18089 | a response such as in "stick store response". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 18090 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18091 | payload_lv(<offset1>,<length>[,<offset2>]) : binary (deprecated) |
| 18092 | This is an alias for "req.payload_lv" when used in the context of a request |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 18093 | (e.g. "stick on", "stick match"), and for "res.payload_lv" when used in the |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18094 | context of a response such as in "stick store response". |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 18095 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18096 | req.len : integer |
| 18097 | req_len : integer (deprecated) |
| 18098 | Returns an integer value corresponding to the number of bytes present in the |
| 18099 | request buffer. This is mostly used in ACL. It is important to understand |
| 18100 | that this test does not return false as long as the buffer is changing. This |
| 18101 | means that a check with equality to zero will almost always immediately match |
| 18102 | at the beginning of the session, while a test for more data will wait for |
| 18103 | that data to come in and return false only when haproxy is certain that no |
| 18104 | more data will come in. This test was designed to be used with TCP request |
| 18105 | content inspection. |
Willy Tarreau | a7ad50c | 2012-04-29 15:39:40 +0200 | [diff] [blame] | 18106 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18107 | req.payload(<offset>,<length>) : binary |
| 18108 | This extracts a binary block of <length> bytes and starting at byte <offset> |
Willy Tarreau | 00f0084 | 2013-08-02 11:07:32 +0200 | [diff] [blame] | 18109 | in the request buffer. As a special case, if the <length> argument is zero, |
| 18110 | the the whole buffer from <offset> to the end is extracted. This can be used |
| 18111 | with ACLs in order to check for the presence of some content in a buffer at |
| 18112 | any location. |
Willy Tarreau | a7ad50c | 2012-04-29 15:39:40 +0200 | [diff] [blame] | 18113 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18114 | ACL alternatives : |
| 18115 | payload(<offset>,<length>) : hex binary match |
Willy Tarreau | a7ad50c | 2012-04-29 15:39:40 +0200 | [diff] [blame] | 18116 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18117 | req.payload_lv(<offset1>,<length>[,<offset2>]) : binary |
| 18118 | This extracts a binary block whose size is specified at <offset1> for <length> |
| 18119 | bytes, and which starts at <offset2> if specified or just after the length in |
| 18120 | the request buffer. The <offset2> parameter also supports relative offsets if |
| 18121 | prepended with a '+' or '-' sign. |
Willy Tarreau | a7ad50c | 2012-04-29 15:39:40 +0200 | [diff] [blame] | 18122 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18123 | ACL alternatives : |
| 18124 | payload_lv(<offset1>,<length>[,<offset2>]) : hex binary match |
Willy Tarreau | a7ad50c | 2012-04-29 15:39:40 +0200 | [diff] [blame] | 18125 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18126 | Example : please consult the example from the "stick store-response" keyword. |
Willy Tarreau | a7ad50c | 2012-04-29 15:39:40 +0200 | [diff] [blame] | 18127 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18128 | req.proto_http : boolean |
| 18129 | req_proto_http : boolean (deprecated) |
| 18130 | Returns true when data in the request buffer look like HTTP and correctly |
| 18131 | parses as such. It is the same parser as the common HTTP request parser which |
| 18132 | is used so there should be no surprises. The test does not match until the |
| 18133 | request is complete, failed or timed out. This test may be used to report the |
| 18134 | protocol in TCP logs, but the biggest use is to block TCP request analysis |
| 18135 | until a complete HTTP request is present in the buffer, for example to track |
| 18136 | a header. |
Willy Tarreau | a7ad50c | 2012-04-29 15:39:40 +0200 | [diff] [blame] | 18137 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18138 | Example: |
| 18139 | # track request counts per "base" (concatenation of Host+URL) |
| 18140 | tcp-request inspect-delay 10s |
| 18141 | tcp-request content reject if !HTTP |
Willy Tarreau | be4a3ef | 2013-06-17 15:04:07 +0200 | [diff] [blame] | 18142 | tcp-request content track-sc0 base table req-rate |
Willy Tarreau | a7ad50c | 2012-04-29 15:39:40 +0200 | [diff] [blame] | 18143 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18144 | req.rdp_cookie([<name>]) : string |
| 18145 | rdp_cookie([<name>]) : string (deprecated) |
| 18146 | When the request buffer looks like the RDP protocol, extracts the RDP cookie |
| 18147 | <name>, or any cookie if unspecified. The parser only checks for the first |
| 18148 | cookie, as illustrated in the RDP protocol specification. The cookie name is |
| 18149 | case insensitive. Generally the "MSTS" cookie name will be used, as it can |
| 18150 | contain the user name of the client connecting to the server if properly |
| 18151 | configured on the client. The "MSTSHASH" cookie is often used as well for |
| 18152 | session stickiness to servers. |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18153 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18154 | This differs from "balance rdp-cookie" in that any balancing algorithm may be |
| 18155 | used and thus the distribution of clients to backend servers is not linked to |
| 18156 | a hash of the RDP cookie. It is envisaged that using a balancing algorithm |
| 18157 | such as "balance roundrobin" or "balance leastconn" will lead to a more even |
| 18158 | distribution of clients to backend servers than the hash used by "balance |
| 18159 | rdp-cookie". |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18160 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18161 | ACL derivatives : |
| 18162 | req_rdp_cookie([<name>]) : exact string match |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18163 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18164 | Example : |
| 18165 | listen tse-farm |
| 18166 | bind 0.0.0.0:3389 |
| 18167 | # wait up to 5s for an RDP cookie in the request |
| 18168 | tcp-request inspect-delay 5s |
| 18169 | tcp-request content accept if RDP_COOKIE |
| 18170 | # apply RDP cookie persistence |
| 18171 | persist rdp-cookie |
| 18172 | # Persist based on the mstshash cookie |
| 18173 | # This is only useful makes sense if |
| 18174 | # balance rdp-cookie is not used |
| 18175 | stick-table type string size 204800 |
| 18176 | stick on req.rdp_cookie(mstshash) |
| 18177 | server srv1 1.1.1.1:3389 |
| 18178 | server srv1 1.1.1.2:3389 |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18179 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18180 | See also : "balance rdp-cookie", "persist rdp-cookie", "tcp-request" and the |
| 18181 | "req_rdp_cookie" ACL. |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18182 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18183 | req.rdp_cookie_cnt([name]) : integer |
| 18184 | rdp_cookie_cnt([name]) : integer (deprecated) |
| 18185 | Tries to parse the request buffer as RDP protocol, then returns an integer |
| 18186 | corresponding to the number of RDP cookies found. If an optional cookie name |
| 18187 | is passed, only cookies matching this name are considered. This is mostly |
| 18188 | used in ACL. |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18189 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18190 | ACL derivatives : |
| 18191 | req_rdp_cookie_cnt([<name>]) : integer match |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18192 | |
Alex Zorin | 4afdd13 | 2018-12-30 13:56:28 +1100 | [diff] [blame] | 18193 | req.ssl_alpn : string |
| 18194 | Returns a string containing the values of the Application-Layer Protocol |
| 18195 | Negotiation (ALPN) TLS extension (RFC7301), sent by the client within the SSL |
| 18196 | ClientHello message. Note that this only applies to raw contents found in the |
| 18197 | request buffer and not to the contents deciphered via an SSL data layer, so |
| 18198 | this will not work with "bind" lines having the "ssl" option. This is useful |
| 18199 | in ACL to make a routing decision based upon the ALPN preferences of a TLS |
Jarno Huuskonen | e504f81 | 2019-01-03 07:56:49 +0200 | [diff] [blame] | 18200 | client, like in the example below. See also "ssl_fc_alpn". |
Alex Zorin | 4afdd13 | 2018-12-30 13:56:28 +1100 | [diff] [blame] | 18201 | |
| 18202 | Examples : |
| 18203 | # Wait for a client hello for at most 5 seconds |
| 18204 | tcp-request inspect-delay 5s |
| 18205 | tcp-request content accept if { req_ssl_hello_type 1 } |
Jarno Huuskonen | e504f81 | 2019-01-03 07:56:49 +0200 | [diff] [blame] | 18206 | use_backend bk_acme if { req.ssl_alpn acme-tls/1 } |
Alex Zorin | 4afdd13 | 2018-12-30 13:56:28 +1100 | [diff] [blame] | 18207 | default_backend bk_default |
| 18208 | |
Nenad Merdanovic | 5fc7d7e | 2015-07-07 22:00:17 +0200 | [diff] [blame] | 18209 | req.ssl_ec_ext : boolean |
| 18210 | Returns a boolean identifying if client sent the Supported Elliptic Curves |
| 18211 | Extension as defined in RFC4492, section 5.1. within the SSL ClientHello |
Cyril Bonté | 307ee1e | 2015-09-28 23:16:06 +0200 | [diff] [blame] | 18212 | message. This can be used to present ECC compatible clients with EC |
| 18213 | certificate and to use RSA for all others, on the same IP address. Note that |
| 18214 | this only applies to raw contents found in the request buffer and not to |
| 18215 | contents deciphered via an SSL data layer, so this will not work with "bind" |
| 18216 | lines having the "ssl" option. |
Nenad Merdanovic | 5fc7d7e | 2015-07-07 22:00:17 +0200 | [diff] [blame] | 18217 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18218 | req.ssl_hello_type : integer |
| 18219 | req_ssl_hello_type : integer (deprecated) |
| 18220 | Returns an integer value containing the type of the SSL hello message found |
| 18221 | in the request buffer if the buffer contains data that parse as a complete |
| 18222 | SSL (v3 or superior) client hello message. Note that this only applies to raw |
| 18223 | contents found in the request buffer and not to contents deciphered via an |
| 18224 | SSL data layer, so this will not work with "bind" lines having the "ssl" |
| 18225 | option. This is mostly used in ACL to detect presence of an SSL hello message |
| 18226 | that is supposed to contain an SSL session ID usable for stickiness. |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18227 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18228 | req.ssl_sni : string |
| 18229 | req_ssl_sni : string (deprecated) |
| 18230 | Returns a string containing the value of the Server Name TLS extension sent |
| 18231 | by a client in a TLS stream passing through the request buffer if the buffer |
| 18232 | contains data that parse as a complete SSL (v3 or superior) client hello |
| 18233 | message. Note that this only applies to raw contents found in the request |
| 18234 | buffer and not to contents deciphered via an SSL data layer, so this will not |
Lukas Tribus | a267b5d | 2020-07-19 00:25:06 +0200 | [diff] [blame] | 18235 | work with "bind" lines having the "ssl" option. This will only work for actual |
| 18236 | implicit TLS based protocols like HTTPS (443), IMAPS (993), SMTPS (465), |
| 18237 | however it will not work for explicit TLS based protocols, like SMTP (25/587) |
| 18238 | or IMAP (143). SNI normally contains the name of the host the client tries to |
| 18239 | connect to (for recent browsers). SNI is useful for allowing or denying access |
| 18240 | to certain hosts when SSL/TLS is used by the client. This test was designed to |
| 18241 | be used with TCP request content inspection. If content switching is needed, |
| 18242 | it is recommended to first wait for a complete client hello (type 1), like in |
| 18243 | the example below. See also "ssl_fc_sni". |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18244 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18245 | ACL derivatives : |
| 18246 | req_ssl_sni : exact string match |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18247 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18248 | Examples : |
| 18249 | # Wait for a client hello for at most 5 seconds |
| 18250 | tcp-request inspect-delay 5s |
| 18251 | tcp-request content accept if { req_ssl_hello_type 1 } |
| 18252 | use_backend bk_allow if { req_ssl_sni -f allowed_sites } |
| 18253 | default_backend bk_sorry_page |
Willy Tarreau | 04aa6a9 | 2012-04-06 18:57:55 +0200 | [diff] [blame] | 18254 | |
Pradeep Jindal | bb2acf5 | 2015-09-29 10:12:57 +0530 | [diff] [blame] | 18255 | req.ssl_st_ext : integer |
| 18256 | Returns 0 if the client didn't send a SessionTicket TLS Extension (RFC5077) |
| 18257 | Returns 1 if the client sent SessionTicket TLS Extension |
| 18258 | Returns 2 if the client also sent non-zero length TLS SessionTicket |
| 18259 | Note that this only applies to raw contents found in the request buffer and |
| 18260 | not to contents deciphered via an SSL data layer, so this will not work with |
| 18261 | "bind" lines having the "ssl" option. This can for example be used to detect |
| 18262 | whether the client sent a SessionTicket or not and stick it accordingly, if |
| 18263 | no SessionTicket then stick on SessionID or don't stick as there's no server |
| 18264 | side state is there when SessionTickets are in use. |
| 18265 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18266 | req.ssl_ver : integer |
| 18267 | req_ssl_ver : integer (deprecated) |
| 18268 | Returns an integer value containing the version of the SSL/TLS protocol of a |
| 18269 | stream present in the request buffer. Both SSLv2 hello messages and SSLv3 |
| 18270 | messages are supported. TLSv1 is announced as SSL version 3.1. The value is |
| 18271 | composed of the major version multiplied by 65536, added to the minor |
| 18272 | version. Note that this only applies to raw contents found in the request |
| 18273 | buffer and not to contents deciphered via an SSL data layer, so this will not |
| 18274 | work with "bind" lines having the "ssl" option. The ACL version of the test |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 18275 | matches against a decimal notation in the form MAJOR.MINOR (e.g. 3.1). This |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18276 | fetch is mostly used in ACL. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18277 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18278 | ACL derivatives : |
| 18279 | req_ssl_ver : decimal match |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18280 | |
Willy Tarreau | 47e8eba | 2013-09-11 23:28:46 +0200 | [diff] [blame] | 18281 | res.len : integer |
| 18282 | Returns an integer value corresponding to the number of bytes present in the |
| 18283 | response buffer. This is mostly used in ACL. It is important to understand |
| 18284 | that this test does not return false as long as the buffer is changing. This |
| 18285 | means that a check with equality to zero will almost always immediately match |
| 18286 | at the beginning of the session, while a test for more data will wait for |
| 18287 | that data to come in and return false only when haproxy is certain that no |
| 18288 | more data will come in. This test was designed to be used with TCP response |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18289 | content inspection. But it may also be used in tcp-check based expect rules. |
Willy Tarreau | 47e8eba | 2013-09-11 23:28:46 +0200 | [diff] [blame] | 18290 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18291 | res.payload(<offset>,<length>) : binary |
| 18292 | This extracts a binary block of <length> bytes and starting at byte <offset> |
Willy Tarreau | 00f0084 | 2013-08-02 11:07:32 +0200 | [diff] [blame] | 18293 | in the response buffer. As a special case, if the <length> argument is zero, |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18294 | the whole buffer from <offset> to the end is extracted. This can be used |
Willy Tarreau | 00f0084 | 2013-08-02 11:07:32 +0200 | [diff] [blame] | 18295 | with ACLs in order to check for the presence of some content in a buffer at |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18296 | any location. It may also be used in tcp-check based expect rules. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18297 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18298 | res.payload_lv(<offset1>,<length>[,<offset2>]) : binary |
| 18299 | This extracts a binary block whose size is specified at <offset1> for <length> |
| 18300 | bytes, and which starts at <offset2> if specified or just after the length in |
| 18301 | the response buffer. The <offset2> parameter also supports relative offsets |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18302 | if prepended with a '+' or '-' sign. It may also be used in tcp-check based |
| 18303 | expect rules. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18304 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18305 | Example : please consult the example from the "stick store-response" keyword. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18306 | |
Willy Tarreau | 971f7b6 | 2015-09-29 14:06:59 +0200 | [diff] [blame] | 18307 | res.ssl_hello_type : integer |
| 18308 | rep_ssl_hello_type : integer (deprecated) |
| 18309 | Returns an integer value containing the type of the SSL hello message found |
| 18310 | in the response buffer if the buffer contains data that parses as a complete |
| 18311 | SSL (v3 or superior) hello message. Note that this only applies to raw |
| 18312 | contents found in the response buffer and not to contents deciphered via an |
| 18313 | SSL data layer, so this will not work with "server" lines having the "ssl" |
| 18314 | option. This is mostly used in ACL to detect presence of an SSL hello message |
| 18315 | that is supposed to contain an SSL session ID usable for stickiness. |
| 18316 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18317 | wait_end : boolean |
| 18318 | This fetch either returns true when the inspection period is over, or does |
| 18319 | not fetch. It is only used in ACLs, in conjunction with content analysis to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 18320 | avoid returning a wrong verdict early. It may also be used to delay some |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18321 | actions, such as a delayed reject for some special addresses. Since it either |
| 18322 | stops the rules evaluation or immediately returns true, it is recommended to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 18323 | use this acl as the last one in a rule. Please note that the default ACL |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18324 | "WAIT_END" is always usable without prior declaration. This test was designed |
| 18325 | to be used with TCP request content inspection. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18326 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18327 | Examples : |
| 18328 | # delay every incoming request by 2 seconds |
| 18329 | tcp-request inspect-delay 2s |
| 18330 | tcp-request content accept if WAIT_END |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18331 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18332 | # don't immediately tell bad guys they are rejected |
| 18333 | tcp-request inspect-delay 10s |
| 18334 | acl goodguys src 10.0.0.0/24 |
| 18335 | acl badguys src 10.0.1.0/24 |
| 18336 | tcp-request content accept if goodguys |
| 18337 | tcp-request content reject if badguys WAIT_END |
| 18338 | tcp-request content reject |
| 18339 | |
| 18340 | |
Thierry FOURNIER | 060762e | 2014-04-23 13:29:15 +0200 | [diff] [blame] | 18341 | 7.3.6. Fetching HTTP samples (Layer 7) |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18342 | -------------------------------------- |
| 18343 | |
| 18344 | It is possible to fetch samples from HTTP contents, requests and responses. |
| 18345 | This application layer is also called layer 7. It is only possible to fetch the |
| 18346 | data in this section when a full HTTP request or response has been parsed from |
| 18347 | its respective request or response buffer. This is always the case with all |
| 18348 | HTTP specific rules and for sections running with "mode http". When using TCP |
| 18349 | content inspection, it may be necessary to support an inspection delay in order |
| 18350 | to let the request or response come in first. These fetches may require a bit |
| 18351 | more CPU resources than the layer 4 ones, but not much since the request and |
| 18352 | response are indexed. |
| 18353 | |
| 18354 | base : string |
| 18355 | This returns the concatenation of the first Host header and the path part of |
| 18356 | the request, which starts at the first slash and ends before the question |
| 18357 | mark. It can be useful in virtual hosted environments to detect URL abuses as |
| 18358 | well as to improve shared caches efficiency. Using this with a limited size |
| 18359 | stick table also allows one to collect statistics about most commonly |
| 18360 | requested objects by host/path. With ACLs it can allow simple content |
| 18361 | switching rules involving the host and the path at the same time, such as |
| 18362 | "www.example.com/favicon.ico". See also "path" and "uri". |
| 18363 | |
| 18364 | ACL derivatives : |
| 18365 | base : exact string match |
| 18366 | base_beg : prefix match |
| 18367 | base_dir : subdir match |
| 18368 | base_dom : domain match |
| 18369 | base_end : suffix match |
| 18370 | base_len : length match |
| 18371 | base_reg : regex match |
| 18372 | base_sub : substring match |
| 18373 | |
| 18374 | base32 : integer |
| 18375 | This returns a 32-bit hash of the value returned by the "base" fetch method |
| 18376 | above. This is useful to track per-URL activity on high traffic sites without |
| 18377 | having to store all URLs. Instead a shorter hash is stored, saving a lot of |
Willy Tarreau | 23ec4ca | 2014-07-15 20:15:37 +0200 | [diff] [blame] | 18378 | memory. The output type is an unsigned integer. The hash function used is |
| 18379 | SDBM with full avalanche on the output. Technically, base32 is exactly equal |
| 18380 | to "base,sdbm(1)". |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18381 | |
| 18382 | base32+src : binary |
| 18383 | This returns the concatenation of the base32 fetch above and the src fetch |
| 18384 | below. The resulting type is of type binary, with a size of 8 or 20 bytes |
| 18385 | depending on the source address family. This can be used to track per-IP, |
| 18386 | per-URL counters. |
| 18387 | |
William Lallemand | 65ad6e1 | 2014-01-31 15:08:02 +0100 | [diff] [blame] | 18388 | capture.req.hdr(<idx>) : string |
| 18389 | This extracts the content of the header captured by the "capture request |
| 18390 | header", idx is the position of the capture keyword in the configuration. |
| 18391 | The first entry is an index of 0. See also: "capture request header". |
| 18392 | |
| 18393 | capture.req.method : string |
| 18394 | This extracts the METHOD of an HTTP request. It can be used in both request |
| 18395 | and response. Unlike "method", it can be used in both request and response |
| 18396 | because it's allocated. |
| 18397 | |
| 18398 | capture.req.uri : string |
| 18399 | This extracts the request's URI, which starts at the first slash and ends |
| 18400 | before the first space in the request (without the host part). Unlike "path" |
| 18401 | and "url", it can be used in both request and response because it's |
| 18402 | allocated. |
| 18403 | |
Willy Tarreau | 3c1b5ec | 2014-04-24 23:41:57 +0200 | [diff] [blame] | 18404 | capture.req.ver : string |
| 18405 | This extracts the request's HTTP version and returns either "HTTP/1.0" or |
| 18406 | "HTTP/1.1". Unlike "req.ver", it can be used in both request, response, and |
| 18407 | logs because it relies on a persistent flag. |
| 18408 | |
William Lallemand | 65ad6e1 | 2014-01-31 15:08:02 +0100 | [diff] [blame] | 18409 | capture.res.hdr(<idx>) : string |
| 18410 | This extracts the content of the header captured by the "capture response |
| 18411 | header", idx is the position of the capture keyword in the configuration. |
| 18412 | The first entry is an index of 0. |
| 18413 | See also: "capture response header" |
| 18414 | |
Willy Tarreau | 3c1b5ec | 2014-04-24 23:41:57 +0200 | [diff] [blame] | 18415 | capture.res.ver : string |
| 18416 | This extracts the response's HTTP version and returns either "HTTP/1.0" or |
| 18417 | "HTTP/1.1". Unlike "res.ver", it can be used in logs because it relies on a |
| 18418 | persistent flag. |
| 18419 | |
Willy Tarreau | a5910cc | 2015-05-02 00:46:08 +0200 | [diff] [blame] | 18420 | req.body : binary |
Christopher Faulet | af4dc4c | 2020-05-05 17:33:25 +0200 | [diff] [blame] | 18421 | This returns the HTTP request's available body as a block of data. It is |
| 18422 | recommended to use "option http-buffer-request" to be sure to wait, as much |
| 18423 | as possible, for the request's body. |
Willy Tarreau | a5910cc | 2015-05-02 00:46:08 +0200 | [diff] [blame] | 18424 | |
Thierry FOURNIER | 9826c77 | 2015-05-20 15:50:54 +0200 | [diff] [blame] | 18425 | req.body_param([<name>) : string |
| 18426 | This fetch assumes that the body of the POST request is url-encoded. The user |
| 18427 | can check if the "content-type" contains the value |
| 18428 | "application/x-www-form-urlencoded". This extracts the first occurrence of the |
| 18429 | parameter <name> in the body, which ends before '&'. The parameter name is |
| 18430 | case-sensitive. If no name is given, any parameter will match, and the first |
| 18431 | one will be returned. The result is a string corresponding to the value of the |
| 18432 | parameter <name> as presented in the request body (no URL decoding is |
| 18433 | performed). Note that the ACL version of this fetch iterates over multiple |
| 18434 | parameters and will iteratively report all parameters values if no name is |
| 18435 | given. |
| 18436 | |
Willy Tarreau | a5910cc | 2015-05-02 00:46:08 +0200 | [diff] [blame] | 18437 | req.body_len : integer |
| 18438 | This returns the length of the HTTP request's available body in bytes. It may |
| 18439 | be lower than the advertised length if the body is larger than the buffer. It |
Christopher Faulet | af4dc4c | 2020-05-05 17:33:25 +0200 | [diff] [blame] | 18440 | is recommended to use "option http-buffer-request" to be sure to wait, as |
| 18441 | much as possible, for the request's body. |
Willy Tarreau | a5910cc | 2015-05-02 00:46:08 +0200 | [diff] [blame] | 18442 | |
| 18443 | req.body_size : integer |
| 18444 | This returns the advertised length of the HTTP request's body in bytes. It |
Christopher Faulet | af4dc4c | 2020-05-05 17:33:25 +0200 | [diff] [blame] | 18445 | will represent the advertised Content-Length header, or the size of the |
| 18446 | available data in case of chunked encoding. |
Willy Tarreau | a5910cc | 2015-05-02 00:46:08 +0200 | [diff] [blame] | 18447 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18448 | req.cook([<name>]) : string |
| 18449 | cook([<name>]) : string (deprecated) |
| 18450 | This extracts the last occurrence of the cookie name <name> on a "Cookie" |
| 18451 | header line from the request, and returns its value as string. If no name is |
| 18452 | specified, the first cookie value is returned. When used with ACLs, all |
| 18453 | matching cookies are evaluated. Spaces around the name and the value are |
| 18454 | ignored as requested by the Cookie header specification (RFC6265). The cookie |
| 18455 | name is case-sensitive. Empty cookies are valid, so an empty cookie may very |
| 18456 | well return an empty value if it is present. Use the "found" match to detect |
| 18457 | presence. Use the res.cook() variant for response cookies sent by the server. |
| 18458 | |
| 18459 | ACL derivatives : |
| 18460 | cook([<name>]) : exact string match |
| 18461 | cook_beg([<name>]) : prefix match |
| 18462 | cook_dir([<name>]) : subdir match |
| 18463 | cook_dom([<name>]) : domain match |
| 18464 | cook_end([<name>]) : suffix match |
| 18465 | cook_len([<name>]) : length match |
| 18466 | cook_reg([<name>]) : regex match |
| 18467 | cook_sub([<name>]) : substring match |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18468 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18469 | req.cook_cnt([<name>]) : integer |
| 18470 | cook_cnt([<name>]) : integer (deprecated) |
| 18471 | Returns an integer value representing the number of occurrences of the cookie |
| 18472 | <name> in the request, or all cookies if <name> is not specified. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18473 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18474 | req.cook_val([<name>]) : integer |
| 18475 | cook_val([<name>]) : integer (deprecated) |
| 18476 | This extracts the last occurrence of the cookie name <name> on a "Cookie" |
| 18477 | header line from the request, and converts its value to an integer which is |
| 18478 | returned. If no name is specified, the first cookie value is returned. When |
| 18479 | used in ACLs, all matching names are iterated over until a value matches. |
Willy Tarreau | 0e69854 | 2011-09-16 08:32:32 +0200 | [diff] [blame] | 18480 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18481 | cookie([<name>]) : string (deprecated) |
| 18482 | This extracts the last occurrence of the cookie name <name> on a "Cookie" |
| 18483 | header line from the request, or a "Set-Cookie" header from the response, and |
| 18484 | returns its value as a string. A typical use is to get multiple clients |
| 18485 | sharing a same profile use the same server. This can be similar to what |
Willy Tarreau | 294d0f0 | 2015-08-10 19:40:12 +0200 | [diff] [blame] | 18486 | "appsession" did with the "request-learn" statement, but with support for |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18487 | multi-peer synchronization and state keeping across restarts. If no name is |
| 18488 | specified, the first cookie value is returned. This fetch should not be used |
| 18489 | anymore and should be replaced by req.cook() or res.cook() instead as it |
| 18490 | ambiguously uses the direction based on the context where it is used. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18491 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18492 | hdr([<name>[,<occ>]]) : string |
| 18493 | This is equivalent to req.hdr() when used on requests, and to res.hdr() when |
| 18494 | used on responses. Please refer to these respective fetches for more details. |
| 18495 | In case of doubt about the fetch direction, please use the explicit ones. |
| 18496 | Note that contrary to the hdr() sample fetch method, the hdr_* ACL keywords |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 18497 | unambiguously apply to the request headers. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18498 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18499 | req.fhdr(<name>[,<occ>]) : string |
| 18500 | This extracts the last occurrence of header <name> in an HTTP request. When |
| 18501 | used from an ACL, all occurrences are iterated over until a match is found. |
| 18502 | Optionally, a specific occurrence might be specified as a position number. |
| 18503 | Positive values indicate a position from the first occurrence, with 1 being |
| 18504 | the first one. Negative values indicate positions relative to the last one, |
| 18505 | with -1 being the last one. It differs from req.hdr() in that any commas |
| 18506 | present in the value are returned and are not used as delimiters. This is |
| 18507 | sometimes useful with headers such as User-Agent. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18508 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18509 | req.fhdr_cnt([<name>]) : integer |
| 18510 | Returns an integer value representing the number of occurrences of request |
| 18511 | header field name <name>, or the total number of header fields if <name> is |
| 18512 | not specified. Contrary to its req.hdr_cnt() cousin, this function returns |
| 18513 | the number of full line headers and does not stop on commas. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18514 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18515 | req.hdr([<name>[,<occ>]]) : string |
| 18516 | This extracts the last occurrence of header <name> in an HTTP request. When |
| 18517 | used from an ACL, all occurrences are iterated over until a match is found. |
| 18518 | Optionally, a specific occurrence might be specified as a position number. |
| 18519 | Positive values indicate a position from the first occurrence, with 1 being |
| 18520 | the first one. Negative values indicate positions relative to the last one, |
| 18521 | with -1 being the last one. A typical use is with the X-Forwarded-For header |
| 18522 | once converted to IP, associated with an IP stick-table. The function |
| 18523 | considers any comma as a delimiter for distinct values. If full-line headers |
Lukas Tribus | 2395368 | 2017-04-28 13:24:30 +0000 | [diff] [blame] | 18524 | are desired instead, use req.fhdr(). Please carefully check RFC7231 to know |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18525 | how certain headers are supposed to be parsed. Also, some of them are case |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 18526 | insensitive (e.g. Connection). |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18527 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18528 | ACL derivatives : |
| 18529 | hdr([<name>[,<occ>]]) : exact string match |
| 18530 | hdr_beg([<name>[,<occ>]]) : prefix match |
| 18531 | hdr_dir([<name>[,<occ>]]) : subdir match |
| 18532 | hdr_dom([<name>[,<occ>]]) : domain match |
| 18533 | hdr_end([<name>[,<occ>]]) : suffix match |
| 18534 | hdr_len([<name>[,<occ>]]) : length match |
| 18535 | hdr_reg([<name>[,<occ>]]) : regex match |
| 18536 | hdr_sub([<name>[,<occ>]]) : substring match |
| 18537 | |
| 18538 | req.hdr_cnt([<name>]) : integer |
| 18539 | hdr_cnt([<header>]) : integer (deprecated) |
| 18540 | Returns an integer value representing the number of occurrences of request |
| 18541 | header field name <name>, or the total number of header field values if |
| 18542 | <name> is not specified. It is important to remember that one header line may |
| 18543 | count as several headers if it has several values. The function considers any |
| 18544 | comma as a delimiter for distinct values. If full-line headers are desired |
| 18545 | instead, req.fhdr_cnt() should be used instead. With ACLs, it can be used to |
| 18546 | detect presence, absence or abuse of a specific header, as well as to block |
| 18547 | request smuggling attacks by rejecting requests which contain more than one |
| 18548 | of certain headers. See "req.hdr" for more information on header matching. |
| 18549 | |
| 18550 | req.hdr_ip([<name>[,<occ>]]) : ip |
| 18551 | hdr_ip([<name>[,<occ>]]) : ip (deprecated) |
| 18552 | This extracts the last occurrence of header <name> in an HTTP request, |
| 18553 | converts it to an IPv4 or IPv6 address and returns this address. When used |
| 18554 | with ACLs, all occurrences are checked, and if <name> is omitted, every value |
| 18555 | of every header is checked. Optionally, a specific occurrence might be |
| 18556 | specified as a position number. Positive values indicate a position from the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 18557 | first occurrence, with 1 being the first one. Negative values indicate |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18558 | positions relative to the last one, with -1 being the last one. A typical use |
| 18559 | is with the X-Forwarded-For and X-Client-IP headers. |
| 18560 | |
| 18561 | req.hdr_val([<name>[,<occ>]]) : integer |
| 18562 | hdr_val([<name>[,<occ>]]) : integer (deprecated) |
| 18563 | This extracts the last occurrence of header <name> in an HTTP request, and |
| 18564 | converts it to an integer value. When used with ACLs, all occurrences are |
| 18565 | checked, and if <name> is omitted, every value of every header is checked. |
| 18566 | Optionally, a specific occurrence might be specified as a position number. |
| 18567 | Positive values indicate a position from the first occurrence, with 1 being |
| 18568 | the first one. Negative values indicate positions relative to the last one, |
| 18569 | with -1 being the last one. A typical use is with the X-Forwarded-For header. |
| 18570 | |
Christopher Faulet | 687a68e | 2020-11-24 17:13:24 +0100 | [diff] [blame] | 18571 | req.hdrs : string |
| 18572 | Returns the current request headers as string including the last empty line |
| 18573 | separating headers from the request body. The last empty line can be used to |
| 18574 | detect a truncated header block. This sample fetch is useful for some SPOE |
| 18575 | headers analyzers and for advanced logging. |
| 18576 | |
| 18577 | req.hdrs_bin : binary |
| 18578 | Returns the current request headers contained in preparsed binary form. This |
| 18579 | is useful for offloading some processing with SPOE. Each string is described |
| 18580 | by a length followed by the number of bytes indicated in the length. The |
| 18581 | length is represented using the variable integer encoding detailed in the |
| 18582 | SPOE documentation. The end of the list is marked by a couple of empty header |
| 18583 | names and values (length of 0 for both). |
| 18584 | |
| 18585 | *(<str:header-name><str:header-value>)<empty string><empty string> |
Frédéric Lécaille | ec89119 | 2019-02-26 15:02:35 +0100 | [diff] [blame] | 18586 | |
Christopher Faulet | 687a68e | 2020-11-24 17:13:24 +0100 | [diff] [blame] | 18587 | int: refer to the SPOE documentation for the encoding |
| 18588 | str: <int:length><bytes> |
Frédéric Lécaille | ec89119 | 2019-02-26 15:02:35 +0100 | [diff] [blame] | 18589 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18590 | http_auth(<userlist>) : boolean |
| 18591 | Returns a boolean indicating whether the authentication data received from |
| 18592 | the client match a username & password stored in the specified userlist. This |
| 18593 | fetch function is not really useful outside of ACLs. Currently only http |
| 18594 | basic auth is supported. |
| 18595 | |
Thierry FOURNIER | 9eec0a6 | 2014-01-22 18:38:02 +0100 | [diff] [blame] | 18596 | http_auth_group(<userlist>) : string |
| 18597 | Returns a string corresponding to the user name found in the authentication |
| 18598 | data received from the client if both the user name and password are valid |
| 18599 | according to the specified userlist. The main purpose is to use it in ACLs |
| 18600 | where it is then checked whether the user belongs to any group within a list. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18601 | This fetch function is not really useful outside of ACLs. Currently only http |
| 18602 | basic auth is supported. |
| 18603 | |
| 18604 | ACL derivatives : |
Thierry FOURNIER | 9eec0a6 | 2014-01-22 18:38:02 +0100 | [diff] [blame] | 18605 | http_auth_group(<userlist>) : group ... |
| 18606 | Returns true when the user extracted from the request and whose password is |
| 18607 | valid according to the specified userlist belongs to at least one of the |
| 18608 | groups. |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18609 | |
Christopher Faulet | a406356 | 2019-08-02 11:51:37 +0200 | [diff] [blame] | 18610 | http_auth_pass : string |
Willy Tarreau | c9c6cdb | 2020-03-05 16:03:58 +0100 | [diff] [blame] | 18611 | Returns the user's password found in the authentication data received from |
| 18612 | the client, as supplied in the Authorization header. Not checks are |
| 18613 | performed by this sample fetch. Only Basic authentication is supported. |
Christopher Faulet | a406356 | 2019-08-02 11:51:37 +0200 | [diff] [blame] | 18614 | |
| 18615 | http_auth_type : string |
Willy Tarreau | c9c6cdb | 2020-03-05 16:03:58 +0100 | [diff] [blame] | 18616 | Returns the authentication method found in the authentication data received from |
| 18617 | the client, as supplied in the Authorization header. Not checks are |
| 18618 | performed by this sample fetch. Only Basic authentication is supported. |
Christopher Faulet | a406356 | 2019-08-02 11:51:37 +0200 | [diff] [blame] | 18619 | |
| 18620 | http_auth_user : string |
Willy Tarreau | c9c6cdb | 2020-03-05 16:03:58 +0100 | [diff] [blame] | 18621 | Returns the user name found in the authentication data received from the |
| 18622 | client, as supplied in the Authorization header. Not checks are performed by |
| 18623 | this sample fetch. Only Basic authentication is supported. |
Christopher Faulet | a406356 | 2019-08-02 11:51:37 +0200 | [diff] [blame] | 18624 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18625 | http_first_req : boolean |
Willy Tarreau | 7f18e52 | 2010-10-22 20:04:13 +0200 | [diff] [blame] | 18626 | Returns true when the request being processed is the first one of the |
| 18627 | connection. This can be used to add or remove headers that may be missing |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18628 | from some requests when a request is not the first one, or to help grouping |
| 18629 | requests in the logs. |
Willy Tarreau | 7f18e52 | 2010-10-22 20:04:13 +0200 | [diff] [blame] | 18630 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18631 | method : integer + string |
| 18632 | Returns an integer value corresponding to the method in the HTTP request. For |
| 18633 | example, "GET" equals 1 (check sources to establish the matching). Value 9 |
| 18634 | means "other method" and may be converted to a string extracted from the |
| 18635 | stream. This should not be used directly as a sample, this is only meant to |
| 18636 | be used from ACLs, which transparently convert methods from patterns to these |
| 18637 | integer + string values. Some predefined ACL already check for most common |
| 18638 | methods. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18639 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18640 | ACL derivatives : |
| 18641 | method : case insensitive method match |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18642 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18643 | Example : |
| 18644 | # only accept GET and HEAD requests |
| 18645 | acl valid_method method GET HEAD |
| 18646 | http-request deny if ! valid_method |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18647 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18648 | path : string |
| 18649 | This extracts the request's URL path, which starts at the first slash and |
| 18650 | ends before the question mark (without the host part). A typical use is with |
| 18651 | prefetch-capable caches, and with portals which need to aggregate multiple |
| 18652 | information from databases and keep them in caches. Note that with outgoing |
| 18653 | caches, it would be wiser to use "url" instead. With ACLs, it's typically |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 18654 | used to match exact file names (e.g. "/login.php"), or directory parts using |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18655 | the derivative forms. See also the "url" and "base" fetch methods. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18656 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18657 | ACL derivatives : |
| 18658 | path : exact string match |
| 18659 | path_beg : prefix match |
| 18660 | path_dir : subdir match |
| 18661 | path_dom : domain match |
| 18662 | path_end : suffix match |
| 18663 | path_len : length match |
| 18664 | path_reg : regex match |
| 18665 | path_sub : substring match |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18666 | |
Christopher Faulet | e720c32 | 2020-09-02 17:25:18 +0200 | [diff] [blame] | 18667 | pathq : string |
| 18668 | This extracts the request's URL path with the query-string, which starts at |
| 18669 | the first slash. This sample fetch is pretty handy to always retrieve a |
| 18670 | relative URI, excluding the scheme and the authority part, if any. Indeed, |
| 18671 | while it is the common representation for an HTTP/1.1 request target, in |
| 18672 | HTTP/2, an absolute URI is often used. This sample fetch will return the same |
| 18673 | result in both cases. |
| 18674 | |
Willy Tarreau | 49ad95c | 2015-01-19 15:06:26 +0100 | [diff] [blame] | 18675 | query : string |
| 18676 | This extracts the request's query string, which starts after the first |
| 18677 | question mark. If no question mark is present, this fetch returns nothing. If |
| 18678 | a question mark is present but nothing follows, it returns an empty string. |
| 18679 | This means it's possible to easily know whether a query string is present |
Tim Düsterhus | 4896c44 | 2016-11-29 02:15:19 +0100 | [diff] [blame] | 18680 | using the "found" matching method. This fetch is the complement of "path" |
Willy Tarreau | 49ad95c | 2015-01-19 15:06:26 +0100 | [diff] [blame] | 18681 | which stops before the question mark. |
| 18682 | |
Willy Tarreau | eb27ec7 | 2015-02-20 13:55:29 +0100 | [diff] [blame] | 18683 | req.hdr_names([<delim>]) : string |
| 18684 | This builds a string made from the concatenation of all header names as they |
| 18685 | appear in the request when the rule is evaluated. The default delimiter is |
| 18686 | the comma (',') but it may be overridden as an optional argument <delim>. In |
| 18687 | this case, only the first character of <delim> is considered. |
| 18688 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18689 | req.ver : string |
| 18690 | req_ver : string (deprecated) |
| 18691 | Returns the version string from the HTTP request, for example "1.1". This can |
| 18692 | be useful for logs, but is mostly there for ACL. Some predefined ACL already |
| 18693 | check for versions 1.0 and 1.1. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18694 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18695 | ACL derivatives : |
| 18696 | req_ver : exact string match |
Willy Tarreau | 0e69854 | 2011-09-16 08:32:32 +0200 | [diff] [blame] | 18697 | |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18698 | res.body : binary |
| 18699 | This returns the HTTP response's available body as a block of data. Unlike |
| 18700 | the request side, there is no directive to wait for the response's body. This |
| 18701 | sample fetch is really useful (and usable) in the health-check context. It |
| 18702 | may be used in tcp-check based expect rules. |
| 18703 | |
| 18704 | res.body_len : integer |
| 18705 | This returns the length of the HTTP response available body in bytes. Unlike |
| 18706 | the request side, there is no directive to wait for the response's body. This |
| 18707 | sample fetch is really useful (and usable) in the health-check context. It |
| 18708 | may be used in tcp-check based expect rules. |
| 18709 | |
| 18710 | res.body_size : integer |
| 18711 | This returns the advertised length of the HTTP response body in bytes. It |
| 18712 | will represent the advertised Content-Length header, or the size of the |
| 18713 | available data in case of chunked encoding. Unlike the request side, there is |
| 18714 | no directive to wait for the response body. This sample fetch is really |
| 18715 | useful (and usable) in the health-check context. It may be used in tcp-check |
| 18716 | based expect rules. |
| 18717 | |
Remi Tricot-Le Breton | bf97121 | 2020-10-27 11:55:57 +0100 | [diff] [blame] | 18718 | res.cache_hit : boolean |
| 18719 | Returns the boolean "true" value if the response has been built out of an |
| 18720 | HTTP cache entry, otherwise returns boolean "false". |
| 18721 | |
| 18722 | res.cache_name : string |
| 18723 | Returns a string containing the name of the HTTP cache that was used to |
| 18724 | build the HTTP response if res.cache_hit is true, otherwise returns an |
| 18725 | empty string. |
| 18726 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18727 | res.comp : boolean |
| 18728 | Returns the boolean "true" value if the response has been compressed by |
| 18729 | HAProxy, otherwise returns boolean "false". This may be used to add |
| 18730 | information in the logs. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18731 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18732 | res.comp_algo : string |
| 18733 | Returns a string containing the name of the algorithm used if the response |
| 18734 | was compressed by HAProxy, for example : "deflate". This may be used to add |
| 18735 | some information in the logs. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18736 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18737 | res.cook([<name>]) : string |
| 18738 | scook([<name>]) : string (deprecated) |
| 18739 | This extracts the last occurrence of the cookie name <name> on a "Set-Cookie" |
| 18740 | header line from the response, and returns its value as string. If no name is |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18741 | specified, the first cookie value is returned. It may be used in tcp-check |
| 18742 | based expect rules. |
Willy Tarreau | 0ce3aa0 | 2012-04-25 18:46:33 +0200 | [diff] [blame] | 18743 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18744 | ACL derivatives : |
| 18745 | scook([<name>] : exact string match |
Willy Tarreau | 0ce3aa0 | 2012-04-25 18:46:33 +0200 | [diff] [blame] | 18746 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18747 | res.cook_cnt([<name>]) : integer |
| 18748 | scook_cnt([<name>]) : integer (deprecated) |
| 18749 | Returns an integer value representing the number of occurrences of the cookie |
| 18750 | <name> in the response, or all cookies if <name> is not specified. This is |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18751 | mostly useful when combined with ACLs to detect suspicious responses. It may |
| 18752 | be used in tcp-check based expect rules. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18753 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18754 | res.cook_val([<name>]) : integer |
| 18755 | scook_val([<name>]) : integer (deprecated) |
| 18756 | This extracts the last occurrence of the cookie name <name> on a "Set-Cookie" |
| 18757 | header line from the response, and converts its value to an integer which is |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18758 | returned. If no name is specified, the first cookie value is returned. It may |
| 18759 | be used in tcp-check based expect rules. |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 18760 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18761 | res.fhdr([<name>[,<occ>]]) : string |
| 18762 | This extracts the last occurrence of header <name> in an HTTP response, or of |
| 18763 | the last header if no <name> is specified. Optionally, a specific occurrence |
| 18764 | might be specified as a position number. Positive values indicate a position |
| 18765 | from the first occurrence, with 1 being the first one. Negative values |
| 18766 | indicate positions relative to the last one, with -1 being the last one. It |
| 18767 | differs from res.hdr() in that any commas present in the value are returned |
| 18768 | and are not used as delimiters. If this is not desired, the res.hdr() fetch |
| 18769 | should be used instead. This is sometimes useful with headers such as Date or |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18770 | Expires. It may be used in tcp-check based expect rules. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18771 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18772 | res.fhdr_cnt([<name>]) : integer |
| 18773 | Returns an integer value representing the number of occurrences of response |
| 18774 | header field name <name>, or the total number of header fields if <name> is |
| 18775 | not specified. Contrary to its res.hdr_cnt() cousin, this function returns |
| 18776 | the number of full line headers and does not stop on commas. If this is not |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18777 | desired, the res.hdr_cnt() fetch should be used instead. It may be used in |
| 18778 | tcp-check based expect rules. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18779 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18780 | res.hdr([<name>[,<occ>]]) : string |
| 18781 | shdr([<name>[,<occ>]]) : string (deprecated) |
| 18782 | This extracts the last occurrence of header <name> in an HTTP response, or of |
| 18783 | the last header if no <name> is specified. Optionally, a specific occurrence |
| 18784 | might be specified as a position number. Positive values indicate a position |
| 18785 | from the first occurrence, with 1 being the first one. Negative values |
| 18786 | indicate positions relative to the last one, with -1 being the last one. This |
| 18787 | can be useful to learn some data into a stick-table. The function considers |
| 18788 | any comma as a delimiter for distinct values. If this is not desired, the |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18789 | res.fhdr() fetch should be used instead. It may be used in tcp-check based |
| 18790 | expect rules. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18791 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18792 | ACL derivatives : |
| 18793 | shdr([<name>[,<occ>]]) : exact string match |
| 18794 | shdr_beg([<name>[,<occ>]]) : prefix match |
| 18795 | shdr_dir([<name>[,<occ>]]) : subdir match |
| 18796 | shdr_dom([<name>[,<occ>]]) : domain match |
| 18797 | shdr_end([<name>[,<occ>]]) : suffix match |
| 18798 | shdr_len([<name>[,<occ>]]) : length match |
| 18799 | shdr_reg([<name>[,<occ>]]) : regex match |
| 18800 | shdr_sub([<name>[,<occ>]]) : substring match |
| 18801 | |
| 18802 | res.hdr_cnt([<name>]) : integer |
| 18803 | shdr_cnt([<name>]) : integer (deprecated) |
| 18804 | Returns an integer value representing the number of occurrences of response |
| 18805 | header field name <name>, or the total number of header fields if <name> is |
| 18806 | not specified. The function considers any comma as a delimiter for distinct |
| 18807 | values. If this is not desired, the res.fhdr_cnt() fetch should be used |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18808 | instead. It may be used in tcp-check based expect rules. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18809 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18810 | res.hdr_ip([<name>[,<occ>]]) : ip |
| 18811 | shdr_ip([<name>[,<occ>]]) : ip (deprecated) |
| 18812 | This extracts the last occurrence of header <name> in an HTTP response, |
| 18813 | convert it to an IPv4 or IPv6 address and returns this address. Optionally, a |
| 18814 | specific occurrence might be specified as a position number. Positive values |
| 18815 | indicate a position from the first occurrence, with 1 being the first one. |
| 18816 | Negative values indicate positions relative to the last one, with -1 being |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18817 | the last one. This can be useful to learn some data into a stick table. It |
| 18818 | may be used in tcp-check based expect rules. |
Willy Tarreau | 6a06a40 | 2007-07-15 20:15:28 +0200 | [diff] [blame] | 18819 | |
Willy Tarreau | eb27ec7 | 2015-02-20 13:55:29 +0100 | [diff] [blame] | 18820 | res.hdr_names([<delim>]) : string |
| 18821 | This builds a string made from the concatenation of all header names as they |
| 18822 | appear in the response when the rule is evaluated. The default delimiter is |
| 18823 | the comma (',') but it may be overridden as an optional argument <delim>. In |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18824 | this case, only the first character of <delim> is considered. It may be used |
| 18825 | in tcp-check based expect rules. |
Willy Tarreau | eb27ec7 | 2015-02-20 13:55:29 +0100 | [diff] [blame] | 18826 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18827 | res.hdr_val([<name>[,<occ>]]) : integer |
| 18828 | shdr_val([<name>[,<occ>]]) : integer (deprecated) |
| 18829 | This extracts the last occurrence of header <name> in an HTTP response, and |
| 18830 | converts it to an integer value. Optionally, a specific occurrence might be |
| 18831 | specified as a position number. Positive values indicate a position from the |
| 18832 | first occurrence, with 1 being the first one. Negative values indicate |
| 18833 | positions relative to the last one, with -1 being the last one. This can be |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18834 | useful to learn some data into a stick table. It may be used in tcp-check |
| 18835 | based expect rules. |
| 18836 | |
| 18837 | res.hdrs : string |
| 18838 | Returns the current response headers as string including the last empty line |
| 18839 | separating headers from the request body. The last empty line can be used to |
| 18840 | detect a truncated header block. This sample fetch is useful for some SPOE |
| 18841 | headers analyzers and for advanced logging. It may also be used in tcp-check |
| 18842 | based expect rules. |
| 18843 | |
| 18844 | res.hdrs_bin : binary |
| 18845 | Returns the current response headers contained in preparsed binary form. This |
| 18846 | is useful for offloading some processing with SPOE. It may be used in |
| 18847 | tcp-check based expect rules. Each string is described by a length followed |
| 18848 | by the number of bytes indicated in the length. The length is represented |
| 18849 | using the variable integer encoding detailed in the SPOE documentation. The |
| 18850 | end of the list is marked by a couple of empty header names and values |
| 18851 | (length of 0 for both). |
| 18852 | |
| 18853 | *(<str:header-name><str:header-value>)<empty string><empty string> |
| 18854 | |
| 18855 | int: refer to the SPOE documentation for the encoding |
| 18856 | str: <int:length><bytes> |
Alexandre Cassen | 5eb1a90 | 2007-11-29 15:43:32 +0100 | [diff] [blame] | 18857 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18858 | res.ver : string |
| 18859 | resp_ver : string (deprecated) |
| 18860 | Returns the version string from the HTTP response, for example "1.1". This |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18861 | can be useful for logs, but is mostly there for ACL. It may be used in |
| 18862 | tcp-check based expect rules. |
Willy Tarreau | 0e69854 | 2011-09-16 08:32:32 +0200 | [diff] [blame] | 18863 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18864 | ACL derivatives : |
| 18865 | resp_ver : exact string match |
Alexandre Cassen | 5eb1a90 | 2007-11-29 15:43:32 +0100 | [diff] [blame] | 18866 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18867 | set-cookie([<name>]) : string (deprecated) |
| 18868 | This extracts the last occurrence of the cookie name <name> on a "Set-Cookie" |
| 18869 | header line from the response and uses the corresponding value to match. This |
Willy Tarreau | 294d0f0 | 2015-08-10 19:40:12 +0200 | [diff] [blame] | 18870 | can be comparable to what "appsession" did with default options, but with |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18871 | support for multi-peer synchronization and state keeping across restarts. |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 18872 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18873 | This fetch function is deprecated and has been superseded by the "res.cook" |
| 18874 | fetch. This keyword will disappear soon. |
Krzysztof Piotr Oledzki | 6b35ce1 | 2010-02-01 23:35:44 +0100 | [diff] [blame] | 18875 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18876 | status : integer |
| 18877 | Returns an integer containing the HTTP status code in the HTTP response, for |
| 18878 | example, 302. It is mostly used within ACLs and integer ranges, for example, |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18879 | to remove any Location header if the response is not a 3xx. It may be used in |
| 18880 | tcp-check based expect rules. |
Willy Tarreau | 25c1ebc | 2012-04-25 16:21:44 +0200 | [diff] [blame] | 18881 | |
Thierry Fournier | 0e00dca | 2016-04-07 15:47:40 +0200 | [diff] [blame] | 18882 | unique-id : string |
| 18883 | Returns the unique-id attached to the request. The directive |
| 18884 | "unique-id-format" must be set. If it is not set, the unique-id sample fetch |
| 18885 | fails. Note that the unique-id is usually used with HTTP requests, however this |
| 18886 | sample fetch can be used with other protocols. Obviously, if it is used with |
| 18887 | other protocols than HTTP, the unique-id-format directive must not contain |
| 18888 | HTTP parts. See: unique-id-format and unique-id-header |
| 18889 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18890 | url : string |
| 18891 | This extracts the request's URL as presented in the request. A typical use is |
| 18892 | with prefetch-capable caches, and with portals which need to aggregate |
| 18893 | multiple information from databases and keep them in caches. With ACLs, using |
| 18894 | "path" is preferred over using "url", because clients may send a full URL as |
| 18895 | is normally done with proxies. The only real use is to match "*" which does |
| 18896 | not match in "path", and for which there is already a predefined ACL. See |
| 18897 | also "path" and "base". |
Willy Tarreau | 25c1ebc | 2012-04-25 16:21:44 +0200 | [diff] [blame] | 18898 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18899 | ACL derivatives : |
| 18900 | url : exact string match |
| 18901 | url_beg : prefix match |
| 18902 | url_dir : subdir match |
| 18903 | url_dom : domain match |
| 18904 | url_end : suffix match |
| 18905 | url_len : length match |
| 18906 | url_reg : regex match |
| 18907 | url_sub : substring match |
Willy Tarreau | 25c1ebc | 2012-04-25 16:21:44 +0200 | [diff] [blame] | 18908 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18909 | url_ip : ip |
| 18910 | This extracts the IP address from the request's URL when the host part is |
| 18911 | presented as an IP address. Its use is very limited. For instance, a |
| 18912 | monitoring system might use this field as an alternative for the source IP in |
| 18913 | order to test what path a given source address would follow, or to force an |
| 18914 | entry in a table for a given source address. With ACLs it can be used to |
| 18915 | restrict access to certain systems through a proxy, for example when combined |
| 18916 | with option "http_proxy". |
Willy Tarreau | 25c1ebc | 2012-04-25 16:21:44 +0200 | [diff] [blame] | 18917 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18918 | url_port : integer |
| 18919 | This extracts the port part from the request's URL. Note that if the port is |
| 18920 | not specified in the request, port 80 is assumed. With ACLs it can be used to |
| 18921 | restrict access to certain systems through a proxy, for example when combined |
| 18922 | with option "http_proxy". |
Willy Tarreau | 25c1ebc | 2012-04-25 16:21:44 +0200 | [diff] [blame] | 18923 | |
Willy Tarreau | 1ede1da | 2015-05-07 16:06:18 +0200 | [diff] [blame] | 18924 | urlp([<name>[,<delim>]]) : string |
| 18925 | url_param([<name>[,<delim>]]) : string |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18926 | This extracts the first occurrence of the parameter <name> in the query |
| 18927 | string, which begins after either '?' or <delim>, and which ends before '&', |
Willy Tarreau | 1ede1da | 2015-05-07 16:06:18 +0200 | [diff] [blame] | 18928 | ';' or <delim>. The parameter name is case-sensitive. If no name is given, |
| 18929 | any parameter will match, and the first one will be returned. The result is |
| 18930 | a string corresponding to the value of the parameter <name> as presented in |
| 18931 | the request (no URL decoding is performed). This can be used for session |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18932 | stickiness based on a client ID, to extract an application cookie passed as a |
| 18933 | URL parameter, or in ACLs to apply some checks. Note that the ACL version of |
Willy Tarreau | 1ede1da | 2015-05-07 16:06:18 +0200 | [diff] [blame] | 18934 | this fetch iterates over multiple parameters and will iteratively report all |
| 18935 | parameters values if no name is given |
Willy Tarreau | 25c1ebc | 2012-04-25 16:21:44 +0200 | [diff] [blame] | 18936 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18937 | ACL derivatives : |
| 18938 | urlp(<name>[,<delim>]) : exact string match |
| 18939 | urlp_beg(<name>[,<delim>]) : prefix match |
| 18940 | urlp_dir(<name>[,<delim>]) : subdir match |
| 18941 | urlp_dom(<name>[,<delim>]) : domain match |
| 18942 | urlp_end(<name>[,<delim>]) : suffix match |
| 18943 | urlp_len(<name>[,<delim>]) : length match |
| 18944 | urlp_reg(<name>[,<delim>]) : regex match |
| 18945 | urlp_sub(<name>[,<delim>]) : substring match |
Willy Tarreau | 25c1ebc | 2012-04-25 16:21:44 +0200 | [diff] [blame] | 18946 | |
Willy Tarreau | 25c1ebc | 2012-04-25 16:21:44 +0200 | [diff] [blame] | 18947 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18948 | Example : |
| 18949 | # match http://example.com/foo?PHPSESSIONID=some_id |
| 18950 | stick on urlp(PHPSESSIONID) |
| 18951 | # match http://example.com/foo;JSESSIONID=some_id |
| 18952 | stick on urlp(JSESSIONID,;) |
Willy Tarreau | 25c1ebc | 2012-04-25 16:21:44 +0200 | [diff] [blame] | 18953 | |
Jarno Huuskonen | 676f622 | 2017-03-30 09:19:45 +0300 | [diff] [blame] | 18954 | urlp_val([<name>[,<delim>]]) : integer |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 18955 | See "urlp" above. This one extracts the URL parameter <name> in the request |
| 18956 | and converts it to an integer value. This can be used for session stickiness |
| 18957 | based on a user ID for example, or with ACLs to match a page number or price. |
Willy Tarreau | a9fddca | 2012-07-31 07:51:48 +0200 | [diff] [blame] | 18958 | |
Dragan Dosen | 0070cd5 | 2016-06-16 12:19:49 +0200 | [diff] [blame] | 18959 | url32 : integer |
| 18960 | This returns a 32-bit hash of the value obtained by concatenating the first |
| 18961 | Host header and the whole URL including parameters (not only the path part of |
| 18962 | the request, as in the "base32" fetch above). This is useful to track per-URL |
| 18963 | activity. A shorter hash is stored, saving a lot of memory. The output type |
| 18964 | is an unsigned integer. |
| 18965 | |
| 18966 | url32+src : binary |
| 18967 | This returns the concatenation of the "url32" fetch and the "src" fetch. The |
| 18968 | resulting type is of type binary, with a size of 8 or 20 bytes depending on |
| 18969 | the source address family. This can be used to track per-IP, per-URL counters. |
| 18970 | |
Christopher Faulet | 16032ab | 2020-04-30 11:30:00 +0200 | [diff] [blame] | 18971 | |
Christopher Faulet | e596d18 | 2020-05-05 17:46:34 +0200 | [diff] [blame] | 18972 | 7.3.7. Fetching samples for developers |
Christopher Faulet | d47941d | 2020-01-08 14:40:19 +0100 | [diff] [blame] | 18973 | --------------------------------------- |
| 18974 | |
| 18975 | This set of sample fetch methods is reserved to developers and must never be |
| 18976 | used on a production environment, except on developer demand, for debugging |
| 18977 | purposes. Moreover, no special care will be taken on backwards compatibility. |
| 18978 | There is no warranty the following sample fetches will never change, be renamed |
| 18979 | or simply removed. So be really careful if you should use one of them. To avoid |
| 18980 | any ambiguity, these sample fetches are placed in the dedicated scope "internal", |
| 18981 | for instance "internal.strm.is_htx". |
| 18982 | |
| 18983 | internal.htx.data : integer |
| 18984 | Returns the size in bytes used by data in the HTX message associated to a |
| 18985 | channel. The channel is chosen depending on the sample direction. |
| 18986 | |
| 18987 | internal.htx.free : integer |
| 18988 | Returns the free space (size - used) in bytes in the HTX message associated |
| 18989 | to a channel. The channel is chosen depending on the sample direction. |
| 18990 | |
| 18991 | internal.htx.free_data : integer |
| 18992 | Returns the free space for the data in bytes in the HTX message associated to |
| 18993 | a channel. The channel is chosen depending on the sample direction. |
| 18994 | |
| 18995 | internal.htx.has_eom : boolean |
| 18996 | Returns true if the HTX message associated to a channel contains an |
| 18997 | end-of-message block (EOM). Otherwise, it returns false. The channel is |
| 18998 | chosen depending on the sample direction. |
| 18999 | |
| 19000 | internal.htx.nbblks : integer |
| 19001 | Returns the number of blocks present in the HTX message associated to a |
| 19002 | channel. The channel is chosen depending on the sample direction. |
| 19003 | |
| 19004 | internal.htx.size : integer |
| 19005 | Returns the total size in bytes of the HTX message associated to a |
| 19006 | channel. The channel is chosen depending on the sample direction. |
| 19007 | |
| 19008 | internal.htx.used : integer |
| 19009 | Returns the total size used in bytes (data + metadata) in the HTX message |
| 19010 | associated to a channel. The channel is chosen depending on the sample |
| 19011 | direction. |
| 19012 | |
| 19013 | internal.htx_blk.size(<idx>) : integer |
| 19014 | Returns the size of the block at the position <idx> in the HTX message |
| 19015 | associated to a channel or 0 if it does not exist. The channel is chosen |
| 19016 | depending on the sample direction. <idx> may be any positive integer or one |
| 19017 | of the special value : |
| 19018 | * head : The oldest inserted block |
| 19019 | * tail : The newest inserted block |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 19020 | * first : The first block where to (re)start the analysis |
Christopher Faulet | d47941d | 2020-01-08 14:40:19 +0100 | [diff] [blame] | 19021 | |
| 19022 | internal.htx_blk.type(<idx>) : string |
| 19023 | Returns the type of the block at the position <idx> in the HTX message |
| 19024 | associated to a channel or "HTX_BLK_UNUSED" if it does not exist. The channel |
| 19025 | is chosen depending on the sample direction. <idx> may be any positive |
| 19026 | integer or one of the special value : |
| 19027 | * head : The oldest inserted block |
| 19028 | * tail : The newest inserted block |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 19029 | * first : The first block where to (re)start the analysis |
Christopher Faulet | d47941d | 2020-01-08 14:40:19 +0100 | [diff] [blame] | 19030 | |
| 19031 | internal.htx_blk.data(<idx>) : binary |
| 19032 | Returns the value of the DATA block at the position <idx> in the HTX message |
| 19033 | associated to a channel or an empty string if it does not exist or if it is |
| 19034 | not a DATA block. The channel is chosen depending on the sample direction. |
| 19035 | <idx> may be any positive integer or one of the special value : |
| 19036 | |
| 19037 | * head : The oldest inserted block |
| 19038 | * tail : The newest inserted block |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 19039 | * first : The first block where to (re)start the analysis |
Christopher Faulet | d47941d | 2020-01-08 14:40:19 +0100 | [diff] [blame] | 19040 | |
| 19041 | internal.htx_blk.hdrname(<idx>) : string |
| 19042 | Returns the header name of the HEADER block at the position <idx> in the HTX |
| 19043 | message associated to a channel or an empty string if it does not exist or if |
| 19044 | it is not an HEADER block. The channel is chosen depending on the sample |
| 19045 | direction. <idx> may be any positive integer or one of the special value : |
| 19046 | |
| 19047 | * head : The oldest inserted block |
| 19048 | * tail : The newest inserted block |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 19049 | * first : The first block where to (re)start the analysis |
Christopher Faulet | d47941d | 2020-01-08 14:40:19 +0100 | [diff] [blame] | 19050 | |
| 19051 | internal.htx_blk.hdrval(<idx>) : string |
| 19052 | Returns the header value of the HEADER block at the position <idx> in the HTX |
| 19053 | message associated to a channel or an empty string if it does not exist or if |
| 19054 | it is not an HEADER block. The channel is chosen depending on the sample |
| 19055 | direction. <idx> may be any positive integer or one of the special value : |
| 19056 | |
| 19057 | * head : The oldest inserted block |
| 19058 | * tail : The newest inserted block |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 19059 | * first : The first block where to (re)start the analysis |
Christopher Faulet | d47941d | 2020-01-08 14:40:19 +0100 | [diff] [blame] | 19060 | |
| 19061 | internal.htx_blk.start_line(<idx>) : string |
| 19062 | Returns the value of the REQ_SL or RES_SL block at the position <idx> in the |
| 19063 | HTX message associated to a channel or an empty string if it does not exist |
| 19064 | or if it is not a SL block. The channel is chosen depending on the sample |
| 19065 | direction. <idx> may be any positive integer or one of the special value : |
| 19066 | |
| 19067 | * head : The oldest inserted block |
| 19068 | * tail : The newest inserted block |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 19069 | * first : The first block where to (re)start the analysis |
Christopher Faulet | d47941d | 2020-01-08 14:40:19 +0100 | [diff] [blame] | 19070 | |
| 19071 | internal.strm.is_htx : boolean |
| 19072 | Returns true if the current stream is an HTX stream. It means the data in the |
| 19073 | channels buffers are stored using the internal HTX representation. Otherwise, |
| 19074 | it returns false. |
| 19075 | |
| 19076 | |
Willy Tarreau | 74ca504 | 2013-06-11 23:12:07 +0200 | [diff] [blame] | 19077 | 7.4. Pre-defined ACLs |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19078 | --------------------- |
Willy Tarreau | ced2701 | 2008-01-17 20:35:34 +0100 | [diff] [blame] | 19079 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19080 | Some predefined ACLs are hard-coded so that they do not have to be declared in |
| 19081 | every frontend which needs them. They all have their names in upper case in |
Patrick Mézard | 2382ad6 | 2010-05-09 10:43:32 +0200 | [diff] [blame] | 19082 | order to avoid confusion. Their equivalence is provided below. |
Willy Tarreau | ced2701 | 2008-01-17 20:35:34 +0100 | [diff] [blame] | 19083 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19084 | ACL name Equivalent to Usage |
| 19085 | ---------------+-----------------------------+--------------------------------- |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19086 | FALSE always_false never match |
Willy Tarreau | 2492d5b | 2009-07-11 00:06:00 +0200 | [diff] [blame] | 19087 | HTTP req_proto_http match if protocol is valid HTTP |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19088 | HTTP_1.0 req_ver 1.0 match HTTP version 1.0 |
| 19089 | HTTP_1.1 req_ver 1.1 match HTTP version 1.1 |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 19090 | HTTP_CONTENT hdr_val(content-length) gt 0 match an existing content-length |
| 19091 | HTTP_URL_ABS url_reg ^[^/:]*:// match absolute URL with scheme |
| 19092 | HTTP_URL_SLASH url_beg / match URL beginning with "/" |
| 19093 | HTTP_URL_STAR url * match URL equal to "*" |
| 19094 | LOCALHOST src 127.0.0.1/8 match connection from local host |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19095 | METH_CONNECT method CONNECT match HTTP CONNECT method |
Daniel Schneller | 9ff96c7 | 2016-04-11 17:45:29 +0200 | [diff] [blame] | 19096 | METH_DELETE method DELETE match HTTP DELETE method |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19097 | METH_GET method GET HEAD match HTTP GET or HEAD method |
| 19098 | METH_HEAD method HEAD match HTTP HEAD method |
| 19099 | METH_OPTIONS method OPTIONS match HTTP OPTIONS method |
| 19100 | METH_POST method POST match HTTP POST method |
Daniel Schneller | 9ff96c7 | 2016-04-11 17:45:29 +0200 | [diff] [blame] | 19101 | METH_PUT method PUT match HTTP PUT method |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19102 | METH_TRACE method TRACE match HTTP TRACE method |
Emeric Brun | bede3d0 | 2009-06-30 17:54:00 +0200 | [diff] [blame] | 19103 | RDP_COOKIE req_rdp_cookie_cnt gt 0 match presence of an RDP cookie |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19104 | REQ_CONTENT req_len gt 0 match data in the request buffer |
Willy Tarreau | d63335a | 2010-02-26 12:56:52 +0100 | [diff] [blame] | 19105 | TRUE always_true always match |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19106 | WAIT_END wait_end wait for end of content analysis |
| 19107 | ---------------+-----------------------------+--------------------------------- |
Willy Tarreau | ced2701 | 2008-01-17 20:35:34 +0100 | [diff] [blame] | 19108 | |
Willy Tarreau | b937b7e | 2010-01-12 15:27:54 +0100 | [diff] [blame] | 19109 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19110 | 8. Logging |
| 19111 | ---------- |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 19112 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19113 | One of HAProxy's strong points certainly lies is its precise logs. It probably |
| 19114 | provides the finest level of information available for such a product, which is |
| 19115 | very important for troubleshooting complex environments. Standard information |
| 19116 | provided in logs include client ports, TCP/HTTP state timers, precise session |
| 19117 | state at termination and precise termination cause, information about decisions |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 19118 | to direct traffic to a server, and of course the ability to capture arbitrary |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19119 | headers. |
| 19120 | |
| 19121 | In order to improve administrators reactivity, it offers a great transparency |
| 19122 | about encountered problems, both internal and external, and it is possible to |
| 19123 | send logs to different sources at the same time with different level filters : |
| 19124 | |
| 19125 | - global process-level logs (system errors, start/stop, etc..) |
| 19126 | - per-instance system and internal errors (lack of resource, bugs, ...) |
| 19127 | - per-instance external troubles (servers up/down, max connections) |
| 19128 | - per-instance activity (client connections), either at the establishment or |
| 19129 | at the termination. |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19130 | - per-request control of log-level, e.g. |
Jim Freeman | 9e8714b | 2015-05-26 09:16:34 -0600 | [diff] [blame] | 19131 | http-request set-log-level silent if sensitive_request |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19132 | |
| 19133 | The ability to distribute different levels of logs to different log servers |
| 19134 | allow several production teams to interact and to fix their problems as soon |
| 19135 | as possible. For example, the system team might monitor system-wide errors, |
| 19136 | while the application team might be monitoring the up/down for their servers in |
| 19137 | real time, and the security team might analyze the activity logs with one hour |
| 19138 | delay. |
| 19139 | |
| 19140 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19141 | 8.1. Log levels |
| 19142 | --------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19143 | |
Simon Horman | df791f5 | 2011-05-29 15:01:10 +0900 | [diff] [blame] | 19144 | TCP and HTTP connections can be logged with information such as the date, time, |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19145 | source IP address, destination address, connection duration, response times, |
Simon Horman | df791f5 | 2011-05-29 15:01:10 +0900 | [diff] [blame] | 19146 | HTTP request, HTTP return code, number of bytes transmitted, conditions |
| 19147 | in which the session ended, and even exchanged cookies values. For example |
| 19148 | track a particular user's problems. All messages may be sent to up to two |
| 19149 | syslog servers. Check the "log" keyword in section 4.2 for more information |
| 19150 | about log facilities. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19151 | |
| 19152 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19153 | 8.2. Log formats |
| 19154 | ---------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19155 | |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19156 | HAProxy supports 5 log formats. Several fields are common between these formats |
Simon Horman | df791f5 | 2011-05-29 15:01:10 +0900 | [diff] [blame] | 19157 | and will be detailed in the following sections. A few of them may vary |
| 19158 | slightly with the configuration, due to indicators specific to certain |
| 19159 | options. The supported formats are as follows : |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19160 | |
| 19161 | - the default format, which is very basic and very rarely used. It only |
| 19162 | provides very basic information about the incoming connection at the moment |
| 19163 | it is accepted : source IP:port, destination IP:port, and frontend-name. |
| 19164 | This mode will eventually disappear so it will not be described to great |
| 19165 | extents. |
| 19166 | |
| 19167 | - the TCP format, which is more advanced. This format is enabled when "option |
| 19168 | tcplog" is set on the frontend. HAProxy will then usually wait for the |
| 19169 | connection to terminate before logging. This format provides much richer |
| 19170 | information, such as timers, connection counts, queue size, etc... This |
| 19171 | format is recommended for pure TCP proxies. |
| 19172 | |
| 19173 | - the HTTP format, which is the most advanced for HTTP proxying. This format |
| 19174 | is enabled when "option httplog" is set on the frontend. It provides the |
| 19175 | same information as the TCP format with some HTTP-specific fields such as |
| 19176 | the request, the status code, and captures of headers and cookies. This |
| 19177 | format is recommended for HTTP proxies. |
| 19178 | |
Emeric Brun | 3a058f3 | 2009-06-30 18:26:00 +0200 | [diff] [blame] | 19179 | - the CLF HTTP format, which is equivalent to the HTTP format, but with the |
| 19180 | fields arranged in the same order as the CLF format. In this mode, all |
| 19181 | timers, captures, flags, etc... appear one per field after the end of the |
| 19182 | common fields, in the same order they appear in the standard HTTP format. |
| 19183 | |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19184 | - the custom log format, allows you to make your own log line. |
| 19185 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19186 | Next sections will go deeper into details for each of these formats. Format |
| 19187 | specification will be performed on a "field" basis. Unless stated otherwise, a |
| 19188 | field is a portion of text delimited by any number of spaces. Since syslog |
| 19189 | servers are susceptible of inserting fields at the beginning of a line, it is |
| 19190 | always assumed that the first field is the one containing the process name and |
| 19191 | identifier. |
| 19192 | |
| 19193 | Note : Since log lines may be quite long, the log examples in sections below |
| 19194 | might be broken into multiple lines. The example log lines will be |
| 19195 | prefixed with 3 closing angle brackets ('>>>') and each time a log is |
| 19196 | broken into multiple lines, each non-final line will end with a |
| 19197 | backslash ('\') and the next line will start indented by two characters. |
| 19198 | |
| 19199 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19200 | 8.2.1. Default log format |
| 19201 | ------------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19202 | |
| 19203 | This format is used when no specific option is set. The log is emitted as soon |
| 19204 | as the connection is accepted. One should note that this currently is the only |
| 19205 | format which logs the request's destination IP and ports. |
| 19206 | |
| 19207 | Example : |
| 19208 | listen www |
| 19209 | mode http |
| 19210 | log global |
| 19211 | server srv1 127.0.0.1:8000 |
| 19212 | |
| 19213 | >>> Feb 6 12:12:09 localhost \ |
| 19214 | haproxy[14385]: Connect from 10.0.1.2:33312 to 10.0.3.31:8012 \ |
| 19215 | (www/HTTP) |
| 19216 | |
| 19217 | Field Format Extract from the example above |
| 19218 | 1 process_name '[' pid ']:' haproxy[14385]: |
| 19219 | 2 'Connect from' Connect from |
| 19220 | 3 source_ip ':' source_port 10.0.1.2:33312 |
| 19221 | 4 'to' to |
| 19222 | 5 destination_ip ':' destination_port 10.0.3.31:8012 |
| 19223 | 6 '(' frontend_name '/' mode ')' (www/HTTP) |
| 19224 | |
| 19225 | Detailed fields description : |
| 19226 | - "source_ip" is the IP address of the client which initiated the connection. |
| 19227 | - "source_port" is the TCP port of the client which initiated the connection. |
| 19228 | - "destination_ip" is the IP address the client connected to. |
| 19229 | - "destination_port" is the TCP port the client connected to. |
| 19230 | - "frontend_name" is the name of the frontend (or listener) which received |
| 19231 | and processed the connection. |
| 19232 | - "mode is the mode the frontend is operating (TCP or HTTP). |
| 19233 | |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 19234 | In case of a UNIX socket, the source and destination addresses are marked as |
| 19235 | "unix:" and the ports reflect the internal ID of the socket which accepted the |
| 19236 | connection (the same ID as reported in the stats). |
| 19237 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19238 | It is advised not to use this deprecated format for newer installations as it |
| 19239 | will eventually disappear. |
| 19240 | |
| 19241 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19242 | 8.2.2. TCP log format |
| 19243 | --------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19244 | |
| 19245 | The TCP format is used when "option tcplog" is specified in the frontend, and |
| 19246 | is the recommended format for pure TCP proxies. It provides a lot of precious |
| 19247 | information for troubleshooting. Since this format includes timers and byte |
| 19248 | counts, the log is normally emitted at the end of the session. It can be |
| 19249 | emitted earlier if "option logasap" is specified, which makes sense in most |
| 19250 | environments with long sessions such as remote terminals. Sessions which match |
| 19251 | the "monitor" rules are never logged. It is also possible not to emit logs for |
| 19252 | sessions for which no data were exchanged between the client and the server, by |
Willy Tarreau | c9bd0cc | 2009-05-10 11:57:02 +0200 | [diff] [blame] | 19253 | specifying "option dontlognull" in the frontend. Successful connections will |
| 19254 | not be logged if "option dontlog-normal" is specified in the frontend. A few |
| 19255 | fields may slightly vary depending on some configuration options, those are |
| 19256 | marked with a star ('*') after the field name below. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19257 | |
| 19258 | Example : |
| 19259 | frontend fnt |
| 19260 | mode tcp |
| 19261 | option tcplog |
| 19262 | log global |
| 19263 | default_backend bck |
| 19264 | |
| 19265 | backend bck |
| 19266 | server srv1 127.0.0.1:8000 |
| 19267 | |
| 19268 | >>> Feb 6 12:12:56 localhost \ |
| 19269 | haproxy[14387]: 10.0.1.2:33313 [06/Feb/2009:12:12:51.443] fnt \ |
| 19270 | bck/srv1 0/0/5007 212 -- 0/0/0/0/3 0/0 |
| 19271 | |
| 19272 | Field Format Extract from the example above |
| 19273 | 1 process_name '[' pid ']:' haproxy[14387]: |
| 19274 | 2 client_ip ':' client_port 10.0.1.2:33313 |
| 19275 | 3 '[' accept_date ']' [06/Feb/2009:12:12:51.443] |
| 19276 | 4 frontend_name fnt |
| 19277 | 5 backend_name '/' server_name bck/srv1 |
| 19278 | 6 Tw '/' Tc '/' Tt* 0/0/5007 |
| 19279 | 7 bytes_read* 212 |
| 19280 | 8 termination_state -- |
| 19281 | 9 actconn '/' feconn '/' beconn '/' srv_conn '/' retries* 0/0/0/0/3 |
| 19282 | 10 srv_queue '/' backend_queue 0/0 |
| 19283 | |
| 19284 | Detailed fields description : |
| 19285 | - "client_ip" is the IP address of the client which initiated the TCP |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 19286 | connection to haproxy. If the connection was accepted on a UNIX socket |
| 19287 | instead, the IP address would be replaced with the word "unix". Note that |
| 19288 | when the connection is accepted on a socket configured with "accept-proxy" |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 19289 | and the PROXY protocol is correctly used, or with a "accept-netscaler-cip" |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19290 | and the NetScaler Client IP insertion protocol is correctly used, then the |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 19291 | logs will reflect the forwarded connection's information. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19292 | |
| 19293 | - "client_port" is the TCP port of the client which initiated the connection. |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 19294 | If the connection was accepted on a UNIX socket instead, the port would be |
| 19295 | replaced with the ID of the accepting socket, which is also reported in the |
| 19296 | stats interface. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19297 | |
| 19298 | - "accept_date" is the exact date when the connection was received by haproxy |
| 19299 | (which might be very slightly different from the date observed on the |
| 19300 | network if there was some queuing in the system's backlog). This is usually |
Willy Tarreau | 590a051 | 2018-09-05 11:56:48 +0200 | [diff] [blame] | 19301 | the same date which may appear in any upstream firewall's log. When used in |
| 19302 | HTTP mode, the accept_date field will be reset to the first moment the |
| 19303 | connection is ready to receive a new request (end of previous response for |
| 19304 | HTTP/1, immediately after previous request for HTTP/2). |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19305 | |
| 19306 | - "frontend_name" is the name of the frontend (or listener) which received |
| 19307 | and processed the connection. |
| 19308 | |
| 19309 | - "backend_name" is the name of the backend (or listener) which was selected |
| 19310 | to manage the connection to the server. This will be the same as the |
| 19311 | frontend if no switching rule has been applied, which is common for TCP |
| 19312 | applications. |
| 19313 | |
| 19314 | - "server_name" is the name of the last server to which the connection was |
| 19315 | sent, which might differ from the first one if there were connection errors |
| 19316 | and a redispatch occurred. Note that this server belongs to the backend |
| 19317 | which processed the request. If the connection was aborted before reaching |
| 19318 | a server, "<NOSRV>" is indicated instead of a server name. |
| 19319 | |
| 19320 | - "Tw" is the total time in milliseconds spent waiting in the various queues. |
| 19321 | It can be "-1" if the connection was aborted before reaching the queue. |
| 19322 | See "Timers" below for more details. |
| 19323 | |
| 19324 | - "Tc" is the total time in milliseconds spent waiting for the connection to |
| 19325 | establish to the final server, including retries. It can be "-1" if the |
| 19326 | connection was aborted before a connection could be established. See |
| 19327 | "Timers" below for more details. |
| 19328 | |
| 19329 | - "Tt" is the total time in milliseconds elapsed between the accept and the |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 19330 | last close. It covers all possible processing. There is one exception, if |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19331 | "option logasap" was specified, then the time counting stops at the moment |
| 19332 | the log is emitted. In this case, a '+' sign is prepended before the value, |
| 19333 | indicating that the final one will be larger. See "Timers" below for more |
| 19334 | details. |
| 19335 | |
| 19336 | - "bytes_read" is the total number of bytes transmitted from the server to |
| 19337 | the client when the log is emitted. If "option logasap" is specified, the |
| 19338 | this value will be prefixed with a '+' sign indicating that the final one |
| 19339 | may be larger. Please note that this value is a 64-bit counter, so log |
| 19340 | analysis tools must be able to handle it without overflowing. |
| 19341 | |
| 19342 | - "termination_state" is the condition the session was in when the session |
| 19343 | ended. This indicates the session state, which side caused the end of |
| 19344 | session to happen, and for what reason (timeout, error, ...). The normal |
| 19345 | flags should be "--", indicating the session was closed by either end with |
| 19346 | no data remaining in buffers. See below "Session state at disconnection" |
| 19347 | for more details. |
| 19348 | |
| 19349 | - "actconn" is the total number of concurrent connections on the process when |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 19350 | the session was logged. It is useful to detect when some per-process system |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19351 | limits have been reached. For instance, if actconn is close to 512 when |
| 19352 | multiple connection errors occur, chances are high that the system limits |
| 19353 | the process to use a maximum of 1024 file descriptors and that all of them |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19354 | are used. See section 3 "Global parameters" to find how to tune the system. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19355 | |
| 19356 | - "feconn" is the total number of concurrent connections on the frontend when |
| 19357 | the session was logged. It is useful to estimate the amount of resource |
| 19358 | required to sustain high loads, and to detect when the frontend's "maxconn" |
| 19359 | has been reached. Most often when this value increases by huge jumps, it is |
| 19360 | because there is congestion on the backend servers, but sometimes it can be |
| 19361 | caused by a denial of service attack. |
| 19362 | |
| 19363 | - "beconn" is the total number of concurrent connections handled by the |
| 19364 | backend when the session was logged. It includes the total number of |
| 19365 | concurrent connections active on servers as well as the number of |
| 19366 | connections pending in queues. It is useful to estimate the amount of |
| 19367 | additional servers needed to support high loads for a given application. |
| 19368 | Most often when this value increases by huge jumps, it is because there is |
| 19369 | congestion on the backend servers, but sometimes it can be caused by a |
| 19370 | denial of service attack. |
| 19371 | |
| 19372 | - "srv_conn" is the total number of concurrent connections still active on |
| 19373 | the server when the session was logged. It can never exceed the server's |
| 19374 | configured "maxconn" parameter. If this value is very often close or equal |
| 19375 | to the server's "maxconn", it means that traffic regulation is involved a |
| 19376 | lot, meaning that either the server's maxconn value is too low, or that |
| 19377 | there aren't enough servers to process the load with an optimal response |
| 19378 | time. When only one of the server's "srv_conn" is high, it usually means |
| 19379 | that this server has some trouble causing the connections to take longer to |
| 19380 | be processed than on other servers. |
| 19381 | |
| 19382 | - "retries" is the number of connection retries experienced by this session |
| 19383 | when trying to connect to the server. It must normally be zero, unless a |
| 19384 | server is being stopped at the same moment the connection was attempted. |
| 19385 | Frequent retries generally indicate either a network problem between |
| 19386 | haproxy and the server, or a misconfigured system backlog on the server |
| 19387 | preventing new connections from being queued. This field may optionally be |
| 19388 | prefixed with a '+' sign, indicating that the session has experienced a |
| 19389 | redispatch after the maximal retry count has been reached on the initial |
| 19390 | server. In this case, the server name appearing in the log is the one the |
| 19391 | connection was redispatched to, and not the first one, though both may |
| 19392 | sometimes be the same in case of hashing for instance. So as a general rule |
| 19393 | of thumb, when a '+' is present in front of the retry count, this count |
| 19394 | should not be attributed to the logged server. |
| 19395 | |
| 19396 | - "srv_queue" is the total number of requests which were processed before |
| 19397 | this one in the server queue. It is zero when the request has not gone |
| 19398 | through the server queue. It makes it possible to estimate the approximate |
| 19399 | server's response time by dividing the time spent in queue by the number of |
| 19400 | requests in the queue. It is worth noting that if a session experiences a |
| 19401 | redispatch and passes through two server queues, their positions will be |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19402 | cumulative. A request should not pass through both the server queue and the |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19403 | backend queue unless a redispatch occurs. |
| 19404 | |
| 19405 | - "backend_queue" is the total number of requests which were processed before |
| 19406 | this one in the backend's global queue. It is zero when the request has not |
| 19407 | gone through the global queue. It makes it possible to estimate the average |
| 19408 | queue length, which easily translates into a number of missing servers when |
| 19409 | divided by a server's "maxconn" parameter. It is worth noting that if a |
| 19410 | session experiences a redispatch, it may pass twice in the backend's queue, |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19411 | and then both positions will be cumulative. A request should not pass |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19412 | through both the server queue and the backend queue unless a redispatch |
| 19413 | occurs. |
| 19414 | |
| 19415 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19416 | 8.2.3. HTTP log format |
| 19417 | ---------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19418 | |
| 19419 | The HTTP format is the most complete and the best suited for HTTP proxies. It |
| 19420 | is enabled by when "option httplog" is specified in the frontend. It provides |
| 19421 | the same level of information as the TCP format with additional features which |
| 19422 | are specific to the HTTP protocol. Just like the TCP format, the log is usually |
| 19423 | emitted at the end of the session, unless "option logasap" is specified, which |
| 19424 | generally only makes sense for download sites. A session which matches the |
| 19425 | "monitor" rules will never logged. It is also possible not to log sessions for |
| 19426 | which no data were sent by the client by specifying "option dontlognull" in the |
Willy Tarreau | c9bd0cc | 2009-05-10 11:57:02 +0200 | [diff] [blame] | 19427 | frontend. Successful connections will not be logged if "option dontlog-normal" |
| 19428 | is specified in the frontend. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19429 | |
| 19430 | Most fields are shared with the TCP log, some being different. A few fields may |
| 19431 | slightly vary depending on some configuration options. Those ones are marked |
| 19432 | with a star ('*') after the field name below. |
| 19433 | |
| 19434 | Example : |
| 19435 | frontend http-in |
| 19436 | mode http |
| 19437 | option httplog |
| 19438 | log global |
| 19439 | default_backend bck |
| 19440 | |
| 19441 | backend static |
| 19442 | server srv1 127.0.0.1:8000 |
| 19443 | |
| 19444 | >>> Feb 6 12:14:14 localhost \ |
| 19445 | haproxy[14389]: 10.0.1.2:33317 [06/Feb/2009:12:14:14.655] http-in \ |
| 19446 | static/srv1 10/0/30/69/109 200 2750 - - ---- 1/1/1/1/0 0/0 {1wt.eu} \ |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 19447 | {} "GET /index.html HTTP/1.1" |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19448 | |
| 19449 | Field Format Extract from the example above |
| 19450 | 1 process_name '[' pid ']:' haproxy[14389]: |
| 19451 | 2 client_ip ':' client_port 10.0.1.2:33317 |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19452 | 3 '[' request_date ']' [06/Feb/2009:12:14:14.655] |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19453 | 4 frontend_name http-in |
| 19454 | 5 backend_name '/' server_name static/srv1 |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19455 | 6 TR '/' Tw '/' Tc '/' Tr '/' Ta* 10/0/30/69/109 |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19456 | 7 status_code 200 |
| 19457 | 8 bytes_read* 2750 |
| 19458 | 9 captured_request_cookie - |
| 19459 | 10 captured_response_cookie - |
| 19460 | 11 termination_state ---- |
| 19461 | 12 actconn '/' feconn '/' beconn '/' srv_conn '/' retries* 1/1/1/1/0 |
| 19462 | 13 srv_queue '/' backend_queue 0/0 |
| 19463 | 14 '{' captured_request_headers* '}' {haproxy.1wt.eu} |
| 19464 | 15 '{' captured_response_headers* '}' {} |
| 19465 | 16 '"' http_request '"' "GET /index.html HTTP/1.1" |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 19466 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19467 | Detailed fields description : |
| 19468 | - "client_ip" is the IP address of the client which initiated the TCP |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 19469 | connection to haproxy. If the connection was accepted on a UNIX socket |
| 19470 | instead, the IP address would be replaced with the word "unix". Note that |
| 19471 | when the connection is accepted on a socket configured with "accept-proxy" |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 19472 | and the PROXY protocol is correctly used, or with a "accept-netscaler-cip" |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19473 | and the NetScaler Client IP insertion protocol is correctly used, then the |
Bertrand Jacquin | 93b227d | 2016-06-04 15:11:10 +0100 | [diff] [blame] | 19474 | logs will reflect the forwarded connection's information. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19475 | |
| 19476 | - "client_port" is the TCP port of the client which initiated the connection. |
Willy Tarreau | ceb24bc | 2010-11-09 12:46:41 +0100 | [diff] [blame] | 19477 | If the connection was accepted on a UNIX socket instead, the port would be |
| 19478 | replaced with the ID of the accepting socket, which is also reported in the |
| 19479 | stats interface. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19480 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19481 | - "request_date" is the exact date when the first byte of the HTTP request |
| 19482 | was received by haproxy (log field %tr). |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19483 | |
| 19484 | - "frontend_name" is the name of the frontend (or listener) which received |
| 19485 | and processed the connection. |
| 19486 | |
| 19487 | - "backend_name" is the name of the backend (or listener) which was selected |
| 19488 | to manage the connection to the server. This will be the same as the |
| 19489 | frontend if no switching rule has been applied. |
| 19490 | |
| 19491 | - "server_name" is the name of the last server to which the connection was |
| 19492 | sent, which might differ from the first one if there were connection errors |
| 19493 | and a redispatch occurred. Note that this server belongs to the backend |
| 19494 | which processed the request. If the request was aborted before reaching a |
| 19495 | server, "<NOSRV>" is indicated instead of a server name. If the request was |
| 19496 | intercepted by the stats subsystem, "<STATS>" is indicated instead. |
| 19497 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19498 | - "TR" is the total time in milliseconds spent waiting for a full HTTP |
| 19499 | request from the client (not counting body) after the first byte was |
| 19500 | received. It can be "-1" if the connection was aborted before a complete |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 19501 | request could be received or a bad request was received. It should |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19502 | always be very small because a request generally fits in one single packet. |
| 19503 | Large times here generally indicate network issues between the client and |
Willy Tarreau | 590a051 | 2018-09-05 11:56:48 +0200 | [diff] [blame] | 19504 | haproxy or requests being typed by hand. See section 8.4 "Timing Events" |
| 19505 | for more details. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19506 | |
| 19507 | - "Tw" is the total time in milliseconds spent waiting in the various queues. |
| 19508 | It can be "-1" if the connection was aborted before reaching the queue. |
Willy Tarreau | 590a051 | 2018-09-05 11:56:48 +0200 | [diff] [blame] | 19509 | See section 8.4 "Timing Events" for more details. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19510 | |
| 19511 | - "Tc" is the total time in milliseconds spent waiting for the connection to |
| 19512 | establish to the final server, including retries. It can be "-1" if the |
Willy Tarreau | 590a051 | 2018-09-05 11:56:48 +0200 | [diff] [blame] | 19513 | request was aborted before a connection could be established. See section |
| 19514 | 8.4 "Timing Events" for more details. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19515 | |
| 19516 | - "Tr" is the total time in milliseconds spent waiting for the server to send |
| 19517 | a full HTTP response, not counting data. It can be "-1" if the request was |
| 19518 | aborted before a complete response could be received. It generally matches |
| 19519 | the server's processing time for the request, though it may be altered by |
| 19520 | the amount of data sent by the client to the server. Large times here on |
Willy Tarreau | 590a051 | 2018-09-05 11:56:48 +0200 | [diff] [blame] | 19521 | "GET" requests generally indicate an overloaded server. See section 8.4 |
| 19522 | "Timing Events" for more details. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19523 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19524 | - "Ta" is the time the request remained active in haproxy, which is the total |
| 19525 | time in milliseconds elapsed between the first byte of the request was |
| 19526 | received and the last byte of response was sent. It covers all possible |
| 19527 | processing except the handshake (see Th) and idle time (see Ti). There is |
| 19528 | one exception, if "option logasap" was specified, then the time counting |
| 19529 | stops at the moment the log is emitted. In this case, a '+' sign is |
| 19530 | prepended before the value, indicating that the final one will be larger. |
Willy Tarreau | 590a051 | 2018-09-05 11:56:48 +0200 | [diff] [blame] | 19531 | See section 8.4 "Timing Events" for more details. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19532 | |
| 19533 | - "status_code" is the HTTP status code returned to the client. This status |
| 19534 | is generally set by the server, but it might also be set by haproxy when |
| 19535 | the server cannot be reached or when its response is blocked by haproxy. |
| 19536 | |
| 19537 | - "bytes_read" is the total number of bytes transmitted to the client when |
| 19538 | the log is emitted. This does include HTTP headers. If "option logasap" is |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 19539 | specified, this value will be prefixed with a '+' sign indicating that |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19540 | the final one may be larger. Please note that this value is a 64-bit |
| 19541 | counter, so log analysis tools must be able to handle it without |
| 19542 | overflowing. |
| 19543 | |
| 19544 | - "captured_request_cookie" is an optional "name=value" entry indicating that |
| 19545 | the client had this cookie in the request. The cookie name and its maximum |
| 19546 | length are defined by the "capture cookie" statement in the frontend |
| 19547 | configuration. The field is a single dash ('-') when the option is not |
| 19548 | set. Only one cookie may be captured, it is generally used to track session |
| 19549 | ID exchanges between a client and a server to detect session crossing |
| 19550 | between clients due to application bugs. For more details, please consult |
| 19551 | the section "Capturing HTTP headers and cookies" below. |
| 19552 | |
| 19553 | - "captured_response_cookie" is an optional "name=value" entry indicating |
| 19554 | that the server has returned a cookie with its response. The cookie name |
| 19555 | and its maximum length are defined by the "capture cookie" statement in the |
| 19556 | frontend configuration. The field is a single dash ('-') when the option is |
| 19557 | not set. Only one cookie may be captured, it is generally used to track |
| 19558 | session ID exchanges between a client and a server to detect session |
| 19559 | crossing between clients due to application bugs. For more details, please |
| 19560 | consult the section "Capturing HTTP headers and cookies" below. |
| 19561 | |
| 19562 | - "termination_state" is the condition the session was in when the session |
| 19563 | ended. This indicates the session state, which side caused the end of |
| 19564 | session to happen, for what reason (timeout, error, ...), just like in TCP |
| 19565 | logs, and information about persistence operations on cookies in the last |
| 19566 | two characters. The normal flags should begin with "--", indicating the |
| 19567 | session was closed by either end with no data remaining in buffers. See |
| 19568 | below "Session state at disconnection" for more details. |
| 19569 | |
| 19570 | - "actconn" is the total number of concurrent connections on the process when |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 19571 | the session was logged. It is useful to detect when some per-process system |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19572 | limits have been reached. For instance, if actconn is close to 512 or 1024 |
| 19573 | when multiple connection errors occur, chances are high that the system |
| 19574 | limits the process to use a maximum of 1024 file descriptors and that all |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19575 | of them are used. See section 3 "Global parameters" to find how to tune the |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19576 | system. |
| 19577 | |
| 19578 | - "feconn" is the total number of concurrent connections on the frontend when |
| 19579 | the session was logged. It is useful to estimate the amount of resource |
| 19580 | required to sustain high loads, and to detect when the frontend's "maxconn" |
| 19581 | has been reached. Most often when this value increases by huge jumps, it is |
| 19582 | because there is congestion on the backend servers, but sometimes it can be |
| 19583 | caused by a denial of service attack. |
| 19584 | |
| 19585 | - "beconn" is the total number of concurrent connections handled by the |
| 19586 | backend when the session was logged. It includes the total number of |
| 19587 | concurrent connections active on servers as well as the number of |
| 19588 | connections pending in queues. It is useful to estimate the amount of |
| 19589 | additional servers needed to support high loads for a given application. |
| 19590 | Most often when this value increases by huge jumps, it is because there is |
| 19591 | congestion on the backend servers, but sometimes it can be caused by a |
| 19592 | denial of service attack. |
| 19593 | |
| 19594 | - "srv_conn" is the total number of concurrent connections still active on |
| 19595 | the server when the session was logged. It can never exceed the server's |
| 19596 | configured "maxconn" parameter. If this value is very often close or equal |
| 19597 | to the server's "maxconn", it means that traffic regulation is involved a |
| 19598 | lot, meaning that either the server's maxconn value is too low, or that |
| 19599 | there aren't enough servers to process the load with an optimal response |
| 19600 | time. When only one of the server's "srv_conn" is high, it usually means |
| 19601 | that this server has some trouble causing the requests to take longer to be |
| 19602 | processed than on other servers. |
| 19603 | |
| 19604 | - "retries" is the number of connection retries experienced by this session |
| 19605 | when trying to connect to the server. It must normally be zero, unless a |
| 19606 | server is being stopped at the same moment the connection was attempted. |
| 19607 | Frequent retries generally indicate either a network problem between |
| 19608 | haproxy and the server, or a misconfigured system backlog on the server |
| 19609 | preventing new connections from being queued. This field may optionally be |
| 19610 | prefixed with a '+' sign, indicating that the session has experienced a |
| 19611 | redispatch after the maximal retry count has been reached on the initial |
| 19612 | server. In this case, the server name appearing in the log is the one the |
| 19613 | connection was redispatched to, and not the first one, though both may |
| 19614 | sometimes be the same in case of hashing for instance. So as a general rule |
| 19615 | of thumb, when a '+' is present in front of the retry count, this count |
| 19616 | should not be attributed to the logged server. |
| 19617 | |
| 19618 | - "srv_queue" is the total number of requests which were processed before |
| 19619 | this one in the server queue. It is zero when the request has not gone |
| 19620 | through the server queue. It makes it possible to estimate the approximate |
| 19621 | server's response time by dividing the time spent in queue by the number of |
| 19622 | requests in the queue. It is worth noting that if a session experiences a |
| 19623 | redispatch and passes through two server queues, their positions will be |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19624 | cumulative. A request should not pass through both the server queue and the |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19625 | backend queue unless a redispatch occurs. |
| 19626 | |
| 19627 | - "backend_queue" is the total number of requests which were processed before |
| 19628 | this one in the backend's global queue. It is zero when the request has not |
| 19629 | gone through the global queue. It makes it possible to estimate the average |
| 19630 | queue length, which easily translates into a number of missing servers when |
| 19631 | divided by a server's "maxconn" parameter. It is worth noting that if a |
| 19632 | session experiences a redispatch, it may pass twice in the backend's queue, |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19633 | and then both positions will be cumulative. A request should not pass |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19634 | through both the server queue and the backend queue unless a redispatch |
| 19635 | occurs. |
| 19636 | |
| 19637 | - "captured_request_headers" is a list of headers captured in the request due |
| 19638 | to the presence of the "capture request header" statement in the frontend. |
| 19639 | Multiple headers can be captured, they will be delimited by a vertical bar |
| 19640 | ('|'). When no capture is enabled, the braces do not appear, causing a |
| 19641 | shift of remaining fields. It is important to note that this field may |
| 19642 | contain spaces, and that using it requires a smarter log parser than when |
| 19643 | it's not used. Please consult the section "Capturing HTTP headers and |
| 19644 | cookies" below for more details. |
| 19645 | |
| 19646 | - "captured_response_headers" is a list of headers captured in the response |
| 19647 | due to the presence of the "capture response header" statement in the |
| 19648 | frontend. Multiple headers can be captured, they will be delimited by a |
| 19649 | vertical bar ('|'). When no capture is enabled, the braces do not appear, |
| 19650 | causing a shift of remaining fields. It is important to note that this |
| 19651 | field may contain spaces, and that using it requires a smarter log parser |
| 19652 | than when it's not used. Please consult the section "Capturing HTTP headers |
| 19653 | and cookies" below for more details. |
| 19654 | |
| 19655 | - "http_request" is the complete HTTP request line, including the method, |
| 19656 | request and HTTP version string. Non-printable characters are encoded (see |
| 19657 | below the section "Non-printable characters"). This is always the last |
| 19658 | field, and it is always delimited by quotes and is the only one which can |
| 19659 | contain quotes. If new fields are added to the log format, they will be |
| 19660 | added before this field. This field might be truncated if the request is |
| 19661 | huge and does not fit in the standard syslog buffer (1024 characters). This |
| 19662 | is the reason why this field must always remain the last one. |
| 19663 | |
| 19664 | |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 19665 | 8.2.4. Custom log format |
| 19666 | ------------------------ |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19667 | |
Willy Tarreau | 2beef58 | 2012-12-20 17:22:52 +0100 | [diff] [blame] | 19668 | The directive log-format allows you to customize the logs in http mode and tcp |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19669 | mode. It takes a string as argument. |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19670 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19671 | HAProxy understands some log format variables. % precedes log format variables. |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19672 | Variables can take arguments using braces ('{}'), and multiple arguments are |
| 19673 | separated by commas within the braces. Flags may be added or removed by |
| 19674 | prefixing them with a '+' or '-' sign. |
| 19675 | |
| 19676 | Special variable "%o" may be used to propagate its flags to all other |
| 19677 | variables on the same format string. This is particularly handy with quoted |
Dragan Dosen | 835b921 | 2016-02-12 13:23:03 +0100 | [diff] [blame] | 19678 | ("Q") and escaped ("E") string formats. |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19679 | |
Willy Tarreau | c836845 | 2012-12-21 00:09:23 +0100 | [diff] [blame] | 19680 | If a variable is named between square brackets ('[' .. ']') then it is used |
Willy Tarreau | be722a2 | 2014-06-13 16:31:59 +0200 | [diff] [blame] | 19681 | as a sample expression rule (see section 7.3). This it useful to add some |
Willy Tarreau | c836845 | 2012-12-21 00:09:23 +0100 | [diff] [blame] | 19682 | less common information such as the client's SSL certificate's DN, or to log |
| 19683 | the key that would be used to store an entry into a stick table. |
| 19684 | |
Dragan Dosen | 1e3b16f | 2020-06-23 18:16:44 +0200 | [diff] [blame] | 19685 | Note: spaces must be escaped. In configuration directives "log-format", |
| 19686 | "log-format-sd" and "unique-id-format", spaces are considered as |
| 19687 | delimiters and are merged. In order to emit a verbatim '%', it must be |
| 19688 | preceded by another '%' resulting in '%%'. |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19689 | |
Dragan Dosen | 835b921 | 2016-02-12 13:23:03 +0100 | [diff] [blame] | 19690 | Note: when using the RFC5424 syslog message format, the characters '"', |
| 19691 | '\' and ']' inside PARAM-VALUE should be escaped with '\' as prefix (see |
| 19692 | https://tools.ietf.org/html/rfc5424#section-6.3.3 for more details). In |
| 19693 | such cases, the use of the flag "E" should be considered. |
| 19694 | |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19695 | Flags are : |
| 19696 | * Q: quote a string |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 19697 | * X: hexadecimal representation (IPs, Ports, %Ts, %rt, %pid) |
Dragan Dosen | 835b921 | 2016-02-12 13:23:03 +0100 | [diff] [blame] | 19698 | * E: escape characters '"', '\' and ']' in a string with '\' as prefix |
| 19699 | (intended purpose is for the RFC5424 structured-data log formats) |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19700 | |
| 19701 | Example: |
| 19702 | |
| 19703 | log-format %T\ %t\ Some\ Text |
| 19704 | log-format %{+Q}o\ %t\ %s\ %{-Q}r |
| 19705 | |
Dragan Dosen | 835b921 | 2016-02-12 13:23:03 +0100 | [diff] [blame] | 19706 | log-format-sd %{+Q,+E}o\ [exampleSDID@1234\ header=%[capture.req.hdr(0)]] |
| 19707 | |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19708 | At the moment, the default HTTP format is defined this way : |
| 19709 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19710 | log-format "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC \ |
| 19711 | %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r" |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19712 | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19713 | the default CLF format is defined this way : |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19714 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19715 | log-format "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp \ |
| 19716 | %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc \ |
| 19717 | %bc %sc %rc %sq %bq %CC %CS %hrl %hsl" |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19718 | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19719 | and the default TCP format is defined this way : |
| 19720 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19721 | log-format "%ci:%cp [%t] %ft %b/%s %Tw/%Tc/%Tt %B %ts \ |
| 19722 | %ac/%fc/%bc/%sc/%rc %sq/%bq" |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19723 | |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19724 | Please refer to the table below for currently defined variables : |
| 19725 | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19726 | +---+------+-----------------------------------------------+-------------+ |
Willy Tarreau | ffc3fcd | 2012-10-12 20:17:54 +0200 | [diff] [blame] | 19727 | | R | var | field name (8.2.2 and 8.2.3 for description) | type | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19728 | +---+------+-----------------------------------------------+-------------+ |
| 19729 | | | %o | special variable, apply flags on all next var | | |
| 19730 | +---+------+-----------------------------------------------+-------------+ |
Willy Tarreau | 2beef58 | 2012-12-20 17:22:52 +0100 | [diff] [blame] | 19731 | | | %B | bytes_read (from server to client) | numeric | |
| 19732 | | H | %CC | captured_request_cookie | string | |
| 19733 | | H | %CS | captured_response_cookie | string | |
William Lallemand | 5f23240 | 2012-04-05 18:02:55 +0200 | [diff] [blame] | 19734 | | | %H | hostname | string | |
Andrew Hayworth | 0ebc55f | 2015-04-27 21:37:03 +0000 | [diff] [blame] | 19735 | | H | %HM | HTTP method (ex: POST) | string | |
Maciej Zdeb | 21acc33 | 2020-11-26 10:45:52 +0000 | [diff] [blame] | 19736 | | H | %HP | HTTP request URI without query string | string | |
Maciej Zdeb | fcdfd85 | 2020-11-30 18:27:47 +0000 | [diff] [blame] | 19737 | | H | %HPO | HTTP path only (without host nor query string)| string | |
Andrew Hayworth | e63ac87 | 2015-07-31 16:14:16 +0000 | [diff] [blame] | 19738 | | H | %HQ | HTTP request URI query string (ex: ?bar=baz) | string | |
Andrew Hayworth | 0ebc55f | 2015-04-27 21:37:03 +0000 | [diff] [blame] | 19739 | | H | %HU | HTTP request URI (ex: /foo?bar=baz) | string | |
| 19740 | | H | %HV | HTTP version (ex: HTTP/1.0) | string | |
William Lallemand | a73203e | 2012-03-12 12:48:57 +0100 | [diff] [blame] | 19741 | | | %ID | unique-id | string | |
Willy Tarreau | 4bf9963 | 2014-06-13 12:21:40 +0200 | [diff] [blame] | 19742 | | | %ST | status_code | numeric | |
William Lallemand | 5f23240 | 2012-04-05 18:02:55 +0200 | [diff] [blame] | 19743 | | | %T | gmt_date_time | date | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19744 | | | %Ta | Active time of the request (from TR to end) | numeric | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19745 | | | %Tc | Tc | numeric | |
Willy Tarreau | 27b639d | 2016-05-17 17:55:27 +0200 | [diff] [blame] | 19746 | | | %Td | Td = Tt - (Tq + Tw + Tc + Tr) | numeric | |
Yuxans Yao | 4e25b01 | 2012-10-19 10:36:09 +0800 | [diff] [blame] | 19747 | | | %Tl | local_date_time | date | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19748 | | | %Th | connection handshake time (SSL, PROXY proto) | numeric | |
| 19749 | | H | %Ti | idle time before the HTTP request | numeric | |
| 19750 | | H | %Tq | Th + Ti + TR | numeric | |
| 19751 | | H | %TR | time to receive the full request from 1st byte| numeric | |
| 19752 | | H | %Tr | Tr (response time) | numeric | |
William Lallemand | 5f23240 | 2012-04-05 18:02:55 +0200 | [diff] [blame] | 19753 | | | %Ts | timestamp | numeric | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19754 | | | %Tt | Tt | numeric | |
Damien Claisse | 57c8eb9 | 2020-04-28 12:09:19 +0000 | [diff] [blame] | 19755 | | | %Tu | Tu | numeric | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19756 | | | %Tw | Tw | numeric | |
Willy Tarreau | 2beef58 | 2012-12-20 17:22:52 +0100 | [diff] [blame] | 19757 | | | %U | bytes_uploaded (from client to server) | numeric | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19758 | | | %ac | actconn | numeric | |
| 19759 | | | %b | backend_name | string | |
Willy Tarreau | 2beef58 | 2012-12-20 17:22:52 +0100 | [diff] [blame] | 19760 | | | %bc | beconn (backend concurrent connections) | numeric | |
| 19761 | | | %bi | backend_source_ip (connecting address) | IP | |
| 19762 | | | %bp | backend_source_port (connecting address) | numeric | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19763 | | | %bq | backend_queue | numeric | |
Willy Tarreau | 2beef58 | 2012-12-20 17:22:52 +0100 | [diff] [blame] | 19764 | | | %ci | client_ip (accepted address) | IP | |
| 19765 | | | %cp | client_port (accepted address) | numeric | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19766 | | | %f | frontend_name | string | |
Willy Tarreau | 2beef58 | 2012-12-20 17:22:52 +0100 | [diff] [blame] | 19767 | | | %fc | feconn (frontend concurrent connections) | numeric | |
| 19768 | | | %fi | frontend_ip (accepting address) | IP | |
| 19769 | | | %fp | frontend_port (accepting address) | numeric | |
Willy Tarreau | 773d65f | 2012-10-12 14:56:11 +0200 | [diff] [blame] | 19770 | | | %ft | frontend_name_transport ('~' suffix for SSL) | string | |
Willy Tarreau | 7346acb | 2014-08-28 15:03:15 +0200 | [diff] [blame] | 19771 | | | %lc | frontend_log_counter | numeric | |
Willy Tarreau | d9ed3d2 | 2014-06-13 12:23:06 +0200 | [diff] [blame] | 19772 | | | %hr | captured_request_headers default style | string | |
| 19773 | | | %hrl | captured_request_headers CLF style | string list | |
| 19774 | | | %hs | captured_response_headers default style | string | |
| 19775 | | | %hsl | captured_response_headers CLF style | string list | |
Willy Tarreau | 812c88e | 2015-08-09 10:56:35 +0200 | [diff] [blame] | 19776 | | | %ms | accept date milliseconds (left-padded with 0) | numeric | |
William Lallemand | 5f23240 | 2012-04-05 18:02:55 +0200 | [diff] [blame] | 19777 | | | %pid | PID | numeric | |
Willy Tarreau | ffc3fcd | 2012-10-12 20:17:54 +0200 | [diff] [blame] | 19778 | | H | %r | http_request | string | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19779 | | | %rc | retries | numeric | |
Willy Tarreau | 1f0da24 | 2014-01-25 11:01:50 +0100 | [diff] [blame] | 19780 | | | %rt | request_counter (HTTP req or TCP session) | numeric | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19781 | | | %s | server_name | string | |
Willy Tarreau | 2beef58 | 2012-12-20 17:22:52 +0100 | [diff] [blame] | 19782 | | | %sc | srv_conn (server concurrent connections) | numeric | |
| 19783 | | | %si | server_IP (target address) | IP | |
| 19784 | | | %sp | server_port (target address) | numeric | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19785 | | | %sq | srv_queue | numeric | |
Willy Tarreau | ffc3fcd | 2012-10-12 20:17:54 +0200 | [diff] [blame] | 19786 | | S | %sslc| ssl_ciphers (ex: AES-SHA) | string | |
| 19787 | | S | %sslv| ssl_version (ex: TLSv1) | string | |
Willy Tarreau | 2beef58 | 2012-12-20 17:22:52 +0100 | [diff] [blame] | 19788 | | | %t | date_time (with millisecond resolution) | date | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19789 | | H | %tr | date_time of HTTP request | date | |
| 19790 | | H | %trg | gmt_date_time of start of HTTP request | date | |
Jens Bissinger | 15c64ff | 2018-08-23 14:11:27 +0200 | [diff] [blame] | 19791 | | H | %trl | local_date_time of start of HTTP request | date | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19792 | | | %ts | termination_state | string | |
Willy Tarreau | ffc3fcd | 2012-10-12 20:17:54 +0200 | [diff] [blame] | 19793 | | H | %tsc | termination_state with cookie status | string | |
William Lallemand | bddd4fd | 2012-02-27 11:23:10 +0100 | [diff] [blame] | 19794 | +---+------+-----------------------------------------------+-------------+ |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19795 | |
Willy Tarreau | ffc3fcd | 2012-10-12 20:17:54 +0200 | [diff] [blame] | 19796 | R = Restrictions : H = mode http only ; S = SSL only |
William Lallemand | 4894040 | 2012-01-30 16:47:22 +0100 | [diff] [blame] | 19797 | |
Willy Tarreau | 5f51e1a | 2012-12-03 18:40:10 +0100 | [diff] [blame] | 19798 | |
| 19799 | 8.2.5. Error log format |
| 19800 | ----------------------- |
| 19801 | |
| 19802 | When an incoming connection fails due to an SSL handshake or an invalid PROXY |
| 19803 | protocol header, haproxy will log the event using a shorter, fixed line format. |
| 19804 | By default, logs are emitted at the LOG_INFO level, unless the option |
| 19805 | "log-separate-errors" is set in the backend, in which case the LOG_ERR level |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19806 | will be used. Connections on which no data are exchanged (e.g. probes) are not |
Willy Tarreau | 5f51e1a | 2012-12-03 18:40:10 +0100 | [diff] [blame] | 19807 | logged if the "dontlognull" option is set. |
| 19808 | |
| 19809 | The format looks like this : |
| 19810 | |
| 19811 | >>> Dec 3 18:27:14 localhost \ |
| 19812 | haproxy[6103]: 127.0.0.1:56059 [03/Dec/2012:17:35:10.380] frt/f1: \ |
| 19813 | Connection error during SSL handshake |
| 19814 | |
| 19815 | Field Format Extract from the example above |
| 19816 | 1 process_name '[' pid ']:' haproxy[6103]: |
| 19817 | 2 client_ip ':' client_port 127.0.0.1:56059 |
| 19818 | 3 '[' accept_date ']' [03/Dec/2012:17:35:10.380] |
| 19819 | 4 frontend_name "/" bind_name ":" frt/f1: |
| 19820 | 5 message Connection error during SSL handshake |
| 19821 | |
| 19822 | These fields just provide minimal information to help debugging connection |
| 19823 | failures. |
| 19824 | |
| 19825 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19826 | 8.3. Advanced logging options |
| 19827 | ----------------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19828 | |
| 19829 | Some advanced logging options are often looked for but are not easy to find out |
| 19830 | just by looking at the various options. Here is an entry point for the few |
| 19831 | options which can enable better logging. Please refer to the keywords reference |
| 19832 | for more information about their usage. |
| 19833 | |
| 19834 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19835 | 8.3.1. Disabling logging of external tests |
| 19836 | ------------------------------------------ |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19837 | |
| 19838 | It is quite common to have some monitoring tools perform health checks on |
| 19839 | haproxy. Sometimes it will be a layer 3 load-balancer such as LVS or any |
| 19840 | commercial load-balancer, and sometimes it will simply be a more complete |
| 19841 | monitoring system such as Nagios. When the tests are very frequent, users often |
| 19842 | ask how to disable logging for those checks. There are three possibilities : |
| 19843 | |
| 19844 | - if connections come from everywhere and are just TCP probes, it is often |
| 19845 | desired to simply disable logging of connections without data exchange, by |
| 19846 | setting "option dontlognull" in the frontend. It also disables logging of |
| 19847 | port scans, which may or may not be desired. |
| 19848 | |
Willy Tarreau | 9e9919d | 2020-10-14 15:55:23 +0200 | [diff] [blame] | 19849 | - it is possible to use the "http-request set-log-level silent" action using |
| 19850 | a variety of conditions (source networks, paths, user-agents, etc). |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19851 | |
| 19852 | - if the tests are performed on a known URI, use "monitor-uri" to declare |
| 19853 | this URI as dedicated to monitoring. Any host sending this request will |
| 19854 | only get the result of a health-check, and the request will not be logged. |
| 19855 | |
| 19856 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19857 | 8.3.2. Logging before waiting for the session to terminate |
| 19858 | ---------------------------------------------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19859 | |
| 19860 | The problem with logging at end of connection is that you have no clue about |
| 19861 | what is happening during very long sessions, such as remote terminal sessions |
| 19862 | or large file downloads. This problem can be worked around by specifying |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19863 | "option logasap" in the frontend. HAProxy will then log as soon as possible, |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19864 | just before data transfer begins. This means that in case of TCP, it will still |
| 19865 | log the connection status to the server, and in case of HTTP, it will log just |
| 19866 | after processing the server headers. In this case, the number of bytes reported |
| 19867 | is the number of header bytes sent to the client. In order to avoid confusion |
| 19868 | with normal logs, the total time field and the number of bytes are prefixed |
| 19869 | with a '+' sign which means that real numbers are certainly larger. |
| 19870 | |
| 19871 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19872 | 8.3.3. Raising log level upon errors |
| 19873 | ------------------------------------ |
Willy Tarreau | c9bd0cc | 2009-05-10 11:57:02 +0200 | [diff] [blame] | 19874 | |
| 19875 | Sometimes it is more convenient to separate normal traffic from errors logs, |
| 19876 | for instance in order to ease error monitoring from log files. When the option |
| 19877 | "log-separate-errors" is used, connections which experience errors, timeouts, |
| 19878 | retries, redispatches or HTTP status codes 5xx will see their syslog level |
| 19879 | raised from "info" to "err". This will help a syslog daemon store the log in |
| 19880 | a separate file. It is very important to keep the errors in the normal traffic |
| 19881 | file too, so that log ordering is not altered. You should also be careful if |
| 19882 | you already have configured your syslog daemon to store all logs higher than |
| 19883 | "notice" in an "admin" file, because the "err" level is higher than "notice". |
| 19884 | |
| 19885 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19886 | 8.3.4. Disabling logging of successful connections |
| 19887 | -------------------------------------------------- |
Willy Tarreau | c9bd0cc | 2009-05-10 11:57:02 +0200 | [diff] [blame] | 19888 | |
| 19889 | Although this may sound strange at first, some large sites have to deal with |
| 19890 | multiple thousands of logs per second and are experiencing difficulties keeping |
| 19891 | them intact for a long time or detecting errors within them. If the option |
| 19892 | "dontlog-normal" is set on the frontend, all normal connections will not be |
| 19893 | logged. In this regard, a normal connection is defined as one without any |
| 19894 | error, timeout, retry nor redispatch. In HTTP, the status code is checked too, |
| 19895 | and a response with a status 5xx is not considered normal and will be logged |
| 19896 | too. Of course, doing is is really discouraged as it will remove most of the |
| 19897 | useful information from the logs. Do this only if you have no other |
| 19898 | alternative. |
| 19899 | |
| 19900 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 19901 | 8.4. Timing events |
| 19902 | ------------------ |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19903 | |
| 19904 | Timers provide a great help in troubleshooting network problems. All values are |
| 19905 | reported in milliseconds (ms). These timers should be used in conjunction with |
| 19906 | the session termination flags. In TCP mode with "option tcplog" set on the |
| 19907 | frontend, 3 control points are reported under the form "Tw/Tc/Tt", and in HTTP |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19908 | mode, 5 control points are reported under the form "TR/Tw/Tc/Tr/Ta". In |
| 19909 | addition, three other measures are provided, "Th", "Ti", and "Tq". |
| 19910 | |
Guillaume de Lafond | f27cddc | 2016-12-23 17:32:43 +0100 | [diff] [blame] | 19911 | Timings events in HTTP mode: |
| 19912 | |
| 19913 | first request 2nd request |
| 19914 | |<-------------------------------->|<-------------- ... |
| 19915 | t tr t tr ... |
| 19916 | ---|----|----|----|----|----|----|----|----|-- |
| 19917 | : Th Ti TR Tw Tc Tr Td : Ti ... |
| 19918 | :<---- Tq ---->: : |
| 19919 | :<-------------- Tt -------------->: |
Damien Claisse | 57c8eb9 | 2020-04-28 12:09:19 +0000 | [diff] [blame] | 19920 | :<-- -----Tu--------------->: |
Guillaume de Lafond | f27cddc | 2016-12-23 17:32:43 +0100 | [diff] [blame] | 19921 | :<--------- Ta --------->: |
| 19922 | |
| 19923 | Timings events in TCP mode: |
| 19924 | |
| 19925 | TCP session |
| 19926 | |<----------------->| |
| 19927 | t t |
| 19928 | ---|----|----|----|----|--- |
| 19929 | | Th Tw Tc Td | |
| 19930 | |<------ Tt ------->| |
| 19931 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19932 | - Th: total time to accept tcp connection and execute handshakes for low level |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19933 | protocols. Currently, these protocols are proxy-protocol and SSL. This may |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19934 | only happen once during the whole connection's lifetime. A large time here |
| 19935 | may indicate that the client only pre-established the connection without |
| 19936 | speaking, that it is experiencing network issues preventing it from |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19937 | completing a handshake in a reasonable time (e.g. MTU issues), or that an |
Willy Tarreau | 590a051 | 2018-09-05 11:56:48 +0200 | [diff] [blame] | 19938 | SSL handshake was very expensive to compute. Please note that this time is |
| 19939 | reported only before the first request, so it is safe to average it over |
| 19940 | all request to calculate the amortized value. The second and subsequent |
| 19941 | request will always report zero here. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19942 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19943 | - Ti: is the idle time before the HTTP request (HTTP mode only). This timer |
| 19944 | counts between the end of the handshakes and the first byte of the HTTP |
| 19945 | request. When dealing with a second request in keep-alive mode, it starts |
Willy Tarreau | 590a051 | 2018-09-05 11:56:48 +0200 | [diff] [blame] | 19946 | to count after the end of the transmission the previous response. When a |
| 19947 | multiplexed protocol such as HTTP/2 is used, it starts to count immediately |
| 19948 | after the previous request. Some browsers pre-establish connections to a |
| 19949 | server in order to reduce the latency of a future request, and keep them |
| 19950 | pending until they need it. This delay will be reported as the idle time. A |
| 19951 | value of -1 indicates that nothing was received on the connection. |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19952 | |
| 19953 | - TR: total time to get the client request (HTTP mode only). It's the time |
| 19954 | elapsed between the first bytes received and the moment the proxy received |
| 19955 | the empty line marking the end of the HTTP headers. The value "-1" |
| 19956 | indicates that the end of headers has never been seen. This happens when |
| 19957 | the client closes prematurely or times out. This time is usually very short |
| 19958 | since most requests fit in a single packet. A large time may indicate a |
| 19959 | request typed by hand during a test. |
| 19960 | |
| 19961 | - Tq: total time to get the client request from the accept date or since the |
| 19962 | emission of the last byte of the previous response (HTTP mode only). It's |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 19963 | exactly equal to Th + Ti + TR unless any of them is -1, in which case it |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19964 | returns -1 as well. This timer used to be very useful before the arrival of |
| 19965 | HTTP keep-alive and browsers' pre-connect feature. It's recommended to drop |
| 19966 | it in favor of TR nowadays, as the idle time adds a lot of noise to the |
| 19967 | reports. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 19968 | |
| 19969 | - Tw: total time spent in the queues waiting for a connection slot. It |
| 19970 | accounts for backend queue as well as the server queues, and depends on the |
| 19971 | queue size, and the time needed for the server to complete previous |
| 19972 | requests. The value "-1" means that the request was killed before reaching |
| 19973 | the queue, which is generally what happens with invalid or denied requests. |
| 19974 | |
| 19975 | - Tc: total time to establish the TCP connection to the server. It's the time |
| 19976 | elapsed between the moment the proxy sent the connection request, and the |
| 19977 | moment it was acknowledged by the server, or between the TCP SYN packet and |
| 19978 | the matching SYN/ACK packet in return. The value "-1" means that the |
| 19979 | connection never established. |
| 19980 | |
| 19981 | - Tr: server response time (HTTP mode only). It's the time elapsed between |
| 19982 | the moment the TCP connection was established to the server and the moment |
| 19983 | the server sent its complete response headers. It purely shows its request |
| 19984 | processing time, without the network overhead due to the data transmission. |
| 19985 | It is worth noting that when the client has data to send to the server, for |
| 19986 | instance during a POST request, the time already runs, and this can distort |
| 19987 | apparent response time. For this reason, it's generally wise not to trust |
| 19988 | too much this field for POST requests initiated from clients behind an |
| 19989 | untrusted network. A value of "-1" here means that the last the response |
| 19990 | header (empty line) was never seen, most likely because the server timeout |
| 19991 | stroke before the server managed to process the request. |
| 19992 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 19993 | - Ta: total active time for the HTTP request, between the moment the proxy |
| 19994 | received the first byte of the request header and the emission of the last |
| 19995 | byte of the response body. The exception is when the "logasap" option is |
| 19996 | specified. In this case, it only equals (TR+Tw+Tc+Tr), and is prefixed with |
| 19997 | a '+' sign. From this field, we can deduce "Td", the data transmission time, |
| 19998 | by subtracting other timers when valid : |
| 19999 | |
| 20000 | Td = Ta - (TR + Tw + Tc + Tr) |
| 20001 | |
| 20002 | Timers with "-1" values have to be excluded from this equation. Note that |
| 20003 | "Ta" can never be negative. |
| 20004 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20005 | - Tt: total session duration time, between the moment the proxy accepted it |
| 20006 | and the moment both ends were closed. The exception is when the "logasap" |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20007 | option is specified. In this case, it only equals (Th+Ti+TR+Tw+Tc+Tr), and |
| 20008 | is prefixed with a '+' sign. From this field, we can deduce "Td", the data |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 20009 | transmission time, by subtracting other timers when valid : |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20010 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20011 | Td = Tt - (Th + Ti + TR + Tw + Tc + Tr) |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20012 | |
| 20013 | Timers with "-1" values have to be excluded from this equation. In TCP |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20014 | mode, "Ti", "Tq" and "Tr" have to be excluded too. Note that "Tt" can never |
| 20015 | be negative and that for HTTP, Tt is simply equal to (Th+Ti+Ta). |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20016 | |
Damien Claisse | 57c8eb9 | 2020-04-28 12:09:19 +0000 | [diff] [blame] | 20017 | - Tu: total estimated time as seen from client, between the moment the proxy |
| 20018 | accepted it and the moment both ends were closed, without idle time. |
| 20019 | This is useful to roughly measure end-to-end time as a user would see it, |
| 20020 | without idle time pollution from keep-alive time between requests. This |
| 20021 | timer in only an estimation of time seen by user as it assumes network |
| 20022 | latency is the same in both directions. The exception is when the "logasap" |
| 20023 | option is specified. In this case, it only equals (Th+TR+Tw+Tc+Tr), and is |
| 20024 | prefixed with a '+' sign. |
| 20025 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20026 | These timers provide precious indications on trouble causes. Since the TCP |
| 20027 | protocol defines retransmit delays of 3, 6, 12... seconds, we know for sure |
| 20028 | that timers close to multiples of 3s are nearly always related to lost packets |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20029 | due to network problems (wires, negotiation, congestion). Moreover, if "Ta" or |
| 20030 | "Tt" is close to a timeout value specified in the configuration, it often means |
| 20031 | that a session has been aborted on timeout. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20032 | |
| 20033 | Most common cases : |
| 20034 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20035 | - If "Th" or "Ti" are close to 3000, a packet has probably been lost between |
| 20036 | the client and the proxy. This is very rare on local networks but might |
| 20037 | happen when clients are on far remote networks and send large requests. It |
| 20038 | may happen that values larger than usual appear here without any network |
| 20039 | cause. Sometimes, during an attack or just after a resource starvation has |
| 20040 | ended, haproxy may accept thousands of connections in a few milliseconds. |
| 20041 | The time spent accepting these connections will inevitably slightly delay |
| 20042 | processing of other connections, and it can happen that request times in the |
| 20043 | order of a few tens of milliseconds are measured after a few thousands of |
| 20044 | new connections have been accepted at once. Using one of the keep-alive |
| 20045 | modes may display larger idle times since "Ti" measures the time spent |
Patrick Mezard | 105faca | 2010-06-12 17:02:46 +0200 | [diff] [blame] | 20046 | waiting for additional requests. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20047 | |
| 20048 | - If "Tc" is close to 3000, a packet has probably been lost between the |
| 20049 | server and the proxy during the server connection phase. This value should |
| 20050 | always be very low, such as 1 ms on local networks and less than a few tens |
| 20051 | of ms on remote networks. |
| 20052 | |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 20053 | - If "Tr" is nearly always lower than 3000 except some rare values which seem |
| 20054 | to be the average majored by 3000, there are probably some packets lost |
| 20055 | between the proxy and the server. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20056 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20057 | - If "Ta" is large even for small byte counts, it generally is because |
| 20058 | neither the client nor the server decides to close the connection while |
| 20059 | haproxy is running in tunnel mode and both have agreed on a keep-alive |
| 20060 | connection mode. In order to solve this issue, it will be needed to specify |
| 20061 | one of the HTTP options to manipulate keep-alive or close options on either |
| 20062 | the frontend or the backend. Having the smallest possible 'Ta' or 'Tt' is |
| 20063 | important when connection regulation is used with the "maxconn" option on |
| 20064 | the servers, since no new connection will be sent to the server until |
| 20065 | another one is released. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20066 | |
| 20067 | Other noticeable HTTP log cases ('xx' means any value to be ignored) : |
| 20068 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20069 | TR/Tw/Tc/Tr/+Ta The "option logasap" is present on the frontend and the log |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20070 | was emitted before the data phase. All the timers are valid |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20071 | except "Ta" which is shorter than reality. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20072 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20073 | -1/xx/xx/xx/Ta The client was not able to send a complete request in time |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20074 | or it aborted too early. Check the session termination flags |
| 20075 | then "timeout http-request" and "timeout client" settings. |
| 20076 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20077 | TR/-1/xx/xx/Ta It was not possible to process the request, maybe because |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20078 | servers were out of order, because the request was invalid |
| 20079 | or forbidden by ACL rules. Check the session termination |
| 20080 | flags. |
| 20081 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20082 | TR/Tw/-1/xx/Ta The connection could not establish on the server. Either it |
| 20083 | actively refused it or it timed out after Ta-(TR+Tw) ms. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20084 | Check the session termination flags, then check the |
| 20085 | "timeout connect" setting. Note that the tarpit action might |
| 20086 | return similar-looking patterns, with "Tw" equal to the time |
| 20087 | the client connection was maintained open. |
| 20088 | |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20089 | TR/Tw/Tc/-1/Ta The server has accepted the connection but did not return |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 20090 | a complete response in time, or it closed its connection |
Thierry FOURNIER / OZON.IO | 4cac359 | 2016-07-28 17:19:45 +0200 | [diff] [blame] | 20091 | unexpectedly after Ta-(TR+Tw+Tc) ms. Check the session |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20092 | termination flags, then check the "timeout server" setting. |
| 20093 | |
| 20094 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 20095 | 8.5. Session state at disconnection |
| 20096 | ----------------------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20097 | |
| 20098 | TCP and HTTP logs provide a session termination indicator in the |
| 20099 | "termination_state" field, just before the number of active connections. It is |
| 20100 | 2-characters long in TCP mode, and is extended to 4 characters in HTTP mode, |
| 20101 | each of which has a special meaning : |
| 20102 | |
| 20103 | - On the first character, a code reporting the first event which caused the |
| 20104 | session to terminate : |
| 20105 | |
| 20106 | C : the TCP session was unexpectedly aborted by the client. |
| 20107 | |
| 20108 | S : the TCP session was unexpectedly aborted by the server, or the |
| 20109 | server explicitly refused it. |
| 20110 | |
| 20111 | P : the session was prematurely aborted by the proxy, because of a |
| 20112 | connection limit enforcement, because a DENY filter was matched, |
| 20113 | because of a security check which detected and blocked a dangerous |
| 20114 | error in server response which might have caused information leak |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20115 | (e.g. cacheable cookie). |
Willy Tarreau | 570f221 | 2013-06-10 16:42:09 +0200 | [diff] [blame] | 20116 | |
| 20117 | L : the session was locally processed by haproxy and was not passed to |
| 20118 | a server. This is what happens for stats and redirects. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20119 | |
| 20120 | R : a resource on the proxy has been exhausted (memory, sockets, source |
| 20121 | ports, ...). Usually, this appears during the connection phase, and |
| 20122 | system logs should contain a copy of the precise error. If this |
| 20123 | happens, it must be considered as a very serious anomaly which |
| 20124 | should be fixed as soon as possible by any means. |
| 20125 | |
| 20126 | I : an internal error was identified by the proxy during a self-check. |
| 20127 | This should NEVER happen, and you are encouraged to report any log |
| 20128 | containing this, because this would almost certainly be a bug. It |
| 20129 | would be wise to preventively restart the process after such an |
| 20130 | event too, in case it would be caused by memory corruption. |
| 20131 | |
Simon Horman | 752dc4a | 2011-06-21 14:34:59 +0900 | [diff] [blame] | 20132 | D : the session was killed by haproxy because the server was detected |
| 20133 | as down and was configured to kill all connections when going down. |
| 20134 | |
Justin Karneges | eb2c24a | 2012-05-24 15:28:52 -0700 | [diff] [blame] | 20135 | U : the session was killed by haproxy on this backup server because an |
| 20136 | active server was detected as up and was configured to kill all |
| 20137 | backup connections when going up. |
| 20138 | |
Willy Tarreau | a2a64e9 | 2011-09-07 23:01:56 +0200 | [diff] [blame] | 20139 | K : the session was actively killed by an admin operating on haproxy. |
| 20140 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20141 | c : the client-side timeout expired while waiting for the client to |
| 20142 | send or receive data. |
| 20143 | |
| 20144 | s : the server-side timeout expired while waiting for the server to |
| 20145 | send or receive data. |
| 20146 | |
| 20147 | - : normal session completion, both the client and the server closed |
| 20148 | with nothing left in the buffers. |
| 20149 | |
| 20150 | - on the second character, the TCP or HTTP session state when it was closed : |
| 20151 | |
Willy Tarreau | f7b30a9 | 2010-12-06 22:59:17 +0100 | [diff] [blame] | 20152 | R : the proxy was waiting for a complete, valid REQUEST from the client |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20153 | (HTTP mode only). Nothing was sent to any server. |
| 20154 | |
| 20155 | Q : the proxy was waiting in the QUEUE for a connection slot. This can |
| 20156 | only happen when servers have a 'maxconn' parameter set. It can |
| 20157 | also happen in the global queue after a redispatch consecutive to |
| 20158 | a failed attempt to connect to a dying server. If no redispatch is |
| 20159 | reported, then no connection attempt was made to any server. |
| 20160 | |
| 20161 | C : the proxy was waiting for the CONNECTION to establish on the |
| 20162 | server. The server might at most have noticed a connection attempt. |
| 20163 | |
| 20164 | H : the proxy was waiting for complete, valid response HEADERS from the |
| 20165 | server (HTTP only). |
| 20166 | |
| 20167 | D : the session was in the DATA phase. |
| 20168 | |
| 20169 | L : the proxy was still transmitting LAST data to the client while the |
| 20170 | server had already finished. This one is very rare as it can only |
| 20171 | happen when the client dies while receiving the last packets. |
| 20172 | |
| 20173 | T : the request was tarpitted. It has been held open with the client |
| 20174 | during the whole "timeout tarpit" duration or until the client |
| 20175 | closed, both of which will be reported in the "Tw" timer. |
| 20176 | |
| 20177 | - : normal session completion after end of data transfer. |
| 20178 | |
| 20179 | - the third character tells whether the persistence cookie was provided by |
| 20180 | the client (only in HTTP mode) : |
| 20181 | |
| 20182 | N : the client provided NO cookie. This is usually the case for new |
| 20183 | visitors, so counting the number of occurrences of this flag in the |
| 20184 | logs generally indicate a valid trend for the site frequentation. |
| 20185 | |
| 20186 | I : the client provided an INVALID cookie matching no known server. |
| 20187 | This might be caused by a recent configuration change, mixed |
Cyril Bonté | a8e7bbc | 2010-04-25 22:29:29 +0200 | [diff] [blame] | 20188 | cookies between HTTP/HTTPS sites, persistence conditionally |
| 20189 | ignored, or an attack. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20190 | |
| 20191 | D : the client provided a cookie designating a server which was DOWN, |
| 20192 | so either "option persist" was used and the client was sent to |
| 20193 | this server, or it was not set and the client was redispatched to |
| 20194 | another server. |
| 20195 | |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 20196 | V : the client provided a VALID cookie, and was sent to the associated |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20197 | server. |
| 20198 | |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 20199 | E : the client provided a valid cookie, but with a last date which was |
| 20200 | older than what is allowed by the "maxidle" cookie parameter, so |
| 20201 | the cookie is consider EXPIRED and is ignored. The request will be |
| 20202 | redispatched just as if there was no cookie. |
| 20203 | |
| 20204 | O : the client provided a valid cookie, but with a first date which was |
| 20205 | older than what is allowed by the "maxlife" cookie parameter, so |
| 20206 | the cookie is consider too OLD and is ignored. The request will be |
| 20207 | redispatched just as if there was no cookie. |
| 20208 | |
Willy Tarreau | c89ccb6 | 2012-04-05 21:18:22 +0200 | [diff] [blame] | 20209 | U : a cookie was present but was not used to select the server because |
| 20210 | some other server selection mechanism was used instead (typically a |
| 20211 | "use-server" rule). |
| 20212 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20213 | - : does not apply (no cookie set in configuration). |
| 20214 | |
| 20215 | - the last character reports what operations were performed on the persistence |
| 20216 | cookie returned by the server (only in HTTP mode) : |
| 20217 | |
| 20218 | N : NO cookie was provided by the server, and none was inserted either. |
| 20219 | |
| 20220 | I : no cookie was provided by the server, and the proxy INSERTED one. |
| 20221 | Note that in "cookie insert" mode, if the server provides a cookie, |
| 20222 | it will still be overwritten and reported as "I" here. |
| 20223 | |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 20224 | U : the proxy UPDATED the last date in the cookie that was presented by |
| 20225 | the client. This can only happen in insert mode with "maxidle". It |
Jarno Huuskonen | 0e82b92 | 2014-04-12 18:22:19 +0300 | [diff] [blame] | 20226 | happens every time there is activity at a different date than the |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 20227 | date indicated in the cookie. If any other change happens, such as |
| 20228 | a redispatch, then the cookie will be marked as inserted instead. |
| 20229 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20230 | P : a cookie was PROVIDED by the server and transmitted as-is. |
| 20231 | |
| 20232 | R : the cookie provided by the server was REWRITTEN by the proxy, which |
| 20233 | happens in "cookie rewrite" or "cookie prefix" modes. |
| 20234 | |
| 20235 | D : the cookie provided by the server was DELETED by the proxy. |
| 20236 | |
| 20237 | - : does not apply (no cookie set in configuration). |
| 20238 | |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 20239 | The combination of the two first flags gives a lot of information about what |
| 20240 | was happening when the session terminated, and why it did terminate. It can be |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20241 | helpful to detect server saturation, network troubles, local system resource |
| 20242 | starvation, attacks, etc... |
| 20243 | |
| 20244 | The most common termination flags combinations are indicated below. They are |
| 20245 | alphabetically sorted, with the lowercase set just after the upper case for |
| 20246 | easier finding and understanding. |
| 20247 | |
| 20248 | Flags Reason |
| 20249 | |
| 20250 | -- Normal termination. |
| 20251 | |
| 20252 | CC The client aborted before the connection could be established to the |
| 20253 | server. This can happen when haproxy tries to connect to a recently |
| 20254 | dead (or unchecked) server, and the client aborts while haproxy is |
| 20255 | waiting for the server to respond or for "timeout connect" to expire. |
| 20256 | |
| 20257 | CD The client unexpectedly aborted during data transfer. This can be |
| 20258 | caused by a browser crash, by an intermediate equipment between the |
| 20259 | client and haproxy which decided to actively break the connection, |
| 20260 | by network routing issues between the client and haproxy, or by a |
| 20261 | keep-alive session between the server and the client terminated first |
| 20262 | by the client. |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 20263 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20264 | cD The client did not send nor acknowledge any data for as long as the |
| 20265 | "timeout client" delay. This is often caused by network failures on |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 20266 | the client side, or the client simply leaving the net uncleanly. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20267 | |
| 20268 | CH The client aborted while waiting for the server to start responding. |
| 20269 | It might be the server taking too long to respond or the client |
| 20270 | clicking the 'Stop' button too fast. |
| 20271 | |
| 20272 | cH The "timeout client" stroke while waiting for client data during a |
| 20273 | POST request. This is sometimes caused by too large TCP MSS values |
| 20274 | for PPPoE networks which cannot transport full-sized packets. It can |
| 20275 | also happen when client timeout is smaller than server timeout and |
| 20276 | the server takes too long to respond. |
| 20277 | |
| 20278 | CQ The client aborted while its session was queued, waiting for a server |
| 20279 | with enough empty slots to accept it. It might be that either all the |
| 20280 | servers were saturated or that the assigned server was taking too |
| 20281 | long a time to respond. |
| 20282 | |
| 20283 | CR The client aborted before sending a full HTTP request. Most likely |
| 20284 | the request was typed by hand using a telnet client, and aborted |
| 20285 | too early. The HTTP status code is likely a 400 here. Sometimes this |
| 20286 | might also be caused by an IDS killing the connection between haproxy |
Willy Tarreau | 0f228a0 | 2015-05-01 15:37:53 +0200 | [diff] [blame] | 20287 | and the client. "option http-ignore-probes" can be used to ignore |
| 20288 | connections without any data transfer. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20289 | |
| 20290 | cR The "timeout http-request" stroke before the client sent a full HTTP |
| 20291 | request. This is sometimes caused by too large TCP MSS values on the |
| 20292 | client side for PPPoE networks which cannot transport full-sized |
| 20293 | packets, or by clients sending requests by hand and not typing fast |
| 20294 | enough, or forgetting to enter the empty line at the end of the |
Willy Tarreau | 2705a61 | 2014-05-23 17:38:34 +0200 | [diff] [blame] | 20295 | request. The HTTP status code is likely a 408 here. Note: recently, |
Willy Tarreau | 0f228a0 | 2015-05-01 15:37:53 +0200 | [diff] [blame] | 20296 | some browsers started to implement a "pre-connect" feature consisting |
| 20297 | in speculatively connecting to some recently visited web sites just |
| 20298 | in case the user would like to visit them. This results in many |
| 20299 | connections being established to web sites, which end up in 408 |
| 20300 | Request Timeout if the timeout strikes first, or 400 Bad Request when |
| 20301 | the browser decides to close them first. These ones pollute the log |
| 20302 | and feed the error counters. Some versions of some browsers have even |
| 20303 | been reported to display the error code. It is possible to work |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20304 | around the undesirable effects of this behavior by adding "option |
Willy Tarreau | 0f228a0 | 2015-05-01 15:37:53 +0200 | [diff] [blame] | 20305 | http-ignore-probes" in the frontend, resulting in connections with |
| 20306 | zero data transfer to be totally ignored. This will definitely hide |
| 20307 | the errors of people experiencing connectivity issues though. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20308 | |
| 20309 | CT The client aborted while its session was tarpitted. It is important to |
| 20310 | check if this happens on valid requests, in order to be sure that no |
Willy Tarreau | 55165fe | 2009-05-10 12:02:55 +0200 | [diff] [blame] | 20311 | wrong tarpit rules have been written. If a lot of them happen, it |
| 20312 | might make sense to lower the "timeout tarpit" value to something |
| 20313 | closer to the average reported "Tw" timer, in order not to consume |
| 20314 | resources for just a few attackers. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20315 | |
Willy Tarreau | 570f221 | 2013-06-10 16:42:09 +0200 | [diff] [blame] | 20316 | LR The request was intercepted and locally handled by haproxy. Generally |
| 20317 | it means that this was a redirect or a stats request. |
| 20318 | |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 20319 | SC The server or an equipment between it and haproxy explicitly refused |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20320 | the TCP connection (the proxy received a TCP RST or an ICMP message |
| 20321 | in return). Under some circumstances, it can also be the network |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20322 | stack telling the proxy that the server is unreachable (e.g. no route, |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20323 | or no ARP response on local network). When this happens in HTTP mode, |
| 20324 | the status code is likely a 502 or 503 here. |
| 20325 | |
| 20326 | sC The "timeout connect" stroke before a connection to the server could |
| 20327 | complete. When this happens in HTTP mode, the status code is likely a |
| 20328 | 503 or 504 here. |
| 20329 | |
| 20330 | SD The connection to the server died with an error during the data |
| 20331 | transfer. This usually means that haproxy has received an RST from |
| 20332 | the server or an ICMP message from an intermediate equipment while |
| 20333 | exchanging data with the server. This can be caused by a server crash |
| 20334 | or by a network issue on an intermediate equipment. |
| 20335 | |
| 20336 | sD The server did not send nor acknowledge any data for as long as the |
| 20337 | "timeout server" setting during the data phase. This is often caused |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20338 | by too short timeouts on L4 equipment before the server (firewalls, |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20339 | load-balancers, ...), as well as keep-alive sessions maintained |
| 20340 | between the client and the server expiring first on haproxy. |
| 20341 | |
| 20342 | SH The server aborted before sending its full HTTP response headers, or |
| 20343 | it crashed while processing the request. Since a server aborting at |
| 20344 | this moment is very rare, it would be wise to inspect its logs to |
| 20345 | control whether it crashed and why. The logged request may indicate a |
| 20346 | small set of faulty requests, demonstrating bugs in the application. |
| 20347 | Sometimes this might also be caused by an IDS killing the connection |
| 20348 | between haproxy and the server. |
| 20349 | |
| 20350 | sH The "timeout server" stroke before the server could return its |
| 20351 | response headers. This is the most common anomaly, indicating too |
| 20352 | long transactions, probably caused by server or database saturation. |
| 20353 | The immediate workaround consists in increasing the "timeout server" |
| 20354 | setting, but it is important to keep in mind that the user experience |
| 20355 | will suffer from these long response times. The only long term |
| 20356 | solution is to fix the application. |
| 20357 | |
| 20358 | sQ The session spent too much time in queue and has been expired. See |
| 20359 | the "timeout queue" and "timeout connect" settings to find out how to |
| 20360 | fix this if it happens too often. If it often happens massively in |
| 20361 | short periods, it may indicate general problems on the affected |
| 20362 | servers due to I/O or database congestion, or saturation caused by |
| 20363 | external attacks. |
| 20364 | |
| 20365 | PC The proxy refused to establish a connection to the server because the |
| 20366 | process' socket limit has been reached while attempting to connect. |
Cyril Bonté | dc4d903 | 2012-04-08 21:57:39 +0200 | [diff] [blame] | 20367 | The global "maxconn" parameter may be increased in the configuration |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20368 | so that it does not happen anymore. This status is very rare and |
| 20369 | might happen when the global "ulimit-n" parameter is forced by hand. |
| 20370 | |
Willy Tarreau | ed2fd2d | 2010-12-29 11:23:27 +0100 | [diff] [blame] | 20371 | PD The proxy blocked an incorrectly formatted chunked encoded message in |
| 20372 | a request or a response, after the server has emitted its headers. In |
| 20373 | most cases, this will indicate an invalid message from the server to |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20374 | the client. HAProxy supports chunk sizes of up to 2GB - 1 (2147483647 |
Willy Tarreau | f3a3e13 | 2013-08-31 08:16:26 +0200 | [diff] [blame] | 20375 | bytes). Any larger size will be considered as an error. |
Willy Tarreau | ed2fd2d | 2010-12-29 11:23:27 +0100 | [diff] [blame] | 20376 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20377 | PH The proxy blocked the server's response, because it was invalid, |
| 20378 | incomplete, dangerous (cache control), or matched a security filter. |
| 20379 | In any case, an HTTP 502 error is sent to the client. One possible |
| 20380 | cause for this error is an invalid syntax in an HTTP header name |
Willy Tarreau | ed2fd2d | 2010-12-29 11:23:27 +0100 | [diff] [blame] | 20381 | containing unauthorized characters. It is also possible but quite |
| 20382 | rare, that the proxy blocked a chunked-encoding request from the |
| 20383 | client due to an invalid syntax, before the server responded. In this |
| 20384 | case, an HTTP 400 error is sent to the client and reported in the |
| 20385 | logs. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20386 | |
| 20387 | PR The proxy blocked the client's HTTP request, either because of an |
| 20388 | invalid HTTP syntax, in which case it returned an HTTP 400 error to |
| 20389 | the client, or because a deny filter matched, in which case it |
| 20390 | returned an HTTP 403 error. |
| 20391 | |
| 20392 | PT The proxy blocked the client's request and has tarpitted its |
| 20393 | connection before returning it a 500 server error. Nothing was sent |
| 20394 | to the server. The connection was maintained open for as long as |
| 20395 | reported by the "Tw" timer field. |
| 20396 | |
| 20397 | RC A local resource has been exhausted (memory, sockets, source ports) |
| 20398 | preventing the connection to the server from establishing. The error |
| 20399 | logs will tell precisely what was missing. This is very rare and can |
| 20400 | only be solved by proper system tuning. |
| 20401 | |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 20402 | The combination of the two last flags gives a lot of information about how |
| 20403 | persistence was handled by the client, the server and by haproxy. This is very |
| 20404 | important to troubleshoot disconnections, when users complain they have to |
| 20405 | re-authenticate. The commonly encountered flags are : |
| 20406 | |
| 20407 | -- Persistence cookie is not enabled. |
| 20408 | |
| 20409 | NN No cookie was provided by the client, none was inserted in the |
| 20410 | response. For instance, this can be in insert mode with "postonly" |
| 20411 | set on a GET request. |
| 20412 | |
| 20413 | II A cookie designating an invalid server was provided by the client, |
| 20414 | a valid one was inserted in the response. This typically happens when |
Jamie Gloudon | aaa2100 | 2012-08-25 00:18:33 -0400 | [diff] [blame] | 20415 | a "server" entry is removed from the configuration, since its cookie |
Willy Tarreau | 996a92c | 2010-10-13 19:30:47 +0200 | [diff] [blame] | 20416 | value can be presented by a client when no other server knows it. |
| 20417 | |
| 20418 | NI No cookie was provided by the client, one was inserted in the |
| 20419 | response. This typically happens for first requests from every user |
| 20420 | in "insert" mode, which makes it an easy way to count real users. |
| 20421 | |
| 20422 | VN A cookie was provided by the client, none was inserted in the |
| 20423 | response. This happens for most responses for which the client has |
| 20424 | already got a cookie. |
| 20425 | |
| 20426 | VU A cookie was provided by the client, with a last visit date which is |
| 20427 | not completely up-to-date, so an updated cookie was provided in |
| 20428 | response. This can also happen if there was no date at all, or if |
| 20429 | there was a date but the "maxidle" parameter was not set, so that the |
| 20430 | cookie can be switched to unlimited time. |
| 20431 | |
| 20432 | EI A cookie was provided by the client, with a last visit date which is |
| 20433 | too old for the "maxidle" parameter, so the cookie was ignored and a |
| 20434 | new cookie was inserted in the response. |
| 20435 | |
| 20436 | OI A cookie was provided by the client, with a first visit date which is |
| 20437 | too old for the "maxlife" parameter, so the cookie was ignored and a |
| 20438 | new cookie was inserted in the response. |
| 20439 | |
| 20440 | DI The server designated by the cookie was down, a new server was |
| 20441 | selected and a new cookie was emitted in the response. |
| 20442 | |
| 20443 | VI The server designated by the cookie was not marked dead but could not |
| 20444 | be reached. A redispatch happened and selected another one, which was |
| 20445 | then advertised in the response. |
| 20446 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20447 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 20448 | 8.6. Non-printable characters |
| 20449 | ----------------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20450 | |
| 20451 | In order not to cause trouble to log analysis tools or terminals during log |
| 20452 | consulting, non-printable characters are not sent as-is into log files, but are |
| 20453 | converted to the two-digits hexadecimal representation of their ASCII code, |
| 20454 | prefixed by the character '#'. The only characters that can be logged without |
| 20455 | being escaped are comprised between 32 and 126 (inclusive). Obviously, the |
| 20456 | escape character '#' itself is also encoded to avoid any ambiguity ("#23"). It |
| 20457 | is the same for the character '"' which becomes "#22", as well as '{', '|' and |
| 20458 | '}' when logging headers. |
| 20459 | |
| 20460 | Note that the space character (' ') is not encoded in headers, which can cause |
| 20461 | issues for tools relying on space count to locate fields. A typical header |
| 20462 | containing spaces is "User-Agent". |
| 20463 | |
| 20464 | Last, it has been observed that some syslog daemons such as syslog-ng escape |
| 20465 | the quote ('"') with a backslash ('\'). The reverse operation can safely be |
| 20466 | performed since no quote may appear anywhere else in the logs. |
| 20467 | |
| 20468 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 20469 | 8.7. Capturing HTTP cookies |
| 20470 | --------------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20471 | |
| 20472 | Cookie capture simplifies the tracking a complete user session. This can be |
| 20473 | achieved using the "capture cookie" statement in the frontend. Please refer to |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 20474 | section 4.2 for more details. Only one cookie can be captured, and the same |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20475 | cookie will simultaneously be checked in the request ("Cookie:" header) and in |
| 20476 | the response ("Set-Cookie:" header). The respective values will be reported in |
| 20477 | the HTTP logs at the "captured_request_cookie" and "captured_response_cookie" |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 20478 | locations (see section 8.2.3 about HTTP log format). When either cookie is |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20479 | not seen, a dash ('-') replaces the value. This way, it's easy to detect when a |
| 20480 | user switches to a new session for example, because the server will reassign it |
| 20481 | a new cookie. It is also possible to detect if a server unexpectedly sets a |
| 20482 | wrong cookie to a client, leading to session crossing. |
| 20483 | |
| 20484 | Examples : |
| 20485 | # capture the first cookie whose name starts with "ASPSESSION" |
| 20486 | capture cookie ASPSESSION len 32 |
| 20487 | |
| 20488 | # capture the first cookie whose name is exactly "vgnvisitor" |
| 20489 | capture cookie vgnvisitor= len 32 |
| 20490 | |
| 20491 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 20492 | 8.8. Capturing HTTP headers |
| 20493 | --------------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20494 | |
| 20495 | Header captures are useful to track unique request identifiers set by an upper |
| 20496 | proxy, virtual host names, user-agents, POST content-length, referrers, etc. In |
| 20497 | the response, one can search for information about the response length, how the |
| 20498 | server asked the cache to behave, or an object location during a redirection. |
| 20499 | |
| 20500 | Header captures are performed using the "capture request header" and "capture |
| 20501 | response header" statements in the frontend. Please consult their definition in |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 20502 | section 4.2 for more details. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20503 | |
| 20504 | It is possible to include both request headers and response headers at the same |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 20505 | time. Non-existent headers are logged as empty strings, and if one header |
| 20506 | appears more than once, only its last occurrence will be logged. Request headers |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20507 | are grouped within braces '{' and '}' in the same order as they were declared, |
| 20508 | and delimited with a vertical bar '|' without any space. Response headers |
| 20509 | follow the same representation, but are displayed after a space following the |
| 20510 | request headers block. These blocks are displayed just before the HTTP request |
| 20511 | in the logs. |
| 20512 | |
Willy Tarreau | d9ed3d2 | 2014-06-13 12:23:06 +0200 | [diff] [blame] | 20513 | As a special case, it is possible to specify an HTTP header capture in a TCP |
| 20514 | frontend. The purpose is to enable logging of headers which will be parsed in |
| 20515 | an HTTP backend if the request is then switched to this HTTP backend. |
| 20516 | |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20517 | Example : |
| 20518 | # This instance chains to the outgoing proxy |
| 20519 | listen proxy-out |
| 20520 | mode http |
| 20521 | option httplog |
| 20522 | option logasap |
| 20523 | log global |
| 20524 | server cache1 192.168.1.1:3128 |
| 20525 | |
| 20526 | # log the name of the virtual server |
| 20527 | capture request header Host len 20 |
| 20528 | |
| 20529 | # log the amount of data uploaded during a POST |
| 20530 | capture request header Content-Length len 10 |
| 20531 | |
| 20532 | # log the beginning of the referrer |
| 20533 | capture request header Referer len 20 |
| 20534 | |
| 20535 | # server name (useful for outgoing proxies only) |
| 20536 | capture response header Server len 20 |
| 20537 | |
| 20538 | # logging the content-length is useful with "option logasap" |
| 20539 | capture response header Content-Length len 10 |
| 20540 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20541 | # log the expected cache behavior on the response |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20542 | capture response header Cache-Control len 8 |
| 20543 | |
| 20544 | # the Via header will report the next proxy's name |
| 20545 | capture response header Via len 20 |
| 20546 | |
| 20547 | # log the URL location during a redirection |
| 20548 | capture response header Location len 20 |
| 20549 | |
| 20550 | >>> Aug 9 20:26:09 localhost \ |
| 20551 | haproxy[2022]: 127.0.0.1:34014 [09/Aug/2004:20:26:09] proxy-out \ |
| 20552 | proxy-out/cache1 0/0/0/162/+162 200 +350 - - ---- 0/0/0/0/0 0/0 \ |
| 20553 | {fr.adserver.yahoo.co||http://fr.f416.mail.} {|864|private||} \ |
| 20554 | "GET http://fr.adserver.yahoo.com/" |
| 20555 | |
| 20556 | >>> Aug 9 20:30:46 localhost \ |
| 20557 | haproxy[2022]: 127.0.0.1:34020 [09/Aug/2004:20:30:46] proxy-out \ |
| 20558 | proxy-out/cache1 0/0/0/182/+182 200 +279 - - ---- 0/0/0/0/0 0/0 \ |
| 20559 | {w.ods.org||} {Formilux/0.1.8|3495|||} \ |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 20560 | "GET http://trafic.1wt.eu/ HTTP/1.1" |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20561 | |
| 20562 | >>> Aug 9 20:30:46 localhost \ |
| 20563 | haproxy[2022]: 127.0.0.1:34028 [09/Aug/2004:20:30:46] proxy-out \ |
| 20564 | proxy-out/cache1 0/0/2/126/+128 301 +223 - - ---- 0/0/0/0/0 0/0 \ |
| 20565 | {www.sytadin.equipement.gouv.fr||http://trafic.1wt.eu/} \ |
| 20566 | {Apache|230|||http://www.sytadin.} \ |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 20567 | "GET http://www.sytadin.equipement.gouv.fr/ HTTP/1.1" |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20568 | |
| 20569 | |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 20570 | 8.9. Examples of logs |
| 20571 | --------------------- |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20572 | |
| 20573 | These are real-world examples of logs accompanied with an explanation. Some of |
| 20574 | them have been made up by hand. The syslog part has been removed for better |
| 20575 | reading. Their sole purpose is to explain how to decipher them. |
| 20576 | |
| 20577 | >>> haproxy[674]: 127.0.0.1:33318 [15/Oct/2003:08:31:57.130] px-http \ |
| 20578 | px-http/srv1 6559/0/7/147/6723 200 243 - - ---- 5/3/3/1/0 0/0 \ |
| 20579 | "HEAD / HTTP/1.0" |
| 20580 | |
| 20581 | => long request (6.5s) entered by hand through 'telnet'. The server replied |
| 20582 | in 147 ms, and the session ended normally ('----') |
| 20583 | |
| 20584 | >>> haproxy[674]: 127.0.0.1:33319 [15/Oct/2003:08:31:57.149] px-http \ |
| 20585 | px-http/srv1 6559/1230/7/147/6870 200 243 - - ---- 324/239/239/99/0 \ |
| 20586 | 0/9 "HEAD / HTTP/1.0" |
| 20587 | |
| 20588 | => Idem, but the request was queued in the global queue behind 9 other |
| 20589 | requests, and waited there for 1230 ms. |
| 20590 | |
| 20591 | >>> haproxy[674]: 127.0.0.1:33320 [15/Oct/2003:08:32:17.654] px-http \ |
| 20592 | px-http/srv1 9/0/7/14/+30 200 +243 - - ---- 3/3/3/1/0 0/0 \ |
| 20593 | "GET /image.iso HTTP/1.0" |
| 20594 | |
| 20595 | => request for a long data transfer. The "logasap" option was specified, so |
Krzysztof Piotr Oledzki | f864533 | 2009-12-13 21:55:50 +0100 | [diff] [blame] | 20596 | the log was produced just before transferring data. The server replied in |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20597 | 14 ms, 243 bytes of headers were sent to the client, and total time from |
| 20598 | accept to first data byte is 30 ms. |
| 20599 | |
| 20600 | >>> haproxy[674]: 127.0.0.1:33320 [15/Oct/2003:08:32:17.925] px-http \ |
| 20601 | px-http/srv1 9/0/7/14/30 502 243 - - PH-- 3/2/2/0/0 0/0 \ |
| 20602 | "GET /cgi-bin/bug.cgi? HTTP/1.0" |
| 20603 | |
Christopher Faulet | 87f1f3d | 2019-07-18 14:51:20 +0200 | [diff] [blame] | 20604 | => the proxy blocked a server response either because of an "http-response |
| 20605 | deny" rule, or because the response was improperly formatted and not |
| 20606 | HTTP-compliant, or because it blocked sensitive information which risked |
| 20607 | being cached. In this case, the response is replaced with a "502 bad |
| 20608 | gateway". The flags ("PH--") tell us that it was haproxy who decided to |
| 20609 | return the 502 and not the server. |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20610 | |
| 20611 | >>> haproxy[18113]: 127.0.0.1:34548 [15/Oct/2003:15:18:55.798] px-http \ |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 20612 | px-http/<NOSRV> -1/-1/-1/-1/8490 -1 0 - - CR-- 2/2/2/0/0 0/0 "" |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20613 | |
| 20614 | => the client never completed its request and aborted itself ("C---") after |
| 20615 | 8.5s, while the proxy was waiting for the request headers ("-R--"). |
| 20616 | Nothing was sent to any server. |
| 20617 | |
| 20618 | >>> haproxy[18113]: 127.0.0.1:34549 [15/Oct/2003:15:19:06.103] px-http \ |
| 20619 | px-http/<NOSRV> -1/-1/-1/-1/50001 408 0 - - cR-- 2/2/2/0/0 0/0 "" |
| 20620 | |
| 20621 | => The client never completed its request, which was aborted by the |
| 20622 | time-out ("c---") after 50s, while the proxy was waiting for the request |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20623 | headers ("-R--"). Nothing was sent to any server, but the proxy could |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20624 | send a 408 return code to the client. |
| 20625 | |
| 20626 | >>> haproxy[18989]: 127.0.0.1:34550 [15/Oct/2003:15:24:28.312] px-tcp \ |
| 20627 | px-tcp/srv1 0/0/5007 0 cD 0/0/0/0/0 0/0 |
| 20628 | |
| 20629 | => This log was produced with "option tcplog". The client timed out after |
| 20630 | 5 seconds ("c----"). |
| 20631 | |
| 20632 | >>> haproxy[18989]: 10.0.0.1:34552 [15/Oct/2003:15:26:31.462] px-http \ |
| 20633 | px-http/srv1 3183/-1/-1/-1/11215 503 0 - - SC-- 205/202/202/115/3 \ |
Willy Tarreau | d72758d | 2010-01-12 10:42:19 +0100 | [diff] [blame] | 20634 | 0/0 "HEAD / HTTP/1.0" |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20635 | |
| 20636 | => The request took 3s to complete (probably a network problem), and the |
Willy Tarreau | c57f0e2 | 2009-05-10 13:12:33 +0200 | [diff] [blame] | 20637 | connection to the server failed ('SC--') after 4 attempts of 2 seconds |
Willy Tarreau | cc6c891 | 2009-02-22 10:53:55 +0100 | [diff] [blame] | 20638 | (config says 'retries 3'), and no redispatch (otherwise we would have |
| 20639 | seen "/+3"). Status code 503 was returned to the client. There were 115 |
| 20640 | connections on this server, 202 connections on this proxy, and 205 on |
| 20641 | the global process. It is possible that the server refused the |
| 20642 | connection because of too many already established. |
Willy Tarreau | 844e3c5 | 2008-01-11 16:28:18 +0100 | [diff] [blame] | 20643 | |
Willy Tarreau | 52b2d22 | 2011-09-07 23:48:48 +0200 | [diff] [blame] | 20644 | |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 20645 | 9. Supported filters |
| 20646 | -------------------- |
| 20647 | |
| 20648 | Here are listed officially supported filters with the list of parameters they |
| 20649 | accept. Depending on compile options, some of these filters might be |
| 20650 | unavailable. The list of available filters is reported in haproxy -vv. |
| 20651 | |
| 20652 | See also : "filter" |
| 20653 | |
| 20654 | 9.1. Trace |
| 20655 | ---------- |
| 20656 | |
Christopher Faulet | c41d8bd | 2020-11-17 10:43:26 +0100 | [diff] [blame] | 20657 | filter trace [name <name>] [random-forwarding] [hexdump] |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 20658 | |
| 20659 | Arguments: |
| 20660 | <name> is an arbitrary name that will be reported in |
| 20661 | messages. If no name is provided, "TRACE" is used. |
| 20662 | |
Christopher Faulet | 96a577a | 2020-11-17 10:45:05 +0100 | [diff] [blame] | 20663 | <quiet> inhibits trace messages. |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 20664 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20665 | <random-forwarding> enables the random forwarding of parsed data. By |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 20666 | default, this filter forwards all previously parsed |
| 20667 | data. With this parameter, it only forwards a random |
| 20668 | amount of the parsed data. |
| 20669 | |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20670 | <hexdump> dumps all forwarded data to the server and the client. |
Christopher Faulet | 31bfe1f | 2016-12-09 17:42:38 +0100 | [diff] [blame] | 20671 | |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 20672 | This filter can be used as a base to develop new filters. It defines all |
| 20673 | callbacks and print a message on the standard error stream (stderr) with useful |
| 20674 | information for all of them. It may be useful to debug the activity of other |
| 20675 | filters or, quite simply, HAProxy's activity. |
| 20676 | |
| 20677 | Using <random-parsing> and/or <random-forwarding> parameters is a good way to |
| 20678 | tests the behavior of a filter that parses data exchanged between a client and |
| 20679 | a server by adding some latencies in the processing. |
| 20680 | |
| 20681 | |
| 20682 | 9.2. HTTP compression |
| 20683 | --------------------- |
| 20684 | |
| 20685 | filter compression |
| 20686 | |
| 20687 | The HTTP compression has been moved in a filter in HAProxy 1.7. "compression" |
| 20688 | keyword must still be used to enable and configure the HTTP compression. And |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20689 | when no other filter is used, it is enough. When used with the cache or the |
| 20690 | fcgi-app enabled, it is also enough. In this case, the compression is always |
| 20691 | done after the response is stored in the cache. But it is mandatory to |
| 20692 | explicitly use a filter line to enable the HTTP compression when at least one |
| 20693 | filter other than the cache or the fcgi-app is used for the same |
| 20694 | listener/frontend/backend. This is important to know the filters evaluation |
| 20695 | order. |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 20696 | |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20697 | See also : "compression", section 9.4 about the cache filter and section 9.5 |
| 20698 | about the fcgi-app filter. |
Christopher Faulet | c3fe533 | 2016-04-07 15:30:10 +0200 | [diff] [blame] | 20699 | |
| 20700 | |
Christopher Faulet | f7e4e7e | 2016-10-27 22:29:49 +0200 | [diff] [blame] | 20701 | 9.3. Stream Processing Offload Engine (SPOE) |
| 20702 | -------------------------------------------- |
| 20703 | |
| 20704 | filter spoe [engine <name>] config <file> |
| 20705 | |
| 20706 | Arguments : |
| 20707 | |
| 20708 | <name> is the engine name that will be used to find the right scope in |
| 20709 | the configuration file. If not provided, all the file will be |
| 20710 | parsed. |
| 20711 | |
| 20712 | <file> is the path of the engine configuration file. This file can |
| 20713 | contain configuration of several engines. In this case, each |
| 20714 | part must be placed in its own scope. |
| 20715 | |
| 20716 | The Stream Processing Offload Engine (SPOE) is a filter communicating with |
| 20717 | external components. It allows the offload of some specifics processing on the |
Davor Ocelic | e9ed281 | 2017-12-25 17:49:28 +0100 | [diff] [blame] | 20718 | streams in tiered applications. These external components and information |
Christopher Faulet | f7e4e7e | 2016-10-27 22:29:49 +0200 | [diff] [blame] | 20719 | exchanged with them are configured in dedicated files, for the main part. It |
| 20720 | also requires dedicated backends, defined in HAProxy configuration. |
| 20721 | |
| 20722 | SPOE communicates with external components using an in-house binary protocol, |
| 20723 | the Stream Processing Offload Protocol (SPOP). |
| 20724 | |
Tim Düsterhus | 4896c44 | 2016-11-29 02:15:19 +0100 | [diff] [blame] | 20725 | For all information about the SPOE configuration and the SPOP specification, see |
Christopher Faulet | f7e4e7e | 2016-10-27 22:29:49 +0200 | [diff] [blame] | 20726 | "doc/SPOE.txt". |
| 20727 | |
Christopher Faulet | 99a17a2 | 2018-12-11 09:18:27 +0100 | [diff] [blame] | 20728 | 9.4. Cache |
| 20729 | ---------- |
| 20730 | |
| 20731 | filter cache <name> |
| 20732 | |
| 20733 | Arguments : |
| 20734 | |
| 20735 | <name> is name of the cache section this filter will use. |
| 20736 | |
| 20737 | The cache uses a filter to store cacheable responses. The HTTP rules |
| 20738 | "cache-store" and "cache-use" must be used to define how and when to use a |
John Roesler | fb2fce1 | 2019-07-10 15:45:51 -0500 | [diff] [blame] | 20739 | cache. By default the corresponding filter is implicitly defined. And when no |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20740 | other filters than fcgi-app or compression are used, it is enough. In such |
| 20741 | case, the compression filter is always evaluated after the cache filter. But it |
| 20742 | is mandatory to explicitly use a filter line to use a cache when at least one |
| 20743 | filter other than the compression or the fcgi-app is used for the same |
Christopher Faulet | 27d93c3 | 2018-12-15 22:32:02 +0100 | [diff] [blame] | 20744 | listener/frontend/backend. This is important to know the filters evaluation |
| 20745 | order. |
Christopher Faulet | 99a17a2 | 2018-12-11 09:18:27 +0100 | [diff] [blame] | 20746 | |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20747 | See also : section 9.2 about the compression filter, section 9.5 about the |
| 20748 | fcgi-app filter and section 6 about cache. |
| 20749 | |
| 20750 | |
| 20751 | 9.5. Fcgi-app |
| 20752 | ------------- |
| 20753 | |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 20754 | filter fcgi-app <name> |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20755 | |
| 20756 | Arguments : |
| 20757 | |
| 20758 | <name> is name of the fcgi-app section this filter will use. |
| 20759 | |
| 20760 | The FastCGI application uses a filter to evaluate all custom parameters on the |
| 20761 | request path, and to process the headers on the response path. the <name> must |
| 20762 | reference an existing fcgi-app section. The directive "use-fcgi-app" should be |
| 20763 | used to define the application to use. By default the corresponding filter is |
| 20764 | implicitly defined. And when no other filters than cache or compression are |
| 20765 | used, it is enough. But it is mandatory to explicitly use a filter line to a |
| 20766 | fcgi-app when at least one filter other than the compression or the cache is |
| 20767 | used for the same backend. This is important to know the filters evaluation |
| 20768 | order. |
| 20769 | |
| 20770 | See also: "use-fcgi-app", section 9.2 about the compression filter, section 9.4 |
| 20771 | about the cache filter and section 10 about FastCGI application. |
| 20772 | |
| 20773 | |
Miroslav Zagorac | dc32cd9 | 2020-12-13 18:32:57 +0100 | [diff] [blame] | 20774 | 9.6. OpenTracing |
| 20775 | ---------------- |
| 20776 | |
| 20777 | The OpenTracing filter adds native support for using distributed tracing in |
| 20778 | HAProxy. This is enabled by sending an OpenTracing compliant request to one |
| 20779 | of the supported tracers such as Datadog, Jaeger, Lightstep and Zipkin tracers. |
| 20780 | Please note: tracers are not listed by any preference, but alphabetically. |
| 20781 | |
| 20782 | This feature is only enabled when haproxy was built with USE_OT=1. |
| 20783 | |
| 20784 | The OpenTracing filter activation is done explicitly by specifying it in the |
| 20785 | HAProxy configuration. If this is not done, the OpenTracing filter in no way |
| 20786 | participates in the work of HAProxy. |
| 20787 | |
| 20788 | filter opentracing [id <id>] config <file> |
| 20789 | |
| 20790 | Arguments : |
| 20791 | |
| 20792 | <id> is the OpenTracing filter id that will be used to find the |
| 20793 | right scope in the configuration file. If no filter id is |
| 20794 | specified, 'ot-filter' is used as default. If scope is not |
| 20795 | specified in the configuration file, it applies to all defined |
| 20796 | OpenTracing filters. |
| 20797 | |
| 20798 | <file> is the path of the OpenTracing configuration file. The same |
| 20799 | file can contain configurations for multiple OpenTracing |
| 20800 | filters simultaneously. In that case we do not need to define |
| 20801 | scope so the same configuration applies to all filters or each |
| 20802 | filter must have its own scope defined. |
| 20803 | |
| 20804 | More detailed documentation related to the operation, configuration and use |
| 20805 | of the filter can be found in the contrib/opentracing directory. |
| 20806 | |
| 20807 | |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20808 | 10. FastCGI applications |
| 20809 | ------------------------- |
| 20810 | |
| 20811 | HAProxy is able to send HTTP requests to Responder FastCGI applications. This |
| 20812 | feature was added in HAProxy 2.1. To do so, servers must be configured to use |
| 20813 | the FastCGI protocol (using the keyword "proto fcgi" on the server line) and a |
| 20814 | FastCGI application must be configured and used by the backend managing these |
| 20815 | servers (using the keyword "use-fcgi-app" into the proxy section). Several |
| 20816 | FastCGI applications may be defined, but only one can be used at a time by a |
| 20817 | backend. |
| 20818 | |
| 20819 | HAProxy implements all features of the FastCGI specification for Responder |
| 20820 | application. Especially it is able to multiplex several requests on a simple |
| 20821 | connection. |
| 20822 | |
| 20823 | 10.1. Setup |
| 20824 | ----------- |
| 20825 | |
| 20826 | 10.1.1. Fcgi-app section |
| 20827 | -------------------------- |
| 20828 | |
| 20829 | fcgi-app <name> |
| 20830 | Declare a FastCGI application named <name>. To be valid, at least the |
| 20831 | document root must be defined. |
| 20832 | |
| 20833 | acl <aclname> <criterion> [flags] [operator] <value> ... |
| 20834 | Declare or complete an access list. |
| 20835 | |
| 20836 | See "acl" keyword in section 4.2 and section 7 about ACL usage for |
| 20837 | details. ACLs defined for a FastCGI application are private. They cannot be |
| 20838 | used by any other application or by any proxy. In the same way, ACLs defined |
| 20839 | in any other section are not usable by a FastCGI application. However, |
| 20840 | Pre-defined ACLs are available. |
| 20841 | |
| 20842 | docroot <path> |
| 20843 | Define the document root on the remote host. <path> will be used to build |
| 20844 | the default value of FastCGI parameters SCRIPT_FILENAME and |
| 20845 | PATH_TRANSLATED. It is a mandatory setting. |
| 20846 | |
| 20847 | index <script-name> |
| 20848 | Define the script name that will be appended after an URI that ends with a |
| 20849 | slash ("/") to set the default value of the FastCGI parameter SCRIPT_NAME. It |
| 20850 | is an optional setting. |
| 20851 | |
| 20852 | Example : |
| 20853 | index index.php |
| 20854 | |
| 20855 | log-stderr global |
| 20856 | log-stderr <address> [len <length>] [format <format>] |
Jan Wagner | 3e67860 | 2020-12-17 22:22:32 +0100 | [diff] [blame] | 20857 | [sample <ranges>:<sample_size>] <facility> [<level> [<minlevel>]] |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20858 | Enable logging of STDERR messages reported by the FastCGI application. |
| 20859 | |
| 20860 | See "log" keyword in section 4.2 for details. It is an optional setting. By |
| 20861 | default STDERR messages are ignored. |
| 20862 | |
| 20863 | pass-header <name> [ { if | unless } <condition> ] |
| 20864 | Specify the name of a request header which will be passed to the FastCGI |
| 20865 | application. It may optionally be followed by an ACL-based condition, in |
| 20866 | which case it will only be evaluated if the condition is true. |
| 20867 | |
| 20868 | Most request headers are already available to the FastCGI application, |
| 20869 | prefixed with "HTTP_". Thus, this directive is only required to pass headers |
| 20870 | that are purposefully omitted. Currently, the headers "Authorization", |
| 20871 | "Proxy-Authorization" and hop-by-hop headers are omitted. |
| 20872 | |
| 20873 | Note that the headers "Content-type" and "Content-length" are never passed to |
| 20874 | the FastCGI application because they are already converted into parameters. |
| 20875 | |
| 20876 | path-info <regex> |
Christopher Faulet | 28cb366 | 2020-02-14 14:47:37 +0100 | [diff] [blame] | 20877 | Define a regular expression to extract the script-name and the path-info from |
Christopher Faulet | 6c57f2d | 2020-02-14 16:55:52 +0100 | [diff] [blame] | 20878 | the URL-decoded path. Thus, <regex> may have two captures: the first one to |
| 20879 | capture the script name and the second one to capture the path-info. The |
| 20880 | first one is mandatory, the second one is optional. This way, it is possible |
| 20881 | to extract the script-name from the path ignoring the path-info. It is an |
| 20882 | optional setting. If it is not defined, no matching is performed on the |
| 20883 | path. and the FastCGI parameters PATH_INFO and PATH_TRANSLATED are not |
| 20884 | filled. |
Christopher Faulet | 28cb366 | 2020-02-14 14:47:37 +0100 | [diff] [blame] | 20885 | |
| 20886 | For security reason, when this regular expression is defined, the newline and |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 20887 | the null characters are forbidden from the path, once URL-decoded. The reason |
Christopher Faulet | 28cb366 | 2020-02-14 14:47:37 +0100 | [diff] [blame] | 20888 | to such limitation is because otherwise the matching always fails (due to a |
| 20889 | limitation one the way regular expression are executed in HAProxy). So if one |
| 20890 | of these two characters is found in the URL-decoded path, an error is |
| 20891 | returned to the client. The principle of least astonishment is applied here. |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20892 | |
| 20893 | Example : |
Christopher Faulet | 6c57f2d | 2020-02-14 16:55:52 +0100 | [diff] [blame] | 20894 | path-info ^(/.+\.php)(/.*)?$ # both script-name and path-info may be set |
| 20895 | path-info ^(/.+\.php) # the path-info is ignored |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20896 | |
| 20897 | option get-values |
| 20898 | no option get-values |
| 20899 | Enable or disable the retrieve of variables about connection management. |
| 20900 | |
Daniel Corbett | 67a8271 | 2020-07-06 23:01:19 -0400 | [diff] [blame] | 20901 | HAProxy is able to send the record FCGI_GET_VALUES on connection |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20902 | establishment to retrieve the value for following variables: |
| 20903 | |
| 20904 | * FCGI_MAX_REQS The maximum number of concurrent requests this |
| 20905 | application will accept. |
| 20906 | |
William Lallemand | 93e548e | 2019-09-30 13:54:02 +0200 | [diff] [blame] | 20907 | * FCGI_MPXS_CONNS "0" if this application does not multiplex connections, |
| 20908 | "1" otherwise. |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20909 | |
| 20910 | Some FastCGI applications does not support this feature. Some others close |
Ilya Shipitsin | 11057a3 | 2020-06-21 21:18:27 +0500 | [diff] [blame] | 20911 | the connection immediately after sending their response. So, by default, this |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 20912 | option is disabled. |
| 20913 | |
| 20914 | Note that the maximum number of concurrent requests accepted by a FastCGI |
| 20915 | application is a connection variable. It only limits the number of streams |
| 20916 | per connection. If the global load must be limited on the application, the |
| 20917 | server parameters "maxconn" and "pool-max-conn" must be set. In addition, if |
| 20918 | an application does not support connection multiplexing, the maximum number |
| 20919 | of concurrent requests is automatically set to 1. |
| 20920 | |
| 20921 | option keep-conn |
| 20922 | no option keep-conn |
| 20923 | Instruct the FastCGI application to keep the connection open or not after |
| 20924 | sending a response. |
| 20925 | |
| 20926 | If disabled, the FastCGI application closes the connection after responding |
| 20927 | to this request. By default, this option is enabled. |
| 20928 | |
| 20929 | option max-reqs <reqs> |
| 20930 | Define the maximum number of concurrent requests this application will |
| 20931 | accept. |
| 20932 | |
| 20933 | This option may be overwritten if the variable FCGI_MAX_REQS is retrieved |
| 20934 | during connection establishment. Furthermore, if the application does not |
| 20935 | support connection multiplexing, this option will be ignored. By default set |
| 20936 | to 1. |
| 20937 | |
| 20938 | option mpxs-conns |
| 20939 | no option mpxs-conns |
| 20940 | Enable or disable the support of connection multiplexing. |
| 20941 | |
| 20942 | This option may be overwritten if the variable FCGI_MPXS_CONNS is retrieved |
| 20943 | during connection establishment. It is disabled by default. |
| 20944 | |
| 20945 | set-param <name> <fmt> [ { if | unless } <condition> ] |
| 20946 | Set a FastCGI parameter that should be passed to this application. Its |
| 20947 | value, defined by <fmt> must follows the log-format rules (see section 8.2.4 |
| 20948 | "Custom Log format"). It may optionally be followed by an ACL-based |
| 20949 | condition, in which case it will only be evaluated if the condition is true. |
| 20950 | |
| 20951 | With this directive, it is possible to overwrite the value of default FastCGI |
| 20952 | parameters. If the value is evaluated to an empty string, the rule is |
| 20953 | ignored. These directives are evaluated in their declaration order. |
| 20954 | |
| 20955 | Example : |
| 20956 | # PHP only, required if PHP was built with --enable-force-cgi-redirect |
| 20957 | set-param REDIRECT_STATUS 200 |
| 20958 | |
| 20959 | set-param PHP_AUTH_DIGEST %[req.hdr(Authorization)] |
| 20960 | |
| 20961 | |
| 20962 | 10.1.2. Proxy section |
| 20963 | --------------------- |
| 20964 | |
| 20965 | use-fcgi-app <name> |
| 20966 | Define the FastCGI application to use for the backend. |
| 20967 | |
| 20968 | Arguments : |
| 20969 | <name> is the name of the FastCGI application to use. |
| 20970 | |
| 20971 | This keyword is only available for HTTP proxies with the backend capability |
| 20972 | and with at least one FastCGI server. However, FastCGI servers can be mixed |
| 20973 | with HTTP servers. But except there is a good reason to do so, it is not |
| 20974 | recommended (see section 10.3 about the limitations for details). Only one |
| 20975 | application may be defined at a time per backend. |
| 20976 | |
| 20977 | Note that, once a FastCGI application is referenced for a backend, depending |
| 20978 | on the configuration some processing may be done even if the request is not |
| 20979 | sent to a FastCGI server. Rules to set parameters or pass headers to an |
| 20980 | application are evaluated. |
| 20981 | |
| 20982 | |
| 20983 | 10.1.3. Example |
| 20984 | --------------- |
| 20985 | |
| 20986 | frontend front-http |
| 20987 | mode http |
| 20988 | bind *:80 |
| 20989 | bind *: |
| 20990 | |
| 20991 | use_backend back-dynamic if { path_reg ^/.+\.php(/.*)?$ } |
| 20992 | default_backend back-static |
| 20993 | |
| 20994 | backend back-static |
| 20995 | mode http |
| 20996 | server www A.B.C.D:80 |
| 20997 | |
| 20998 | backend back-dynamic |
| 20999 | mode http |
| 21000 | use-fcgi-app php-fpm |
| 21001 | server php-fpm A.B.C.D:9000 proto fcgi |
| 21002 | |
| 21003 | fcgi-app php-fpm |
| 21004 | log-stderr global |
| 21005 | option keep-conn |
| 21006 | |
| 21007 | docroot /var/www/my-app |
| 21008 | index index.php |
| 21009 | path-info ^(/.+\.php)(/.*)?$ |
| 21010 | |
| 21011 | |
| 21012 | 10.2. Default parameters |
| 21013 | ------------------------ |
| 21014 | |
| 21015 | A Responder FastCGI application has the same purpose as a CGI/1.1 program. In |
| 21016 | the CGI/1.1 specification (RFC3875), several variables must be passed to the |
Ilya Shipitsin | 8525fd9 | 2020-02-29 12:34:59 +0500 | [diff] [blame] | 21017 | script. So HAProxy set them and some others commonly used by FastCGI |
Christopher Faulet | b30b310 | 2019-09-12 23:03:09 +0200 | [diff] [blame] | 21018 | applications. All these variables may be overwritten, with caution though. |
| 21019 | |
| 21020 | +-------------------+-----------------------------------------------------+ |
| 21021 | | AUTH_TYPE | Identifies the mechanism, if any, used by HAProxy | |
| 21022 | | | to authenticate the user. Concretely, only the | |
| 21023 | | | BASIC authentication mechanism is supported. | |
| 21024 | | | | |
| 21025 | +-------------------+-----------------------------------------------------+ |
| 21026 | | CONTENT_LENGTH | Contains the size of the message-body attached to | |
| 21027 | | | the request. It means only requests with a known | |
| 21028 | | | size are considered as valid and sent to the | |
| 21029 | | | application. | |
| 21030 | | | | |
| 21031 | +-------------------+-----------------------------------------------------+ |
| 21032 | | CONTENT_TYPE | Contains the type of the message-body attached to | |
| 21033 | | | the request. It may not be set. | |
| 21034 | | | | |
| 21035 | +-------------------+-----------------------------------------------------+ |
| 21036 | | DOCUMENT_ROOT | Contains the document root on the remote host under | |
| 21037 | | | which the script should be executed, as defined in | |
| 21038 | | | the application's configuration. | |
| 21039 | | | | |
| 21040 | +-------------------+-----------------------------------------------------+ |
| 21041 | | GATEWAY_INTERFACE | Contains the dialect of CGI being used by HAProxy | |
| 21042 | | | to communicate with the FastCGI application. | |
| 21043 | | | Concretely, it is set to "CGI/1.1". | |
| 21044 | | | | |
| 21045 | +-------------------+-----------------------------------------------------+ |
| 21046 | | PATH_INFO | Contains the portion of the URI path hierarchy | |
| 21047 | | | following the part that identifies the script | |
| 21048 | | | itself. To be set, the directive "path-info" must | |
| 21049 | | | be defined. | |
| 21050 | | | | |
| 21051 | +-------------------+-----------------------------------------------------+ |
| 21052 | | PATH_TRANSLATED | If PATH_INFO is set, it is its translated version. | |
| 21053 | | | It is the concatenation of DOCUMENT_ROOT and | |
| 21054 | | | PATH_INFO. If PATH_INFO is not set, this parameters | |
| 21055 | | | is not set too. | |
| 21056 | | | | |
| 21057 | +-------------------+-----------------------------------------------------+ |
| 21058 | | QUERY_STRING | Contains the request's query string. It may not be | |
| 21059 | | | set. | |
| 21060 | | | | |
| 21061 | +-------------------+-----------------------------------------------------+ |
| 21062 | | REMOTE_ADDR | Contains the network address of the client sending | |
| 21063 | | | the request. | |
| 21064 | | | | |
| 21065 | +-------------------+-----------------------------------------------------+ |
| 21066 | | REMOTE_USER | Contains the user identification string supplied by | |
| 21067 | | | client as part of user authentication. | |
| 21068 | | | | |
| 21069 | +-------------------+-----------------------------------------------------+ |
| 21070 | | REQUEST_METHOD | Contains the method which should be used by the | |
| 21071 | | | script to process the request. | |
| 21072 | | | | |
| 21073 | +-------------------+-----------------------------------------------------+ |
| 21074 | | REQUEST_URI | Contains the request's URI. | |
| 21075 | | | | |
| 21076 | +-------------------+-----------------------------------------------------+ |
| 21077 | | SCRIPT_FILENAME | Contains the absolute pathname of the script. it is | |
| 21078 | | | the concatenation of DOCUMENT_ROOT and SCRIPT_NAME. | |
| 21079 | | | | |
| 21080 | +-------------------+-----------------------------------------------------+ |
| 21081 | | SCRIPT_NAME | Contains the name of the script. If the directive | |
| 21082 | | | "path-info" is defined, it is the first part of the | |
| 21083 | | | URI path hierarchy, ending with the script name. | |
| 21084 | | | Otherwise, it is the entire URI path. | |
| 21085 | | | | |
| 21086 | +-------------------+-----------------------------------------------------+ |
| 21087 | | SERVER_NAME | Contains the name of the server host to which the | |
| 21088 | | | client request is directed. It is the value of the | |
| 21089 | | | header "Host", if defined. Otherwise, the | |
| 21090 | | | destination address of the connection on the client | |
| 21091 | | | side. | |
| 21092 | | | | |
| 21093 | +-------------------+-----------------------------------------------------+ |
| 21094 | | SERVER_PORT | Contains the destination TCP port of the connection | |
| 21095 | | | on the client side, which is the port the client | |
| 21096 | | | connected to. | |
| 21097 | | | | |
| 21098 | +-------------------+-----------------------------------------------------+ |
| 21099 | | SERVER_PROTOCOL | Contains the request's protocol. | |
| 21100 | | | | |
| 21101 | +-------------------+-----------------------------------------------------+ |
| 21102 | | HTTPS | Set to a non-empty value ("on") if the script was | |
| 21103 | | | queried through the HTTPS protocol. | |
| 21104 | | | | |
| 21105 | +-------------------+-----------------------------------------------------+ |
| 21106 | |
| 21107 | |
| 21108 | 10.3. Limitations |
| 21109 | ------------------ |
| 21110 | |
| 21111 | The current implementation have some limitations. The first one is about the |
| 21112 | way some request headers are hidden to the FastCGI applications. This happens |
| 21113 | during the headers analysis, on the backend side, before the connection |
| 21114 | establishment. At this stage, HAProxy know the backend is using a FastCGI |
| 21115 | application but it don't know if the request will be routed to a FastCGI server |
| 21116 | or not. But to hide request headers, it simply removes them from the HTX |
| 21117 | message. So, if the request is finally routed to an HTTP server, it never see |
| 21118 | these headers. For this reason, it is not recommended to mix FastCGI servers |
| 21119 | and HTTP servers under the same backend. |
| 21120 | |
| 21121 | Similarly, the rules "set-param" and "pass-header" are evaluated during the |
| 21122 | request headers analysis. So the evaluation is always performed, even if the |
| 21123 | requests is finally forwarded to an HTTP server. |
| 21124 | |
| 21125 | About the rules "set-param", when a rule is applied, a pseudo header is added |
| 21126 | into the HTX message. So, the same way than for HTTP header rewrites, it may |
| 21127 | fail if the buffer is full. The rules "set-param" will compete with |
| 21128 | "http-request" ones. |
| 21129 | |
| 21130 | Finally, all FastCGI params and HTTP headers are sent into a unique record |
| 21131 | FCGI_PARAM. Encoding of this record must be done in one pass, otherwise a |
| 21132 | processing error is returned. It means the record FCGI_PARAM, once encoded, |
| 21133 | must not exceeds the size of a buffer. However, there is no reserve to respect |
| 21134 | here. |
William Lallemand | 86d0df0 | 2017-11-24 21:36:45 +0100 | [diff] [blame] | 21135 | |
Willy Tarreau | 0ba2750 | 2007-12-24 16:55:16 +0100 | [diff] [blame] | 21136 | /* |
| 21137 | * Local variables: |
| 21138 | * fill-column: 79 |
| 21139 | * End: |
| 21140 | */ |